aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)AuthorFilesLines
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.
2019-01-22LaTeX template: Use `footnotehyper` if available (#5234)Andrew Dunning1-4/+5
Use the [`footnotehyper`](https://ctan.org/pkg/footnotehyper/) package if available. This is a rewrite of `footnote` that is compatible with `hyperref` and `babel-frenchb`. This patch also addresses the incompatibility with `xcolor` noted in #4861, but the new package has only been available since 2016, so this template still loads `xcolor` earlier for compatibility with older distributions. Note that the `footnote` package is part of `collection-latexrecommended` in TeX Live, so there shouldn't be any problem loading it unconditionally as we now do if `footnotehyper` is not available.
2019-01-22Clarify that $ must come right before $. (#5243)Lev E. Givon1-0/+3
2019-01-21Mention `raw_attribute` in documentation for `raw_html` and `raw_tex`.John MacFarlane1-0/+7
Thanks to @eiro. Closes #5240.
2019-01-12LaTeX template: Simplify fontspec usage (#5218)Andrew Dunning1-4/+3
Simplify the approach of #5212, ensuring that `mainfont` is used as the base font for scaling and that LuaLaTeX does not display the mono font with TeX ligatures (as it does not use the `Mapping=tex-ansi` option). With a modified version of `\defaultfontfeatures`, fontspec will continue to report scaling against the old default font in the log, but it nonetheless displays main font at the specified size. Using this rather than setting `Scale=MatchLowercase` for each family individually means that users will not lose scaling when upgrading to the new template if they were using other font options. Scaling can be disabled for an individual family by adding the option `Scale=1` to `sansfontoptions`, `monofontoptions`, etc. Remove the `\setromanfont` command added in #4665, as this is not documented in the fontspec manual and appears to be a deprecated alias for `\setmainfont`. For the release notes, I should also add that one can imitate the previous appearance with `-V mainfontoptions="Scale=MatchLowercase"`.
2019-01-11 LaTeX template: Render \subtitle (#5213)Andrew Dunning1-41/+28
Addresses closed issues #4675, #3896, #1327. This renders `\subtitle` using the `etoolbox` package if `\subtitle` is not already defined by the documentclass (as it is in beamer, KOMA, memoir classes). Based on an example from Enrico Gregorio, <https://tex.stackexchange.com/a/50186>. Update list of LaTeX packages. Note that `etoolbox` must be loaded outside the command definition. Putting it inside causes an error if `\title` is placed after `\begin{document}`. It's already loaded on LuaLaTeX/XeLaTeX in any case.
2019-01-07Clarified automatic identifiers.John MacFarlane1-1/+3
We remove non-alphanumerics. This includes, e.g., emojis. Closes #5201.
2019-01-06Add DokuWiki reader (#5108)Alexander1-0/+1
Closes #1792
2019-01-03MANUAL: Update list of latex packages used.John MacFarlane1-1/+16
2019-01-02A trivial change to document the addition of `task_lists`.John MacFarlane1-1/+0
These notes should have been in the previous commit message. Added `task_list` extension. API changes: + Added constructor `Ext_task_lists` to `Extension`. + Added `taskListItemFromAscii` and `taskListItemToAscii` to Text.Pandoc.Shared. Task lists are supported form markdown and gfm input. They should work, to some degree, in all output formats, though in most formats you'll get an ordered list with a following task list box. In HTML and LaTeX/PDF output, the bullet will be suppressed for nicer output.
2019-01-02Implement task lists (#5139)Mauro Bieg1-2/+9
Closes #3051
2019-01-02Manual: make it clear that `hard_line_breaks` works in gfm.John MacFarlane1-4/+4
See #5195.
2018-12-27Fix typo in MANUAL.txtGeoffrey Ely1-1/+1
The example to create a div with id `refs` instead creates a div with class `#refs`. The fix is to add curly brackets.
2018-12-12ICML writer: support custom-styles (#5137)Mauro Bieg1-8/+10
see #2106
2018-11-24Update date in manual and update man page.John MacFarlane1-1/+1
2018-11-21MANUAL: Fix outdated description of latex_macros extension.John MacFarlane1-1/+1
2018-11-19MANUAL.txt: Clarified placement of bibliography.John MacFarlane1-4/+17
2018-11-15MANUAL: Under security, added note about +RTS option to limit heap size.John MacFarlane1-0/+3
See #5047.
2018-11-13Fix note on curly brace syntx for locators.John MacFarlane1-2/+2
2018-11-12Document new explicit syntax for citeproc locators.John MacFarlane1-0/+7
2018-11-11Text.Pandoc.Shared: add parameter to uniqueIdent, inlineListToIdentifier.John MacFarlane1-9/+24
The parameter is Extensions. This allows these functions to be sensitive to the settings of `Ext_gfm_auto_identifiers` and `Ext_ascii_identifiers`. This allows us to use `uniqueIdent` in the CommonMark reader, replacing some custom code. It also means that `gfm_auto_identifiers` can now be used in all formats. Semantically, `gfm_auto_identifiers` is now a modifier of `auto_identifiers`; for identifiers to be set, `auto_identifiers` must be turned on, and then the type of identifier produced depends on `gfm_auto_identifiers` and `ascii_identifiers` are set. Closes #5057.
2018-11-11Remove `ascii_identifiers` from `githubMarkdownExtensions`.John MacFarlane1-1/+1
GitHub doesn't seem to strip non-ascii characters.
2018-11-05MANUAL.txt: remove confusing cross-links for some extensions.John MacFarlane1-4/+4
I think the text comment to look in the pandoc markdown section is enough.
2018-11-05MANUAL: don't put pandoc in code ticks in heading.John MacFarlane1-2/+2
2018-11-05MANUAL.txt: --ascii works for gfm too.John MacFarlane1-1/+1
2018-11-05CommonMark writer: respect --ascii (#5043)quasicomputational1-7/+6
2018-11-05MANUAL.txt: added "A note on security."John MacFarlane1-0/+30
2018-11-04MANUAL.txt: add `man` to `--from` options.John MacFarlane1-0/+1
2018-11-03Document romanfont, romanfontoptions.John MacFarlane1-2/+2
2018-11-03AsciiDoc writer: use single-line section headers.John MacFarlane1-1/+1
The underline style is now deprecated. Previously `--atx-headers` would enable the single-line style; now the single-line style is always used. Closes #5038.
2018-11-01Update manual date and man page.John MacFarlane1-1/+1
2018-11-01Change 'groff' -> 'roff'.John MacFarlane1-8/+8
These formats (man, ms) are not groff-specific.
2018-11-01Implement --ascii for Markdown writer.John MacFarlane1-5/+5
2018-11-01HTML writer: use character entities references when possible for HTML5.John MacFarlane1-1/+1
2018-11-01MANUAL: clarify LaTeX image dimensions outputMauro Bieg1-4/+6
2018-10-28small wording changeJohn MacFarlane1-2/+2
2018-10-28EPUB writer: use metadata field `css` instead of `stylesheet`mb211-3/+3
closes #4990
2018-10-18Groff escaping changes.John MacFarlane1-3/+4
- `--ascii` is now turned on automatically for man output, for portability. All man output will be escaped to ASCII. - In T.P.Writers.Groff, `escapeChar`, `escapeString`, and `escapeCode` now take a boolean parameter that selects ascii-only output. This is used by the Ms writer for `--ascii`, instead of doing an extra pass after writing the document. - In ms output without `--ascii`, unicode is used whenever possible (e.g. for double quotes). - A few escapes are changed: e.g. `\[rs]` instead of `\\` for backslash, and `\ga]` instead of `` \` `` for backtick.
2018-10-05CommonMark writer: add plain text fallbacks. (#4531)quasicomputational1-2/+8
Previously, the writer would unconditionally emit HTMLish output for subscripts, superscripts, strikeouts (if the strikeout extension is disabled) and small caps, even with raw_html disabled. Now there are plain-text (and, where possible, fancy Unicode) fallbacks for all of these corresponding (mostly) to the Markdown fallbacks, and the HTMLish output is only used when raw_html is enabled. This commit adds exported functions `toSuperscript` and `toSubscript` to `Text.Pandoc.Writers.Shared`. [API change] Closes #4528.
2018-09-30Implement `--ascii` (`writerPreferAscii`) in writers, not App.John MacFarlane1-2/+4
Now the `write*` functions for Docbook, HTML, ICML, JATS, Man, Ms, OPML are sensitive to `writerPreferAscii`. Previously the to-ascii translation was done in Text.Pandoc.App, and thus not available to those using the writer functions directly. In addition, the LaTeX writer is now sensitive to `writerPreferAscii` and to `--ascii`. 100% ASCII output can't be guaranteed, but the writer will use commands like `\"{a}` and `\l` whenever possible, to avoid emiting a non-ASCII character. A new unexported module, Text.Pandoc.Groff, has been added to store functions used in the different groff-based writers.
2018-09-27Version to 2.3.1.John MacFarlane1-1/+1
2018-09-27MANUAL: epub:type is only useful for epub3Mauro Bieg1-3/+3
2018-09-18Add .options class to option headers in manual.John MacFarlane1-7/+7
This will allow autogeneration of ids for particular options in the manual.
2018-09-16MANUAL: use https for context wiki links.John MacFarlane1-11/+11
Otherwise the wiki won't redirect. Closes #4910.
2018-09-16Update manual date and man page.John MacFarlane1-1/+1
2018-09-15Merge pull request #4604 from mb21/yaml-fileJohn MacFarlane1-1/+13
Introduce --metadata-file option
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-15 02:15:51 +0000