aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)AuthorFilesLines
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.
2021-06-02MANUAL: more details and a useful link for YAML syntax.John MacFarlane1-0/+7
2021-05-31Bump to 2.14.0.1; update changelog and man page.John MacFarlane1-1/+1
2021-05-28Update manual.John MacFarlane1-1/+1
2021-05-27rebase_relative_paths: leave empty paths unchanged.John MacFarlane1-2/+2
2021-05-27rebase_relative_paths extension: don't change fragment paths.John MacFarlane1-0/+3
We don't want a pure fragment path to be rewritten, since these are used for cross-referencing.
2021-05-27Modify rebase_reference_links treatment of reference links/images.John MacFarlane1-1/+5
The directory is based on the file containing the link reference, not the file containing the link, if these differ.
2021-05-27Citeproc: Don't detect math elements as locators.John MacFarlane1-1/+1
Closes #7321.
2021-05-27Add `rebase_relative_paths` extension.John MacFarlane1-2/+26
- Add manual entry for (non-default) extension `rebase_relative_paths`. - Add constructor `Ext_rebase_relative_paths` to `Extensions` in Text.Pandoc.Extensions [API change]. When enabled, this extension rewrites relative image and link paths by prepending the (relative) directory of the containing file. - Make Markdown reader sensitive to the new extension. - Add tests for #3752. Closes #3752. NB. currently the extension applies to markdown and associated readers but not commonmark/gfm.
2021-05-27Add citation example for locators and suffixesTristan Stenner1-1/+3
2021-05-21Regenerate man page.John MacFarlane1-1/+1
2021-05-21Fix link to KDE syntax highlighting docs.John MacFarlane1-1/+1
Closes jgm/pandoc-website#51.
2021-05-19Revisions to citation syntax description update.John MacFarlane1-5/+5
2021-05-19Update documentation on citation syntax.John MacFarlane1-32/+69
2021-05-15MANUAL: note that `institute` variable works for HTML-based slides.John MacFarlane1-2/+5
2021-05-14MANUAL: add info about YAML escape sequences, link to spec.Albert Krewinkel1-4/+7
Closes: #7152
2021-05-14Beamer writer: support exampleblock and alertblock.John MacFarlane1-1/+5
A block will be rendered as an exampleblock if the heading has class `example` and alertblock if it has class `alert`. Closes #7278.
2021-05-13Implement curly-brace syntax for Markdown citation keys.John MacFarlane1-5/+10
The change provides a way to use citation keys that contain special characters not usable with the standard citation key syntax. Example: `@{foo_bar{x}'}` for the key `foo_bar{x}`. Closes #6026. The change requires adding a new parameter to the `citeKey` parser from Text.Pandoc.Parsing [API change]. Markdown reader: recognize @{..} syntax for citatinos. Markdown writer: use @{..} syntax for citations when needed. Update manual with curly-brace syntax for citations. Closes #6026.
2021-05-13Update manual date and man page.John MacFarlane1-1/+1
2021-04-18MANUAL: Add information about `lang` and bibliography sorting.John MacFarlane1-10/+17
2021-03-20Support `yaml_metadata_block` extension form commonmark, gfm.John MacFarlane1-0/+16
This is a bit more limited than with markdown, as documented in the manual: - The YAML block must be the first thing in the input. - The leaf notes are parsed in isolation from the rest of the document. So, for example, you can't use reference links if the references are defined later in the document. Closes #6537.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-15 23:16:56 +0000