aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)AuthorFilesLines
2021-12-22Add text wrapping to HTML output.John MacFarlane1-1/+0
Previously the HTML writer was exceptional in not being sensitive to the `--wrap` option. With this change `--wrap` now works for HTML. The default (as with other formats) is automatic wrapping to 72 columns. A new internal module, T.P.Writers.Blaze, exports `layoutMarkup`. This converts a blaze Html structure into a doclayout Doc Text. In addition, we now add a line break between an `img` tag and the associated `figcaption`. Note: Output is never wrapped in `writeHtmlStringForEPUB`. This accords with previous behavior since previously the HTML writer was insensitive to `--wrap` settings. There's no real need to wrap HTML inside a zipped container. Note that the contents of script, textarea, and pre tags are always laid out with the `flush` combinator, so that unwanted spaces won't be introduced if these occur in an indented context in a template. Closes #7764.
2021-12-19Add a writer for Markua 0.10 (#7729)binaarinen1-0/+2
Markua is a markdown variant used by Leanpub. More information about Markua can be found at https://leanpub.com/markua/read. Adds a new exported function `writeMarkua` from T.P.Writers.Markdown. [API change] Closes #1871. Co-authored by Tim Wisotzki and Samuel Lemmenmeier.
2021-11-30Fix typo. Closes jgm/pandoc-website#54.John MacFarlane1-1/+1
2021-11-23Improve detection of pipe table line widths.John MacFarlane1-6/+6
Fixed calculation of maximum column widths in pipe tables. It is now based on the length of the markdown line, rather than a "stringified" version of the parsed line. This should be more predictable for users. In addition, we take into account double-wide characters such as emojis. Closes #7713.
2021-11-20Update man page.John MacFarlane1-1/+1
2021-11-14Fix misspelled extension name in manual.John MacFarlane1-1/+1
`short_subsuperscript` -> `short_subsuperscripts`. Closes #7690.
2021-11-07Replace old sample custom reader with a full-featured reader for creole.John MacFarlane1-1/+1
This is better as an example. And it is faster than pandoc's regular creole parser, which shows that high-performance readers can be developed this way.
2021-11-06Pass ReaderOptions to custom readers as second parameter.John MacFarlane1-3/+3
2021-11-05Add interface for custom readers written in Lua. (#7671)John MacFarlane1-9/+27
New module Text.Pandoc.Readers.Custom, exporting readCustom [API change]. Users can now do `-f myreader.lua` and pandoc will treat the script myreader.lua as a custom reader, which parses an input string to a pandoc AST, using the pandoc module defined for Lua filters. A sample custom reader can be found in data/reader.lua. Closes #7669.
2021-11-05MANUAL.txt: update table of exit codes and corresponding errorsAlbert Krewinkel1-0/+2
2021-11-02Bump to 2.16.1, update changelog.John MacFarlane1-1/+1
2021-10-31Bump to 2.16, update changelog.John MacFarlane1-1/+1
2021-10-22Bump to 2.15, updaet man page.John MacFarlane1-1/+1
2021-09-30epub: Add EPUB3 subject metadata (authority/term)nuew1-2/+8
This adds the ability to specify EPUB 3 `authority` and `term` specific refinements to the `subject` tag. Specifying a plain `subject` tag in metadata will function as before.
2021-09-29EPUB writer: treat epub:type "frontispiece" as front matter.John MacFarlane1-0/+1
This allows you to include a frontispiece using ``` ![](yourimage.jpg) etc. ``` Closes #7600.
2021-09-26Update documentation for definition_list extension.John MacFarlane1-2/+2
In 2015, we relaxed indentation requirements for the first line of a definition (see commit d3544dc and issue #2087), but the documnentation wasn't updated to reflect the change. Closes #7594.
2021-09-19Use babel, not polyglossia, with xelatex.John MacFarlane1-5/+5
Previously polyglossia worked better with xelatex, but that is no longer the case, so we simplify the code so that babel is used with all latex engines. This involves a change to the default LaTeX template.
2021-09-17mention revealjs support of title-toc in MANUAL Christophe Dervieux1-1/+1
Following addition in #7171
2021-09-16pptx: Support specifying slide background imagesEmily Bourke1-24/+45
In the reveal-js output, it’s possible to use reveal’s `data-background-image` class on a slide’s title to specify a background image for the slide. With this commit, it’s possible to use `background-image` in the same way for pptx output. Only the “stretch” mode is supported, and the background image is centred around the slide in the image’s larger axis, matching the observed default behaviour of PowerPoint. - Support `background-image` per slide. - Add tests. - Update manual.
2021-09-15pptx: Add support for incremental listsEmily Bourke1-3/+0
- Support -i option - Support incremental/noincremental divs - Support older block quote syntax - Add tests One thing not clear from the manual is what should happen when the input uses a combination of these things. For example, what should the following produce? ```md ::: {.incremental .nonincremental} - are - these - incremental? ::: ::: incremental ::::: nonincremental - or - these? ::::: ::: ::: nonincremental > - how > - about > - these? ::: ``` In this commit I’ve taken the following approach, matching the observed behaviour for beamer and reveal.js output: - if a div with both classes, incremental wins - the innermost incremental/nonincremental div is the one which takes effect - a block quote containing a list as its first element inverts whether the list is incremental, whether or not the quote is inside an incremental/non-incremental div I’ve added some tests to verify this behaviour. This commit closes issue #5689 (https://github.com/jgm/pandoc/issues/5689).
2021-09-12Add note to Security section that commonmark is better...John MacFarlane1-1/+4
than markdown as far as pathological performance goes.
2021-09-10MANUAL: Document formats affected by `--reference-location`.John MacFarlane1-1/+3
2021-09-10Support `--reference-location` for HTML output (#7461)Francesco Mazzoli1-1/+1
The HTML writer now supports `EndOfBlock`, `EndOfSection`, and `EndOfDocument` for reference locations. EPUB and HTML slide show formats are also affected by this change. This works similarly to the markdown writer, but with special care taken to skipping section divs with what regards to the block level. The change also takes care to not modify the output if `EndOfDocument` is used.
2021-09-01pptx: Add support for more layoutsEmily Bourke1-3/+49
Until now, the pptx writer only supported four slide layouts: “Title Slide” (used for the automatically generated metadata slide), “Section Header” (used for headings above the slide level), “Two Column” (used when there’s a columns div containing at least two column divs), and “Title and Content” (used for all other slides). This commit adds support for three more layouts: Comparison, Content with Caption, and Blank. - Support “Comparison” slide layout This layout is used when a slide contains at least two columns, at least one of which contains some text followed by some non-text (e.g. an image or table). The text in each column is inserted into the “body” placeholder for that column, and the non-text is inserted into the ObjType placeholder. Any extra content after the non-text is overlaid on top of the preceding content, rather than dropping it completely (as currently happens for the two-column layout). + Accept straightforward test changes Adding the new layout means the “-deleted-layouts” tests have an additional layout added to the master and master rels. + Add new tests for the comparison layout + Add new tests to pandoc.cabal - Support “Content with Caption” slide layout This layout is used when a slide’s body contains some text, followed by non-text (e.g. and image or a table). Before now, in this case the image or table would break onto a new slide: to get that output again, users can add a horizontal rule before the image or table. + Accept straightforward tests The “-deleted-layouts” tests all have an extra layout and relationship in the master for the Content with Caption layout. + Accept remove-empty-slides test Empty slides are still removed, but the Content with Caption layout is now used. + Change slide-level-0/h1-h2-with-text description This test now triggers the content with caption layout, giving a different (but still correct) result. + Add new tests for the new layout + Add new tests to the cabal file - Support “Blank” slide layout This layout is used when a slide contains only blank content (e.g. non-breaking spaces). No content is inserted into any placeholders in the layout. Fixes #5097. + Accept straightforward test changes Blank layout now copied over from reference doc as well, when layouts have been deleted. + Add some new tests A slide should use the blank layout if: - It contains only speaker notes - It contains only an empty heading with a body of nbsps - It contains only a heading containing only nbsps - Change ContentType -> Placeholder This type was starting to have a constructor for each placeholder on each slide (e.g. `ComparisonUpperLeftContent`). I’ve changed it instead to identify a placeholder by type and index, as I think that’s clearer and less redundant. - Describe layout-choosing logic in manual
2021-08-28Add more potential threats to security section of manual.John MacFarlane1-3/+11
2021-08-28Add `--sandbox` option.John MacFarlane1-1/+12
+ Add sandbox feature for readers. When this option is used, readers and writers only have access to input files (and other files specified directly on command line). This restriction is enforced in the type system. + Filters, PDF production, custom writers are unaffected. This feature only insulates the actual readers and writers, not the pipeline around them in Text.Pandoc.App. + Note that when `--sandboxed` is specified, readers won't have access to the resource path, nor will anything have access to the user data directory. + Add module Text.Pandoc.Class.Sandbox, defining `sandbox`. Exported via Text.Pandoc.Class. [API change] Closes #5045.
2021-08-27Clarify 'attributes' extension supportWilliam Lupton1-1/+2
2021-08-22MANUAL: document error code 25John MacFarlane1-0/+1
2021-08-22Add some more info regarding `--slide-level=0`Salim B1-8/+9
2021-08-22Harmonize spelling of 'slide show'Salim B1-4/+4
2021-08-20Update manual date and man page.John MacFarlane1-1/+1
2021-08-20MANUAL.txt/security: add a note on security risks of include directives.John MacFarlane1-3/+8
2021-08-19Clarify that each YAML block is a separate YAML documentWilliam Lupton1-0/+4
2021-08-17Document new link-bibliography metadata field.John MacFarlane1-3/+10
This affects whether hyperlinks are added to the bibliography by citeproc.
2021-08-17pptx: Select layouts from reference doc by nameEmily Bourke1-7/+12
Until now, users had to make sure that their reference doc contains layouts in a specific order: the first four layouts in the file had to have a specific structure, or else pandoc would error (or sometimes successfully produce a pptx file, which PowerPoint would then fail to open). This commit changes the layout selection to use the layout names rather than order: users must make sure their reference doc contains four layouts with specific names, and if a layout with the right name isn’t found pandoc will output a warning and use the corresponding layout from the default reference doc as a fallback. I believe the use of names rather than order will be clearer to users, and the clearer errors will help them troubleshoot when things go wrong. - Add tests for moved layouts - Add tests for deleted layouts - Add newly included layouts to slideMaster1.xml to fix tests
2021-08-15Multimarkdown sub- and superscripts (#5512) (#7188)OCzarnecki1-0/+12
Added an extension `short_subsuperscripts` which modifies the behavior of `subscript` and `superscript`, allowing subscripts or superscripts containing only alphanumerics to end with a space character (eg. `x^2 = 4` or `H~2 is combustible`). This improves support for multimarkdown. Closes #5512. Add `Ext_short_subsuperscripts` constructor to `Extension` [API change]. This is enabled by default for `markdown_mmd`.
2021-08-15Remove documentation for `.ul` shortcut for now.John MacFarlane1-1/+1
See #7307. Motivation: there is talk of removing this.
2021-08-15Make docx writer sensitive to `native_numbering` extension.John MacFarlane1-1/+1
Figure and table numbers are now only included if `native_numbering` is enabled. (By default it is disabled.) This is a behavior change with respect to 2.14.1, but the behavior is that of previous versions. The change was necessary to avoid incompatibilities between pandoc's native numbering and third-party cross reference filters like pandoc-crossref. Closes #7499.
2021-08-12Document use of the 'underline' class. (#7492)William Lupton1-0/+12
Addresses a comment in #7484.
2021-08-11Clarify internal punctuation in citation keys. (#7491)William Lupton1-5/+8
Addresses a comment in #5458.
2021-08-10Add RTF reader.John MacFarlane1-0/+1
- `rtf` is now supported as an input format as well as output. - New module Text.Pandoc.Readers.RTF (exporting `readRTF`). [API change] Closes #3982.
2021-08-08Allow `--slide-level=0`.John MacFarlane1-5/+7
When the slide level is set to 0, headings won't be used at all in splitting the document into slides. Horizontal rules must be used to separate slides. Closes #7476.
2021-08-08Remove obsolete and incorrect sentence in `--slide-level` docs.John MacFarlane1-3/+1
2021-07-18Bump to 2.14.1, update changelog and man page.John MacFarlane1-1/+1
2021-07-07Don't incorporate externally linked images in EPUB documents (#7430)Michael Hoffmann1-0/+6
Just like it is possible to avoid incorporating an image in EPUB by passing `data-external="1"` to a raw HTML snippet, this makes the same possible for native Images, by looking for an associated `external` attribute.
2021-06-20Bump to 2.14.0.3, update changelog, require latest skylighting.John MacFarlane1-1/+1
2021-06-14Rephrase section on unsafe HTML in manual.John MacFarlane1-3/+3
2021-06-10Bump to 2.14.0.2, update chaneglog and manual.John MacFarlane1-1/+1
2021-06-10Fix MediaBag regressions.John MacFarlane1-6/+6
With the 2.14 release `--extract-media` stopped working as before; there could be mismatches between the paths in the rendered document and the extracted media. This patch makes several changes (while keeping the same API). The `mediaPath` in 2.14 was always constructed from the SHA1 hash of the media contents. Now, we preserve the original path unless it's an absolute path or contains `..` segments (in that case we use a path based on the SHA1 hash of the contents). When constructing a path from the SHA1 hash, we always use the original extension, if there is one. Otherwise we look up an appropriate extension for the mime type. `mediaDirectory` and `mediaItems` now use the `mediaPath`, rather than the mediabag key, for the first component of the tuple. This makes more sense, I think, and fits with the documentation of these functions; eventually, though, we should rework the API so that `mediaItems` returns both the keys and the MediaItems. Rewriting of source paths in `extractMedia` has been fixed. `fillMediaBag` has been modified so that it doesn't modify image paths (that was part of the problem in #7345). We now do path normalization (e.g. `\` separators on Windows) only in writing the media; the paths are left unchanged in the image links (sensibly, since they might be URLs and not file paths). These changes should restore the original behavior from before 2.14. Closes #7345.
2021-06-07Mention GladTeX for EPUB exportSebastian Humenda1-5/+4
This updates the manual and the web site about the GladTeX usage.