path: root/README
diff options
authorJohn MacFarlane <>2015-09-22 22:21:06 -0700
committerJohn MacFarlane <>2015-09-22 22:21:06 -0700
commitf232a0a720ea4879fe2e6f1b9e1a5c4e20097341 (patch)
treed2bd6aaf46f3601fcd14e1b3713b0e6cd7459fbf /README
parentd25a37c122a85b0aeef7d0039d5464d275ad4b07 (diff)
parent622df7034c96d1d0ba10b1ad654840ac93baf7f7 (diff)
Merge pull request #2369 from mb21/language-variables
`lang` variable is now in BCP47 format
Diffstat (limited to 'README')
1 files changed, 16 insertions, 4 deletions
diff --git a/README b/README
index 93efab039..8921d076e 100644
--- a/README
+++ b/README
@@ -945,7 +945,19 @@ as `title`, `author`, and `date`) as well as the following:
: body of document
-: language code for HTML or LaTeX documents
+: The `lang` variable should be set by the user to a language
+ code according to [BCP 47] (e.g. `en` or `en-GB`).
+ For some output formats, pandoc will convert it to an approriate
+ format stored in the additional variables `babel-lang`,
+ `polyglossia-lang`, `polyglossia-variant` (LaTeX)
+ and `context-lang` (ConTeXt).
+: Should be set to a list of other languages used in the document
+ in the YAML metadata, according to [BCP 47]. For example:
+ `otherlangs: [en-GB, fr]`.
+ Currently only used by XeTeX through the generated
+ `polyglossia-otherlangs` variable.
: base URL for Slidy documents (defaults to
@@ -3264,8 +3276,8 @@ The following fields are recognized:
~ A string value in `YYYY-MM-DD` format. (Only the year is necessary.)
Pandoc will attempt to convert other common date formats.
- ~ A string value in [RFC5646] format. Pandoc will default to the local
+`lang` (or legacy: `language`)
+ ~ A string value in [BCP 47] format. Pandoc will default to the local
language if nothing is specified.
@@ -3549,7 +3561,7 @@ Xavier Olive.
[marc relators]:
+[BCP 47]:
[InDesign ICML]: