aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)AuthorFilesLines
2019-09-16Add note on --print-default-template explaining how to print partials.John MacFarlane1-0/+5
2019-09-12Change exit codes.John MacFarlane1-3/+3
It's good practice not to use codes 1-2 for user errors. Also, we used 65 for two different errors. - PandocAppError was 1, is now 4 - PandocOptionError was 2, is now 6 - PandocMakePDFError was 65, is now 66
2019-09-12MANUAL: add section for exit codes.John MacFarlane1-0/+27
2019-09-10Add --shift-heading-level-by option.John MacFarlane1-1/+18
Deprecate --base-heading-level. The new option does everything the old one does, but also allows negative shifts. It also promotes the document metadata (if not null) to a level-1 heading with a +1 shift, and demotes an initial level-1 heading to document metadata with a -1 shift. This supports converting documents that use an initial level-1 heading for the document title. Closes #5615.
2019-09-08MANUAL: document some pptx limitations...John MacFarlane1-0/+5
in slide show section: - no incremental display (#5689) - no pause with `. . .` (#5701)
2019-09-08Add -L option as shortcut for --lua-filter.John MacFarlane1-1/+1
2019-08-24Change optMetadataFile type from Maybe to List (#5702)Owen McGrath1-7/+8
Changed optMetadataFile from `Maybe FilePath` to `[FilePath]`. This allows for multiple YAML metadata files to be added. The new default value has been changed from `Nothing` to `[]`. To account for this change in `Text.Pandoc.App`, `metaDataFromFile` now operates on two `mapM` calls (for `readFileLazy` and `yamlToMeta`) and a fold. Added a test (command/5700.md) which tests this functionality and updated MANUAL.txt, as per the contributing guidelines. With the current behavior, using `foldr1 (<>)`, values within files specified first will be used over those in later files. (If the reverse of this behavior would be preferred, it should be fixed by changing foldr1 to foldl1.)
2019-08-14MANUAL: link to YAML spec (#5687)Mauro Bieg1-4/+6
2019-07-28Use doctemplates 0.3, change type of writerTemplate.John MacFarlane1-13/+12
* Require recent doctemplates. It is more flexible and supports partials. * Changed type of writerTemplate to Maybe Template instead of Maybe String. * Remove code from the LaTeX, Docbook, and JATS writers that looked in the template for strings to determine whether it is a book or an article, or whether csquotes is used. This was always kludgy and unreliable. To use csquotes for LaTeX, set `csquotes` in your variables or metadata. It is no longer sufficient to put `\usepackage{csquotes}` in your template or header includes. To specify a book style, use the `documentclass` variable or `--top-level-division`. * Change template code to use new API for doctemplates.
2019-07-19MANUAL: reveal.js flags (#5653)Mauro Bieg1-0/+2
2019-07-16Add option to include source files in ConTeXt PDFs (#5578)Tristan Stenner1-0/+3
Add a metadata option (`includesource`) to attach the source documents to the resulting PDF.
2019-07-15Customizable type of PDF/A for the ConTeXt writer (issue #5608) (#5610)Karl Pettersson1-5/+21
* Let the user choose type of PDF/A generated with ConTeXt (closes #5608) * Updated ConTeXt test documents for changes in tagging * Updated color profile settings in accordance with ConTeXt wiki * Made ICC profile and output intent for PDF/A customizable * Read pdfa variable from meta (and updated manual)
2019-07-12Pass through aria- attributes to HTML5.John MacFarlane1-4/+5
Also document addition of data- prefix to unknown attributes. Closes #5646.
2019-06-14Powerpoint code formatting is now context dependent (#5573)Jeroen de Haas1-0/+9
This commit alters the way in which the Powerpoint writer treats inline code and code blocks. - Inline code is now formatted at the same size as the surrounding text. - Code blocks are now given a margin and font size according to their level. - Furthermore this commit allows changing the font with which code is formatted via the `monofont` option. Tested in - PowerPoint 365 for Windows - 1808 (Build 10730.20344 Click-to-Run) - PowerPoint 365 for Mac - 16.26 (19060901)
2019-06-11Update manual date, readme, man page.John MacFarlane1-1/+1
2019-06-08PDF via ms: make TOC appear at beginning and in PDF bookmarks.John MacFarlane1-0/+6
Previously the TOC appeared at the end of the document, and was not bookmarked. If you want it to continue appearing at the end, add `--pdf-engine-opt=--no-toc-relocation` to your command line. Closes #5553.
2019-06-06MANUAL.txt, pandoc.cabal: mention Jira as possible target formatAlbert Krewinkel1-2/+4
2019-06-04Fix document section assignments in EPUB writer.John MacFarlane1-5/+12
For example, introduction should go in bodymatter, not frontmatter, and epigraph, conclusion, and afterward should go in bodymatter, not backmatter. For the full list of assignments, see the manual. Closes #5546.
2019-05-28MANUAL: add note about title-meta, author-meta, date-meta.John MacFarlane1-0/+6
Closes #5486.
2019-05-07MANUAL.txt: removes double 'inside' (#5489)♫ Christian Krause ♫1-1/+1
2019-05-04Add template variable `curdir` with working directoryJohn MacFarlane1-0/+5
from which pandoc is run. Closes #5464.
2019-04-05Update man page and README.John MacFarlane1-1/+1
2019-04-02Manual: Improve 'header' and 'heading' usage (#5424)Andrew Dunning1-112/+112
Corrects usage of 'heading' and 'header' in text (but does not change programmed names). Partially addresses #5423.
2019-04-02LaTeX template: Ensure correct heading/table order (#5421)Andrew Dunning1-10/+40
Improve the workaround for #1658, adapting a solution by @u-fischer in <https://github.com/latex3/latex2e/issues/131> that works whether or not the `indent` variable is enabled. Remove `subparagraph` variable in LaTeX template. The default is now to use run-in style for level 4 and 5 headings (`\paragraph` and `\subparagraph`). To get the previous default behavior (where these were formatted as blocks, like `\subsubsection`), set the `block-headings` variable. An example is given in the manual of reformatting the appearance of headings more thoroughly using KOMA-Script. Closes #5365.
2019-04-02Add xwiki output format to manual.John MacFarlane1-0/+5
2019-03-31Docs: Specify that templates from PPT 2013 are known to work.Jesse Rosenthal1-3/+3
There have been problems reported with other recent versions. Starts to address #5402
2019-03-29MANUAL: add paragraph on options affecting markdown in ipynb.John MacFarlane1-0/+6
2019-03-13Update manual date and man page.John MacFarlane1-1/+1
2019-03-09Add recommendation to use `raw_attribute` with ipynb.John MacFarlane1-0/+12
See #5354.
2019-03-08Allow -o/--output to be used with --print-*.John MacFarlane1-16/+23
`--print-default-data-file` `--print-highlighting-style` `--print-default-template` Note that `-o` must occur BEFORE the `--print*` command on the command line (this is documented). Closes #5357.
2019-03-07Add tectonic as an option for --pdf-engine. (#5346)Cormac Relf1-3/+3
Closes #5345 Runs tectonic on STDIN instead of a temporary .tex file, so that it looks in the working directory for `\include` and `\input` like the rest of the engines. Allows overriding the output directory without messing up the args with `--pdf-engine-opt=--outdir --pdf-engine-opt="$DIR"`.
2019-03-03Update manual date, man page, README.md.John MacFarlane1-1/+1
2019-03-02Use XDG data directory for user data directory.John MacFarlane1-12/+7
Instead of `$HOME/.pandoc`, the default user data directory is now `$XDG_DATA_HOME/pandoc`, where `XDG_DATA_HOME` defaults to `$HOME/.local/share` but can be overridden by setting the environment variable. If this directory is missing, then `$HOME/.pandoc` is searched instead, for backwards compatibility. However, we recommend moving local pandoc data files from `$HOME/.pandoc` to `$HOME/.local/share/pandoc`. On Windows the default user data directory remains the same. Closes #3582.
2019-03-01Update MANUAL on slide shows to reflect changes.John MacFarlane1-3/+3
2019-02-28Shared: add filterIpynbOutput. [API change]John MacFarlane1-0/+9
Add command line option `--ipynb-output=all|none|best`. Closes #5339.
2019-02-28Remove spaces on empty lines in manual.John MacFarlane1-9/+9
2019-02-28Clarify variable substitution indentation in templates (#5338)Agustín Martín Barbero1-0/+2
Add `The value of a variable will be indented to the same level as the variable.` to the MANUAL.
2019-02-27Add latexmk as an option for --pdf-engine.John MacFarlane1-4/+7
Closes #3195. Note that you can use --pdf-engine-opt=-outdir=bar to specify a persistent temp dir.
2019-02-20MANUAL: reorder custom-styles section (#5324)Mauro Bieg1-47/+51
2019-02-09Added support for the `subject` metadata variable to PDF. (#5289)Pascal Wagler1-1/+1
2019-02-09Adds Asciidoctor sprcific writer and testsTG1-2/+7
2019-02-09AsciiDoc Writer: DisplayMath as asciidoc latexmath blockTG1-1/+1
2019-01-30Update manual.John MacFarlane1-1/+1
2019-01-30Manual: document `date-meta` template variable (#5260)Tristan Stenner1-0/+10
In HTML based formats the `date` metadata variable is converted to ISO 8601 and available as `$date-meta`, but it's not documented at the moment.
2019-01-26Improve writing metadata for docx, pptx and odt (#5252)Agustín Martín Barbero1-6/+40
* docx writer: support custom properties. Solves the writer part of #3024. Also supports additional core properties: `subject`, `lang`, `category`, `description`. * odt writer: improve standard properties, including the following core properties: `generator` (Pandoc/VERSION), `description`, `subject`, `keywords`, `initial-creator` (from authors), `creation-date` (actual creation date). Also fix date. * pptx writer: support custom properties. Also supports additional core properties: `subject`, `category`, `description`. * Includes golden tests. * MANUAL: document metadata support for docx, odt, pptx writers
2019-01-25Update ipynb example in manual.John MacFarlane1-17/+19
2019-01-24Allow some command line options to take URL in addition to FILE.John MacFarlane1-3/+3
`--include-in-header`, `--include-before-body`, `--include-after-body`
2019-01-23Manual: Reorganize template variables (#5249)Andrew Dunning1-208/+305
Add additional headings to categorize variables, and alphabetize when there is large number; add more examples.
2019-01-23LaTeX template: Restrict `institute` to Beamer (#5219)Andrew Dunning1-4/+4
The `\institute` command is only standard in the Beamer class. Use a conditional to restrict this to Beamer output rather than output an empty command. To add this information to a LaTeX class providing an `\institute` command, use `header-includes`.
2019-01-22Support ipynb (Jupyter notebook) as input and output format.John MacFarlane1-1/+125
[API change] * Depend on ipynb library. * Add `ipynb` as input and output format. * Added Text.Pandoc.Readers.Ipynb (supports both nbformat v3 and v4). * Added Text.Pandoc.Writers.Ipynb (supports nbformat v4). * Added ipynb readers and writers to T.P.Readers, T.P.Writers, and T.P.Extensions. Register the file extension .ipynb for this format. * Add `PandocIpynbDecodingError` constructor to Text.Pandoc.Error.Error. * Note: there is no template for ipynb.