path: root/README
diff options
authorJohn MacFarlane <>2015-09-26 17:06:56 -0700
committerJohn MacFarlane <>2015-09-26 17:06:56 -0700
commitfdfc961284a71f634e8513d76f69f6d0add0b29b (patch)
tree99f1d2c2d1a16af0579182a3569d7455833b9ca3 /README
parent72bade01f54291cf1571c01cd989980df147d4e6 (diff)
parent7b0c1e0d37a4820b23d901965f059bba82cd48ae (diff)
Merge pull request #2419 from mb21/bidi
Support bidirectional text output with XeLaTeX, ConTeXt and HTML
Diffstat (limited to 'README')
1 files changed, 19 insertions, 0 deletions
diff --git a/README b/README
index 387ff7e89..e5812bda6 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