aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)AuthorFilesLines
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.
2021-03-20Update man page and manual date.John MacFarlane1-1/+1
2021-03-08Update date in changelog and manual.John MacFarlane1-1/+1
2021-03-06Allow `--resource-path` to accumulate.John MacFarlane1-0/+5
Previously, if `--resource-path` were used multiple times, the last resource path would replace the others. With this change, each time `--resource-path` is used, it prepends the specified path components to the existing resource path. Similarly, when `resource-path` is specified in a defaults file, the paths provided will be prepended to the existing resource path. This change also allows one to avoid using the OS-specific path separator; instead, one can simply use `--resource-path` a number of times with single paths. This form of command will not have an OS-dependent behavior. This change facilitates the use of multiple, small defaults files: each can specify a directory containing its own resources without clobbering the resource paths set by the others. Closes #6152.
2021-03-05Allow `${.}` in defaults files paths...John MacFarlane1-0/+13
to refer to the directory where the default file is. This will make it possible to create moveable "packages" of resources in a directory. Closes #5871.
2021-03-05Implement environment variable interpolation in defaults files.John MacFarlane1-0/+15
This allows the syntax `${HOME}` to be used, in fields that expect file paths only. Any environment variable may be interpolated in this way. A warning will be raised for undefined variables. The special variable `USERDATA` is automatically set to the user data directory in force when the defaults file is parsed. (Note: it may be different from the eventual user data directory, if the defaults file or further command line options change that.) Closes #5982. Closes #5977. Closes #6108 (path not taken).
2021-03-05Shared: Change defaultUserDataDirs -> defaultUserDataDir.John MacFarlane1-6/+6
Rationale: the manual says that the XDG data directory will be used if it exists, otherwise the legacy data directory. So we should just determine this and use this directory, rather than having a search path which could cause some things to be taken from one data directory and others from others. [API change]
2021-03-04Revert "Revert "Relax `--abbreviations` rules so that a period isn't required.John MacFarlane1-3/+3
This reverts commit 916ce4d51121e0529b938fda71f37e947882abe5. I was confused in thinking it wouldn't work.
2021-03-04Revert "Relax `--abbreviations` rules so that a period isn't required."John MacFarlane1-3/+3
This reverts commit e461b7dd45f717f3317216c7d3207a1d24bf1c85. Ill-advised change. This doesn't work because we parse strings in chunks.
2021-03-04Relax `--abbreviations` rules so that a period isn't required.John MacFarlane1-3/+3
Partially addresses #7124.
2021-03-04Update date on manual.John MacFarlane1-1/+1
2021-02-26Fix/update URLs and use HTTP**S** where possible (#7122)Salim B1-1/+1
2021-02-22T.P.Error: Add PandocUnsupportedCharsetError constructor...John MacFarlane1-0/+1
...for PandocError. [API change]
2021-02-19MANUAL: block-level formatting is not allowed in line blocks.John MacFarlane1-0/+3
Closes #7107.
2021-02-19Clarify `tex_math_dollars` extension.John MacFarlane1-1/+2
Note that no blank lines are allowed between the delimiters in display math.
2021-02-11Add MANUAL section on reproducible builds.John MacFarlane1-0/+15
2021-02-10Add new unexported module T.P.XMLParser.John MacFarlane1-0/+1
This exports functions that uses xml-conduit's parser to produce an xml-light Element or [Content]. This allows existing pandoc code to use a better parser without much modification. The new parser is used in all places where xml-light's parser was previously used. Benchmarks show a significant performance improvement in parsing XML-based formats (especially ODT and FB2). Note that the xml-light types use String, so the conversion from xml-conduit types involves a lot of extra allocation. It would be desirable to avoid that in the future by gradually switching to using xml-conduit directly. This can be done module by module. The new parser also reports errors, which we report when possible. A new constructor PandocXMLError has been added to PandocError in T.P.Error [API change]. Closes #7091, which was the main stimulus. These changes revealed the need for some changes in the tests. The docbook-reader.docbook test lacked definitions for the entities it used; these have been added. And the docx golden tests have been updated, because the new parser does not preserve the order of attributes. Add entity defs to docbook-reader.docbook. Update golden tests for docx.
2021-02-07 Document no template fallback for absolute path (#7088)Nixon Enraght-Moony1-1/+2
See jgm/pandoc#7077
2021-02-03ePub writer: `belongs-to-collection` metadata (#7063)Nick Berendsen1-0/+9
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-25 23:50:58 +0000