git.iko.soy/typeable/pandoc
on master help sign in
Documented use of YAML metadata for EPUB.
commit6e17070be15be95cd05c466d4a2fed3ad5d756ef authorJohn MacFarlane <jgm@berkeley.edu> dateSat 30 Nov 2013, 15:06 (13 years ago) parent6595968
1 file changed+72−1
README+72−1
README+72−1
@@ -560,6 +560,10 @@ Options affecting specific writers
560560 id="BookId">` (a randomly generated UUID). Any of these may be
561561 overridden by elements in the metadata file.
562562
563+ Note: if the source document is markdown, a YAML metadata block
564+ in the document can be used instead. See below under
565+ [EPUB Metadata].
566+
563567`--epub-embed-font=`*FILE*
564568: Embed the specified font in the EPUB. This option can be repeated
565569 to embed multiple fonts. To use embedded fonts, you
@@ -2749,6 +2753,72 @@ To show the notes window, press `s` while viewing the presentation.
27492753Notes are not yet supported for other slide formats, but the notes
27502754will not appear on the slides themselves.
27512755
2756+EPUB Metadata
2757+=============
2758+
2759+EPUB metadata may be specified using the `--epub-metadata` option, but
2760+if the source document is markdown, it is better to use a YAML metadata
2761+block. Here is an example:
2762+
2763+ ---
2764+ title:
2765+ - type: main
2766+ text: My Book
2767+ - type: subtitle
2768+ text: An investigation of metadata
2769+ creator:
2770+ - role: author
2771+ text: John Smith
2772+ - role: editor
2773+ text: Sarah Jones
2774+ identifier:
2775+ - scheme: DOI
2776+ text: doi:10.234234.234/33
2777+ publisher: My Press
2778+ rights: (c) 2007 John Smith, CC BY-NC
2779+ ...
2780+
2781+The following fields are recognized:
2782+
2783+identifier
2784+ ~ Either a string value or an object with fields `text` and
2785+ `scheme`. Valid values for `scheme` are `ISBN-10`,
2786+ `GTIN-13`, `UPC`, `ISMN-10`, `DOI`, `LCCN`, `GTIN-14`,
2787+ `ISBN-13`, `Legal deposit number`, `URN`, `OCLC`,
2788+ `ISMN-13`, `ISBN-A`, `JP`, `OLCC`.
2789+title
2790+ ~ Either a string value, or an object with fields `file-as` and
2791+ `type`, or a list of such objects. Valid values for `type` are
2792+ `main`, `subtitle`, `short`, `collection`, `edition`, `extended`.
2793+creator
2794+ ~ Either a string value, or an object with fields `role`, `file-as`,
2795+ and `text`, or a list of such objects. Valid values for `role` are
2796+ [marc relators](http://www.loc.gov/marc/relators/relaterm.html), but
2797+ pandoc will attempt to translate the human-readable versions
2798+ (like "author" and "editor") to the appropriate marc relators.
2799+contributor
2800+ ~ Same format as `creator`.
2801+date
2802+ ~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
2803+ Pandoc will attempt to convert other common date formats.
2804+language
2805+ ~ A string value in [RFC5646] format. Pandoc will default to the local
2806+ language if nothing is specified.
2807+subject
2808+ ~ A string value or a list of such values.
2809+description
2810+ ~ A string value.
2811+type
2812+ ~ A string value.
2813+format
2814+ ~ A string value.
2815+relation
2816+ ~ A string value.
2817+coverage
2818+ ~ A string value.
2819+rights
2820+ ~ A string value.
2821+
27522822Literate Haskell support
27532823========================
27542824
@@ -2860,4 +2930,5 @@ Jamie F. Olson.
28602930[reveal.js]: http://lab.hakim.se/reveal-js/
28612931[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
28622932[lua]: http://www.lua.org
2863−
2933+[marc relators]: http://www.loc.gov/marc/relators/relaterm.html
2934+[RFC5646]: http://tools.ietf.org/html/rfc5646