Notas de Luis

Tabla de Contenidos

Más allá de Markdown

Pandoc default Extensions

Pandoc Extension: ''escaped_line_breaks'' ####

A backslash followed by a newline is also a hard line break. Note: in multiline and grid table cells, this is the only way to create a hard line break, since trailing spaces in the cells are ignored.

Pandoc 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 example, and #5.

Pandoc 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}

Thus, for example, the following headers will all be assigned the identifier foo:

  # My header {#foo}
  ## My header ##    {#foo1}
  My other header   {#foo2}

(This syntax is compatible with [PHP Markdown Extra].)

Note that although this syntax allows assignment of classes and key/value attributes, writers generally don't use all of this information. Identifiers, classes, and key/value attributes are used in HTML and HTML-based formats such as EPUB and slidy. Identifiers are used for labels and link anchors in the LaTeX, ConTeXt, Textile, and AsciiDoc writers.

Headers with the class unnumbered will not be numbered, even if –number-sections is specified. 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

  # My header {.unnumbered}

Pandoc 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,

  • Remove all formatting, links, etc.
  • Remove all footnotes.
  • Remove all punctuation, except underscores, hyphens, and periods.
  • Replace all spaces and newlines with hyphens.
  • Convert all alphabetic characters to lowercase.
  • Remove everything up to the first letter (identifiers may not begin with a number or punctuation mark).
  • 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-house
  [HTML], [S5], or [RTF]?         html-s5-or-rtf
  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 document to another. A link to this section, for example, might look like this:

  See the section on
  [[#header-identifiers-in-html-latex-and-context|header identifiers]].

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 –html5 was specified), and the identifier will be attached to the enclosing

'' (or <section>) tag rather than the header itself. This allows entire sections to be manipulated using javascript or treated differently in CSS.

Pandoc Extension: ''implicit_header_references'' ####

Pandoc behaves as if reference links have been defined for each header. So, to link to a header

  # Header identifiers in HTML

you can simply write

  [Header identifiers in HTML]

or

  [Header identifiers in HTML][]

or

  [the section on header identifiers][header identifiers in
  HTML]

instead of giving the identifier explicitly:

  [[#header-identifiers-in-html|Header identifiers in HTML]]

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.

Like regular reference links, these references are case-insensitive.

Explicit link reference definitions always take priority over implicit header references. So, in the following example, the link will point to bar, not to #foo:

  # Foo
  [foo]: bar
  See [foo]

Pandoc 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 > 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:

  > This is a block quote.
  >> Nested.

Pandoc Extension: ''fenced_code_blocks'' ####

In addition to standard indented code blocks, pandoc supports *fenced* code blocks. These begin with a row of three or more tildes (~) and end with a row of tildes 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 > 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:

  ~~~~~~~~~~~~~~~~
  ~~~~~~~~~~
  code including tildes
  ~~~~~~~~~~
  ~~~~~~~~~~~~~~~~

Pandoc Extension: ''backtick_code_blocks'' ####

Same as fenced_code_blocks, but uses backticks (`'' '' ``) instead of tildes (~).

Pandoc Extension: ''fenced_code_attributes'' ####

Optionally, you may attach attributes to fenced or backtick code block using this syntax:

  ~~~~ {#mycode .haskell .numberLines startFrom="100"}
  qsort []     = []
  qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++
                 qsort (filter (>= x) xs)
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here mycode is an identifier, haskell and numberLines are classes, and startFrom is an attribute with val.. .ue 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:

  <pre id="mycode" class="haskell numberLines" startFrom="100">
    <code>
    ...
    </code>
  </pre>

A shortcut form can also be used for specifying the language of the code block:

    qsort [] = []

This is equivalent to:

    qsort [] = []

If the fenced_code_attributes extension is disabled, but input contains class attribute(s) for the codeblock, the first class attribute will be printed after the opening fence as a bare word.

To prevent all highlighting, use the –no-highlight flag. To set the highlighting style, use –highlight-style. For more information on highlighting, see [Syntax highlighting], below.

Pandoc 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].

Pandoc Extension: ''fancy_lists'' ####

Unlike standard Markdown, pandoc allows ordered list items to be marked with uppercase and lowercase letters and roman numerals, in addition to arabic numerals. List markers may be enclosed in parentheses or followed by a single right-parentheses or period. They must be separated from the text that follows by at least one space, and, if the list marker is a capital letter with a period, by at least two spaces.[^2]

[^2]: 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:
      (C\) 2007 Joe Smith

The fancy_lists extension also allows '#' to be used as an ordered list marker in place of a numeral:

  #. one
  #. two

Pandoc 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:

  (2) Two
  (5) Three
    - Four
  *   Five

If default list markers are desired, use #.:

  #.  one
  #.  two
  #.  three

Pandoc Extension: ''definition_lists'' ####

Pandoc supports definition lists, using the syntax of [PHP Markdown Extra] with some extensions.[^3]

  Term 1
  :   Definition 1
  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.

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. The body of the definition (including the first line, aside from the colon or tilde) should be indented four spaces. However, as with other Markdown lists, you can “lazily” omit indentation except at the beginning of a paragraph or other block element:

  Term 1
  :   Definition
  with lazy continuation.
      Second paragraph of the definition.

If you leave space before the definition (as in the example above), the text of the definition will be treated as a paragraph. In some output formats, this will mean greater spacing between term/definition pairs. For a more compact definition list, omit the space before the definition:

  Term 1
    ~ Definition 1
  Term 2
    ~ Definition 2a
    ~ Definition 2b

Note that space between items in a definition list is required……… (A variant that loosens this requirement, but disallows “lazy” hard wrapping, can be activated with compact_definition_lists: see [Non-pandoc extensions], below.)

[^3]: I have been influenced by the suggestions of David Wheeler.

Pandoc 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 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.pl on some “edge cases” involving lists. Consider this source:

  +   First
  +   Second:
  	-   Fee
  	-   Fie
  	-   Foe
  +   Third

Pandoc transforms this into a “compact list” (with no <p> tags around “First”, “Second”, or “Third”), while Markdown puts <p> 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.pl.)

Ending a list ###

What if you want to put an indented code block after a list?

  1. item one
  2. item two
      { my code block }

Trouble! Here pandoc (like other Markdown implementations) will treat { my code block } as 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:

  1. item one
  2. item two
  <!-- end of list -->
      { my code block }

You can use the same trick if you want two consecutive lists instead of one big list:

  1. one
  2. two
  3. three
  <!-- -->
  1. uno
  2. dos
  3. tres

Pandoc Extension: ''table_captions'' ####

A caption may optionally be provided with all 4 kinds of tables (as illustrated in the examples below). A caption is a paragraph beginning with the string Table: (or just :), which will be stripped off. It may appear either before or after the table.

Pandoc Extension: ''simple_tables'' ####

Simple tables look like this:

    Right     Left     Center     Default
  -------     ------ ----------   -------
       12     12        12            12
      123     123       123          123
        1     1          1             1
  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:[^4]

  • 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.
  • If the dashed line is flush with the header text on the left side but extends beyond it on the right, the column is left-aligned.
  • If the dashed line extends beyond the header text on both sides, the column is centered.
  • If the dashed line is flush with the header text on both sides, the default alignment is used (in most cases, this will be left).

[^4]: This scheme is due to Michel Fortin, who proposed it on the

     [[http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html|Markdown discussion list]].

The table must end with a blank line, or a line of dashes followed by a blank line.

The column headers may be omitted, provided a dashed line is used to end the table. For example:

  1. —— —— ———- ——-

12 12 12 12

      123     123       123           123
        1     1          1              1
  -------     ------ ----------   -------
  1. —— —— ———- ——-

12 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.

Pandoc Extension: ''multiline_tables'' ####

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:

   Centered   Default           Right Left
    Header    Aligned         Aligned Aligned
  ----------- ------- --------------- -------------------------
     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.
  Table: Here's the caption. It, too, may span
  multiple lines.

These work like simple tables, but with the following differences:

  • They must begin with a row of dashes, before the header text

(unless the headers are omitted).

  • They must end with a row of dashes, then a blank line.
  • 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:

  1. ———- ——- ————— ————————- 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.
  
  ---------- ------- --------------- -------------------------
  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.

Pandoc Extension: ''grid_tables'' ####

Grid tables look like this:

  : Sample grid table.
  +---------------+---------------+--------------------+
  | Fruit         | Price         | Advantages         |
  +===============+===============+====================+
  | Bananas       | $1.34         | - built-in wrapper |
  |               |               | - bright color     |
  +---------------+---------------+--------------------+
  | Oranges       | $2.10         | - cures scurvy     |
  |               |               | - tasty            |
  +---------------+---------------+--------------------+

: Sample grid table.

+—————+—————+——————–+

Fruit Price Advantages

+===============+===============+====================+

Bananas $1.34 - built-in wrapper
- bright color

+—————+—————+——————–+

Oranges $2.10 - cures scurvy
- tasty

+—————+—————+——————–+

The row of =s separates the header from the table body, and can be omitted for a headerl. …….ess 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].

[Emacs table mode]: http://table.sourceforge.net/

Pandoc Extension: ''pipe_tables'' ####

Pipe tables look like this:

  | Right | Left | Default | Center |
  |------:|:-----|---------|:------:|
  |   12  |  12  |    12   |    12  |
  |  123  |  123 |   123   |   123  |
  |    1  |    1 |     1   |     1  |
    : Demonstration of pipe table syntax.
Right Left Default Center
——::—–———:——:
12 12 12 12
123 123 123 123
1 1 1 1
  : Demonstration of pipe table syntax.

The syntax is identical to [PHP Markdown Extra tables]. The beginning and ending pipe characters are optional, but pipes are required between all columns. The colons indicate column alignment as shown. The header cannot be omitted. To simulate a headerless table, include a header with blank cells.

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
  -----|-----:
  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. If a pipe table contains a row whose printable content is wider than the column width (see –columns), then the cell contents will wrap, with the relative cell widths determined by the widths of the separator lines.

Note: pandoc also recognizes pipe tables of the following form, as can be produced by Emacs' orgtbl-mode:

  | One | Two   |
  |-----+-------|
  | 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.

[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table

Pandoc Extension: ''pandoc_title_block'' ####

If the file begins with a title block

  % title
  % author(s) (separated by semicolons)
  % date

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:

  %
  % Author
  % My title
  %
  % 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:

  % Author One
    Author Two
  % Author One; Author Two
  % Author One;
    Author 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: once 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 (–title-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

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.

Pandoc Extension: ''yaml_metadata_block'' ####

A YAML metadata block is a valid YAML object, delimited by a line of three hyphens () at the top and a line of three hyphens () or three dots () at the bottom. A YAML metadata block may occur anywhere in the document, but if it is not at the beginning, it must be preceded by a blank line. (Note that, because of the way pandoc concatenates input files when several are provided, you may also keep the metadata in a separate YAML file and pass it to pandoc as an argument, along with your Markdown files:

  pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html

Just be sure that the YAML file begins with and ends with or .)

Metadata will be taken from the fields of the YAML object and added to any existing document metadata. Metadata can contain lists and objects (nested arbitrarily), but all string scalars will be interpreted as Markdown. Fields with names ending in an underscore will be ignored by pandoc. (They may be given a role by external processors.)

A document may contain multiple metadata blocks. The metadata fields will be combined through a *left-biased union*: if two metadata blocks attempt to set the same field, the value from the first block will be taken.

When pandoc is used with -t markdown to create a Markdown document, a YAML metadata block will be produced only if the -s/–standalone option is used. All of the metadata will appear in a single block at the beginning of the document.

Note that YAML escaping rules must be followed. Thus, for example, if a title contains a colon, it must be quoted. The pipe character (|) can be used to begin an indented block that will be interpreted literally, without need for escaping. This form is necessary when the field contains blank lines:

  1. -

title: 'This is the title: it contains a colon'

  author:
  - name: Author One
    affiliation: University of Somewhere
  - name: Author Two
    affiliation: University of Nowhere
  tags: [nothing, nothingness]
  abstract: |
    This is the abstract.
    It consists of two paragraphs.
  ...

Template variables will be set automatically from the metadata. Thus, for example, in writing HTML, the variable abstract will be set to the HTML equivalent of the Markdown in the abstract field:

  <p>This is the abstract.</p>
  <p>It consists of two paragraphs.</p>

Note: The author variable in the default templates expects a simple list or string. To use the structured authors in the example, you would need a custom template. For example:

  $for(author)$
  $if(author.name)$
  $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$
  $else$
  $author$
  $endif$
  $endfor$

Pandoc Extension: ''all_symbols_escapable'' ####

Except inside a code block or inline code, any punctuation or space character preceded by a backslash will be treated literally, even if it would normally indicate formatting. Thus, for example, if one writes

  • \*hello\**

one will get

  <em>*hello*</em>

instead of

  <strong>hello</strong>

This rule is easier to remember than standard Markdown's rule, which allows only the following characters to be backslash-escaped:

  \`*_{}[]()>#+-.!

(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 \&#160; or \&nbsp;.

A backslash-escaped newline (i.e. a backslash occurring at the end of a line) i… …..s parsed as a hard line break. It will appear in TeX output as \\ and in HTML as <br />. This is a nice alternative to Markdown's “invisible” way of indicating hard line breaks using two trailing spaces on a line.

Backslash escapes do not work in verbatim contexts.

Pandoc 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 or any included header file call for the [csquotes] package, pandoc will detect this automatically and use \enquote{…} for quoted text.

Pandoc 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*.

Pandoc Extension: ''strikeout'' ####

To strikeout a section of text with a horizontal line, begin and end it with ~~. Thus, for example,

  This ~~is deleted text.~~

Pandoc 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~O is a liquid.  2^10^ is 1024.

If 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~, not P~a cat~.

Pandoc Extension: ''inline_code_attributes'' ####

Attributes can be attached to verbatim text, just as with [fenced code blocks]:

  ''<$>''{.haskell}

Small caps ###

To write small caps, you can use an HTML span tag:

  <span style="font-variant:small-caps;">Small caps</span>

(The semicolon is optional and there may be space after the colon.) This will work in all output formats that support small caps.

Pandoc Extension: ''raw_html'' ####

Markdown allows you to insert raw HTML (or DocBook) anywhere in a document (except verbatim contexts, where <, >, and & are interpreted literally). (Technically this is not an extension, since standard Markdown allows it, but it has been made an extension so that it can be disabled if desired.)

The raw HTML is passed through….. … unchanged in HTML, S5, Slidy, Slideous, DZSlides, EPUB, Markdown, and Textile output, and suppressed in other formats.

Pandoc 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 interprets material between HTML block tags as Markdown. Thus, for example, pandoc will turn

  <table>
  <tr>
  <td>*one*</td>
  <td>[[http://google.com|a link]]</td>
  </tr>
  </table>

into

  <table>
  <tr>
  <td><em>one</em></td>
  <td><a href="http://google.com">a link</a></td>
  </tr>
  </table>

whereas Markdown.pl will preserve it as is.

There is one exception to this rule: text between <script> and <style> 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

'' tags without preventing it from being interpreted as Markdown.

Pandoc Extension: ''native_divs'' ####

Use native pandoc Div blocks for content inside

'' tags. For the most part this should give the same output as markdown_in_html_blocks, but it makes it easier to write pandoc filters to manipulate groups of blocks.

Pandoc Extension: ''native_spans'' ####

Use native pandoc Span blocks for content inside '' tags. For the most part this should give the same output as raw_html, but it makes it easier to write pandoc filters to manipulate groups of inlines. ==== Pandoc 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}{|l|l|}\hline Age & Frequency
\hline 18–25 & 15
26–35 & 33
36–45 & 22
\hline \end{tabular} the material between the begin and end tags will be interpreted as raw LaTeX, not as Markdown. Inline LaTeX is ignored in output formats other than Markdown, LaTeX, and ConTeXt. ==== Pandoc Extension: latex_macros #### ==== For output formats other than LaTeX, pandoc will parse LaTeX \newcommand and \renewcommand 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. ==== Pandoc Extension: shortcut_reference_links #### ==== In a *shortcut* reference link, the second pair of brackets may be omitted entirely: See [my website]. [my website]: http://foo.bar.baz ==== Pandoc feature: Internal links ### ==== To link to another section of the same document, use the automatically generated identifier (see [Header identifiers]). For example: See the Introduction. or See the [Introduction]. [Introduction]: #introduction Internal links are currently supported for HTML formats (including HTML slide shows and EPUB), LaTeX, and ConTeXt. ==== Pandoc Extension: implicit_figures #### ==== An image occurring by itself in a paragraph will be rendered as a figure with a caption.[^5] (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 [^5]: 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. 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\ ==== Pandoc Extension: link_attributes #### ==== Attributes can be set on links and images: An inline image{#id .class width=30 height=20px} and a reference ![image][ref] with attributes. [ref]: foo.jpg “optional title” {#id .class key=val key2=“val 2”} (This syntax is compatible with [PHP Markdown Extra] when only #id and .class are used.) For HTML and EPUB, all attributes except width and height (but including srcset and sizes) are passed through as is. The other writers ignore attributes that are not supported by their output format. The width and height attributes on images are treated specially. When used without a unit, the unit is assumed to be pixels. However, any of the following unit identifiers can be used: px, cm, mm, in, inch and %. There must not be any spaces between the number and the unit. For example: <code> ![](file.jpg){ width=50% } </code> * Dimensions are converted to inches for output in page-based formats like LaTeX. Dimensions are converted to pixels for output in HTML-like formats. Use the –dpi option to specify the number of pixels per inch. The default is 96dpi. * The % unit is generally relative to some available space. For example the above example will render to <img href=“file.jpg” style=“width: 50%;” /> (HTML), \includegraphics[width=0.5\textwidth]{file.jpg} (LaTeX), or \externalfigure[file.jpg][width=0.5\textwidth] (ConTeXt). * Some output formats have a notion of a class (ConTeXt) or a unique identifier (LaTeX \caption), or both (HTML). * When no width or height attributes are specified, the fallback is to look at the image resolution and the dpi metadata embedded in the image file. ==== Pandoc Extension: footnotes ==== Pandoc's Markdown allows footnotes, using the following syntax: Here is a footnote reference,[^1] and another.[^longnote] [^1]: 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 way, 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.). ==== Pandoc Extension: inline_notes ==== Inline footnotes are also allowed (though, unlike regular notes, they cannot contain multiple paragraphs). The syntax is as follows: Here is an inline note.^[Inlines notes are easier 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. ==== Pandoc Extension: citations ==== Using an external filter, pandoc-citeproc, pandoc can automatically generate citations and a bibliography in a number of styles. Basic usage is pandoc –filter pandoc-citeproc myinput.txt In order to use this feature, you will need to specify a bibliography file using the bibliography metadata field in a YAML metadata section, or –bibliography command line argument. You can supply multiple –bibliography arguments or set bibliography metadata field to YAML array, if you want to use multiple bibliography files. The bibliography may have any of these formats: Format File extension ———— ————– BibLaTeX .bib BibTeX .bibtex Copac .copac CSL JSON .json CSL YAML .yaml EndNote .enl EndNote XML .xml ISI .wos MEDLINE .medline MODS .mods RIS .ris Note that .bib can be used with both BibTeX and BibLaTeX files; use .bibtex to force BibTeX. Note that pandoc-citeproc –bib2json and pandoc-citeproc –bib2yaml can produce .json and .yaml files from any of the supported formats. In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]: <i>…</i> : italics <b>…</b> : bold or <sc>…</sc> : small capitals : subscript : superscript : prevent a phrase from being capitalized as title case pandoc-citeproc -j and -y interconvert the CSL JSON and CSL YAML formats as far as possible. As an alternative to specifying a bibliography file using –bibliography or the YAML metadata field bibliography, you can include the citation data directly in the references field of the document's YAML metadata. The field should contain an array of YAML-encoded references, for example: —- references: - type: article-journal id: WatsonCrick1953 author: - family: Watson given: J. D. - family: Crick given: F. H. C. issued: date-parts: - - 1953 - 4 - 25 title: 'Molecular structure of nucleic acids: a structure for deoxyribose nucleic acid' title-short: Molecular structure of nucleic acids container-title: Nature volume: 171 issue: 4356 page: 737-738 DOI: 10.1038/171737a0 URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html language: en-GB … (pandoc-citeproc –bib2yaml can produce these from a bibliography file in one o.. 63% 343K 0s 50K ……f the supported formats.) Citations and references can be formatted using any style supported by the [Citation Style Language], listed in the [Zotero Style Repository]. These files are specified using the –csl option or the csl metadata field. By default, pandoc-citeproc will use the [Chicago Manual of Style] author-date format. The CSL project provides further information on [finding and editing styles]. To make your citations hyperlinks to the corresponding bibliography entries, add link-citations: true to your YAML metadata. 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. The citation key must begin with a letter, digit, or _, and may contain alphanumerics, _, and internal punctuation characters (:.#$%&-+?<>~/). Here are some examples: Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1]. Blah blah [@doe99, pp. 33-35, 38-39 and *passim*]. Blah blah [@smith04; @doe99]. pandoc-citeproc detects locator terms in the [CSL locale files]. Either abbreviated or unabbreviated forms are accepted. In the en-US locale, locator terms can be written in either singular or plural forms, as book, bk./bks.; chapter, chap./chaps.; column, col./cols.; figure, fig./figs.; folio, fol./fols.; number, no./nos.; line, l./ll.; note, n./nn.; opus, op./opp.; page, p./pp.; paragraph, para./paras.; part, pt./pts.; section, sec./secs.; sub verbo, s.v./s.vv.; verse, v./vv.; volume, vol./vols.; /¶¶; §/§§. If no locator term is used, “page” is assumed. 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: Smith says blah [-@smith04]. You can also write an in-text citation, as follows: @smith04 says blah. @smith04 [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. Note that the unnumbered class will be added to this header, so that the section will not be numbered. If you want to include items in the bibliography without actually citing them in the body text, you can define a dummy nocite metadata field and put the citations there: —- nocite: | @item1, @item2 … @item3 In this example, the document will contain a citation for item3 only, but the bibliography will contain entries for item1, item2, and item3. For LaTeX or PDF output, you can also use [natbib] or [biblatex] to render bibliography. In order to do so, specify bibliography files as outlined above, and add –natbib or –biblatex argument to pandoc invocation. Bear in mind that bibliography files have to be in respective format (either BibTeX or BibLaTeX). For more information, see the [pandoc-citeproc man page]. [CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields [Chicago Manual of Style]: http://chicagomanualofstyle.org [Citation Style Language]: http://citationstyles.org [Zotero Style Repository]: https://www.zotero.org/styles [finding and editing styles]: http://citationstyles.org/styles/ [CSL locale files]: https://github.com/citation-style-language/locales [pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md ===== Pandoc non default 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. ==== Pandoc Extension: lists_without_preceding_blankline #### ==== Allow a list to occur right after a paragraph, with no intervening blank space. ==== Pandoc Extension: hard_line_breaks #### ==== Causes all newlines within a paragraph to be interpreted as hard line breaks instead of spaces. ==== Pandoc Extension: ignore_line_breaks #### ==== Causes newlines within a paragraph to be ignored, rather than being treated as spaces or as hard line breaks. This option is intended for use with East Asian languages where spaces are not used between words, but text is divided into lines for readability. ==== Pandoc Extension: east_asian_line_breaks #### ==== Causes newlines within a paragraph to be ignored, rather than being treated as spaces or as hard line breaks, when they occur between two East Asian wide characters. This is a better choice than ignore_line_breaks for texts that include a mix of East Asian wide characters and other characters. === Pandoc Extension: emoji #### === Parses textual emojis like :smile: as Unicode emoticons. ==== Pandoc Extension: tex_math_single_backslash #### ==== Causes anything between \( and \) 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 [. ==== Pandoc Extension: tex_math_double_backslash #### ==== Causes anything between \\( and \\) to be interpreted as inline TeX math, and anything between \\[ and \\] to be interpreted as display TeX math. ==== Pandoc 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. ==== Pandoc Extension: mmd_title_block #### ==== Enables a [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. If pandoc_title_block or yaml_metadata_block is enabled, it will take precedence over mmd_title_block. [MultiMarkdown]: http://fletcherpenney.net/multimarkdown/ ==== Pandoc Extension: abbreviations #### ==== Parses PHP Markdown Extra abbreviation keys, like *[HTML]: Hypertext 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). ==== Pandoc Extension: autolink_bare_uris #### ==== Makes all absolute URIs into links, even when not surrounded by pointy braces <…>. ==== Pandoc Extension: ascii_identifiers #### ==== Causes the identifiers produced by auto_identifiers to be pure ASCII. Accents are stripped off of accented latin letters, and non-latin letters are omitted. …. ..#### Pandoc Extension: mmd_link_attributes #### Parses multimarkdown style key-value attributes on link and image references. This extension should not be confused with the ''link_attributes'' extension. This is a reference ![image][ref] with multimarkdown attributes. [ref]: http://path.to/image “Image title” width=20px height=30px id=myId class=“myClass1 myClass2” ==== Pandoc Extension: mmd_header_identifiers #### ==== Parses multimarkdown style header identifiers (in square brackets, after the header but before any trailing #s in an ATX header). Is this a single list item with two definitions of “bar,” the first of which is lazily wrapped, or two list items? To remove the ambiguity we must either disallow lazy wrapping or require a blank line between list items. ====== Presentations ====== ===== Introduction ===== You can use pandoc to produce an HTML + javascript slide presentation that can be viewed via a web browser. There are five ways to do this, using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js]. You can also produce a PDF slide show using LaTeX [beamer]. Here's the Markdown source for a simple slide show, habits.txt: % Habits % John Doe % March 22, 2005 # 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 ## Going to sleep - Get in bed - Count sheep To produce an HTML/javascript slide show, simply type pandoc -t FORMAT -s habits.txt -o habits.html where FORMAT is either s5, slidy, slideous, dzslides, or revealjs. For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the -s/–standalone option embeds a link to javascripts and CSS files, which are assumed to be available at the relative path s5/default (for S5), slideous (for Slideous), reveal.js (for reveal.js), or at the Slidy website at w3.org (for Slidy). (These paths can be changed by setting the slidy-url, slideous-url, revealjs-url, or s5-url variables; see [Variables for slides], above.) For DZSlides, the (relatively short) javascript and css are included in the file by default. 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. To produce a PDF slide show using beamer, type pandoc -t beamer habits.txt -o habits.pdf Note that a reveal.js slide show can also be converted to a PDF by printing it to a file from the browser. ===== Structuring 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-level option. The document is carved up into slides according to the following rules: * A horizontal rule always starts a new slide. * A header at the slide level always starts a new slide. * Headers *below* the slide level in the hierarchy create headers *within* a slide. * 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 structuring 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. Note: in reveal.js slide shows, if slide level is 2, a two-dimensional layout will be produced, with level 1 headers building horizontally and level 2 headers building vertically. It is not recommended that you use deeper nesting of section levels with reveal.js. ===== Incremental lists ===== By default, these writers produce 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: > - Eat spaghetti > - Drink wine In this way incremental and nonincremental lists can be mixed in a single document. ===== Inserting pauses ===== You can add “pauses” within a slide by including a paragraph containing three dots, separated by spaces: # Slide with a pause content before the pause . . . content after the pause ===== Styling the slides ===== You can change the style of HTML slides by putting customized CSS files in $DATADIR/s5/default (for S5), $DATADIR/slidy (for Slidy), or $DATADIR/slideous (for Slideous), where $DATADIR 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). Pandoc 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. All [reveal.js configuration options] can be set through variables. For example, themes can be used by setting the theme variable: -V theme=moon Or you can specify a custom stylesheet using the –css option. To style beamer slides, you can specify a theme, colortheme, fonttheme, innertheme, and outertheme, using the -V option: pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf Note that header attributes will turn into slide attributes (on a

'' or <section>) in HTML slide format……..s, allowing you to style individual slides. In beamer, the only header attribute that affects slides is the allowframebreaks class, which sets the allowframebreaks option, causing multiple slides to be created if the content overfills the frame. This is recommended especially for bibliographies:

  # References {.allowframebreaks}

Speaker notes

reveal.js has good support for speaker notes. You can add notes to your Markdown document thus:

  <div class="notes">
  This is my note.
  1. It can contain Markdown
  2. like this list
  </div>

To show the notes window, press s while viewing the presentation. Notes are not yet supported for other slide formats, but the notes will not appear on the slides themselves.

Frame attributes in beamer

Sometimes it is necessary to add the LaTeX [fragile] option to a frame in beamer (for example, when using the minted environment). This can be forced by adding the fragile class to the header introducing the slide:

  # Fragile slide {.fragile}

All of the other frame attributes described in Section 8.1 of the [Beamer User's Guide] may also be used: allowdisplaybreaks, allowframebreaks, b, c, t, environment, label, plain, shrink.

Creating EPUBs

EPUB Metadata

EPUB metadata may be specified using the –epub-metadata option, but if the source document is Markdown, it is better to use a [YAML metadata block][Extension: yaml_metadata_block]. Here is an example:

title:

  1. type: main

text: My Book

  1. type: subtitle

text: An investigation of metadata

  creator:
  - role: author
    text: John Smith
  - role: editor
    text: Sarah Jones
  identifier:
  - scheme: DOI
    text: doi:10.234234.234/33
  publisher:  My Press
  rights: © 2007 John Smith, CC BY-NC
  ...

The following fields are recognized:

identifier

~ Either a string value or an object with fields ''text'' and
  ''scheme''.  Valid values for ''scheme'' are ''ISBN-10'',
  ''GTIN-13'', ''UPC'', ''ISMN-10'', ''DOI'', ''LCCN'', ''GTIN-14'',
  ''ISBN-13'', ''Legal deposit number'', ''URN'', ''OCLC'',
  ''ISMN-13'', ''ISBN-A'', ''JP'', ''OLCC''.

title

~ Either a string value, or an object with fields ''file-as'' and
  ''type'', or a list of such objects.  Valid values for ''type'' are
  ''main'', ''subtitle'', ''short'', ''collection'', ''edition'', ''extended''.

creator

~ Either a string value, or an object with fields ''role'', ''file-as'',
  and ''text'', or a list of such objects.  Valid values for ''role'' are
  [MARC relators], but
  pandoc will attempt to translate the human-readable versions
  (like "author" and "editor") to the appropriate marc relators.

contributor

~ Same format as ''creator''.

date

~ A string value in ''YYYY-MM-DD'' format.  (Only the year is necessary.)
  Pandoc will attempt to convert other common date formats.

lang (or legacy: language)

~ A string value in [BCP 47] format.  Pandoc will default to the local
  language if nothing is specified.

subject

~ A string value or a list of such values.

description

~ A string value.

type

~ A string value.

format

~ A string value.

relation

~ A string value.

coverage

~ A string value.

rights

~ A string value.

cover-image

~ A string value (path to cover image).

stylesheet

~ A string value (path to CSS stylesheet).

page-progression-direction

~ Either ''ltr'' or ''rtl''. Specifies the ''page-progression-direction''
  attribute for the [''spine'' element].

[MARC relators]: http://loc.gov/marc/relators/relaterm.html [spine element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem

Linked media

By default, pandoc will download linked media (including audio and video) and include it in the EPUB container, yielding a completely self-contained EPUB. If you want to link to external media resources instead, use raw HTML in your source and add data-external=“1” to the tag with the src attribute. For example:

  <audio controls="1">
    <source src="http://example.com/music/toccata.mp3"
            data-external="1" type="audio/mpeg">
    </source>
  </audio>
computing/coding/markup/markdown_extensions.txt · Última modificación: por 127.0.0.1