Process citations / references with pandoc-manubot-cite filter#300
Process citations / references with pandoc-manubot-cite filter#300dhimmel merged 10 commits intomanubot:masterfrom
Conversation
5e82a38 to
dcff05a
Compare
|
AppVeyor build 1.0.71 for commit dcff05a by @dhimmel is now complete. The rendered manuscript from this build is temporarily available for download at: |
301ab30 to
3ae0f1d
Compare
|
AppVeyor build 1.0.73 for commit 3ae0f1d by @dhimmel failed. |
|
AppVeyor build 1.0.74 for commit 9b1192f by @dhimmel is now complete. The rendered manuscript from this build is temporarily available for download at: |
|
AppVeyor build 1.0.75 for commit bb468d1 by @dhimmel is now complete. The rendered manuscript from this build is temporarily available for download at: |
content/metadata.yaml
Outdated
| citekey-aliases: | ||
| tag:deep-review: doi:10.1098/rsif.2017.0387 |
There was a problem hiding this comment.
For reference, it looks like users need to replace the tab separation from citation-tags.tsv with a space for the YAML to be valid. We could look into manubot process converting citation-tags to citation-aliases if --skip-citations is specified.
I'm also not sure that this is the best place to specify citekey-aliases. It is okay. We should see how it interacts with defaults and per-markdown file yaml metadata blocks. Another option is to default to the link-reference syntax for defining aliases.
There was a problem hiding this comment.
A possible downside of defaulting to the link-reference syntax could be a greater chance of multiply defined tags. We could recommend putting them all in one Markdown file, even a new dedicated files like tags.md.
There was a problem hiding this comment.
A possible downside of defaulting to the link-reference syntax could be a greater chance of multiply defined tags
This is easy to detect and warn (update already do).
We could recommend putting them all in one Markdown file, even a new dedicated files like tags.md.
One downside of this is that it doesn't allow normal markdown viewers to render the link. One of the big benefits of link-reference syntax is the ability of:
[@citekey] to render as a link
[@citekey]: https://github.com/manubot/rootstock/pull/300To render in places like GitHub like below:
@citekey to render as a link
|
AppVeyor build 1.0.76 for commit 49dcfcd by @dhimmel is now complete. The rendered manuscript from this build is temporarily available for download at: |
|
AppVeyor build 1.0.77 for commit b6d61e1 by @dhimmel is now complete. The rendered manuscript from this build is temporarily available for download at: |
|
AppVeyor build 1.0.78 for commit 3984ee9 by @dhimmel is now complete. The rendered manuscript from this build is temporarily available for download at: |
add temp citation-tags.tsv for testing
|
AppVeyor build 1.0.79 for commit d1967d9 by @dhimmel is now complete. The rendered manuscript from this build is temporarily available for download at: |
|
AppVeyor build 1.0.80 for commit 0a7fe11 by @dhimmel is now complete. The rendered manuscript from this build is temporarily available for download at: |
|
AppVeyor build 1.0.81 for commit feb228c by @dhimmel is now complete. The rendered manuscript from this build is temporarily available for download at: |
|
@agitter I am going to merge, since I want to start rolling out this change for additional testing and usage experience. Will address any comments in a subsequent PRs. |
This build is based on 6636b91. This commit was created by the following Travis CI build and job: https://travis-ci.com/manubot/rootstock/builds/144344566 https://travis-ci.com/manubot/rootstock/jobs/275411125 The full commit message that triggered this build is copied below: Process citations / references with pandoc-manubot-cite filter merges #300
This build is based on 6636b91. This commit was created by the following Travis CI build and job: https://travis-ci.com/manubot/rootstock/builds/144344566 https://travis-ci.com/manubot/rootstock/jobs/275411125 The full commit message that triggered this build is copied below: Process citations / references with pandoc-manubot-cite filter merges #300
agitter
left a comment
There was a problem hiding this comment.
This merged pull request looks good to me. I found two small things that could be addressed in a future pull request.
| ``` | ||
|
|
||
| This syntax is also used by [`pandoc-url2cite`](https://github.com/phiresky/pandoc-url2cite). | ||
| Make sure to place these link reference definitions in their own paragraphs. |
There was a problem hiding this comment.
In a future pull request, we can note that these can be placed in any of the content Markdown files. The location for these aliases could be ambiguous because they are not in a dedicated tags file.
| tag:my-doi: doi:10.1016/S0022-2836(05)80360-2 | ||
| ``` | ||
|
|
||
| For backwards compatability, tags can also be defined in `content/citation-tags.tsv`. |
Before merge:
manubot/manubotTesting out manubot/manubot#99 and how it would be integrated with rootstock.