aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
AgeCommit message (Collapse)AuthorFilesLines
2017-08-19Markdown reader: use CommonMark rules for list item nesting.John MacFarlane1-27/+28
Closes #3511. Previously pandoc used the four-space rule: continuation paragraphs, sublists, and other block level content had to be indented 4 spaces. Now the indentation required is determined by the first line of the list item: to be included in the list item, blocks must be indented to the level of the first non-space content after the list marker. Exception: if are 5 or more spaces after the list marker, then the content is interpreted as an indented code block, and continuation paragraphs must be indented two spaces beyond the end of the list marker. See the CommonMark spec for more details and examples. Documents that adhere to the four-space rule should, in most cases, be parsed the same way by the new rules. Here are some examples of texts that will be parsed differently: - a - b will be parsed as a list item with a sublist; under the four-space rule, it would be a list with two items. - a code Here we have an indented code block under the list item, even though it is only indented six spaces from the margin, because it is four spaces past the point where a continuation paragraph could begin. With the four-space rule, this would be a regular paragraph rather than a code block. - a code Here the code block will start with two spaces, whereas under the four-space rule, it would start with `code`. With the four-space rule, indented code under a list item always must be indented eight spaces from the margin, while the new rules require only that it be indented four spaces from the beginning of the first non-space text after the list marker (here, `a`). This change was motivated by a slew of bug reports from people who expected lists to work differently (#3125, #2367, #2575, #2210, #1990, #1137, #744, #172, #137, #128) and by the growing prevalance of CommonMark (now used by GitHub, for example). Users who want to use the old rules can select the `four_space_rule` extension. * Added `four_space_rule` extension. * Added `Ext_four_space_rule` to `Extensions`. * `Parsing` now exports `gobbleAtMostSpaces`, and the type of `gobbleSpaces` has been changed so that a `ReaderOptions` parameter is not needed.
2017-08-17slidy uses https instead of http (#3848)ickc1-1/+1
grep -rl 'http://www.w3.org/Talks/Tools/Slidy2' . | xargs sed -i 's/http:\/\/www\.w3\.org\/Talks\/Tools\/Slidy2/https:\/\/www\.w3\.org\/Talks\/Tools\/Slidy2/g'
2017-08-16Revision to binary format output to stdout:John MacFarlane1-3/+4
We now allow default output to stdout when it can be determined that the output is being piped. (On Windows, as mentioned before, this can't be determined.) Using '-o -' forces output to stdout regardless.
2017-08-16Change behavior with binary format output to stdout.John MacFarlane1-4/+4
Previously, for binary formats, output to stdout was disabled unless we could detect that the output was being piped (and not sent to the terminal). Unfortunately, such detection is not possible on Windows, leaving windows users no way to pipe binary output. So we have changed the behavior in the following way: * If the -o option is not used, binary output is never sent to stdout by default; instead, an error is raised. * IF '-o -' is used, binary output is sent to stdout, regardless of whether it is being piped. This works on Windows too.
2017-08-08Document `gfm` in MANUAL.John MacFarlane1-7/+13
Closes #3509.
2017-07-26MANUAL: clarify that mathml is used for ODT math.John MacFarlane1-2/+5
2017-07-21Added TikiWiki reader (#3800)rlpowell1-6/+7
Added TikiWiki reader, including tests and documentation. It's probably not *complete*, but it works pretty well, handles all the basics (and some not-so-basics).
2017-06-30MANUAL: document ibooks specific epub metadata.John MacFarlane1-0/+12
2017-06-28LaTeX template: added `natbiboptions` variable.John MacFarlane1-0/+3
Closes #3768.
2017-06-27Require nonempty alt text for `implicit_figures`.John MacFarlane1-8/+7
A figure with an empty caption doesn't make sense. Closes #2844.
2017-06-26OpenDocument/ODT writer: Added support for table of contents.John MacFarlane1-1/+2
Closes #2836. Thanks to @anayrat.
2017-06-26Support `--toc` in `opendocument`/`odt`.John MacFarlane1-4/+4
2017-06-23Added note on output formats in docs for `raw_attribute`.John MacFarlane1-0/+4
2017-06-23Text.Pandoc.Extensions: Added `Ext_raw_attribute`.John MacFarlane1-3/+24
Documented in MANUAL.txt. This is enabled by default in pandoc markdown and multimarkdown.
2017-06-22Added `--epub-subdirectory` option.John MacFarlane1-0/+6
This specifies the subdirectory in the OCF container that holds the EPUB specific content. Closes #3720.
2017-06-20Added mention of vimwiki raeder more places.John MacFarlane1-11/+14
2017-06-19Added Vimwiki reader (#3705).Yuchen Pei1-2/+2
* New module Text.Pandoc.Readers.Vimwiki, exporting readVimwiki [API change]. * New input format `vimwiki`. * New data file, `data/vimwiki.css`, for displaying the HTML produced by this reader and pandoc's HTML writer in the style of vimwiki's own HTML export.
2017-06-19Mention muse reader in README, MANUAL, debian control, cabal description.John MacFarlane1-1/+1
2017-06-19Mention Muse writer in MANUAL.txt (#3744)Alexander Krotov1-1/+2
2017-06-05Added aspectratio variable to beamer template (#3723).Václav Haisman1-0/+5
* Transplant jgm/pandoc-templates#236 to Pandoc repository. * Document `aspectratio` in user manual. * Enumerate possible values for `aspectratio`.
2017-05-25Added `spaced_reference_links` extension.John MacFarlane1-1/+9
This is now the default for pandoc's Markdown. It allows whitespace between the two parts of a reference link: e.g. [a] [b] [b]: url This is now forbidden by default. Closes #2602.
2017-05-25Docx writer: Use Table rather than "Table Normal" for table style.John MacFarlane1-1/+1
"Table Normal" is the default table style and can't be modified. Closes #3275, further testing welcome.
2017-05-22Let `--eol` take `native` as an argument.John MacFarlane1-4/+5
Add `Native` to the `LineEnding` type. Make `optEol` a `Native` rather than `Maybe Native`.
2017-05-21Finished implemtation of `--resource-path`.John MacFarlane1-1/+7
* Default is just working directory. * Working directory must be explicitly specifide if `--resource-path` option is used.
2017-05-20Added `--resource-path=SEARCHPATH` command line option.John MacFarlane1-0/+6
SEARCHPATH is separated by the usual character, depending on OS (: on unix, ; on windows). Note: This does not yet work for PDF output, because the routine that creates PDFs runs outside PandocMonad. (This has to do with its use of inTemporaryDirectory and its interaction with our exceptions.) The best solution would be to figure out how to move the PDF creation routines into PandocMonad. Second-best, just pass an extra parameter in? See #852.
2017-05-18Update Figure With Caption -> Captioned Figure in MANUAL.txt.John MacFarlane1-1/+1
2017-05-18Add `--eol` flag and writer option to control line endings.Stefan Dresselhaus1-0/+7
* Add `--eol=crlf|lf` CLI option. * Add `optEol` to `WriterOptions` [API change] * In `Text.Pandoc.UTF8`, add new functions parameterized on `Newline`: `writeFileWith`, `putStrWith`, `putStrLnWith`, `hPutStrWith`, `hPutStrLnWith`. [API change] * Document option in MANUAL.txt. Closes #3663. Closes #2097.
2017-05-15MANUAL: remove refs to highlighting-kate.John MacFarlane1-2/+2
Closes #3672.
2017-05-13Update dates in copyright noticesAlbert Krewinkel1-1/+1
This follows the suggestions given by the FSF for GPL licensed software. <https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html>
2017-05-07Updated documentation for `--extract-media`.John MacFarlane1-4/+9
2017-05-06Small reformatting in MANUAL.John MacFarlane1-41/+45
2017-04-12Use lowercase a4 for latex papersize example.John MacFarlane1-1/+1
2017-04-07Fixed a typo (#3562)Sam Kim1-1/+1
2017-04-04Ms writer improvements:John MacFarlane1-0/+15
- added some variables to the default template. - cleaner output for images (stringify alt text).
2017-04-02MANUAL: document highlighting support in ms.John MacFarlane1-6/+6
2017-04-01Allow a theme file as argument to `--highlight-style`.John MacFarlane1-1/+7
Also include a sample, `default.theme`, in `data/`.
2017-03-30Allow dynamic loading of syntax definitions.John MacFarlane1-0/+8
See #3334. * Add writerSyntaxMap to WriterOptions. * Highlighting: added parameter for SyntaxMap to highlight. * Implemented --syntax-definition option. TODO: [ ] Figure out whether we want to have the xml parsing depend on the dtd (it currently does, and fails unless the language.dtd is found in the same directory). [ ] Add an option to read a KDE syntax highlighting theme as a custom style. [ ] Add tests.
2017-03-30Added JATS writer.John MacFarlane1-6/+6
* New module Text.Pandoc.Writer.JATS exporting writeJATS. * New output format `jats`. * Added tests. * Revised manual.
2017-03-27MANUAL: document that html4 is technically XHTML 1.0 transitional.John MacFarlane1-2/+2
2017-03-26Update date on MANUALJohn MacFarlane1-20/+22
2017-03-24Ms writer: support --toc, date, abstract.John MacFarlane1-3/+4
2017-03-23Allow creation of pdf via groff ms and pdfroff.John MacFarlane1-6/+8
pandoc -t ms -o output.pdf input.txt
2017-03-20Add `space_in_atx_header` extension.John MacFarlane1-0/+6
This is enabled by default in pandoc and GitHub markdown but not the other flavors. This requirse a space between the opening #'s and the header text in ATX headers (as CommonMark does but many other implementations do not). This is desirable to avoid falsely capturing things ilke #hashtag or #5 Closes #3512.
2017-03-20Lua filters (#3514)Albert Krewinkel1-0/+25
* Add `--lua-filter` option. This works like `--filter` but takes pathnames of special lua filters and uses the lua interpreter baked into pandoc, so that no external interpreter is needed. Note that lua filters are all applied after regular filters, regardless of their position on the command line. * Add Text.Pandoc.Lua, exporting `runLuaFilter`. Add `pandoc.lua` to data files. * Add private module Text.Pandoc.Lua.PandocModule to supply the default lua module. * Add Tests.Lua to tests. * Add data/pandoc.lua, the lua module pandoc imports when processing its lua filters. * Document in MANUAL.txt.
2017-03-16MANUAL: document `--abbreviations`.John MacFarlane1-0/+13
Closes #256.
2017-03-13Docx writer: Support 9 levels of headers.John MacFarlane1-5/+6
Closes #1642.
2017-03-12MANUAL: Small clarification in YAML metadata section.John MacFarlane1-1/+1
2017-03-07Clarify that meta-json contains transformed values (#3491)Jakob Voß1-1/+2
Make clear that template variable `meta-json` does not contain plain text values or JSON output format but field values transformed to the selected output format.
2017-03-04Document that html5 output is polyglot compatible.John MacFarlane1-1/+3
2017-02-27Removed `--epub-stylesheet`; use `--css` instead.John MacFarlane1-8/+7
* Removed writerEpubStylesheet in WriterOptions. * Removed `--epub-stylesheet` option. * Allow `--css` to be used with epub. * Allow multiple stylesheets to be used. * Stylesheets will be taken both from `--css` and from the `stylesheet` metadata field (which can contain either a file path or a list of them). Closes #3472, #847.