path: root/README
diff options
authormb21 <>2015-09-25 19:30:21 +0200
committermb21 <>2015-09-26 22:22:24 +0200
commit7b0c1e0d37a4820b23d901965f059bba82cd48ae (patch)
tree866f04fe1dbe12c2b1e293610b614adc89de0266 /README
parentf232a0a720ea4879fe2e6f1b9e1a5c4e20097341 (diff)
Support bidirectional text output with XeLaTeX, ConTeXt and HTML
closes #2191
Diffstat (limited to 'README')
1 files changed, 19 insertions, 0 deletions
diff --git a/README b/README
index 8921d076e..c3f8161a8 100644
--- a/README
+++ b/README
@@ -959,6 +959,25 @@ as `title`, `author`, and `date`) as well as the following:
Currently only used by XeTeX through the generated
`polyglossia-otherlangs` variable.
+: the base direction of the document, either `rtl` (right-to-left)
+ or `ltr` (left-to-right).
+ For bidirectional documents, native pandoc `span`s and `div`s
+ with the `dir` attribute (value `rtl` or `ltr`) can be used to
+ override the base direction in some output formats.
+ This may not always be necessary if the final renderer
+ (e.g. the browser, when generating HTML) supports the
+ [Unicode Bidirectional Algorithm][uba-basics].
+ When using LaTeX for bidi documents, only the XeLaTeX engine
+ is fully supported (see `--latex-engine`).
+ Setting the `dir` variable enables bidirectional text
+ handling in LaTeX and ConTeXt, thus even if the base direction
+ is the default left-to-right, you should set `dir: ltr` for
+ documents that also contain some right-to-left script.
: base URL for Slidy documents (defaults to