.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Pandoc::Metadata 3pm" .TH Pandoc::Metadata 3pm "2023-01-02" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Pandoc::Metadata \- pandoc document metadata .SH "DESCRIPTION" .IX Header "DESCRIPTION" Document metadata such as author, title, and date can be embedded in different documents formats. Metadata can be provided in Pandoc markdown format with metadata blocks at the top of a markdown file or in \s-1YAML\s0 format like this: .PP .Vb 7 \& \-\-\- \& title: a title \& author: \& \- first author \& \- second author \& published: true \& ... .Ve .PP Pandoc supports document metadata build of strings (\*(L"MetaString\*(R"), boolean values (\*(L"MetaBool\*(R"), lists (\*(L"MetaList\*(R"), key-value maps (\*(L"MetaMap\*(R"), lists of inline elements (\*(L"MetaInlines\*(R") and lists of block elements (\*(L"MetaBlocks\*(R"). Simple strings and boolean values can also be specified via pandoc command line option \f(CW\*(C`\-M\*(C'\fR or \f(CW\*(C`\-\-metadata\*(C'\fR: .PP .Vb 4 \& pandoc \-M key=string \& pandoc \-M key=false \& pandoc \-M key=true \& pandoc \-M key .Ve .PP Perl module Pandoc::Elements exports functions to construct metadata elements in the internal document model and the general helper function \&\f(CW\*(C`metadata\*(C'\fR. .SH "COMMON METHODS" .IX Header "COMMON METHODS" All Metadata Elements support common element methods (\f(CW\*(C`name\*(C'\fR, \f(CW\*(C`to_json\*(C'\fR, \f(CW\*(C`string\*(C'\fR, ...) and return true for method \&\f(CW\*(C`is_meta\*(C'\fR. .ie n .SS "value( [ $key | $pointer ] [ %options ] )" .el .SS "value( [ \f(CW$key\fP | \f(CW$pointer\fP ] [ \f(CW%options\fP ] )" .IX Subsection "value( [ $key | $pointer ] [ %options ] )" Called without an argument this method returns an unblessed deep copy of the metadata element. Plain keys at the root level (unless they start with \f(CW\*(C`/\*(C'\fR) and \s-1JSON\s0 Pointer expressions (\s-1RFC 6901\s0 ) can be used to select subfields. Note that \s-1JSON\s0 Pointer escapes slash as \f(CW\*(C`~1\*(C'\fR and character \f(CW\*(C`~\*(C'\fR as \f(CW\*(C`~0\*(C'\fR. \s-1URI\s0 Fragment syntax is not supported. .PP .Vb 9 \& $doc\->value; # full metadata \& $doc\->value(""); # full metadata, explicitly \& $doc\->value(\*(Aq/author\*(Aq); # author field \& $doc\->value(\*(Aqauthor\*(Aq); # author field, plain key \& $doc\->value(\*(Aq/author/name\*(Aq); # name subfield of author field \& $doc\->value(\*(Aq/author/0\*(Aq); # first author field \& $doc\->value(\*(Aq/author/0/name\*(Aq); # name subfield of first author field \& $doc\->value(\*(Aq/~1~0\*(Aq); # metadata field \*(Aq/~\*(Aq \& $doc\->value(\*(Aq/\*(Aq); # field with empty string as key .Ve .PP Returns \f(CW\*(C`undef\*(C'\fR if the selected field does not exist. .PP As a debugging aid you can set option \f(CW\*(C`strict\*(C'\fR to a true value. In this case the method will \f(CW\*(C`croak\*(C'\fR if an invalid pointer, invalid array index, non-existing key or non-existing array index is encountered. .PP Instances of MetaInlines and MetaBlocks are stringified by unless option \&\f(CW\*(C`element\*(C'\fR is set to \f(CW\*(C`keep\*(C'\fR. .PP Setting option \f(CW\*(C`boolean\*(C'\fR to \f(CW\*(C`JSON::PP\*(C'\fR will return \f(CW\*(C`JSON::PP:true\*(C'\fR or \f(CW\*(C`JSON::PP::false\*(C'\fR for MetaBool instances. .SH "METADATA ELEMENTS" .IX Header "METADATA ELEMENTS" .SS "MetaString" .IX Subsection "MetaString" A plain text string metadata value. .PP .Vb 2 \& MetaString $string \& metadata "$string" .Ve .SS "MetaBool" .IX Subsection "MetaBool" A Boolean metadata value. The special values \f(CW"false"\fR and \&\f(CW"FALSE"\fR are recognized as false in addition to normal false values (\f(CW0\fR, \&\f(CW\*(C`undef\*(C'\fR, \f(CW""\fR, ...). .PP .Vb 3 \& MetaBool $value \& metadata JSON::true() \& metadata JSON::false() .Ve .SS "MetaList" .IX Subsection "MetaList" A list of other metadata elements. .PP .Vb 2 \& MetaList [ @values ] \& metadata [ @values ] .Ve .SS "MetaMap" .IX Subsection "MetaMap" A map of keys to other metadata elements. .PP .Vb 2 \& MetaMap { %map } \& metadata { %map } .Ve .SS "MetaInlines" .IX Subsection "MetaInlines" Container for a list of inlines in metadata. .PP .Vb 1 \& MetaInlines [ @inlines ] .Ve .SS "MetaBlocks" .IX Subsection "MetaBlocks" Container for a list of blocks in metadata. .PP .Vb 1 \& MetaBlocks [ @blocks ] .Ve .PP The \f(CW\*(C`string\*(C'\fR method concatenates all stringified content blocks separated by empty lines.