Home

Pandoc User's Guide

Contents

1. Second row 5 0 Here s another one Note the blank line between rows Table Here s the caption It too may span multiple lines These work like simple tables but with the following differences e They must begin with a row of dashes before the header text unless the headers are omitted e They must end with a row of dashes then a blank line e The rows must be separated by blank lines In multiline tables the table parser pays attention to the widths of the columns and the writers try to reproduce these relative widths in the output So if you find that one of the columns is too narrow in the output try widening it in the markdown source Headers may be omitted in multiline tables as well as simple tables First row 12 0 Example of a row that spans multiple lines Second row 5 0 Here s another one Note the blank line between rows Here s a multiline table without headers It is possible for a multiline table to have just one row but the row should be followed by a blank line and then the row of dashes that ends the table or the table may be interpreted as a simple table Grid tables Extension grid_tables table_captions Grid tables look like this Sample grid table Price Advantages 1 34 bright color built in wrapper 27 Pandoc s markdown tasty Oranges 2 10 cures scurvy H The
2. Extension mmd_title block Enables a MultiMarkdown http fletcherpenney net multimarkdown style title block at the top of the document for example Title My title Author John Doe Date September 1 2008 Comment This is a sample mmd title block with a field spanning multiple lines See the MultiMarkdown documentation for details Note that only title author and date are recogni zed other fields are simply ignored by pandoc If pandoc_title_block is enabled it will take precedence over mmd_title_block Extension abbrevations Parses PHP Markdown Extra abbreviation keys like 40 Non pandoc extensions HTML Hyper Text Markup Language Note that the pandoc document model does not support abbreviations so if this extension is enabled abbreviation keys are simply skipped as opposed to being parsed as paragraphs Extension autolink_bare_uris Makes all absolute URIs into links even when not surrounded by pointy braces lt gt Extension link_attributes Parses multimarkdown style key value attributes on link and image references Note that pandoc s internal document model provides nowhere to put these so they are presently just ignored Extension mmd_header identifiers Parses multimarkdown style header identifiers in square brackets after the header but before any trailing s in an ATX header 41 Kapitel 7 Producing slide shows with Pandoc You can use Pandoc to produce
3. In addition to standard indented code blocks Pandoc supports fenced code blocks These begin with a row of three or more tildes or backticks and end with a row of tildes or backticks that must be at least as long as the starting row Everything between these lines is treated as code No indentation is necessary if a gt 3 moveShip 5 gravity DOWN Like regular code blocks fenced code blocks must be separated from surrounding text by blank lines If the code itself contains a row of tildes or backticks just use a longer row of tildes or backticks at the start and end Optionally you may attach attributes to the code block using this syntax mycode haskell numberLines startFrom 100 qsort qsort x xs qsort filter lt x xs x qsort filter gt x xs Pandoc s markdown Here mycode is an identifier haskell and numberLines are classes and startFrom is an attribute with value 100 Some output formats can use this information to do syntax highlighting Currently the only output formats that uses this information are HTML and LaTeX If highlighting is supported for your output format and language then the code block above will appear highlighted with numbered lines To see which languages are supported do pandoc version Otherwise the code block above will appear as follows lt pre id mycode class haskell numberLines startFrom 100 gt lt code gt lt code
4. blocks cid AA A ES 20 ENEE E E aaa icia 21 Bullet lists eiii tdi 21 The four space rile saiia ei E a EE AT E T A mee E E dia 21 Ordered lists irn so e n eS nes e E ES tek EE E ET EES 22 Definition Sts oirre errero ee erer rr Eas a EE a vite T sa ede ceas seco sti 23 Numbered example lists 0 eds 24 Compact and Loose lists ica tata 24 Ending a St oere en ooek tie ie ee RPE OS A es 25 Horizontal rules io esses dsheseseds susiasgsvestead EEEIEE EET EESTE OSEI E PREEN PESE EESPERE AVENS 25 Tables iria ti ETE SEEE id 26 Simple tables acotar E iria E EEE E EEEE 26 Multiline tables ii IAE esas E EEE E E E EENS 26 SA A EE E E amas esses sn wa desstenge ons 27 Pipe tables cian tte ceda ceeds 28 Title block ni so risas Tar patri E A 28 Backslash ESCAPES cotas ni Es Eddie 30 Sd AA veda oss vis usodesdeeesceegseesos tes sebvasasbeoteadssessanddberearanssons 30 Inline formatting 33 55 063 esete aeres e EEE siete beckons Maga ota 30 Emphasis ssl ts inet spice 30 SIIC eiii AD at E ENIE e 31 Superscripts and SUDSCrIpts 255 ssscccsssssedeensssbeceessevesesgesscveesdeedeasgastsbacdasessauanesed 31 NMerbatim ando lead 31 Mathers tatoo rte Aran ran pasaba 32 Raw HIMD dai td 33 AO E E svc sa svcoen ads sestevigeedbende prov sessddsnesh sures cdsbedeaeas eeein geecasens 34 LaTeX Macros tii ds eM Si biie 35 O sdssce ss totic igus tg bss ban case Geattales bat ussacannta ses E E bat E A E seedy eeteaase ba Santee 35 Automatic links sesos
5. enl EndNote XML xml ISI WOS MEDLINE medline Copac copac JSON citeproc json Note that bib can generally be used with both BibTeX and BibLaTeX files but you can use bib tex to force BibTeX You will need to specify the bibliography file using the bibliography command line option which may be repeated if you have several bibliographies By default pandoc will use a Chicago author date format for citations and references To use another style you will need to use the cs1 option to specify a CSL http CitationStyles org 1 0 style file A primer on creating and modifying CSL styles can be found at http citationstyles org down loads primer html A repository of CSL styles can be found at https github com citation style lan guage styles See also http zotero org styles for easy browsing Citations go inside square brackets and are separated by semicolons Each citation must have a key composed of the citation identifier from the database and may optionally have a prefix a locator and a suffix Here are some examples Blah blah see doe99 pp 33 35 also smith04 ch 1 Blah blah doe99 pp 33 35 38 39 and passim Blah blah smith04 doe99 A minus sign before the will suppress mention of the author in the citation This can be useful when the author is already mentioned in the text 38 Pandoc s markdown Smith says blah smith04 You can also write an in text citat
6. theme or colortheme using the V option pandoc t beamer habits txt V theme Warsaw o habits pdf 44 Kapitel 8 Literate Haskell support If you append 1hs or 1iterate_haskell to an appropriate input or output format mark down mardkown_strict rst or latex for input or output beamer html or htm15 for output only pandoc will treat the document as literate Haskell source This means that e In markdown input bird track sections will be parsed as Haskell code rather than block quotations Text between begin code and end code will also be treated as Haskell code e In markdown output code blocks with classes haskell and literate will be rendered using bird tracks and block quotations will be indented one space so they will not be treated as Haskell code In addition headers will be rendered setext style with underlines rather than atx style with characters This is because ghc treats characters in column 1 as introducing line numbers e In restructured text input bird track sections will be parsed as Haskell code e In restructured text output code blocks with class haske11 will be rendered using bird tracks e In LaTeX input text in code environments will be parsed as Haskell code e In LaTeX output code blocks with class haske11 will be rendered inside code environments e In HTML output code blocks with class haske11 will be rendered with class lLiteratehas kell and bird tracks
7. Examples pandoc f markdown lhs t html reads literate Haskell source formatted with markdown conventions and writes ordinary HTML without bird tracks pandoc f markdown lhs t html lhs writes HTML with the Haskell code in bird tracks so it can be copied and pasted as literate Haskell source 45 Kapitel 9 Authors 2006 2013 John MacFarlane jgm at berkeley dot edu Released under the GPL http www gnu org copyleft gpl html version 2 or greater This software carries no warranty of any kind See COPYRIGHT for full copyright and warranty notices Other contributors include Recai OktaAY Paulo Tanimoto Peter Wang Andrea Rossato Eric Kow infinityOx Luke Plant shreevatsa public Puneeth Chaganti Paul Rivier rodja trappe Bradley Kuhn thsutton Nathan Gass Jonathan Daug herty JAOrAOmy Bobbio Justin Bogner gerub Christopher Sawicki Kelsey Hightower Masayoshi Takahashi Antoine Latter Ralf Stephan Eric Seidel B Scott Michel Gavin Beatty Sergey Astanin Arlo O Keeffe Denis Laxalde Brent Yorgey 46
8. See the Introduction Introduction introduction Internal links are currently supported for HTML formats including HTML slide shows and EPUB LaTeX and ConTeXt Images A link immediately preceded by a will be treated as an image The link text will be used as the image s alt text 36 Pandoc s markdown la lune lalune jpg Voyage to the moon movie reel movie reel movie gif Pictures with captions Extension implicit_figures An image occurring by itself in a paragraph will be rendered as a figure with a caption In LaTeX a figure environment will be used in HTML the image will be placed in a div with class figure together with a caption in a p with class caption The image s alt text will be used as the caption This is the caption url of image png If you just want a regular inline image just make sure it is not the only thing in the paragraph One way to do this is to insert a nonbreaking space after the image This image won t be a figure url of image png Footnotes Extension footnotes Pandoc s markdown allows footnotes using the following syntax Here is a footnote reference 1 and another longnote 11 Here is the footnote longnote Here s one with multiple blocks Subsequent paragraphs are indented to show that they belong to the previous footnote some code The whole paragraph can be indented or just the first line In this w
9. between the items one two three The bullets need not be flush with the left margin they may be indented one two or three spaces The bullet must be followed by whitespace List items look best if subsequent lines are flush with the first line after the bullet here is my first list item and my second But markdown also allows a lazy format here is my first list item and my second The four space rule A list item may contain multiple paragraphs and other block level content However subsequent para graphs must be preceded by a blank line and indented four spaces or a tab The list will look better if the first paragraph is aligned with the rest First paragraph Continued Second paragraph With a code block which must be indented eight spaces code List items may include other lists In this case the preceding blank line is optional The nested list must be indented four spaces or one tab 21 Pandoc s markdown fruits apples macintosh red delicious pears peaches vegetables brocolli chard As noted above markdown allows you to write list items lazily instead of indenting continuation lines However if there are multiple paragraphs or other blocks in a list item the first line of each must be indented A lazy lazy list item Another one this looks bad but is legal Second paragraph of second list item Note Although the
10. color for external links in LaTeX documents links as notes causes links to be printed as footnotes in LaTeX documents Variables may be set at the command line using the V variable option This allows users to include custom variables in their templates Templates may contain conditionals The syntax is as follows Sif variable S X Selse Y Sendif This will include X in the template if variable has a non null value otherwise it will include Y X and Y are placeholders for any valid template text and may include interpolated variables or other conditionals The else section may be omitted When variables can have multiple values for example author in a multi author document you can use the for keyword Sfor author lt meta name author content Sauthor gt Sendfor You can optionally specify a separator to be used between consecutive items Sfor author author sep Sendfor If you use custom templates you may need to revise them as pandoc changes We recommend tracking the changes in the default templates and modifying your custom templates accordingly An easy way to do this is to fork the pandoc templates repository http github com jgm pandoc templates and merge in changes after each pandoc release 14 Kapitel 5 Pandoc s markdown Pandoc understands an extended and slightly revised version of John Gruber s markdown http daringfireball net projects markdown syntax This documen
11. gt lt pre gt A shortcut form can also be used for specifying the language of the code block haskell qsort This is equivalent to haskell qsort To prevent all highlighting use the no highlight flag To set the highlighting style use highlight style Line blocks Extension line_blocks A line block is a sequence of lines beginning with a vertical bar followed by a space The division into lines will be preserved in the output as will any leading spaces otherwise the lines will be formatted as markdown This is useful for verse and addresses The limerick packs laughs anatomical In space that is quite economical But the good ones I ve seen So seldom are clean And the clean ones so seldom are comical 200 Main St Berkeley CA 94718 The lines can be hard wrapped if needed but the continuation line must begin with a space The Right Honorable Most Venerable and Righteous Samuel L Constable Jr 200 Main St Berkeley CA 94718 This syntax is borrowed from reStructuredText http docutils sourceforge net docs ref rst introduction html 20 Pandoc s markdown Lists Bullet lists A bullet list is a list of bulleted list items A bulleted list item begins with a bullet or Here 1s a simple example one two three This will produce a compact list If you want a loose list in which each item is formatted as a paragraph put spaces
12. links Kapitel 3 Options General options f FORMAT r FORMAT from FORMAT read FORMAT t FORMAT w FOR MAT to FORMAT write FORMAT o FILE output FILE Specify input format FORMAT can be native native Has kell json JSON version of native AST markdown pandoc s extended markdown markdown_strict origi nal unextended markdown markdown_phpextra PHP Markdown Extra extended markdown markdown_github github extended markdown textile Textile rst reStructuredText html HTML docbook DocBook XML mediawiki MediaWiki markup or latex LaTeX If lhs is appended to markdown rst latex the input will be treated as literate Haskell source see Literate Haskell support below Markdown syntax extensions can be individually enabled or disa bled by appending EXTENSION or EXTENSION to the format name So for example markdown_strict footnotes definition_lists is strict markdown with footnotes and definition lists enabled and mark down pipe_tables hard_line_breaks is pandoc s markdown without pipe tables and with hard line breaks See Pandoc s markdown below for a list of extensions and their names Specify output format FORMAT can be native nati ve Haskell json JSON version of native AST plain plain text markdown pandoc s extended mark down markdown_strict original unextended mark down markdown_phpext ra PHP Markdown extra exten ded ma
13. of the EPUB not the way chapters and sections are displayed to users Some readers may be slow if the chapter files are too lar ge so for large documents with few level 1 headers one might want to use a chapter level of 2 or 3 Use the specified LaTeX engine when producing PDF output The default is pdflatex If the engine is not in your PATH the full path of the engine may be specified here Specify bibliography database to be used in resolving citations The database type will be determined from the extension of FILE which may be mods MODS format bib BibLa TeX format which will normally work for BibTeX files as well bibtex BibTeX format ris RIS format enl EndNote format xml EndNote XML format wos ISI format medline MEDLINE format copac Copac format or json citeproc JSON If you want to use multi ple bibliographies just use this option repeatedly Specify CSL http CitationStyles org style to be used in for matting citations and the bibliography If FILE is not found pandoc will look for it in SHOME csl in unix 10 Options C Documents And Settings USERNAME Application Datalcs in Windows XP and C XUserslUSERNAMEXMAppDatalRoaminglcsl in Windows 7 If the cs1 option is not specified pandoc will use a default style either default cs1 in the user data directory see data dir or if that is not present the Chi cago author date style citat
14. row of s separates the header from the table body and can be omitted for a headerless table The cells of grid tables may contain arbitrary block elements multiple paragraphs code blocks lists etc Alignments are not supported nor are cells that span multiple columns or rows Grid tables can be created easily using Emacs table mode http table sourceforge net Pipe tables Title Extension pipe_tables table_captions Pipe tables look like this Right Left Default Center 12 12 12 12 1235 123 123 123 1 1 1 1 Demonstration of simple table syntax The syntax is the same as in PHP markdown extra http michelf ca projects php markdown extra table The beginning and ending pipe characters are optional but pipes are required between all columns The colons indicate column alignment as shown The header can be omitted but the hori zontal line must still be included as it defines column alignments Since the pipes indicate column boundaries columns need not be vertically aligned as they are in the above example So this is a perfectly legal though ugly pipe table fruit price AR apple 2 05 pear 1 37 orange 3 09 The cells of pipe tables cannot contain block elements like paragraphs and lists and cannot span multiple lines Note Pandoc also recognizes pipe tables of the following form as can produced by Emacs orgt bl mode One Tw
15. second example will be numbered 2 Explanation of examples My third example will be numbered 3 Numbered examples can be labeled and referred to elsewhere in the document good This is a good example As good illustrates The label can be any string of alphanumeric characters underscores or hyphens Compact and loose lists Pandoc behaves differently from Markdown p1 on some edge cases involving lists Consider this source First Second Fee 24 Pandoc s markdown Fie Foe Third Pandoc transforms this into a compact list with no lt p gt tags around First Second or Third while markdown puts lt p gt tags around Second and Third but not First because of the blank space 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 markdown_strict format is specified This behavior is consistent with the official markdown syntax description even though it is different from that of Markdown p1 Ending alist What if you want to put an indented code block after a list item one item two my code block Trouble Here pandoc like other markdown implementations will treat my code block a
16. stan dalone Include contents of FILE verbatim at the end of the docu ment body before the lt body gt tag in HTML or the end document command in LaTeX This option can be be used repeatedly to include multiple files They will be inclu ded in the order specified Implies st andalone Options affecting specific writers self contained offline 5 htm1L5 html q tags ascii reference links atx headers chapters Produce a standalone HTML file with no external dependen cies using data URIs to incorporate the contents of lin ked scripts stylesheets images and videos The resulting file should be self contained in the sense that it needs no exter nal files and no net access to be displayed properly by a brow ser This option works only with HTML output formats inclu ding html htm15 html lhs html15 1hs s5 slidy slideous and dzslides Scripts images and stylesheets at absolute URLs will be downloaded those at relative URLs will be sought first relative to the working directory then rela tive to the user data directory see data dir and finally relative to pandoc s default data directory Deprecated synonym for self contained Produce HTMLS instead of HTML4 This option has no effect for writers other than htm1 Deprecated Use the htm1 5 out put format instead Use lt q gt tags for quotes in HTML Use only ascii characters in output Curr
17. the slide show By default the slide level is the highest header level in the hierarchy that is followed immediately by content and not another header somewhere in the document In the example above level 1 headers are always followed by level 2 headers which are followed by content so 2 is the slide level This default can be overridden using the slide leve1 option The document is carved up into slides according to the following rules e A horizontal rule always starts a new slide e A header at the slide level always starts a new slide e Headers below the slide level in the hierarchy create headers within a slide e Headers above the slide level in the hierarchy create title slides which just contain the section title and help to break the slide show into sections A title page is constructed automatically from the document s title block if present In the case of beamer this can be disabled by commenting out some lines in the default template These rules are designed to support many different styles of slide show If you don t care about struc turing your slides into sections and subsections you can just use level 1 headers for all each slide In that case level 1 will be the slide level But you can also structure the slide show into sections as in the example above For Slidy Slideous and S5 the file produced by pandoc with the s st andalone option embeds alink to javascripts and CSS files which are assum
18. Pandoc User s Guide John MacFarlane Pandoc User s Guide John MacFarlane Inhaltsverzeichnis T Synopsis AN 1 2 DESCTIPUON A A AA A AA A A EA 2 Using Pandora iia erratas 2 Creating a PDP cis rated die cda uds 3 O 3 3 Options NN 4 General options nessis iassa ao r a debts AEE Ea r nE R ROPERT E REIR EE EPE aR KSNR 4 Reader Options sisien reene E ET EE si E TEE EEE EE 5 General writer Options vit ur E a E EE yah E EEE IRE 6 Options affecting specific Writers 0 lee cece cece ence ence ence eeceeeeeeeaeseaeceaeeaa eens eeaes 7 Citation rendering csi5ss cesee insti cvpaesdseesenadesscesegsacden sap sereesdSveasende EENID ness 10 Math rendering HTM Ec dee eos 11 Options il AA TN 12 A Templates cari E AR iiss UA des 13 5 Pandoc s markdowns visose orio sss osaesaseerscaseesdeogecvetes sseedassspdssteedivendendgsbotes A PETO EEES EE oE 15 Philosophy visito iii 15 A 2 s ssecsitss aosteses oa a E otttedsaenaa desert satbersiaks atta ses evade AT gett 15 Headers nr ON 15 Setext style headers cccsvcsscsdsadescseasaasosn ees sesvasd SSE SES EEEE SERA EUNTES EEs 15 Atx style headers ocsi iria ne rE e anen ren li oie idas ERENER E E 16 Header identifiers in HTML LaTeX and ConTeXt ocococncncncnncncncncncncncncnoncnnnnos 16 Block QUOtAtIONS cciootcicnro site ie aere E n ETES cys E E E 18 Verbatim code Bloks ci da Ea oTa 19 Indented code blocks isesi A 19 Fenc d code DIOCKS uta eta a E E E T a EES 19 Lime
19. TML block tags as markdown Thus for example Pandoc will turn lt table gt lt tr gt lt td gt one lt td gt lt td gt a link http google com lt td gt lt tr gt lt table gt into lt table gt SES lt td gt lt em gt one lt em gt lt td gt lt td gt lt a href http google com gt a link lt a gt lt td gt lt tr gt lt table gt whereas Markdown p1 will preserve it as is There is one exception to this rule text between lt script gt and lt style gt tags is not interpreted as markdown This departure from standard markdown should make it easier to mix markdown with HTML block elements For example one can surround a block of markdown text with lt div gt tags without preven ting it from being interpreted as markdown Raw TeX Extension raw_tex In addition to raw HTML pandoc allows raw LaTeX TeX and ConTeXt to be included in a document Inline TeX commands will be preserved and passed unchanged to the LaTeX and ConTeXt writers Thus for example you can use LaTeX to include BibTeX citations This result was proved in cite jones 1967 Note that in LaTeX environments like begin tabular 1 1 hline Age amp Frequency hline 18 25 amp 15 26 35 amp 33 AN 36 45 amp 22 hline end tabular 34 Pandoc s markdown the material between the begin and end tags will be interpreted as raw LaTeX not as markdown Inline LaTeX is ignored in output formats
20. an HTML javascript slide presentation that can be viewed via a web browser There are four ways to do this using S5 http meyerweb com eric tools s5 DZSlides http paulrouget com dzslides Slidy http www w3 org Talks Tools Slidy or Slideous http goessner net articles slideous You can also produce a PDF slide show using LaTeX beamer http www tex ac uk CTAN macros latex contrib beamer Here s the markdown source for a simple slide show habits txt Ao Habits John Doe March 22 2005 Ao Ao He In the morning Getting up Turn off alarm Get out of bed Breakfast Eat eggs Drink coffee In the evening Dinner Eat spaghetti Drink wine picture of spaghetti images spaghetti jpg Going to sleep Get in bed Count sheep To produce the slide show simply type pandoc t s5 s habits txt o habits html for S5 pandoc t slidy s habits txt o habits html for Slidy 42 Producing slide shows with Pandoc pandoc t slideous s habits txt o habits html for Slideous pandoc t dzslides s habits txt o habits html for DZSlides or pandoc t beamer habits txt o habits pdf for beamer With all HTML slide formats the self contained option can be used to produce a single file that contains all of the data necessary to display the slide show including linked scripts stylesheets images and videos Structuring
21. ay multi paragraph footnotes work like multi paragraph list items This paragraph won t be part of the note because it isn t indented The identifiers in footnote references may not contain spaces tabs or newlines These identifiers are used only to correlate the footnote reference with the note itself in the output footnotes will be numbered sequentially The footnotes themselves need not be placed at the end of the document They may appear anywhere except inside other block elements lists block quotes tables etc Extension inline notes 4 This feature is not yet implemented for RTF OpenDocument or ODT In those formats you ll just get an image in a paragraph by itself with no caption 37 Pandoc s markdown Inline footnotes are also allowed though unlike regular notes they cannot contain multiple para graphs The syntax is as follows Here is an inline note Inlines notes ar asier to write since you don t have to pick an identifier and move down to type the note Inline and regular footnotes may be mixed freely Citations Extension citations Pandoc can automatically generate citations and a bibliography in a number of styles using Andrea Rossato s hs citeproc In order to use this feature you will need a bibliographic database in one of the following formats Format File extension MODS mods BibLaTeX bib BibTeX bibtex RIS TIS EndNote
22. cally generated table of contents or in the case of latex context and rst an instruction to create one in the output document This option has no effect on man docbook slidy slideous or s5 output Specify the number of section levels to include in the table of contents The default is 3 which means that level 1 2 and 3 headers will be listed in the contents Implies toc Disables syntax highlighting for code blocks and inlines even when a language attribute is given Options highlight style STYLE H FILE include in header FILE B FILE include befo re body FILE A FILE include after body FILE Specifies the coloring style to be used in highlighted sour ce code Options are pygment s the default kate mono chrome espresso zenburn haddock and tango Include contents of FILE verbatim at the end of the header This can be used for example to include special CSS or java script in HTML documents This option can be used repeatedly to include multiple files in the header They will be included in the order specified Implies st andalone Include contents of FILE verbatim at the beginning of the document body e g after the lt body gt tag in HTML or the begin document command in LaTeX This can be used to include navigation bars or banners in HTML documents This option can be used repeatedly to include multiple files They will be included in the order specified Implies
23. ch you want to be numbered 1 5 specify num ber offset 1 4 Offsets are 0 by default Implies number sections Do not convert quotation marks apostrophes and dashes to the TeX ligatures when writing LaTeX or ConTeXt Instead just use literal unicode characters This is needed for using advan ced OpenType features with XeLaTeX and LuaLaTeX Note normally smart is selected automatically for LaTeX and ConTeXt output but it must be specified explicitly if no tex ligatures is selected If you use literal curly quotes dashes and ellipses in your source then you may want to use no tex ligatures without smart Use listings package for LaTeX code blocks Make list items in slide shows display incrementally one by one The default is for lists to be displayed all at once Specifies that headers with the specified level create slides for beamer s5 slidy slideous dzslides Headers above this level in the hierarchy are used to divide the slide show into sections headers below this level create subheads within a slide The default is to set the slide level based on the contents of the document see Structuring the slide show below Wrap sections in lt div gt tags or lt section gt tags in HTMLS and attach identifiers to the enclosing lt div gt or lt section gt rather than the header itself See Section identi fiers below Specify a method for obfuscating mailto links in HTML documents none leav
24. cument tit le lt dc creator gt from the document authors lt dc date gt from the document date which should be in ISO 8601 format http www w3 org TR NOTE datetime lt dc language gt from the lang variable or if is not set the locale and lt dc identifier id BookId gt aran domly generated UUID Any of these may be overridden by elements in the metadata file Embed the specified font in the EPUB This option can be repeated to embed multiple fonts To use embedded fonts you will need to add declarations like the following to your CSS see pub stylesheet Options epub chap ter level NUMBER latex latex xelatex ngine pdflatexllua Citation rendering bibliography FILE cs1 FILE Gfont face font family DejaVuSans font style normal font weight normal src url DejaVuSans Regular ttf font face font family DejaVuSans font style normal font weight bold src url DejaVuSans Bold ttf font face font family DejaVuSans font style italic font weight normal src url DejaVuSans Oblique ttf font face font family DejaVuSans font style italic font weight bold src url DejaVuSans BoldO0blique ttf body font family DejaVuSans Specify the header level at which to split the EPUB into sepa rate chapter files The default is to split into chapters at level 1 headers This option only affects the internal composition
25. e g jsMath easy load js if provided it will be linked to in the header of standalone HTML documents If a URL is not provided no link to the jsMath load script will be inserted it is then up to the author to provide such a link in the HTML template mathjax URL Use MathJax http www mathjax org to display embedded TeX math in HTML output The URL should point to the Options MathJax js load script If a URL is not provided a link to the MathJax CDN will be inserted gladtex Enclose TeX math in lt eq gt tags in HTML output These can then be processed by gladTeX http ans hsh no home mgg gladtex to produce links to images of the typeset formulas mimetex URL Render TeX math using the mimeTeX http www forkosh com mimetex html CGI script If URL is not specified it is assumed that the script is at cgi bin mimetex cgi webtex URL Render TeX formulas using an external script that converts TeX formulas to images The formula will be concatenated with the URL provided If URL is not specified the Google Chart API will be used Options for wrapper scripts dump args Print information about command line arguments to stdout then exit This option is intended primarily for use in wrapper scripts The first line of output contains the name of the out put file specified with the o option or for stdout if no output file was specified The remaining lines contain the com mand line arg
26. ed to be available at the relative path s5 default for S5 or slideous for Slideous or at the Slidy website at w3 org for Slidy These paths can be changed by setting the slidy url slideous url or s5 url variables see variable above For DZSlides the relatively short javascript and css are included in the file by default Incremental lists By default these writers produces lists that display all at once If you want your lists to display incrementally one item at a time use the i option If you want a particular list to depart from the default that is to display incrementally without the i option and all at once with the i option put it in a block quote gt Eat spaghetti 43 Producing slide shows with Pandoc gt Drink wine In this way incremental and nonincremental lists can be mixed in a single document Styling the slides You can change the style of HTML slides by putting customized CSS files in SDATADIR s5 default for S5 SDATADIR slidy for Slidy or SDATADIR slideous for Slideous whe re SDATADIR is the user data directory see data dir above The originals may be found in pandoc s system data directory generally CABALDIR pandoc VERSION s5 default Pan doc will look there for any files it does not find in the user data directory For dzslides the CSS is included in the HTML file itself and may be modified there To style beamer slides you can specify a beamer
27. ently supported only for HTML output which uses numerical entities instead of UTF 8 when this option is selected Use reference style links rather than inline links in writing markdown or reStructuredText By default inline links are used Use ATX style headers in markdown output The default is to use setext style headers for levels 1 2 and then ATX headers Treat top level headers as chapters in LaTeX ConTeXt and DocBook output When the LaTeX template uses the report Options N number sections num book or memoir class this option is implied If beamer is used top level headers will become part Number section headings in LaTeX ConTeXt HTML or EPUB output By default sections are not numbered Sections with class unnumbered will never be numbered even if number sections is specified Offset for section headings in HTML output ignored in other ber offset NUMBER NUMBERoufput formats The first number is added to the section num no tex ligatures listings i incremental slide level NUMBER section divs email obfuscation nonel javascriptlreferences id prefix STRING T STRING tit le prefix STRING ber for top level headers the second for second level headers and so on So for example if you want the first top level hea der in your document to be numbered 6 specify num ber offset 5 If your document starts with a level 2 hea der whi
28. es eine eese o rE E rE EENE eee EEEE E E A EVRE 35 Joline HKS A o sna aa EO EEEn EESTE Ea EUSE SES REEI 35 iii Pandoc User s Guide Reference links A A 35 Internal ink iss sous e an ates tabled dant E uscd Sie au a eas aad eine 36 IMAGES 262s sdesas set sas deh e E A E tanner es havebaaecgscduabiven E A EE ERS 36 Pictures with Captions mi ees oy ateed E decade sens Ri 37 BOOMOICS illo 37 Citations erie seit E cada A A A E 38 6 NOn pandoc EXtENSIONS 2 d3ss yet sass ey taeweeseeheoaeebaden dee E yee s o pub aa ented tesnceed daz deedaeee es 40 7 Producing slide shows with Pandoc oooccnoccncconccnnccnnncnononoconornnccnnconnccnnccnnccnncnnnccnnconoss 42 Structuring the SUde SHOW 1s ess sesedecgsnseshsneesacsss sien gesh seen dgeabonesteh REEN E esmas Reni 43 Incremental StS Sn nts cess Se ata ada a PE ae etd aed 43 Styling therSlides uti ita cios eiii gees 44 8 Literate Haskell support ii iran aoe 45 Ds A UMNOLS ctra inter a te Sea litis 46 Kapitel 1 Synopsis pandoc options input file Kapitel 2 Description Pandoc is a Haskell http www haskell org library for converting from one markup for mat to another and a command line tool that uses this library It can read markdown http daringfireball net projects markdown and subsets of Textile http redcloth org texti le reStructuredText http docutils sourceforge net docs ref rst introduction html HTML http www w3 org TR h
29. es mailto links as they are javascript obfuscates them using javascript references obfuscates them by printing their letters as decimal or hexadecimal character references Specify a prefix to be added to all automatically generated iden tifiers in HTML and DocBook output and to footnote num bers in markdown output This is useful for preventing duplica te identifiers when generating fragments to be included in other pages Specify STRING as a prefix at the beginning of the title that appears in the HTML header but not in the title as it appears at the beginning of the HTML body Implies st andalone Options c URL css URL reference odt FILE reference docx FILE pub stylesheet FILE pub cover image FILE epub metadata FILE mbed font FILE pub Link to a CSS style sheet This option can be be used repeated ly to include multiple files They will be included in the order specified Use the specified file as a style reference in producing an ODT For best results the reference ODT should be a modified ver sion of an ODT produced using pandoc The contents of the reference ODT are ignored but its stylesheets are used in the new ODT If no reference ODT is specified on the command line pandoc will look for a file reference odt in the user data directory see data dir If this is not found either sensible defaults will be used Use the specified file as a style refe
30. four space rule for continuation paragraphs comes from the official markdown syntax guide http daringfireball net projects markdown syntax list the reference implementation Markdown p1 does not follow it So pandoc will give different results than Markdown p1 when authors have indented continuation paragraphs fewer than four spaces The markdown syntax guide http daringfireball net projects markdown syntax list is not explicit whether the four space rule applies to all block level content in a list item it only mentions paragraphs and code blocks But it implies that the rule applies to all block level content including nested lists and pandoc interprets it that way Ordered lists Ordered lists work just like bulleted lists except that the items begin with enumerators rather than bullets In standard markdown enumerators are decimal numbers followed by a period and a space The num bers themselves are ignored so there is no difference between this list lms one 2 two 3 three and this one 5 one Ta two 1 three Extension fancy_lists Unlike standard markdown Pandoc allows ordered list items to be marked with uppercase and lower case letters and roman numerals in addition to arabic numerals List markers may be enclosed in par entheses or followed by a single right parentheses or period They must be separated from the text 22 Pandoc s markdown that follows by at least one space and if the list
31. hat is the difference between gt gt and gt gt If the verbatim text includes a backtick use double backticks Here is a literal backtick The spaces after the opening backticks and before the closing backticks will be ignored The general rule is that a verbatim span starts with a string of consecutive backticks optionally fol lowed by a space and ends with a string of the same number of backticks optionally preceded by a space 31 Pandoc s markdown Note that backslash escapes and other markdown constructs do not work in verbatim contexts This is a backslash followed by an asterisk 1 Extension inline _ code attributes Attributes can be attached to verbatim text just as with fenced code blocks lt gt haskell Math Extension tex_math_dollars Anything between two characters will be treated as TeX math The opening must have a charac ter immediately to its right while the closing must have a character immediately to its left Thus 20 000 and 30 000 won t parse as math If for some reason you need to enclose text in literal characters backslash escape them and they won t be treated as math delimiters TeX math will be printed in all output formats How it is rendered depends on the output format Markdown LaTeX Org Mode ConTeXt reStructuredText AsciiDoc Texinfo groff man MediaWiki Textile RTF OpenDocument ODT Docbook Docx FictionBook2 HTML S
32. hed to the enclosing lt div gt or lt section gt tag rather than the header itself This allows entire sections to be manipulated using javascript or treated differently in CSS Extension implicit_header_references Pandoc behaves as if reference links have been defined for each header So instead of header identifiers header identifiers in html1 17 Pandoc s markdown you can simply write header identifiers or header identifiers or the section on header identifiers header identifiers If there are multiple headers with identical text the corresponding reference will link to the first one only and you will need to use explicit links to link to the others as described above Unlike regular reference links these references are case sensitive Note if you have defined an explicit identifier for a header then implicit references to it will not work Block quotations Markdown uses email conventions for quoting blocks of text A block quotation is one or more para graphs or other block elements such as lists or headers with each line preceded by a gt character and a space The gt need not start at the left margin but it should not be indented more than three spaces This is a block quote This paragraph has two lines 1 This is a list inside a block quote 2 Second item gt gt gt gt gt A lazy form which requires the gt character onl
33. i Specify a file containing abbreviations for journal tit on abbreviations FILE les and other bibliographic fields indicated by setting form short in the CSL node for the field The format is described at http citationstylist org 2011 10 19 abbreviati ons for zotero test release Here is a short example default container title Lloyd s Law Reports Lloyd s Rep Estates Gazette EG Scots Law Times SLT natbib Use natbib for citations in LaTeX output biblatex Use biblatex for citations in LaTeX output m URL Use the LaTeXMathML http math etsu edu LaTeX latexmathm1 URL MathML script to display embedded TeX math in HTML out put To insert a link to a local copy of the LaTeXMathML js script provide a URL If no URL is provided the contents of the script will be inserted directly into the HTML header pre serving portability at the price of efficiency If you plan to use math on several pages it is much better to link to a copy of the script so it can be cached mathm1 URL Convert TeX math to MathML in docbook as well as html and htm15 In standalone html output a small javascript or a link to such a script if a URL is supplied will be inserted that allows the MathML to be viewed on some browsers jsmath URL Use jsMath http www math union edu dpvc jsmath to display embedded TeX math in HTML output The URL should point to the jsMath load script
34. ified the default user data directory will be used This is SHOME pandoc in unix C Documents And Settings USERNAME Application Datalpe in Windows XP and C Users USERNAME AppData Roaming pandoc in Windows 7 You can find the default user data directory on your system by looking at the out put of pandoc version A reference odt reference docx default csl epub css tem plates slidy slideous or s5 directory placed in this directory will override pandoc s normal defaults v version Print version h help Show usage message Reader options R parse raw Parse untranslatable HTML codes and LaTeX environments as raw HTML or LaTeX instead of ignoring them Affects only HTML and LaTeX input Raw HTML can be printed in markdown reStructuredText HTML Slidy Slideous DZSli des and S5 output raw LaTeX can be printed in markdown reStructuredText LaTeX and ConTeXt output The default is for the readers to omit untranslatable HTML codes and LaTeX environments The LaTeX reader does pass through untrans latable LaTeX commands even if R is not specified S smart Produce typographically correct output converting straight quotes to curly quotes to em dashes to en das hes and to ellipses Nonbreaking spaces are inserted after certain abbreviations such as Mr Note This opti on is significant only when the input format is markdown markdown_strict or textile It
35. ion as follows Qsmith04 says blah smith0O4 p 33 says blah If the style calls for a list of works cited it will be placed at the end of the document Normally you will want to end your document with an appropriate header last paragraph References The bibliography will be inserted after this header 39 Kapitel 6 Non pandoc extensions The following markdown syntax extensions are not enabled by default in pandoc but may be enabled by adding EXTENSION to the format name where EXTENSION is the name of the extension Thus for example markdown hard_line_breaks is markdown with hard line breaks Extension hard_line breaks Causes all newlines within a paragraph to be interpreted as hard line breaks instead of spaces Extension tex_math_single backslash Causes anything between and 1 to be interpreted as inline TeX math and anything between and to be interpreted as display TeX math Note a drawback of this extension is that it precludes escaping and Extension tex_math_double backslash Causes anything between and to be interpreted as inline TeX math and anything between and XX to be interpreted as display TeX math Extension markdown_attribute By default pandoc interprets material inside block level tags as markdown This extension changes the behavior so that markdown is only parsed inside block level tags if the tags have the attribute markdown 1
36. is selected automati cally when the input format is text ile or the output format is latex or context unless no tex ligatures is used old dashes Selects the pandoc lt 1 8 2 1 behavior for parsing smart das hes before a numeral is an en dash and is an em dash This option is selected automatically for textile input base hea Specify the base level for headers defaults to 1 der level NUMBER indented cod Specify classes to use for indented code blocks for example classes CLASSES perl numberLines or haskel1 Multiple classes may be separated by spaces or commas Options default imag extension EXTENSION normalize p preserve tabs tab stop NUMBER s Sstandalone template FILE V KEY VAL variable KEY VAL D FORMAT print default template FORMAT no wrap columns NUMBER toc table of con tents toc depth NUMBER no highlight Specify a default extension to use when image paths URLs have no extension This allows you to use the same source for formats that require different kinds of images Currently this option only affects the markdown and LaTeX readers Normalize the document after reading merge adjacent St r or Emph elements for example and remove repeated Spaces Preserve tabs instead of converting them to spaces the default Note that this will only affect tabs in literal code spans and code blocks tab
37. lidy DZSlides S5 EPUB It will appear verbatim between characters It will be rendered using an interpreted text role math as described here http www american edu econ itex2mml mathhack rst It will be rendered as latexmath It will be rendered inside a math command It will be rendered verbatim without s It will be rendered inside lt math gt tags It will be rendered inside lt span class math gt tags It will be rendered if possible using unicode characters and will otherwise appear verbatim If the mathml flag is used it will be rendered using mathml in an inlineequation or informalequation tag Otherwise it will be rendered if possible using unicode characters It will be rendered using OMML math markup If the webtex option is used formulas are rendered as images using Google Charts or other compatible web service downloaded and embedded in the e book Otherwise they will appear verbatim The way math is rendered in HTML will depend on the com mand line options selected 1 The default is to render TeX math as far as possible using unicode characters as with RTF DocBook and Open Document output Formulas are put inside a span with 32 Pandoc s markdown class math so that they may be styled differently from the surrounding text if needed 2 If the latexmathml option is used TeX math will be displayed between or characters and put in lt span gt tags
38. literally even if it would normally indicate formatting Thus for example if one writes hello one will get lt em gt hello lt em gt instead of lt strong gt hello lt strong gt This rule is easier to remember than standard markdown s rule which allows only the following cha racters to be backslash escaped Vx_0 01 Q gt However if the markdown_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 amp 160 or nbsp A backslash escaped newline i e a backslash occurring at the end of a line is parsed as a hard line break It will appear in TeX output as and in HTML as lt br gt This is a nice alternative to ms markdown s invisible way of indicating hard line breaks using two trailing spaces on a line Backslash escapes do not work in verbatim contexts Smart punctuation Extension If the smart option is specified pandoc will produce typographically correct output converting straight quotes to curly quotes to em dashes to en dashes and to ellipses Nonbreaking spaces are inserted after certain abbreviations such as Mr Note if your LaTeX template uses the csquotes package pandoc will detect automatically this and use enquote for quoted text Inline formatting Emphasis To emphasize some text surround it with s
39. lumn is left aligned e If the dashed line extends beyond the header text on both sides the column is centered e Ifthe dashed line is flush with the header text on both sides the default alignment is used in most cases this will be left The table must end with a blank line or a line of dashes followed by a blank line A caption may optionally be provided as illustrated in the example above A caption is a paragraph beginning with the string Table orjust which will be stripped off It may appear either before or after the table The column headers may be omitted provided a dashed line is used to end the table For example AZ 12 12 12 123 123 123 123 1 1 1 1 When headers are omitted column alignments are determined on the basis of the first line of the table body So in the tables above the columns would be right left center and right aligned respectively Multiline tables Extension multiline tables table_captions Multiline tables allow headers and table rows to span multiple lines of text but cells that span multiple columns or rows of the table are not supported Here is an example 3 This scheme is due to Michel Fortin who proposed it on the Markdown discussion list http six pairlist net pipermail markdown dis cuss 2005 March 001097 html 26 Pandoc s markdown Centered Default Right Left Header Aligned Aligned Aligned First row 12 0 Example of a row that spans multiple lines
40. marker is a capital letter with a period by at least two spaces Extension startnum Pandoc also pays attention to the type of list marker used and to the starting number and both of these are preserved where possible in the output format Thus the following yields a list with numbers followed by a single parenthesis starting with 9 and a sublist with lowercase roman numerals 9 Ninth 10 Tenth 11 Eleventh i subone ii subtwo iii subthree Pandoc will start a new list each time a different type of list marker is used So the following will create three lists Two Three Four Five FRAN aN On If default list markers are desired use one two three Definition lists Extension definition_lists Pandoc supports definition lists using a syntax inspired by PHP Markdown Extra http www michelf com projects php markdown extra and reStructuredText http docutils sourceforge net docs ref rst introduction html 2 Term 1 7 Definition 1 The point of this rule is to ensure that normal paragraphs starting with people s initials like B Russell was an English philosopher do not get treated as list items This rule will not prevent C 2007 Joe Smith from being interpreted as a list item In this case a backslash escape can be used tC 2007 0S St sO OMB 2 I have also been influenced by the suggestions of David Wheeler http www justatheory com computers markup m
41. nce in the document head this is the title that will appear at the top of the window in a browser and once at the beginning of the document body The title in the document head can have an optional prefix attached t it le prefix or T option The title in the body appears as an H1 element with class title so it can be suppressed or reformatted with CSS If a title prefix is specified with T and no title block appears in the document the title prefix will be used by itself as the HTML title The man page writer extracts a title man page section number and other header and footer information from the title line The title is assumed to be the first word on the title line which may optionally end with a single digit section number in parentheses There should be no space between the title and the parentheses Anything after this is assumed to be additional footer and header text A single pipe character should be used to separate the footer text from the header text Thus PANDOC 1 will yield a man page with the title PANDOC and section 1 PANDOC 1 Pandoc User Manuals 29 Pandoc s markdown will also have Pandoc User Manuals in the footer PANDOC 1 Pandoc User Manuals Version 4 0 will also have Version 4 0 in the header Backslash escapes Extension all_symbols_escapable Except inside a code block or inline code any punctuation or space character preceded by a backslash will be treated
42. ng for both input and output If your local character encoding 1s not UTF 8 you should pipe input and output through iconv iconv t utf 8 input txt pandoc iconv f utf 8 Creating a PDF Earlier versions of pandoc came with a program markdown2paf that used pandoc and pdflatex to produce a PDF This is no longer needed since pandoc can now produce pdf output itself To produce a PDF simply specify an output file with a pdf extension Pandoc will create a latex file and use pdflatex or another engine see 1latex engine to convert it to PDF pandoc test txt o test pdf Production of a PDF requires that a LaTeX engine be installed see latex engine below and assumes that the following LaTeX packages are available anssymb amsmath ifxetex ifluatex listings if the listings option is used fancyvrb longtable url graphicx hyperref ulem babel if the lang variable is set font spec if xelatex or lualatex is used as the LaTeX engine x lt xtra and xunicode if xelatex is used hsmarkdown A user who wants a drop in replacement for Markdown p1 may create a symbolic link to the pan doc executable called hsmarkdown When invoked under the name hsmarkdown pandoc will behave as if invoked with f markdown_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
43. nition consists of the bracketed label followed by a colon and a space followed by the URL and optionally after a space a link title either in quotes or in parentheses Here are some examples my label 1 foo bar html My title optional my label 2 foo my label 3 http fsf org The free software foundation 35 Pandoc s markdown my label 4 bar special A title in single quotes The URL may optionally be surrounded by angle brackets my label 5 lt http foo bar baz gt The title may go on the next line my label 3 http fsf org The free software foundation Note that link labels are not case sensitive So this will work Here is my link FOO Foo bar baz In an implicit reference link the second pair of brackets is empty or omitted entirely See my website or my website my website http foo bar baz Note In Markdown p1 and most other markdown implementations reference link definitions can not occur in nested constructions such as list items or block quotes Pandoc lifts this arbitrary seeming restriction So the following is fine in pandoc though not in most other implementations gt My block quote gt gt quote foo Internal links To link to another section of the same document use the automatically generated identifier see Header identifiers in HTML LaTeX and ConTeXt below For example See the Introduction introduction or
44. o my table is nice The difference is that is used instead of Other orgtbl features are not supported In particular to get non default column alignment you ll need to add colons as above block Extension pandoc_title_block If the file begins with a title block 28 Pandoc s markdown separated by semicolons A Ae Je w c a De O K n it will be parsed as bibliographic information not regular text It will be used for example in the title of standalone LaTeX or HTML output The block may contain just a title a title and an author or all three elements If you want to include an author but no title or a title and a date but no author you need a blank line ae Ae Author My title A Ae Je June 15 2006 The title may occupy multiple lines but continuation lines must begin with leading space thus My title on multiple lines If a document has multiple authors the authors may be put on separate lines with leading space or separated by semicolons or both So all of the following are equivalent hor One hor Two ct ct Author One Author Two hor One hor Two The date must fit on one line All three metadata fields may contain standard inline formatting italics links footnotes etc Title blocks will always be parsed but they will affect the output only when the standalone s option is chosen In HTML output titles will appear twice o
45. odest mark down proposal html Pandoc s markdown Term 2 with inline markup Definition 2 some code part of Definition 2 Third paragraph of definition 2 Each term must fit on one line which may optionally be followed by a blank line and must be followed by one or more definitions A definition begins with a colon or tilde which may be indented one or two spaces The body of the definition including the first line aside from the colon or tilde should be indented four spaces A term may have multiple definitions and each definition may consist of one or more block elements paragraph code block list etc each indented four spaces or one tab stop If you leave space after the definition as in the example above the blocks of the definitions will be considered paragraphs In some output formats this will mean greater spacing between term definition pairs For a compact definition list do not leave space between the definition and the next term Term 1 Definition 1 Term 2 Definition 2a Definition 2b Numbered example lists Extension example_lists The special list marker can be used for sequentially numbered examples The first list item with a marker will be numbered 1 the next 2 and so on throughout the document The numbered examples need not occur in a single list each new list using will take up where the last stopped So for example My first example will be numbered 1 My
46. or _ like this 30 Pandoc s markdown This text is _emphasized with underscores_ and this is emphasized with asterisks Double or _ produces strong emphasis This is strong emphasis and with underscores__ A or _ character surrounded by spaces or backslash escaped will not trigger emphasis This is not emphasized and neither is this Extension intraword_underscores Because _ is sometimes used inside words and identifiers pandoc does not interpret a _ surrounded by alphanumeric characters as an emphasis marker If you want to emphasize just part of a word use feas ible not feas able Strikeout Extension strikeout To strikeout a section of text with a horizontal line begin and end it with Thus for example This is deleted text Superscripts and subscripts Extension superscript subscript Superscripts may be written by surrounding the superscripted text by characters subscripts may be written by surrounding the subscripted text by characters Thus for example H 2 0 is a liquid 2 10 is 1024 Tf the superscripted or subscripted text contains spaces these spaces must be escaped with backslashes This is to prevent accidental superscripting and subscripting through the ordinary use of and Thus if you want the letter P with a cat in subscripts use P a cat notP a cat Verbatim To make a short span of text verbatim put it inside backticks W
47. other than Markdown LaTeX and ConTeXt LaTeX macros Extension latex_macros For output formats other than LaTeX pandoc will parse LaTeX newcommand and renewcom mand definitions and apply the resulting macros to all LaTeX math So for example the following will work in all output formats not just LaTeX newcommand tuple 1 langle 1 rangle tuple a b c In LaTeX output the newcommand definition will simply be passed unchanged to the output Links Markdown allows links to be specified in several ways Automatic links If you enclose a URL or email address in pointy brackets it will become a link lt http google com gt lt sam green eggs ham gt Inline links An inline link consists of the link text in square brackets followed by the URL in parentheses Optio nally the URL can be followed by a link title in quotes This is an inline link url and here s one with a title http fsf org click here for a good time There can be no space between the bracketed part and the parenthesized part The link text can contain formatting such as emphasis but the title cannot Reference links An explicit reference link has two parts the link itself and the link definition which may occur elsew here in the document either before or after the link The link consists of link text in square brackets followed by a label in square brackets There can be space between the two The link defi
48. own http www fsf org If multiple input files are given pandoc will concatenate them all with blank lines between them before parsing The format of the input and output can be specified explicitly using command line options The input format can be specified using the r read or f from options the output format using the w writeor t to options Thus to convert hello txt from markdown to LaTeX you could type Description pandoc f markdown t latex hello txt To convert hello htm1 from html to markdown pandoc f html t markdown hello html Supported output formats are listed below under the t to option Supported input formats are listed below under the f from option Note that the rst textile latex and html readers are not complete there are some constructs that they do not parse If the input or output format is not specified explicitly pandoc will attempt to guess it from the extensions of the input and output filenames Thus for example pandoc o hello tex hello txt will convert hello txt from markdown to LaTeX If no output file is specified so that output goes to stdout or if the output file s extension is unknown the output format will default to HTML If no input file is specified so that input comes from stdin or if the input files extensions are unknown the input format will be assumed to be markdown unless explicitly specified Pandoc uses the UTF 8 character encodi
49. ple and 5 Header identifiers in HTML LaTeX and ConText Extension header_attributes Headers can be assigned attributes using this syntax at the end of the line containing the header text identifier class class key value key value Although this syntax allows assignment of classes and key value attributes only identifiers currently have any affect in the writers and only in some writers HTML LaTeX ConTeXt Textile AsciiDoc Thus for example the following headers will all be assigned the identifier foo My header foo My header foo My other header tfoo This syntax is compatible with PHP Markdown Extra http www michelf com projects php mark down extra Headers with the class unnumbered will not be numbered even if number sections is spe cified A single hyphen in an attribute context is equivalent to unnumbered and preferable in non English documents So My header is just the same as Pandoc s markdown My header unnumbered Extension auto_identifiers A header without an explicitly specified identifier will be automatically assigned a unique identifier based on the header text To derive the identifier from the header text e Remove all formatting links etc e Remove all punctuation except underscores hyphens and periods e Replace all spaces and newlines with hyphens e Convert all alphabetic characters to lowercase e Remove everything
50. pt that converts formulas to images The formula will be URL encoded and concatenated with the URL provided If no URL is specified the Google Chart API will be used http chart apis google com chart cht tx chl 7 If the mathjax option is used TeX math will be dis played between for inline math or for display math and put in lt span gt tags withclass math The MathJax http www mathjax org script will be used to render it as formulas Raw HTML Extension raw_html Markdown allows you to insert raw HTML or DocBook anywhere in a document except verbatim contexts where lt gt and amp are interpreted literally Techncially this is not an extension since stan dard markdown allows it but it has been made an extension so that it can be disabled if desired 33 Pandoc s markdown The raw HTML is passed through unchanged in HTML S5 Slidy Slideous DZSlides EPUB Mark down and Textile output and suppressed in other formats Extension markdown_in_html_blocks Standard markdown allows you to include HTML blocks blocks of HTML between balanced tags that are separated from the surrounding text 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 the markdown_strict format is used but by default pandoc inter prets material between H
51. rence in producing a docx file For best results the reference docx should be a modified version of a docx file produced using pandoc The contents of the reference docx are ignored but its stylesheets are used in the new docx If no reference docx is specified on the command line pandoc will look for a file reference docx in the user data directory see data dir If this is not found either sensible defaults will be used The following styles are used by pandoc paragraph Normal Title Authors Date Heading 1 Heading 2 Heading 3 Heading 4 Heading 5 Block Quote Definition Term Definition Body Text Table Caption Image Caption character Default Paragraph Font Body Text Char Verbatim Char Footnote Ref Link Use the specified CSS file to style the EPUB If no stylesheet is specified pandoc will look for a file epub css in the user data directory see dat a dir If itis not found there sen sible defaults will be used Use the specified image as the EPUB cover It is recommended that the image be less than 1000px in width and height Look in the specified XML file for metadata for the EPUB The file should contain a series of Dublin Core elements as docu mented at http dublincore org documents dces For example lt dc rights gt Creative Commons lt dc rights gt lt dc language gt es AR lt dc language gt By default pandoc will include the following meta data elements lt dc title gt from the do
52. rkdown markdown_github github extended markdown rst reStructuredText html XHTML 1 htm15 HTML 5 latex LaTeX beamer LaTeX bea mer slide show context ConTeXt man groff man mediawiki MediaWiki markup textile Textile org Emacs Org Mode texinfo GNU Texinfo docbook DocBook XML opendocument OpenDocument XML odt OpenOffice text document docx Word docx epub EPUB book epub3 EPUB v3 fb2 FictionBook2 e book asciidoc AsciiDoc slidy Slidy HTML and javascript slide show slideous Slideous HTML and java script slide show dzslides HTML5 javascript slide show s5 S5 HTML and javascript slide show or rt f rich text format Note that odt epub and epub3 output will not be directed to stdout an output filename must be speci fied using the o output option If 1hs is appended to markdown rst latex beamer html or htm15 the output will be rendered as literate Haskell source see Literate Haskell support below Markdown syntax extensions can be individually enabled or disabled by appending EXTENSION or EXTENSION to the format name as described above under f Write output to FILE instead of stdout If FILE is output will go to stdout Exception if the output format is odt docx epub or epub3 output to stdout is disabled Options data dir DIRECTORY Specify the user data directory to search for pandoc data files If this option is not spec
53. rweb com eric tools s5 HTML slide shows It can also produce PDF http www adobe com pdf output on systems where LaTeX is installed Pandoc s enhanced version of markdown includes syntax for footnotes tables flexible ordered lists definition lists fenced code blocks superscript subscript strikeout title blocks automa tic tables of contents embedded LaTeX math citations and markdown inside HTML block ele ments These enhancements described below under Pandoc s markdown can be disabled using the markdown_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 set of readers which parse text in a given format and produce a native representation of the document and a set of writers which convert this native repre sentation into a target format Thus adding an input or output format requires only adding a reader or writer Using pandoc If no input file is specified input is read from stdin Otherwise the input files are concatenated with a blank line between each and used as input Output goes to stdout by default though output to stdout is disabled for the odt docx epub and epub3 output formats For output to a file use the o option pandoc o output html input txt Instead of a file an absolute URI may be given In this case pandoc will fetch the content using HTTP pandoc f html t markd
54. s the second paragraph of item two and not as a code block To cut off the list after item two you can insert some non indented content like an HTML comment which won t produce visible output in any format item one item two lt end of list gt my code block You can use the same trick if you want two consecutive lists instead of one big list 1s one 2 two 3 three lt gt Irs uno 2 dos 3 tres Horizontal rules A line containing a row of three or more or _ characters optionally separated by spaces produces a horizontal rule 25 Pandoc s markdown Tables Four kinds of tables may be used The first three kinds presuppose the use of a fixed width font such as Courier The fourth kind can be used with proportionally spaced fonts as it does not require lining up columns Simple tables Extension simple _tables table captions Simple tables look like this Right Left Center Default 12 1 2 12 12 1 23 123 123 123 1 I 1 BE Table Demonstration of simple table syntax The headers and table rows must each fit on one line Column alignments are determined by the position of the header text relative to the dashed line below it e If the dashed line is flush with the header text on the right side but extends beyond it on the left the column is right aligned e If the dashed line is flush with the header text on the left side but extends beyond it on the right the co
55. s are set automatically by pandoc These vary somewhat depending on the output format but include header includes contents specified by H include in header may have multiple values toc non null value if toc table of contents was specified include before contents specified by B include before body may have multiple values include after contents specified by A include after body may have multiple values body body of document title title of document as specified in title block author author of document as specified in title block may have mul tiple values date date of document as specified in title block lang language code for HTML or LaTeX documents slidy url base URL for Slidy documents defaults to http www w3 org Talks Tools Slidy2 slideous url base URL for Slideous documents defaults to default s5 url base URL for S5 documents defaults to ui default fontsize font size 10pt 11pt 12pt for LaTeX documents documentclass document class for LaTeX documents 13 Templates geometry options for LaTeX geomet ry class e g margin 1lin may be repeated for multiple options mainfont sansfont mono fonts for LaTeX documents works only with xelatex and lua font mathfont latex theme theme for LaTeX beamer documents colortheme colortheme for LaTeX beamer documents linkcolor color for internal links in LaTeX documents red green magenta cyan blue black urlcolor
56. s are treated as spaces so you can reflow your paragraphs as you like If you need a hard line break put two or more spaces at the end of a line Extension escaped_line_breaks A backslash followed by a newline is also a hard line break Headers There are two kinds of headers Setext and atx Setext style headers A setext style header is a line of text underlined with a row of signs for a level one header of signs for a level two header A level one header A level two header The header text can contain inline formatting such as emphasis see Inline formatting below 15 Pandoc s markdown Atx style headers An Atx style header consists of one to six signs and a line of text optionally followed by any number of signs The number of signs at the beginning of the line is the header level HH A level two header A level thr header As with setext style headers the header text can contain formatting A level one header with a link url and emphasis Extension blank_before header Standard markdown syntax does not require a blank line before a header 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 Consider for example I like several of their flavors of ice cream 22 for exam
57. s in regular text will be treated as spaces Specify the number of spaces per tab default is 4 General writer options Produce output with an appropriate header and footer e g a standalone HTML LaTeX or RTF file not a fragment This option is set automatically for pdf epub epub3 fb2 docx and odt output Use FILE as a custom template for the generated docu ment Implies standalone See Templates below for a description of template syntax If no extension is specified an extension corresponding to the writer will be added so that template special looks for special html for HTML output If the template is not found pandoc will search for it in the user data directory see data dir If this option is not used a default template appropriate for the out put format will be used see D print default tem plate Set the template variable KEY to the value VAL when rendering the document in standalone mode This is generally only use ful when the template option is used to specify a custom template since pandoc automatically sets the variables used in the default templates If no VAL is specified the key will be given the value t rue Print the default template for an output FORMAT See t for a list of possible FORMATs Disable text wrapping in output By default text is wrapped appropriately for the output format Specify length of lines in characters for text wrapping Include an automati
58. t explains the syntax noting diffe rences from standard markdown Except where noted these differences can be suppressed by using the markdown_strict format instead of markdown An extensions can be enabled by adding EXTENSION to the format name and disabled by adding EXTENSION For examp le markdown_strict footnotes is strict markdown with footnotes enabled while mark down footnotes pipe_tables is pandoc s markdown without footnotes or pipe tables Philosophy Markdown is designed to be easy to write and even more importantly easy to read A Markdown formatted document should be publishable as is as plain text without looking like 1t s been marked up with tags or formatting instructions John Gruber http daringfireball net projects markdown syntax philosophy This principle has guided pandoc s decisions in finding syntax for tables footnotes and other exten sions There is however one respect in which pandoc s aims are different from the original aims of mark down Whereas markdown was originally designed with HTML generation in mind pandoc is desi gned for multiple output formats Thus while pandoc allows the embedding of raw HTML it discou rages it and provides other non HTMLish ways of representing important document elements like definition lists tables mathematics and footnotes Paragraphs A paragraph is one or more lines of text followed by one or more blank line Newline
59. tml40 LaTeX http www latex project org MediaWiki markup http www mediawiki org wiki Help Formatting and DocBook XML http www docbook org and it can write plain text markdown http daringfireball net projects markdown reStructured Text http docutils sourceforge net docs ref rst introduction html XHTML http www w3 org TR xhtml1 HTML 5 http www w3 org TR html5 LaTeX http www latex project org including beamer http www tex ac uk CTAN macros latex contrib beamer slide shows Con TeXt http www pragma ade nl RTF http en wikipedia org wiki Rich_Text_Format DocBook XML http www docbook org OpenDocument XML http opendocument xml org ODT http en wikipedia org wiki OpenDocument Word docx http www microsoft com interop open up openxml default aspx GNU Texinfo http www gnu org software texinfo MediaWiki mark up http www mediawiki org wiki Help Formatting EPUB http www idpf org v2 or v3 FictionBook2 http www fictionbook org index php Eng XML_Schema_Fictionbook_2 1 Texti le http redcloth org textile groff man http developer apple com DOCUMENTATION Dar win Reference ManPages man7 groff_man 7 html pages Emacs Org Mode http orgmode org AsciiDoc http www methods co nz asciidoc and Slidy http www w3 org Talks Tools Slidy Slideous http goessner net articles slideous DZSlides http paulrouget com dzslides or S5 http meye
60. uments one per line in the order they appear These do not include regular Pandoc options and their argu ments but do include any options appearing after a separa tor at the end of the line ignore args Ignore command line arguments for use in wrapper scripts Regular Pandoc options are not ignored Thus for example pandoc ignore args o foo html s foo txt e lati 1s equivalent to pandoc o foo html s Kapitel 4 Templates When the s standalone option is used pandoc uses a template to add header and footer material that is needed for a self standing document To see the default template that is used just type pandoc D FORMAT where FORMAT is the name of the output format A custom template can be specified using the template option You can also override the system default templates for a given output format FOR MAT by putting a file templates default FORMAT in the user data directory see data dir above Exceptions For odt output customize the default opendocument template For pdf output customize the default latex template Templates may contain variables Variable names are sequences of alphanumerics and _ starting with a letter A variable name surrounded by signs will be replaced by its value For example the string titleS in lt title gt Stitles lt title gt will be replaced by the document title To write a literal in a template use Some variable
61. up to the first letter identifiers may not begin with a number or punctuation mark e If nothing is left after this use the identifier section Thus for example Header Identifier Header identifiers in HTML header identifiers in html Dogs in my house dogs in my hous HTML http www w3 org TR htm140 html s5 or rtf S5 http meyerweb com eric tools s5 or RTF http en wikipedia org wiki Rich_Text_Format 3 Applications applications 33 section These rules should in most cases allow one to determine the identifier from the header text The exception is when several headers have the same text in this case the first will get an identifier as described above the second will get the same identifier with 1 appended the third with 2 and so on These identifiers are used to provide link targets in the table of contents generated by the toc table of contents option They also make it easy to provide links from one section of a docu ment to another A link to this section for example might look like this See the section on header identifiers fheader identifiers in html latex and context Note however that this method of providing links to sections works only in HTML LaTeX and ConTeXt formats If the section divs option is specified then each section will be wrapped in a div or a section if htm15 was specified and the identifier will be attac
62. with class LaTeX The LaTeXMathML http math etsu edu LaTeXMathML script will be used to render it as formulas This trick does not work in all browsers but it works in Firefox In browsers that do not support LaTeXMathML TeX math will appear verbatim between characters 3 If the jsmath option is used TeX math will be put inside lt span gt tags for inline math or lt div gt tags for display math with class math The jsMath http www math union edu dpvc jsmath script will be used to render it 4 If the mimetex option is used the mimeTeX http www forkosh com mimetex html CGI script will be called to generate images for each TeX formula This should work in all browsers The mimetex option takes an optio nal URL as argument If no URL is specified it will be assumed that the mimeTeX CGI script is at cgi bin mimetex cgi 5 If the gladtex option is used TeX formulas will be enclosed in lt eq gt tags in the HTML output The resul ting ht ex file may then be processed by gladTeX http ans hsh no home mgg gladtex which will produce image files for each formula and an html file with links to these images So the procedure is pandoc s gladtex myfile txt o myfile htex gladtex d myfile images myfile htex produces myfile html and images in myfile images 6 If the webtex option is used TeX formulas will be converted to lt img gt tags that link to an external scri
63. y on the first line of each block is also allowed gt This is a block quote This paragraph has two lines gt 1 This is a list inside a block quote 2 Second item Among the block elements that can be contained in a block quote are other block quotes That is block quotes can be nested gt This is a block quote gt gt gt A block quote within a block quote Extension blank_before_blockquote 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 gt to end up at the beginning of a line by accident perhaps through line wrapping So unless the markdown_strict format is used the following does not produce a nested block quote in pandoc 18 Pandoc s markdown gt This is a block quote gt gt Nested Verbatim code blocks Indented code blocks A block of text indented four spaces or one tab is treated as verbatim text that is special characters do not trigger special formatting and all spaces and line breaks are preserved For example if a gt 3 moveShip 5 gravity DOWN The initial four space or one tab indentation is not considered part of the verbatim text and is removed in the output Note blank lines in the verbatim text need not begin with four spaces Fenced code blocks Extension fenced_code_blocks

Download Pdf Manuals

Related Search

Related Contents

file  Chapter 8 - AutomationDirect  User manual Mode d'emploi ES 100 PRO - bj  Mode d`emploi  すぐに使える、 Linux。 - 三菱電機インフォメーションネットワーク株式会社  User Manual  Unioeste 43806/2014 Setor Processo Estimativa  Istruzioni d`uso e di montaggio Piani di cottura in  Impressora em Cores Phaser® 7100, guia do administrador  Descargar - Sonypro  

Copyright © All rights reserved. Failed to retrieve file