git.iko.soy/typeable/pandoc
on master help sign in
Various minor formatting and consistency fixes for the program options.
commit6a076ae36e03a8d26bc27cd96e438537e6a11471 authorAndreas Lööw <AndreasLoow@users.noreply.github.com> dateThu 16 Apr 2015, 18:41 (12 years ago) parent2fd5f4c
1 file changed+25−25
README+25−25
README+25−25
@@ -5,7 +5,7 @@
55Synopsis
66========
77
8−pandoc [*options*] [*input-file*]...
8+`pandoc` [*options*] [*input-file*]...
99
1010Description
1111===========
@@ -333,7 +333,7 @@ Reader options
333333 provided. If you want to run a script in the working directory,
334334 preface the filename with `./`.
335335
336−`-M` *KEY[=VAL]*, `--metadata=`*KEY[:VAL]*
336+`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
337337
338338: Set the metadata field *KEY* to the value *VAL*. A value specified
339339 on the command line overrides a value specified in the document.
@@ -359,15 +359,15 @@ Reader options
359359
360360: Specify the number of spaces per tab (default is 4).
361361
362−`--track-changes=`*accept|reject|all*
362+`--track-changes=accept`|`reject`|`all`
363363
364364: Specifies what to do with insertions and deletions produced by the MS
365− Word "track-changes" feature. *accept* (the default), inserts all
366− insertions, and ignores all deletions. *reject* inserts all
367− deletions and ignores insertions. *all* puts in both insertions
365+ Word "track-changes" feature. `accept` (the default), inserts all
366+ insertions, and ignores all deletions. `reject` inserts all
367+ deletions and ignores insertions. `all` puts in both insertions
368368 and deletions, wrapped in spans with `insertion` and `deletion`
369369 classes, respectively. The author and time of change is
370− included. *all* is useful for scripting: only accepting changes
370+ included. `all` is useful for scripting: only accepting changes
371371 from a certain reviewer, say, or before a certain date. This
372372 option only affects the docx reader.
373373
@@ -400,7 +400,7 @@ General writer options
400400 template appropriate for the output format will be used (see
401401 `-D/--print-default-template`).
402402
403−`-V` *KEY[=VAL]*, `--variable=`*KEY[:VAL]*
403+`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
404404
405405: Set the template variable *KEY* to the value *VAL* when rendering the
406406 document in standalone mode. This is generally only useful when the
@@ -423,7 +423,7 @@ General writer options
423423: Disable text wrapping in output. By default, text is wrapped
424424 appropriately for the output format.
425425
426−`--columns`=*NUMBER*
426+`--columns=`*NUMBER*
427427
428428: Specify length of lines in characters (for text wrapping).
429429
@@ -445,7 +445,7 @@ General writer options
445445: Disables syntax highlighting for code blocks and inlines, even when
446446 a language attribute is given.
447447
448−`--highlight-style`=*STYLE*
448+`--highlight-style=`*STYLE*
449449
450450: Specifies the coloring style to be used in highlighted source code.
451451 Options are `pygments` (the default), `kate`, `monochrome`,
@@ -536,7 +536,7 @@ Options affecting specific writers
536536 `unnumbered` will never be numbered, even if `--number-sections`
537537 is specified.
538538
539−`--number-offset`=*NUMBER[,NUMBER,...]*,
539+`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]
540540
541541: Offset for section headings in HTML output (ignored in other
542542 output formats). The first number is added to the section number for
@@ -568,7 +568,7 @@ Options affecting specific writers
568568: Make list items in slide shows display incrementally (one by one).
569569 The default is for lists to be displayed all at once.
570570
571−`--slide-level`=*NUMBER*
571+`--slide-level=`*NUMBER*
572572
573573: Specifies that headers with the specified level create
574574 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
@@ -585,14 +585,14 @@ Options affecting specific writers
585585 rather than the header itself.
586586 See [Section identifiers](#header-identifiers-in-html-latex-and-context), below.
587587
588−`--email-obfuscation=`*none|javascript|references*
588+`--email-obfuscation=none`|`javascript`|`references`
589589
590590: Specify a method for obfuscating `mailto:` links in HTML documents.
591− *none* leaves `mailto:` links as they are. *javascript* obfuscates
592− them using javascript. *references* obfuscates them by printing their
591+ `none` leaves `mailto:` links as they are. `javascript` obfuscates
592+ them using javascript. `references` obfuscates them by printing their
593593 letters as decimal or hexadecimal character references.
594594
595−`--id-prefix`=*STRING*
595+`--id-prefix=`*STRING*
596596
597597: Specify a prefix to be added to all automatically generated identifiers
598598 in HTML and DocBook output, and to footnote numbers in markdown output.
@@ -722,7 +722,7 @@ Options affecting specific writers
722722 documents with few level 1 headers, one might want to use a chapter
723723 level of 2 or 3.
724724
725−`--latex-engine=`*pdflatex|lualatex|xelatex*
725+`--latex-engine=pdflatex`|`lualatex`|`xelatex`
726726
727727: Use the specified LaTeX engine when producing PDF output.
728728 The default is `pdflatex`. If the engine is not in your PATH,
@@ -773,7 +773,7 @@ Citation rendering
773773Math rendering in HTML
774774----------------------
775775
776−`-m` [*URL*], `--latexmathml`[=*URL*]
776+`-m` [*URL*], `--latexmathml`[`=`*URL*]
777777
778778: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
779779 To insert a link to a local copy of the `LaTeXMathML.js` script,
@@ -783,14 +783,14 @@ Math rendering in HTML
783783 several pages, it is much better to link to a copy of the script,
784784 so it can be cached.
785785
786−`--mathml`[=*URL*]
786+`--mathml`[`=`*URL*]
787787
788788: Convert TeX math to MathML (in `docbook` as well as `html` and `html5`).
789789 In standalone `html` output, a small javascript (or a link to such a
790790 script if a *URL* is supplied) will be inserted that allows the MathML to
791791 be viewed on some browsers.
792792
793−`--jsmath`[=*URL*]
793+`--jsmath`[`=`*URL*]
794794
795795: Use [jsMath] to display embedded TeX math in HTML output.
796796 The *URL* should point to the jsMath load script (e.g.
@@ -799,7 +799,7 @@ Math rendering in HTML
799799 no link to the jsMath load script will be inserted; it is then
800800 up to the author to provide such a link in the HTML template.
801801
802−`--mathjax`[=*URL*]
802+`--mathjax`[`=`*URL*]
803803
804804: Use [MathJax] to display embedded TeX math in HTML output.
805805 The *URL* should point to the `MathJax.js` load script.
@@ -812,24 +812,24 @@ Math rendering in HTML
812812 be processed by [gladTeX] to produce links to images of the typeset
813813 formulas.
814814
815−`--mimetex`[=*URL*]
815+`--mimetex`[`=`*URL*]
816816
817817: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
818818 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
819819
820−`--webtex`[=*URL*]
820+`--webtex`[`=`*URL*]
821821
822822: Render TeX formulas using an external script that converts TeX
823823 formulas to images. The formula will be concatenated with the URL
824824 provided. If *URL* is not specified, the Google Chart API will be used.
825825
826−`--katex`[=*URL*]
826+`--katex`[`=`*URL*]
827827
828828: Use [KaTeX] to display embedded TeX math in HTML output.
829829 The *URL* should point to the `katex.js` load script. If a *URL* is
830830 not provided, a link to the KaTeX CDN will be inserted.
831831
832−`--katex-stylesheet=*URL*`
832+`--katex-stylesheet=`*URL*
833833
834834: The *URL* should point to the `katex.css` stylesheet. If this option is
835835 not specified, a link to the KaTeX CDN will be inserted. Note that this