aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)Author
2025-03-29Allow `groff` to be used as `--pdf-engine` with `ms`.John MacFarlane
When `groff` is used as a PDF engine, the `groff` extension to `ms` is automatically enabled. Limitations: - `groff` currently produces larger PDFs than `pdfroff`. - With `groff`, a table of contents produced with `--table-of-contents/--toc` will always be placed at the end of the document. - Certain characters (e.g. Greek characters) may be dropped in the PDF outline. Closes #10738.
2025-03-29fix(revealjs)!: upgrade reveal.js to v5 (#10740)Kolen Cheung
because v4 on unpkg.com is no longer available.
2025-03-24Fix default URL for revealjs in MANUAL.txt.John MacFarlane
2025-03-16Update manual date and generate man pagesJohn MacFarlane
2025-03-12Improve EPUB metadata documentation.John MacFarlane
2025-03-12Change maxwidth default in MANUAL.txt.John MacFarlane
Closes #10683.
2025-03-12Update Security section in manual.John MacFarlane
Alert readers to a threat relating to iframe in HTML. Add LaTeX, Typst to the list of formats that have an `include`. Closes #10682.
2025-03-05Disable citations extension in writers if `--citeproc` is used.John MacFarlane
Otherwise we get undesirable results, as the format's native citation mechanism is used instead of (or in addition to) the citeproc-generated citations. Closes #10662.
2025-03-03MANUAL.txt: Note about `template` variable for typst.John MacFarlane
2025-03-02MANUAL: correct typo: 'date' for doubled 'title' (#10654)Olivier DOSSMANN
2025-02-09Update man pages.John MacFarlane
2025-02-08LaTeX writer/template: Improve babel support.John MacFarlane
Previously we used the `.ini` files for every language, but for European languages these tend to provide inferior results to the `.ldf` files used by classic Babel. Currently Babel documentation recommends using the classic system for European languages written in Latin and Cyrillic scripts and Vietnamese. So the LaTeX writer and template now follow this guidance. Main languages in the list of languages with good "classic" support are added to global documentclass options and will be automatically handled by Babel using the `.ldf` files. If the main language is not in this list, the `babeloptions` variable will be set to `provide=*`, which will cause support to be loaded from the `.ini` file rather than an `.ldf`. So, for example, setting `-V babeloptions=''` with a polytonic Greek document will cause the `.ldf` support to be used instead of the `.ini`. The default setting of this variable can be overwritten, but in most cases the default should give good results. Closes #8283.
2025-02-06MANUAL: note on using typst to produce pdf/a-2b.John MacFarlane
2025-02-04LaTeX template: allow `csquotesoptions` to be specified.John MacFarlane
Obsoletes #7025. See #8283.
2025-01-31Document top-level-division functionality with Docx (#10579)Andrew Dunning
Co-authored-by: John MacFarlane <[email protected]>
2025-01-12Improve links and descriptions for `odt`, `opendocument`.John MacFarlane
Closes #10518.
2025-01-12Bump to 3.6.2 and update manual dateJohn MacFarlane
2025-01-10Docx reader: read table styles as custom styles...John MacFarlane
...when `styles` extension is enabled. Closes #9603. Also improve manual's coverage of custom styles.
2025-01-09replace LibreOffice PDF documentation link to latestStéphane Guillou
... so it links to the latest major release rather than a specific major release (which there are two of every year)
2024-12-27Add Pod readerEvan Silberman
Pod ("Plain old documentation") is a markup languaged used principally to document Perl modules and programs. Since it was originally meant to be translated pretty directly to man, the semantics are fairly simple. This Pod reader was developed with reference to the canonical user and implementer documentation of Pod: https://perldoc.perl.org/perlpod and https://perldoc.perl.org/perlpodspec. There are 1490 .pod, .pl, and .pm in the Perl 5.34 distribution found in /System/Library/Perl on my mac. Of those, this reader dies with a parse error on 7 of them. All of them seem to be cases where pod commands are found within a non-colon-prefixed =begin/=end. perlpodspec says I may treat this as an error. [API change] adds readPod
2024-12-22Update MANUAL.txt date and regenerate man pages.John MacFarlane
2024-12-19Change `--template` to allow use of extensionless templates.John MacFarlane
The intent is to allow bash process substitution: e.g., `--template <(echo "foo")`. Previously pandoc *always* added an extension based on the output format, which caused problems with the absolute filenames used by bash process substitution (e.g. `/dev/fd/11`). Now, if the template has no extension, pandoc will first try to find it without the extension, and then add the extension if it can't be found. So, in general, extensionless templates can now be used. But this has been implemented in a way that should not cause problems for existing uses, unless you are using a template `NAME.FORMAT` but happen to have an extensionless file `NAME` in the template search path. Closes #5270.
2024-12-07Date manual and regenerate man pages.John MacFarlane
2024-12-05List mdoc as a reader format in the manualEvan Silberman
2024-11-23MANUAL: clarify what the example of YAML EPUB metadata shows.John MacFarlane
Closes #10405.
2024-11-09Typst writer: make template sensitive to a `page-numbering` variable.John MacFarlane
This can be set to an empty string (or, in metadata, to false) for no page numbers. Addresses #10370.
2024-10-17Clarify that `--variable` can only assign string values.John MacFarlane
See #10298.
2024-10-08Update MANUAL.txt with information on openxml template.John MacFarlane
Supersedes #10274, closes #10273.
2024-10-06MANUAL.txt: fix typo in template syntax (#10265)Pascal Wagler
2024-10-05Change date on manual.John MacFarlane
2024-10-01Clarifying text about use of `beamerarticle` variable.John MacFarlane
Closes #10250.
2024-10-01Support short title, author, etc. in Beamer (#10244)Thomas Hodgson
+ Add `shorttitle`, `shortsubtitle`, `shortauthor`, `shortinstitute`, `shortdate` to default.beamer. + Note that the brackets are inside conditionals, because some older beamer versions don't allow the empty optional argument. Closes #10248.
2024-10-01Support a list of images for titlegraphic (#10246)Thomas Hodgson
Allow a list of title graphics in default.beamer Title graphic options will be applied to each title graphic. Images will be separated by `\enspace`.
2024-10-01Beamer theme options (#10243)Thomas Hodgson
Add theme options to default.beamer: `colorthemeoptions`, `fontthemeoptions`, `innerthemeoptions`, `outerthemeoptions`.
2024-09-25MANUAL.txt: fix typo introduced by...John MacFarlane
...commit bac631fda84619fd7af0b4c6fbb70360a726f823.
2024-09-22Add support for list of figures (lof) and list of tables (lot) (#10029)Akash Patel
Two new command-line options are added: `--lof[=true|false]`, `--list-of-figures[=true|false]` `--lot[=true|false]`, `--list-of-tables[=true|false]` Only docx, latex, and context are supported at this point. Setting the `lof` and `lot` variables will also work for the formats that are currently supported. [API changes] + Lua: `list_of_figures` and `list_of_tables` can now be used in writer options. + Text.Pandoc.Options: add `writerListOfFigures` and `writerListOfTables` fields to `WriterOptions`. + Text.Pandoc.App.Opt: add `optListOfFigures` and `optListOfTables` to `Opt`. Closes #8245. Co-authored-by: John MacFarlane <[email protected]>
2024-09-18Suggest documentation for syntax highlighting issues on WindowsYehuda Katz
Suggest documentation to preemptively address user issues like #6704
2024-09-09Update man pages.John MacFarlane
2024-09-08Finishing touches on `--link-images`:John MacFarlane
- Document in defaults file section of MANUAL. - Add to pandoc-lua-engine writer option marshalling. - Add to pandoc-server initialization of writer options.
2024-09-08Document figure/table-caption-position in defaults files.John MacFarlane
2024-09-08Docx writer: Support `--number-offsets`.John MacFarlane
2024-09-08Text.Pandoc.Shared: add `makeSectionsWithOffsets` [API change].John MacFarlane
This is like `makeSections` but has an additional parameter specifying number offsets, for use with the `--number-offset` option. Use `makeSectionsWithOffsets` in HTML writer instead of ad hoc and inefficient number-adjusting code. Clarify MANUAL.txt: the `--number-offset` option should only directly affect numbering of the first section heading in a document; subsequent headings will increment normally. Fix test output for #5071 to reflect this.
2024-09-08Add options to change table/figure caption positions.John MacFarlane
+ Add command line options `--table-caption-position` and `--figure-caption-position`. These allow the user to specify whether to put captions above or below tables and figures, respectively. The following output formats are supported: HTML (and related such as EPUB), LaTeX (and Beamer), Docx, ODT/OpenDocument, Typst. + Text.Pandoc.Options: add `CaptionPosition` and new `WriterOptions` fields `writerFigureCaptionPosition` and `writerTableCaptionPosition` [API change]. + Text.Pandoc.Opt: add `Opt` fields `optFigureCaptionPosition` and `optTableCaptionPosition` [API change]. + Docx writer: make table/figure rendering sensitive to caption position settings. + OpenDocument writer: make table/figure rendering sensitive to caption position settings. + Typst writer/template: implement figure caption positions by triggering a show rule in the default template, which determines caption positions for figures and tables globally. + LaTeX writer: make table/figure rendering sensitive to caption position settings. Closes #5116. + HTML writer/template: make `<figcaption>` placement sensitive to caption position settings. For tables, `<caption>` must be the first element, and positioning is determined by CSS, for here we set a variable which the default template is sensitive to.
2024-09-03Add ansi as output format in MANUAL.txt.John MacFarlane
2024-09-02Change default `--pdf-engine` via HTML to WeasyPrint.John MacFarlane
wkhtmltopdf is deprecated. weasyprint is the easiest-to-install, maintained alternative. For better results, one might prefer pagedjs-cli. Closes #10142.
2024-08-22User Guide: Fix CSL Docs broken link (#10100)Tristano Ajmone
In "Specifying bibliographic data," update the URL for CSL YAML/JSON HTML-like markup: that section is no longer part of the official CSL documentation and has been moved to the citeproc-js documentation.
2024-07-31Document the use of luatexjaKolen Cheung
when CJKmainfont is used with lualatex C.f. #3873
2024-07-30Fix asciidoc link in MANUAL. See #10039.John MacFarlane
2024-07-29Add a `citations` (typst) section to the manual.John MacFarlane
Also clarify that `citations` affects both input and output for `org`. See #9127.
2024-07-29Add note on `--citeproc` that you may need to disable `citations`...John MacFarlane
extension on the output format (e.g., `-t markdown-citations`) to see the rendered citation. Supersedes #9127. See #10012.