aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)AuthorFilesLines
2019-11-02Manual: clarify when macro definitions are passed as raw latex.John MacFarlane1-2/+5
In Markdown input, they are always passed through. In LaTeX, only if `latex_macros` is disabled.
2019-11-02LaTeX reader: parse macro defs as raw latex...John MacFarlane1-2/+2
when `latex_macros` is disabled. (When `latex_macros` is enabled, we omit them, since pandoc is applying the macros itself.) Previously, it was documented that the macro definitions got passed through as raw latex regardless of whether `latex_macros` was set -- but in fact they never got passed through.
2019-11-02Document how to use custom writers with `--standalone`.John MacFarlane1-0/+7
Closes #5866.
2019-11-01Revert "ALlow multiple comma-separated files for `--defaults`."John MacFarlane1-3/+2
This reverts commit e96f3fd813b3f8b73c3457ff6e9177e2a4a74164.
2019-11-01ALlow multiple comma-separated files for `--defaults`.John MacFarlane1-2/+3
2019-11-01`--defaults` improvements.John MacFarlane1-6/+3
- ToYAML instance is now for `Opt -> Opt`, rather than `Opt`. - This allows us to handle `--defaults` without clobbering all the options that occur prior to `--defaults` on the command line. (Note, however, that options in `--defaults` can replace these options if the `--defaults` option is used after them, which may be a bit confusing given the name.) - `--defaults` may now be used multiple times on the command line, allowing users to break defaults into different chunks.
2019-10-29Update Template syntax in MANUAL.txt with latest doctemplates.John MacFarlane1-58/+146
2019-10-14Fixed typo in example.John MacFarlane1-1/+1
2019-10-14KaTeX math: respect classoption=fleqn variablemb211-0/+6
closes #5815
2019-10-11More documentation of default filesJohn MacFarlane1-0/+16
2019-10-11Fix `gfm_auto_identifiers` behavior with emojis.John MacFarlane1-0/+1
Closes #5813. Note that we also now use emoji names for emojis when `ascii_identifiers` is enabled.
2019-10-11Improve sample --defaults file in MANUAL.txt.John MacFarlane1-63/+113
2019-10-10Improve parsing of --defaults.John MacFarlane1-69/+89
- Add FromYAML instances to Opt and to all subsidiary types. - Remove the use of HsYAML-aeson, which doesn't give good position information on errors. - Rename some fields in Opt to better match cli options or reflect what the ycontain [API change]: + optMetadataFile -> optMetadataFiles + optPDFEngineArgs -> optPDFEngineOpts + optWrapText -> optWrap - Add IpynbOutput enumerated type to Text.Pandoc.App.Opts. Use this instead fo a string for optIpynbOutput. - Add FromYAML instance for Filter in Text.Pandoc.Filters. With these changes parsing of defaults files should be complete and should give decent error messages. Now (unlike before) we get an error if an unknown field is used.
2019-10-10Fix examplel for defaults.John MacFarlane1-2/+2
2019-10-10Added documentation for --defaults.John MacFarlane1-0/+103
2019-10-10`--metadata-file`: when multiple files specified, second takes precedence...John MacFarlane1-8/+10
on conflicting fields. This changes earlier behavior (but not in a release), where first took precedence. Note that this may seem inconsistent with the behavior of multiple YAML blocks within a document, where the first takes precedence. Still, it is convenient to be able to override defaults with options later on the command line.
2019-10-10Make some writers sensitive to 'unlisted' class on headings.John MacFarlane1-0/+5
If this is present on a heading with the 'unnumbered' class, the heading won't appear in the TOC. This class has no effect if 'unnumbered' is not also specified. This affects HTML-based writers (including slide shows and epub), LateX (including beamer), RTF, and PowerPoint. Other writers do not yet support `unlisted`. Closes #1762.
2019-10-07Remove misleading sentence in --variables documentation.John MacFarlane1-5/+2
2019-10-06Clarify that --dpi provides a default and doesn't override...John MacFarlane1-3/+6
dpi values specified in the images themselves. See #5721.
2019-10-03PR corrections.Wandmalfarbe1-1/+1
2019-10-03Add documentation for the variable `hyperrefoptions`.Wandmalfarbe1-0/+11
2019-09-29Minor reformatting of exit code table.John MacFarlane1-23/+24
2019-09-29MANUAL: Use a table for exit codes.John MacFarlane1-23/+25
2019-09-29MANUAL: Put all template variable docs into one section.John MacFarlane1-34/+38
2019-09-29MANUAL.txt - use axt headers consistently.John MacFarlane1-163/+85
2019-09-29MANUAL.txt: Add fuller documentation of templates.John MacFarlane1-72/+261
Including new template syntax, partials, etc. Closes #5779.
2019-09-29Raise error on unsupported extensions. Closes #4338.John MacFarlane1-1/+4
+ An error is now raised if you try to specify (enable or disable) an extension that does not affect the given format, e.g. `docx+pipe_tables`. + The `--list-extensions[=FORMAT]` option now lists only extensions that affect the given FORMAT. + Text.Pandoc.Error: Add constructors `PandocUnknownReaderError`, `PandocUnknownWriterError`, `PandocUnsupportedExtensionError`. [API change] + Text.Pandoc.Extensions now exports `getAllExtensions`, which returns the extensions that affect a given format (whether enabled by default or not). [API change] + Text.Pandoc.Extensions: change type of `parseFormatSpec` from `Either ParseError (String, Extensions -> Extensions)` to `Either ParseError (String, [Extension], [Extension])` [API change]. + Text.Pandoc.Readers: change type of `getReader` so it returns a value in the PandocMonad instance rather than an Either [API change]. Exceptions for unknown formats and unsupported extensions are now raised by this function and need not be handled by the calling function. + Text.Pandoc.Writers: change type of `getWriter` so it returns a value in the PandocMonad instance rather than an Either [API change]. Exceptions for unknown formats and unsupported extensions are now raised by this function and need not be handled by the calling function.
2019-09-28MANUAL.txt: fixed some markdown errors.John MacFarlane1-7/+7
2019-09-24odt: Add external option for native numberingNils Carlson1-0/+10
This adds an external options +native_numbering to the ODT writer enabling enumeration of figures and tables in ODT output.
2019-09-22Make `plain` output plainer.John MacFarlane1-0/+8
Previously we used the following Project Gutenberg conventions for plain output: - extra space before and after level 1 and 2 headings - all-caps for strong emphasis `LIKE THIS` - underscores surrounding regular emphasis `_like this_` This commit makes `plain` output plainer. Strong and Emph inlines are rendered without special formatting. Headings are also rendered without special formatting, and with only one blank line following. To restore the former behavior, use `-t plain+gutenberg`. API change: Add `Ext_gutenberg` constructor to `Extension`. See #5741.
2019-09-21Update documentation wrt docx reader custom style namesNikolay Yakimov1-3/+3
2019-09-20Preserve built-in styles in DOCX with custom style (#5670)Ben Steinberg1-2/+4
This commit prevents custom styles on divs and spans from overriding styles on certain elements inside them, like headings, blockquotes, and links. On those elements, the "native" style is required for the element to display correctly. This change also allows nesting of custom styles; in order to do so, it removes the default "Compact" style applied to Plain blocks, except when inside a table.
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.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-10 19:16:26 +0000