aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)AuthorFilesLines
2021-02-10Add new unexported module T.P.XMLParser.John MacFarlane1-0/+1
This exports functions that uses xml-conduit's parser to produce an xml-light Element or [Content]. This allows existing pandoc code to use a better parser without much modification. The new parser is used in all places where xml-light's parser was previously used. Benchmarks show a significant performance improvement in parsing XML-based formats (especially ODT and FB2). Note that the xml-light types use String, so the conversion from xml-conduit types involves a lot of extra allocation. It would be desirable to avoid that in the future by gradually switching to using xml-conduit directly. This can be done module by module. The new parser also reports errors, which we report when possible. A new constructor PandocXMLError has been added to PandocError in T.P.Error [API change]. Closes #7091, which was the main stimulus. These changes revealed the need for some changes in the tests. The docbook-reader.docbook test lacked definitions for the entities it used; these have been added. And the docx golden tests have been updated, because the new parser does not preserve the order of attributes. Add entity defs to docbook-reader.docbook. Update golden tests for docx.
2021-02-07 Document no template fallback for absolute path (#7088)Nixon Enraght-Moony1-1/+2
See jgm/pandoc#7077
2021-02-03ePub writer: `belongs-to-collection` metadata (#7063)Nick Berendsen1-0/+9
2021-02-03LaTeX template: Update to iftex package (#7073)Andrew Dunning1-3/+2
Load the iftex package directly rather than via the ifxetex and ifluatex compatibility wrappers, which have been merged into a single package that is part of the LaTeX core. The capitalization of the commands has been changed for compatibility with older versions of TeX Live that have the version of iftex by the Persian TeX Group. This had been removed in <https://github.com/jgm/pandoc/commit/2845794c0c31b2ef1f3e6a73bb5b109da4c74f37> for compatibility with BasicTeX, but that is no longer an issue.
2021-01-27Improve docs for cite-method.John MacFarlane1-1/+4
2021-01-22Update README and man page.John MacFarlane1-1/+1
2021-01-22Merge pull request #7042 from tarleb/jats-element-citationsJohn MacFarlane1-0/+7
JATS writer: use element citations
2021-01-22JATS writer: allow to use element-citationAlbert Krewinkel1-0/+7
2021-01-22Add biblatex, bibtex as output formats (closes #7040).John MacFarlane1-3/+5
* `biblatex` and `bibtex` are now supported as output as well as input formats. * New module Text.Pandoc.Writers.BibTeX, exporting writeBibTeX and writeBibLaTeX. [API change] * New unexported function `writeBibtexString` in Text.Pandoc.Citeproc.BibTeX.
2021-01-11MANUAL.txt: update description of `-L`/`--lua-filter`.Albert Krewinkel1-18/+10
The example filter was outdated, a reference to the separate Lua filters documentation is added instead.
2021-01-08Update copyright notices for 2021 (#7012)Albert Krewinkel1-1/+1
2021-01-05Implement defaults file inheritance (#6924)David Martschenko1-0/+10
Allow defaults files to inherit options from other defaults files by specifying them with the following syntax: `defaults: [list of defaults files or single defaults file]`.
2020-12-30MANUAL: Document use of citations in note styles.John MacFarlane1-0/+28
See #6828.
2020-12-29Bump to 2.11.3.2, update changelog and man pageJohn MacFarlane1-1/+1
2020-12-28MANUAL: note that textarea content is never parsed as Markdown.Albert Krewinkel1-2/+2
2020-12-17Update man page.John MacFarlane1-1/+1
2020-12-17MANUAL: clarify that inline references take precedence ...John MacFarlane1-0/+4
over references defined in an external bibliography.
2020-12-15MANUAL: update `--bibliography` with info about resource-pathJohn MacFarlane1-5/+8
and URLs.
2020-12-15MANUAL.txt: Remove misleading paragraphJohn MacFarlane1-5/+0
about `--resource-path`. (Note that resource-path now affects searching for bibilographies and other resources.)
2020-12-10Add sourcepos extension for commonmarkeJohn MacFarlane1-0/+7
* Add `Ext_sourcepos` constructor for `Extension`. * Add `sourcepos` extension (only for commonmark). * Bump to 2.11.3 With the `sourcepos` extension set set, `data-pos` attributes are added to the AST by the commonmark reader. No other readers are affected. The `data-pos` attributes are put on elements that accept attributes; for other elements, an enlosing Div or Span is added to hold the attributes. Closes #4565.
2020-12-08Document that --number-sections works in ms.John MacFarlane1-2/+2
Closes #6935.
2020-12-05OpenDocument writer: Allow references for internal links (#6774)Nils Carlson1-0/+37
This commit adds two extensions to the OpenDocument writer, `xrefs_name` and `xrefs_number`. Links to headings, figures and tables inside the document are substituted with cross-references that will use the name or caption of the referenced item for `xrefs_name` or the number for `xrefs_number`. For the `xrefs_number` to be useful heading numbers must be enabled in the generated document and table and figure captions must be enabled using for example the `native_numbering` extension. In order for numbers and reference text to be updated the generated document must be refreshed. Co-authored-by: Nils Carlson <nils.carlson@ludd.ltu.se>
2020-11-19Update README.md, man page.John MacFarlane1-1/+1
2020-11-16Added a sentence about `pagetitle` for HTML (#6843)Alex Toldaiev1-1/+2
changed: MANUAL.txt
2020-11-14Fix small typo in manual for `--markdown-headings`.John MacFarlane1-3/+3
2020-11-14MANUAL: wrap some overly long lines.John MacFarlane1-102/+130
2020-11-14Markdown writer: default to using ATX headings.Aner Lucero1-7/+12
Previously we used Setext (underlined) headings by default. The default is now ATX (`##` style). * Add the `--markdown-headings=atx|setext` option. * Deprecate `--atx-headers`. * Add constructor 'ATXHeadingInLHS` constructor to `LogMessage` [API change]. * Support `markdown-headings` in defaults files. * Document new options in MANUAL. Closes #6662.
2020-11-11Manual: correct `link-citation` -> `link-citations`.John MacFarlane1-1/+1
2020-11-07Bump to 2.11.1.1 and update changelog.John MacFarlane1-1/+1
2020-11-03Clarify manual on `--track-changes`.John MacFarlane1-12/+12
Closes #6801.
2020-11-02Update man page.John MacFarlane1-1/+1
2020-11-01Default CSS: avoid padding and color if monobackgroundcolor not given.John MacFarlane1-1/+2
This makes the default more austere, while putting the padded, colored code elements within easy reach.
2020-11-01Updates to default CSS (#6786)Mauro Bieg1-1/+26
- Fix margin before codeblock - Add `monobackgroundcolor` variable, making the background color and padding of code optional. - Ensure that backgrounds from highlighting styles take precedence over monobackgroundcolor - Remove list markers from TOC - Add margin-bottom where needed - Remove italics from blockquote styling - Change borders and spacing in tables to be more consistent with other output formats - Style h5, h6 - Decrease root font-size to 18px - Update tests for styles.html changes - Add CSS example to MANUAL
2020-10-29Allow citation-abbreviations in defaults file.John MacFarlane1-0/+1
2020-10-23Document that --html-q-tags requires the smart extension on the reader.John MacFarlane1-1/+3
Closes #6766.
2020-10-22Update manual date and regenerate man page.John MacFarlane1-1/+1
2020-10-22improve explanation of "indent" variable (#6767)Cyrus Yip1-1/+1
2020-10-16MANUAL: remove org from list of input formats supporting raw_tex (#6753)Nick Fleisher1-1/+1
Also update man page.
2020-10-14Fix CSL JSON conversion examples in MANUAL.John MacFarlane1-4/+4
You need -f csljson.
2020-10-12Fix spelling errors in MANUAL found by fossies codespell tool.John MacFarlane1-3/+3
See #6738
2020-10-10Add citeproc related options to sample defaults file.John MacFarlane1-2/+15
2020-10-08More documentation on converting bib formats.John MacFarlane1-0/+12
2020-10-08MANUAL: Add note about lualatex using selnolig.John MacFarlane1-9/+10
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