Upgrade pandoc to 2.14 and fix plugin breaks #427

vincerubinetti · 2021-06-02T22:28:39Z

supersedes #425

new citeproc filter name upgrade pandoc-xnos packages refs tomduck/pandoc-fignos#85 upgrade panflute to 2.0.5 includes fix to #386 (comment): Element "MetaList" received "CSL_Item" but expected <class 'panflute.base.MetaValue'> pandoc html: disable document-css in template From pandoc 2.11 (2020-10-11) changelog: > Add CSS to default HTML template (#6601, Mauro Bieg). This greatly improves the default typography in pandoc’s HTML output. The CSS is sensitive to a number of variables (e.g. mainfont, fontsize, linestretch): see the manual for details. To restore the earlier, more spartan output, you can disable this with -M document-css=false. pandoc 2.11.3 https://github.com/jgm/pandoc/releases/tag/2.11.3

…stock into dhimmel-pandoc-2.13

AppVeyorBot · 2021-06-02T22:31:48Z

AppVeyor build 1.0.244 for commit b5233d9 is now complete.

Found 52 potential spelling error(s). Preview:

content/02.delete-me.md:44:adipiscing
content/02.delete-me.md:44:aliqua
content/02.delete-me.md:44:amet
content/02.delete-me.md:44:consectetur
content/02.delete-me.md:44:dolore
content/02.delete-me.md:44:eiusmod
content/02.delete-me.md:44:elit
content/02.delete-me.md:44:incididunt
content/02.delete-me.md:44:ipsum
content/02.delete-me.md:44:labore
content/02.delete-me.md:44:Lorem
content/02.delete-me.md:44:magna
content/02...

The rendered manuscript from this build is temporarily available for download at:

dhimmel · 2021-06-03T02:19:04Z

build/plugins/anchors.html

@@ -10,7 +10,8 @@
 <script type="module">
  // which types of elements to add anchors next to, in "document.querySelector"
  // format
-  const typesQuery = 'h1, h2, h3, [id^="fig:"], [id^="tbl:"], [id^="eq:"]';
+  const typesQuery =
+    'h1, h2, h3, div[id^="fig:"], div[id^="tbl:"], span[id^="eq:"]';


Is div[id^="fig:"]the workaround for double table ids (on the div and table) mentioned at #425 (comment)? It works by only matching div ids that start with tbl: as opposed to all elements?

Just to confirm, it is okay for us to proceed despite the duplicate ids, because this PR handles it?

Opened tomduck/pandoc-tablenos#31

Is div[id^="fig:"]the workaround for double table ids (on the div and table) mentioned at #425 (comment)? It works by only matching div ids that start with tbl: as opposed to all elements?

That's correct. I've essentially made the queries more specific. As long as pandoc/table-nos is consistent and never outputs a table without the div wrapper, this should be fine.

Looked at the issue, 👍 FWIW id's being unique isn't just a suggestion, it's a requirement of the spec and can cause unexpected behavior. It shouldn't cause anything to crash though.

Got it.

As long as pandoc/table-nos is consistent and never outputs a table without the div wrapper, this should be fine.

Based on the early discussion in the issue, it seems like the most likely fix is that pandoc-tablenos stops adding the div wrapper for tables since the id is now set in <table>.

So if we upgrade pandoc-tablenos, we might have to tweak this, but that's okay. Let's wait to see what solution pandoc-tablenos adopts and merge this now.

Oh if that’s the case we’ll need to re-add the plug-in to wrap tables in divs for scrolling purposes 😞

dhimmel · 2021-06-03T02:21:54Z

build/themes/default.html

+  .csl-entry {
+    margin-top: 20px;
+    margin-bottom: 20px;
+  }


I think I'd be in favor of a slightly smaller margin between references than:

I think we do want some, but since reference sections can get quite long, perhaps we could get by with slightly less? Maybe 15 (or 50% to 75% of the current spacing)?

Reduced to 15px. I wouldn't recommend going lower than that, as it becomes difficult to distinguish for sighted and hard-of-seeing people alike.

Here's 15. Looks good:

dhimmel

Reviewing https://ci.appveyor.com/api/buildjobs/992931201tet4bko/artifacts/manuscript-1.0.244-b5233d9.html and everything looks good (one small comment about references spacing).

Thanks a lot!

AppVeyorBot · 2021-06-03T16:04:15Z

AppVeyor build 1.0.245 for commit ea9a48f is now complete.

Found 52 potential spelling error(s). Preview:

content/02.delete-me.md:44:adipiscing
content/02.delete-me.md:44:aliqua
content/02.delete-me.md:44:amet
content/02.delete-me.md:44:consectetur
content/02.delete-me.md:44:dolore
content/02.delete-me.md:44:eiusmod
content/02.delete-me.md:44:elit
content/02.delete-me.md:44:incididunt
content/02.delete-me.md:44:ipsum
content/02.delete-me.md:44:labore
content/02.delete-me.md:44:Lorem
content/02.delete-me.md:44:magna
content/02...

The rendered manuscript from this build is temporarily available for download at:

dhimmel

LGTM. Will wait for @agitter to review before merging

dhimmel · 2021-06-09T00:03:34Z

@agitter following up in case you'd like to review

agitter

Looks good to me. I have two minor suggestions, both optional.

USAGE.md

build/environment.yml

Co-authored-by: Anthony Gitter <[email protected]>

AppVeyorBot · 2021-06-10T13:11:47Z

AppVeyor build 1.0.246

agitter · 2021-06-10T16:30:20Z

The builds are failing because adding panflute to the conda-installed packages revealed an actual conflict. panflute 2.1 supports pandoc versions 2.11.0.4—2.13.x. When we install panflute from pip, it can't check the pandoc version. The conda-forge recipe does check the pandoc version.

Our environment appears to work based on the HTML artifacts above when we ran with panflute 2.1.0 and pandoc 2.14.0.1. Should we revert 9ae8d19 and proceed to merge?

Edit: I asked about any known compatibility issues in sergiocorreia/panflute#192

This reverts commit 9ae8d19.

AppVeyorBot · 2021-06-10T23:15:55Z

AppVeyor build 1.0.247

Found 52 potential spelling error(s). Preview:

content/02.delete-me.md:44:adipiscing
content/02.delete-me.md:44:aliqua
content/02.delete-me.md:44:amet
content/02.delete-me.md:44:consectetur
content/02.delete-me.md:44:dolore
content/02.delete-me.md:44:eiusmod
content/02.delete-me.md:44:elit
content/02.delete-me.md:44:incididunt
content/02.delete-me.md:44:ipsum
content/02.delete-me.md:44:labore
content/02.delete-me.md:44:Lorem
content/02.delete-me.md:44:magna
content/02...

for commit eb824ce is now complete. The rendered manuscript from this build is temporarily available for download at:

dhimmel · 2021-06-10T23:20:48Z

Thanks all for the help! Especially @vincerubinetti for the frontend edits. The diff looks simple in the end, but this includes some major upgrades in our dependencies.

* setup.bash: interactive script to guide setup merges manubot/rootstock#417 closes manubot/rootstock#401 * Add "gh repo create" to SETUP.md merges manubot/rootstock#419 closes manubot/rootstock#418 Co-authored-by: Daniel Himmelstein <[email protected]> Co-authored-by: Anthony Gitter <[email protected]> * BUILD_LATEX for basic LaTeX manuscript merges manubot/rootstock#384 refs manubot/rootstock#249 * Pandoc 2.14: update HTML plugins, CSL style, citekey syntax merges manubot/rootstock#427 Co-authored-by: Daniel Himmelstein <[email protected]> Co-authored-by: Anthony Gitter <[email protected]> Co-authored-by: nfry321 <[email protected]> Co-authored-by: Tiago Lubiana <[email protected]> Co-authored-by: Daniel Himmelstein <[email protected]> Co-authored-by: Anthony Gitter <[email protected]> Co-authored-by: Vincent Rubinetti <[email protected]>

merges manubot/rootstock#427 Co-authored-by: Daniel Himmelstein <[email protected]> Co-authored-by: Anthony Gitter <[email protected]>

dhimmel and others added 7 commits May 29, 2021 11:43

upgrade environment

0881325

CSL style: remove handing indent

a6d315c

update pandoc to 2.14

fd7ff49

USAGE: document curly-brace citation keys

fe18096

Merge branch 'pandoc-2.13' of https://github.com/dhimmel/manubot-root…

d3947c3

…stock into dhimmel-pandoc-2.13

upgrade pandoc to 2.13 and fix plugin breaks

b5233d9

vincerubinetti requested review from dhimmel and agitter June 2, 2021 22:28

vincerubinetti mentioned this pull request Jun 2, 2021

upgrade pandoc to version 2.14 #425

Closed

dhimmel reviewed Jun 3, 2021

View reviewed changes

dhimmel changed the title ~~Upgrade pandoc to 2.13 and fix plugin breaks~~ Upgrade pandoc to 2.14 and fix plugin breaks Jun 3, 2021

update csl entry margins

ea9a48f

dhimmel approved these changes Jun 3, 2021

View reviewed changes

agitter approved these changes Jun 9, 2021

View reviewed changes

USAGE.md Outdated Show resolved Hide resolved

build/environment.yml Show resolved Hide resolved

dhimmel and others added 2 commits June 10, 2021 09:08

Update USAGE.md

21617d8

Co-authored-by: Anthony Gitter <[email protected]>

use conda for panflute

9ae8d19

Revert "use conda for panflute"

eb824ce

This reverts commit 9ae8d19.

dhimmel merged commit defe787 into manubot:main Jun 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade pandoc to 2.14 and fix plugin breaks #427

Upgrade pandoc to 2.14 and fix plugin breaks #427

vincerubinetti commented Jun 2, 2021 •

edited by dhimmel

Loading

AppVeyorBot commented Jun 2, 2021

dhimmel Jun 3, 2021

dhimmel Jun 3, 2021

vincerubinetti Jun 3, 2021

dhimmel Jun 3, 2021 •

edited

Loading

vincerubinetti Jun 3, 2021

dhimmel Jun 3, 2021

vincerubinetti Jun 3, 2021

dhimmel Jun 3, 2021

dhimmel left a comment

AppVeyorBot commented Jun 3, 2021

dhimmel left a comment

dhimmel commented Jun 9, 2021

agitter left a comment

AppVeyorBot commented Jun 10, 2021

agitter commented Jun 10, 2021 •

edited

Loading

AppVeyorBot commented Jun 10, 2021

dhimmel commented Jun 10, 2021

Upgrade pandoc to 2.14 and fix plugin breaks #427

Upgrade pandoc to 2.14 and fix plugin breaks #427

Conversation

vincerubinetti commented Jun 2, 2021 • edited by dhimmel Loading

AppVeyorBot commented Jun 2, 2021

dhimmel Jun 3, 2021

Choose a reason for hiding this comment

dhimmel Jun 3, 2021

Choose a reason for hiding this comment

vincerubinetti Jun 3, 2021

Choose a reason for hiding this comment

dhimmel Jun 3, 2021 • edited Loading

Choose a reason for hiding this comment

vincerubinetti Jun 3, 2021

Choose a reason for hiding this comment

dhimmel Jun 3, 2021

Choose a reason for hiding this comment

vincerubinetti Jun 3, 2021

Choose a reason for hiding this comment

dhimmel Jun 3, 2021

Choose a reason for hiding this comment

dhimmel left a comment

Choose a reason for hiding this comment

AppVeyorBot commented Jun 3, 2021

dhimmel left a comment

Choose a reason for hiding this comment

dhimmel commented Jun 9, 2021

agitter left a comment

Choose a reason for hiding this comment

AppVeyorBot commented Jun 10, 2021

agitter commented Jun 10, 2021 • edited Loading

AppVeyorBot commented Jun 10, 2021

dhimmel commented Jun 10, 2021

vincerubinetti commented Jun 2, 2021 •

edited by dhimmel

Loading

dhimmel Jun 3, 2021 •

edited

Loading

agitter commented Jun 10, 2021 •

edited

Loading