Переглянути джерело

update recipes and demo text to reflect deprecation of `pandoc-citeproc`

George C. Privon 2 роки тому
батько
коміт
7840708d74
5 змінених файлів з 18 додано та 17 видалено
  1. 3 2
      README.md
  2. 3 3
      aa/README.md
  3. 4 4
      aastex63/README.md
  4. 5 5
      aastex63/demo.md
  5. 3 3
      mnras/README.md

+ 3 - 2
README.md

@@ -32,11 +32,12 @@ These templates require:
 - [pandoc](https://pandoc.org)
 - A (La)TeX typesetting engine (If you want to make a PDF instead of just stopping at TeX source)
 
-Technically optional, but since I have never seen a paper without citations and in-text references, you will also probably want:
+Technically optional, but since I have never seen a paper without in-text references, you will also probably want:
 
-- [pandoc-citeproc](https://github.com/jgm/pandoc-citeproc)
 - [pandoc-crossref](https://github.com/lierdakil/pandoc-crossref)
 
+*Note*: `[pandoc-citeproc](https://github.com/jgm/pandoc-citeproc)` has been deprecated in favor of `[citeproc](https://github.com/jgm/citeproc)`; the latter is now a built-in library.
+
 ## Ancillary Files
 
 In order to create a PDF from your Markdown source (or the demos included here) you will need the appropriate style file for the journal.

+ 3 - 3
aa/README.md

@@ -3,13 +3,13 @@
 Generate a `tex` file with:
 
 ```
-pandoc demo-structured_abstract.md -s --template aa_template.tex -o demo-structured_abstract.tex -F pandoc-crossref -F pandoc-citeproc --lua-filter=filters/acknowledgments.lua --natbib
+pandoc demo-structured_abstract.md -s --template aa_template.tex -o demo-structured_abstract.tex -F pandoc-crossref --citeproc --lua-filter=filters/acknowledgments.lua --natbib
 ```
 
 Go straight to the pdf with:
 
 ```
-pandoc demo-structured_abstract.md -s --template aa_template.tex -o demo-structured_abstract.pdf -F pandoc-crossref -F pandoc-citeproc --lua-filter=filters/acknowledgments.lua --pdf-engine=xelatex
+pandoc demo-structured_abstract.md -s --template aa_template.tex -o demo-structured_abstract.pdf -F pandoc-crossref --citeproc --lua-filter=filters/acknowledgments.lua --pdf-engine=xelatex
 ```
 
 There are two demonstration files containing sample articles:
@@ -31,4 +31,4 @@ There are two demonstration files containing sample articles:
 
 * The A&A template requires manual enumeration and de-duplication of affilations but this likely requires construction of a pandoc filter to properly handle. For now, all affilations are given the same superscript code and the user must manually adjust to suit.
 * A&A table environments pass through to LaTeX without trouble. But note that these will not translate to other outputs (HTML, epub, etc.). So consider what your desired outputs will be before you put lots of effort into tables. Or write a [pandoc filter](https://pandoc.org/filters.html) to handle tables.
-* The A&A bibliography format is not part of the [Zotero (citation) Style Repository](https://www.zotero.org/styles) so `pandoc-citeproc` does not have access to the correct citation style. This means that using `pandoc` to output directly to PDF will not result in the correct reference formatting. See above for a method to get PDF output with journal-compatible references.
+* The A&A bibliography format is not part of the [Zotero (citation) Style Repository](https://www.zotero.org/styles) so `citeproc` does not have access to the correct citation style. This means that using `pandoc` to output directly to PDF will not result in the correct reference formatting. See above for a method to get PDF output with journal-compatible references.

+ 4 - 4
aastex63/README.md

@@ -3,13 +3,13 @@
 Generate a TeX file with:
 
 ```
-pandoc demo.md -s --template aastex63_template.tex -o demo.tex -F pandoc-crossref -F pandoc-citeproc --lua-filter=filters/acknowledgments.lua --no-highlight --natbib
+pandoc demo.md -s --template aastex63_template.tex -o demo.tex -F pandoc-crossref --citeproc --lua-filter=filters/acknowledgments.lua --no-highlight --natbib
 ```
 
 Go straight to the PDF with:
 
 ```
-pandoc demo.md -s --template aastex63_template.tex -o demo.pdf -F pandoc-crossref -F pandoc-citeproc --lua-filter=filters/acknowledgments.lua --pdf-engine=xelatex --no-highlight
+pandoc demo.md -s --template aastex63_template.tex -o demo.pdf -F pandoc-crossref --citeproc --lua-filter=filters/acknowledgments.lua --pdf-engine=xelatex --no-highlight
 ```
 
 The [`demo.md`](demo.md) file contains a sample article describing the use of this template in generating AASTeX output via pandoc.
@@ -45,10 +45,10 @@ A bare-bones example HTML template is provided in the [`aastex63_website_templat
 This, along with `demo.md`, can be converted to a HTML page with:
 
 ```
-pandoc demo.md -s --template aastex63_website_template.html -o demo.html -F pandoc-crossref -F pandoc-citeproc --lua-filter=filters/acknowledgments.lua
+pandoc demo.md -s --template aastex63_website_template.html -o demo.html -F pandoc-crossref --citeproc --lua-filter=filters/acknowledgments.lua
 ```
 
 ## Known Issues
 
 * AASTeX table environments pass through to LaTeX without trouble. But note that these will not translate to other outputs (HTML, epub, etc.). So consider what your desired outputs will be before you put lots of effort into tables. Or write a [pandoc filter](https://pandoc.org/filters.html) to handle tables.
-* The AAS bibliography format is not part of the [Zotero (citation) Style Repository](https://www.zotero.org/styles) so `pandoc-citeproc` does not have access to the correct citation style. This means that using `pandoc` to output directly to PDF will not result in the correct reference formatting. See above for a method to get PDF output with AAS Journals compatible references.
+* The AAS bibliography format is not part of the [Zotero (citation) Style Repository](https://www.zotero.org/styles) so `citeproc` does not have access to the correct citation style. This means that using `pandoc` to output directly to PDF will not result in the correct reference formatting. See above for a method to get PDF output with AAS Journals compatible references.

+ 5 - 5
aastex63/demo.md

@@ -26,7 +26,7 @@ author:
 #  affiliation: ["Department of Psychoceramics, Wesleyan University, Middletown, CT", "Department of Psychoceramics, Brown University: Providence, RI"]
 #  collaboration: "(ORCID Demonstration)"
 keywords: [miscellaneous]
-software: ["[`pandoc`](http://pandoc.org)", "[`pandoc-citeproc`](https://github.com/jgm/pandoc-citeproc)", "[`pandoc-crossref`](https://github.com/lierdakil/pandoc-crossref)"]
+software: ["[`pandoc`](http://pandoc.org)", "[`citeproc`](https://github.com/jgm/citeproc)", "[`pandoc-crossref`](https://github.com/lierdakil/pandoc-crossref)"]
 facility: []
 abstract: |
   Markdown is a markup format that can be used to create articles with readable source while making it easy to translate to other formats (e.g., \TeX\, HTML, docx, and PDF [via \TeX]).
@@ -230,9 +230,9 @@ So the benefits of directly including \TeX\ tables in the Markdown file must be
 
 ## Citations {#sec:citations}
 
-Citations can be incorporated using the `pandoc-citeproc` filter.
+Citations can be incorporated using the `citeproc` filter.
 These citations take the form of: `[@Astropy2018]`, which corresponds to to: [@Astropy2018] or `@Astropy2018` to cite in the format of: @Astropy2018.
-By default, `pandoc-citeproc` will convert the references into text when generating \TeX\ or PDF files, in a format specified by the user via a Citation Style Language^[<https://citationstyles.org/>] definition.
+By default, `citeproc` will convert the references into text when generating \TeX\ or PDF files, in a format specified by the user via a Citation Style Language^[<https://citationstyles.org/>] definition.
 Presently most of the main astrophysics journals lack entries in the CSL database.
 In order to create journal-compatible submission files the Markdown file must be explicitly converted to \TeX\ prior to compilation to PDF.
 
@@ -309,8 +309,8 @@ Note that a lua parser is included with `pandoc` versions 2.0 and newer, and the
 
 Naively `pandoc` does not support internal reference to figures or equations and does not support numbered section references.
 However the `pandoc-crossref` filter adds support for this (and has been used in the preparation of this document).
-`pandoc-crossref` uses the same syntax as `pandoc-citeproc`, so adds little cognitive overhead in inter-document referencing.
-However to avoid `pandoc-citeproc` incorrectly processing internal references, `pandoc-crossref` must be invoked first.
+`pandoc-crossref` uses the same syntax as `citeproc`, so adds little cognitive overhead in inter-document referencing.
+However to avoid `citeproc` incorrectly processing internal references, `pandoc-crossref` must be invoked first.
 
 ## \TeX\ Clean up {#sec:texclean}
 

+ 3 - 3
mnras/README.md

@@ -3,13 +3,13 @@
 Generate a `tex` file with:
 
 ```
-pandoc demo.md -s --template mnras_template.tex -o demo.tex -F pandoc-crossref -F pandoc-citeproc --lua-filter=filters/acknowledgments.lua --natbib
+pandoc demo.md -s --template mnras_template.tex -o demo.tex -F pandoc-crossref --citeproc --lua-filter=filters/acknowledgments.lua --natbib
 ```
 
 Go straight to the pdf with:
 
 ```
-pandoc demo.md -s --template mnras_template.tex -o demo.pdf -F pandoc-crossref -F pandoc-citeproc --lua-filter=filters/acknowledgments.lua --pdf-engine=xelatex
+pandoc demo.md -s --template mnras_template.tex -o demo.pdf -F pandoc-crossref --citeproc --lua-filter=filters/acknowledgments.lua --pdf-engine=xelatex
 ```
 
 The `demo.md` file contains a sample article describing the use of this template in generating MNRAS output via pandoc.
@@ -28,4 +28,4 @@ The `demo.md` file contains a sample article describing the use of this template
 
 * The MNRAS template requires manual enumeration and de-duplication of affilations but this likely requires construction of a pandoc filter to properly handle. For now, all affilations are given the same superscript code and the user must manually adjust to suit.
 * MNRAS table environments pass through to LaTeX without trouble. But note that these will not translate to other outputs (HTML, epub, etc.). So consider what your desired outputs will be before you put lots of effort into tables. Or write a [pandoc filter](https://pandoc.org/filters.html) to handle tables.
-* The MNRAS bibliography format is not part of the [Zotero (citation) Style Repository](https://www.zotero.org/styles) so `pandoc-citeproc` does not have access to the correct citation style. This means that using `pandoc` to output directly to PDF will not result in the correct reference formatting. See above for a method to get PDF output with journal-compatible references.
+* The MNRAS bibliography format is not part of the [Zotero (citation) Style Repository](https://www.zotero.org/styles) so `citeproc` does not have access to the correct citation style. This means that using `pandoc` to output directly to PDF will not result in the correct reference formatting. See above for a method to get PDF output with journal-compatible references.