NAME

Pandoc::Elements - create and process Pandoc documents

SYNOPSIS

The output of this script hello.pl

    use Pandoc::Elements;
    use JSON;

    print Document({ 
            title => MetaInlines [ Str "Greeting" ] 
        }, [
            Header( 1, attributes { id => 'top' }, [ Str 'Hello' ] ),
            Para [ Str 'Hello, world!' ],
        ])->to_json;

can be converted for instance to HTML with via

    ./hello.pl | pandoc -f json -t html5 --standalone

an equivalent Pandoc Markdown document would be

    % Greeting
    # Gruß {.de}
    Hello, world!

See module Pandoc::Filter and Pandoc::Walker for processing the abstract syntax tree of pandoc documents in Perl.

DESCRIPTION

Pandoc::Elements provides utility functions to create abstract syntax trees (AST) of Pandoc documents. The resulting data structure can be converted by Pandoc to many other document formats, such as HTML, LaTeX, ODT, and ePUB.

FUNCTIONS

In addition to constructor functions for each document element, the following functions are exported.

attributes { key => $value, ... }

Maps a hash reference into an attributes list with id, classes, and ordered key-value pairs.

element( $name => $content )

Create a Pandoc document element. This function is only exported on request.

ELEMENTS

AST elements are encoded as Perl data structures equivalent to the JSON structure, emitted with pandoc output format json. All elements are blessed objects that provide the following element methods and additional accessor methods specific to each element.

ELEMENT METHODS

json

Return the element as JSON encoded string. The following are equivalent:

    $element->to_json;
    JSON->new->utf8->convert_blessed->encode($element);

name

Return the name of the element, e.g. "Para" for a paragraph element.

content

Return the element content. For most elements (Para, Emph, Str...) the content is an array reference with child elements. Other elements consist of multiple parts; for instance the Link element has a link text (content) and a link target (target) with url and title.

is_block

True if the element is a Block element

is_inline

True if the element is an inline Inline element

is_meta

True if the element is a Metadata element

is_document

True if the element is a Document element

BLOCK ELEMENTS

BlockQuote

Block quote, consisting of a list of blocks (content)

BulletList

...

CodeBlock

...

DefinitionList

...

Div

Generic container of blocks (content) with attributes (attrs)

Header

...

HorizontalRule

Horizontal rule

Null

Nothing

OrderedList

Definition list of items/content, each a pair consisting of a term (a list of inlines) and one or more definitions (each a list of blocks)

Para

Paragraph, consisting of a list of Inline elements (content).

Plain

Plain text, not a paragraph, consisting of a list of Inline elements (content).

RawBlock

Raw block with format and content string.

Table

Table, with caption, column alignments, relative column widths (0 = default), column headers (each a list of blocks), and rows (each a list of lists of blocks).

INLINE ELEMENTS

Cite

Code

Emph

Image

LineBreak

Link

Math

Note

Quoted

RawInline

SmallCaps

Space

Span

Str

Strikeout

Strong

Subscript

Superscript

METADATA ELEMENTS

MetaBlocks

MetaBool

MetaInlines

MetaList

MetaMap

MetaString

DOCUMENT ELEMENT

Document

Root element, consisting of metadata hash (meta) and document element array (content).

TYPES

The following elements are used as types only:

DefaultDelim, Period, OneParen, TwoParens, SingleQuote, DoubleQuote, DisplayMath, InlineMath, AuthorInText, SuppressAuthor, NormalCitation, AlignLeft, AlignRight, AlignCenter, AlignDefault, DefaultStyle, Example, Decimal, LowerRoman, UpperRoman, LowerAlpha, UpperAlpha

SEE ALSO

Pandoc implements a wrapper around the pandoc executable.

Text.Pandoc.Definition contains the original definition of Pandoc document data structure in Haskell. This module version was last aligned with pandoc-types-1.12.4.1.

AUTHOR

Jakob Voß <jakob.voss@gbv.de>

COPYRIGHT AND LICENSE

Copyright 2014- Jakob Voß

GNU General Public License, Version 2

This module is heavily based on Pandoc by John MacFarlane.

cpanm Pandoc::Elements

perl -MCPAN -e shell
install Pandoc::Elements