aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)AuthorFilesLines
2020-09-21Add built-in citation support using new citeproc library.John MacFarlane1-183/+347
This deprecates the use of the external pandoc-citeproc filter; citation processing is now built in to pandoc. * Add dependency on citeproc library. * Add Text.Pandoc.Citeproc module (and some associated unexported modules under Text.Pandoc.Citeproc). Exports `processCitations`. [API change] * Add data files needed for Text.Pandoc.Citeproc: default.csl in the data directory, and a citeproc directory that is just used at compile-time. Note that we've added file-embed as a mandatory rather than a conditional depedency, because of the biblatex localization files. We might eventually want to use readDataFile for this, but it would take some code reorganization. * Text.Pandoc.Loging: Add `CiteprocWarning` to `LogMessage` and use it in `processCitations`. [API change] * Add tests from the pandoc-citeproc package as command tests (including some tests pandoc-citeproc did not pass). * Remove instructions for building pandoc-citeproc from CI and release binary build instructions. We will no longer distribute pandoc-citeproc. * Markdown reader: tweak abbreviation support. Don't insert a nonbreaking space after a potential abbreviation if it comes right before a note or citation. This messes up several things, including citeproc's moving of note citations. * Add `csljson` as and input and output format. This allows pandoc to convert between `csljson` and other bibliography formats, and to generate formatted versions of CSL JSON bibliographies. * Add module Text.Pandoc.Writers.CslJson, exporting `writeCslJson`. [API change] * Add module Text.Pandoc.Readers.CslJson, exporting `readCslJson`. [API change] * Added `bibtex`, `biblatex` as input formats. This allows pandoc to convert between BibLaTeX and BibTeX and other bibliography formats, and to generated formatted versions of BibTeX/BibLaTeX bibliographies. * Add module Text.Pandoc.Readers.BibTeX, exporting `readBibTeX` and `readBibLaTeX`. [API change] * Make "standalone" implicit if output format is a bibliography format. This is needed because pandoc readers for bibliography formats put the bibliographic information in the `references` field of metadata; and unless standalone is specified, metadata gets ignored. (TODO: This needs improvement. We should trigger standalone for the reader when the input format is bibliographic, and for the writer when the output format is markdown.) * Carry over `citationNoteNum` to `citationNoteNumber`. This was just ignored in pandoc-citeproc. * Text.Pandoc.Filter: Add `CiteprocFilter` constructor to Filter. [API change] This runs the processCitations transformation. We need to treat it like a filter so it can be placed in the sequence of filter runs (after some, before others). In FromYAML, this is parsed from `citeproc` or `{type: citeproc}`, so this special filter may be specified either way in a defaults file (or by `citeproc: true`, though this gives no control of positioning relative to other filters). TODO: we need to add something to the manual section on defaults files for this. * Add deprecation warning if `upandoc-citeproc` filter is used. * Add `--citeproc/-C` option to trigger citation processing. This behaves like a filter and will be positioned relative to filters as they appear on the command line. * Rewrote the manual on citatations, adding a dedicated Citations section which also includes some information formerly found in the pandoc-citeproc man page. * Look for CSL styles in the `csl` subdirectory of the pandoc user data directory. This changes the old pandoc-citeproc behavior, which looked in `~/.csl`. Users can simply symlink `~/.csl` to the `csl` subdirectory of their pandoc user data directory if they want the old behavior. * Add support for CSL bibliography entry formatting to LaTeX, HTML, Ms writers. Added CSL-related CSS to styles.html.
2020-09-19Add CSS to default HTML template (#6601)Mauro Bieg1-0/+37
2020-09-13Delete obsolete MANUAL section on compact and loose lists.John MacFarlane1-24/+0
This gives a rule that has been been superseded by commit 47537d26db29b9dd0810d039933497d4db4ed813. The section is concerned to explain a discrepancy with original Markdown.pl and its test suite. In the case under consideration, Markdown.pl gave strange results which pandoc corrected. I think it's no longer worth wasting space on this, as its behavior seems clearly wrong. If we are going to comment on every edge case with Markdown.pl, the manual will get too long. Babelmark 2 shows that some of the older implementations follow Markdown.pl -- PHP Markdown, Python Markdown, redcarpet, discount. https://johnmacfarlane.net/babelmark2/?normalize=1&text=%2B+++First%0A%2B+++Second%0A++++-+a%0A++++-+b%0A%0A%2B+Third%0A Closes #6684.
2020-09-13MANUAL: fix position of attributes in headerAlbert Krewinkel1-1/+1
2020-08-09MANUAL: remove lists of support extensions for markdown variants.John MacFarlane1-46/+20
Instead, offer the advice to use `--list-extensions=FORMAT`. Closes #6604.
2020-07-27Remove duplicate 'seriespage'. (#6568)Blake Eryx1-1/+0
2020-07-23update date, man page, README.John MacFarlane1-1/+1
2020-07-23Add `raw_markdown` extension affecting `ipynb` reader.John MacFarlane1-0/+8
Specifying `-f ipynb+raw_markdown` will cause Markdown cells to be represented as raw Markdown blocks, instead of being parsed. This is not what you want when going from `ipynb` to other formats, but it may be useful when going from `ipynb` to Markdown or to `ipynb`, to avoid semantically insignificant changes in the contents of the Markdown cells that might otherwise be introduced. Closes #5408.
2020-07-22Docx writer: support --number-sections.John MacFarlane1-1/+2
Closes #1413.
2020-07-19Remove use of cmark-gfm for commonmark/gfm rendering.John MacFarlane1-1/+2
Instead rely on the markdown writer with appropriate extensions. Export writeCommonMark variant from Markdown writer. This changes a few small things in rendering markdown, e.g. w/r/t requiring backslashes before spaces inside super/subscripts.
2020-07-19Add commonmark_x output format...John MacFarlane1-0/+2
commonmark with a number of useful extensions (more than gfm).
2020-07-19Add generic `attributes` extension.John MacFarlane1-0/+31
This allows attributes to be added to any block or inline element, in principle. (Though in many cases this will be done by adding a Div or Span container, since pandoc's AST doesn't have a slot for attributes for most elements.) Currently this is only possible with the commonmark and gfm readers. Add `Ext_attributes` constructor for `Extension` [API change].
2020-07-19MANUAL.txt: rewrite Raw HTML/TeX section...John MacFarlane1-47/+37
...to avoid duplicate headings for the extensions.
2020-07-19Remove duplicate 'titlepage' in docsBlake Eryx1-1/+0
2020-07-05Fix typo in MANUAL.txtBenjamin Wuethrich1-1/+1
2020-06-29Update manual date, generate man page.John MacFarlane1-1/+1
2020-06-28Delete misleading sentence in manualfor --verboseJohn MacFarlane1-2/+1
2020-06-21MANUAL: clarify partial naming (#6476)Mauro Bieg1-6/+14
2020-06-15MANUAL: describe `jira` as "Jira/Confluence wiki markup"Albert Krewinkel1-2/+2
In the past, Jira's wiki markup was also used by – and could be imported into – Atlassian Confluence. Closes: #6351
2020-05-30Change default revealjs-url to use CDN version of revealjs v4.John MacFarlane1-1/+2
See #6408.
2020-05-20Update links to reveal.js documentation (#6386)Salim B1-4/+3
With the [release of reveal.js 4.0.0](https://github.com/hakimel/reveal.js/releases/tag/4.0.0), the documentation moved from the GitHub README to the dedicated website <https://revealjs.com/>. Note that there are [further adjustments](https://revealjs.com/upgrading/) to the [Pandoc template](https://github.com/jgm/pandoc-templates/blob/master/default.revealjs) necessary in order to make Pandoc work with reveal.js 4.0.0.
2020-05-10Fix misleading note about image size conversions in MANUAL.John MacFarlane1-4/+6
Closes #6353.
2020-05-02LaTeX Writer: Add support for customizable alignment of columns in beamer ↵andrebauer1-0/+35
(#6331) Add support for customizable alignment of columns in beamer. Closes #4805, closes #4150.
2020-04-23Manual: separate adjacent verbatim code blocks (#6307)tom-audm1-12/+24
2020-04-13Add an option to disable certificate validation (#6156)Cédric Couralet1-0/+6
This commit adds the option `--no-check-certificate`, which disables certificate checking when resources are fetched by HTTP. Co-authored-by: Cécile Chemin <cecile.chemin@insee.fr> Co-authored-by: Juliette Fourcot <juliette.fourcot@insee.fr>
2020-04-12Require doctemplates 0.8.2.John MacFarlane1-0/+16
2020-04-11MANUAL: add link to print-css.rocks (#6272)Mauro Bieg1-1/+3
2020-04-09Clarify docs for pipe table column width adjustment.John MacFarlane1-1/+1
See #6254.
2020-04-07Fix ATX header syntax in manualJohn MacFarlane1-1/+1
2020-03-23Update manual date and man paeg.John MacFarlane1-1/+1
2020-03-20Make MANUAL more explicit about NBSP handling by all_symbols_escapable (#6201)Fabien Schurter1-3/+6
Fixes #6154.
2020-03-13Update copyright year (#6186)Albert Krewinkel1-1/+1
* Update copyright year * Copyright: add notes for Lua and Jira modules
2020-02-17Revert "Allow specifying string value in metadata using `!!literal` tag."John MacFarlane1-7/+1
This reverts commit 3493d6afaa6586c46898cf8bdb0c45bb70d31f28. This might be worth considering in the future, but let's not do it yet...the additional complexity needs a better justification.
2020-02-17Allow specifying string value in metadata using `!!literal` tag.John MacFarlane1-1/+7
This is experimental. Normally metadata values are interpreted as markdown, but if the !!literal tag is used they will be interpreted as plain strings. We need to consider whether this can still be implemented if we switch back from HsYAML to yaml for performance reasons.
2020-02-15Update changelog and man page.John MacFarlane1-1/+1
2020-02-12Introduce new format variants for JATS (#6067)Albert Krewinkel1-1/+4
New formats: - `jats_archiving` for the "Archiving and Interchange Tag Set", - `jats_publishing` for the "Journal Publishing Tag Set", and - `jats_articleauthoring` for the "Article Authoring Tag Set." The "jats" output format is now an alias for "jats_archiving". Closes: #6014
2020-01-31Add Text.Pandoc.Readers.CSV (readCSV).John MacFarlane1-0/+2
This adds csv as an input format. The CSV table is converted into a pandoc simple table. Closes #6100.
2020-01-27Update URLs and use HTTP**S** wherever possible (#6090)Salim B1-62/+62
I've changed _all_ `http:` URLs in the file to their `https` equivalents if the respective sites have properly configured HTTPS.
2020-01-12docs: capitalize Lua where it refers to the programming language nameAlbert Krewinkel1-15/+15
This follows the advise on the Lua website (https://www.lua.org/about.html#name): > […] "Lua" is a name, the name of the Earth's moon and the name of the > language. Like most names, it should be written in lower case with an > initial capital, that is, "Lua".
2020-01-05Bump to 2.9.1.1, update manual.John MacFarlane1-1/+1
2019-12-21Update man page and MANUAL date.John MacFarlane1-1/+1
2019-12-20MANUAL: A bit clearer explanation for `--base-header-level`.John MacFarlane1-2/+3
We now say exactly how to work around the deprecation of this option.
2019-12-17Add jira reader (#5913)Albert Krewinkel1-0/+1
Closes #5556
2019-12-11Regenerate man page.John MacFarlane1-1/+1
2019-12-11Add title-slide-attributes variable to reveal.js template. (#5981)Frederik Elwert1-0/+11
2019-12-07Rename template 'filters' as 'pipes'John MacFarlane1-6/+6
to avoid confusion with the other notion of filter used by pandoc. We may want to rename this upstream in doctemplates as well.
2019-12-07Removed trailing whitespace in manual.John MacFarlane1-5/+5
2019-12-07Document display math syntax in manual.John MacFarlane1-0/+3
2019-12-05Update manual date and man page.John MacFarlane1-1/+1
2019-12-05Clean up manual on pdf generation backend options.John MacFarlane1-13/+22
See #5940.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-16 03:03:02 +0000