aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2012-08-09 20:19:06 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2012-08-09 20:24:05 -0700
commit0cb7362f62410f58e2356381bbf2c1fe85abe2a5 (patch)
treeb6158a288fde45e430fe1afb094306ec442575b1 /README
parent71e0c206c169c12e30bec4869dd04e166ef7ed5d (diff)
downloadpandoc-0cb7362f62410f58e2356381bbf2c1fe85abe2a5.tar.gz
Removed `--strict`, added extensions to writer/reader names.
* The `--strict` option has been removed. * Instead of using `--strict`, one can now use `strict` instead of `markdown` as an input or output format name. * The `--enable` and `--disable` optinos have been removed. * It is now possible to enable or disable specific extensions by appending them (with '+' or '-') to the writer or reader name. For example `pandoc -f markdown-footnotes+hard_line_breaks`. * The lhs extensions are now implemented this way, too; you can use either `+lhs` or `+literate_haskell`.
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 15 insertions, 22 deletions
diff --git a/README b/README
index 064c3277b..d8f197cd8 100644
--- a/README
+++ b/README
@@ -26,8 +26,8 @@ tables, flexible ordered lists, definition lists, delimited code blocks,
superscript, subscript, strikeout, title blocks, automatic tables of
contents, embedded LaTeX math, citations, and markdown inside HTML block
elements. (These enhancements, described below under
-[Pandoc's markdown](#pandocs-markdown), can be disabled using the `--strict`
-option.)
+[Pandoc's markdown](#pandocs-markdown), can be disabled using the `strict`
+input or output format.)
In contrast to most existing tools for converting markdown to HTML, which
use regex substitutions, Pandoc has a modular design: it consists of a
@@ -117,10 +117,11 @@ and `xunicode` (if `xelatex` is used).
A user who wants a drop-in replacement for `Markdown.pl` may create
a symbolic link to the `pandoc` executable called `hsmarkdown`. When
-invoked under the name `hsmarkdown`, `pandoc` will behave as if the
-`--strict` flag had been selected, and no command-line options will be
-recognized. However, this approach does not work under Cygwin, due to
-problems with its simulation of symbolic links.
+invoked under the name `hsmarkdown`, `pandoc` will behave as if
+invoked with `-f strict --email-obfuscation=references`,
+and all command-line options will be treated as regular arguments.
+However, this approach does not work under Cygwin, due to problems with
+its simulation of symbolic links.
[Cygwin]: http://www.cygwin.com/
[`iconv`]: http://www.gnu.org/software/libiconv/
@@ -192,12 +193,6 @@ General options
Reader options
--------------
-`--strict`
-: Use strict markdown syntax, with no pandoc extensions or variants.
- When the input format is HTML, this means that constructs that have no
- equivalents in standard markdown (e.g. definition lists or strikeout
- text) will be parsed as raw HTML.
-
`-R`, `--parse-raw`
: Parse untranslatable HTML codes and LaTeX environments as raw HTML
or LaTeX, instead of ignoring them. Affects only HTML and LaTeX
@@ -403,8 +398,6 @@ Options affecting specific writers
*none* leaves `mailto:` links as they are. *javascript* obfuscates
them using javascript. *references* obfuscates them by printing their
letters as decimal or hexadecimal character references.
- If `--strict` is specified, *references* is used regardless of the
- presence of this option.
`--id-prefix`=*STRING*
: Specify a prefix to be added to all automatically generated identifiers
@@ -764,8 +757,8 @@ Pandoc's markdown
Pandoc understands an extended and slightly revised version of
John Gruber's [markdown] syntax. This document explains the syntax,
noting differences from standard markdown. Except where noted, these
-differences can be suppressed by specifying the `--strict` command-line
-option.
+differences can be suppressed by using the `strict` format instead
+of `markdown`.
Philosophy
----------
@@ -934,8 +927,8 @@ Standard markdown syntax does not require a blank line before a block
quote. Pandoc does require this (except, of course, at the beginning of the
document). The reason for the requirement is that it is all too easy for a
`>` to end up at the beginning of a line by accident (perhaps through line
-wrapping). So, unless `--strict` is used, the following does not produce
-a nested block quote in pandoc:
+wrapping). So, unless the `strict` format is used, the following does
+not produce a nested block quote in pandoc:
> This is a block quote.
>> Nested.
@@ -1291,7 +1284,7 @@ around "Third". Pandoc follows a simple rule: if the text is followed by
a blank line, it is treated as a paragraph. Since "Second" is followed
by a list, and not a blank line, it isn't treated as a paragraph. The
fact that the list is followed by a blank line is irrelevant. (Note:
-Pandoc works this way even when the `--strict` option is specified. This
+Pandoc works this way even when the `strict` format is specified. This
behavior is consistent with the official markdown syntax description,
even though it is different from that of `Markdown.pl`.)
@@ -1612,8 +1605,8 @@ which allows only the following characters to be backslash-escaped:
\`*_{}[]()>#+-.!
-(However, if the `--strict` option is supplied, the standard
-markdown rule will be used.)
+(However, if the `strict` format is used, the standard markdown rule
+will be used.)
A backslash-escaped space is parsed as a nonbreaking space. It will
appear in TeX output as `~` and in HTML and XML as `\&#160;` or
@@ -1847,7 +1840,7 @@ with blank lines, and start and end at the left margin. Within
these blocks, everything is interpreted as HTML, not markdown;
so (for example), `*` does not signify emphasis.
-Pandoc behaves this way when `--strict` is specified; but by default,
+Pandoc behaves this way when the `strict` format is used; but by default,
pandoc interprets material between HTML block tags as markdown.
Thus, for example, Pandoc will turn