diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2017-09-07 20:00:57 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2017-09-07 20:00:57 +0000 |
| commit | 37fde31ec1e0167beb49e1c0dfeb96830d6c4dab (patch) | |
| tree | 336891db6a3482d52ec5d9d7310b933e49b5a39a /docutils/docs/ref | |
| parent | ab12220d107ba96a2d1eab5bf22b2ae299fa5950 (diff) | |
| download | docutils-37fde31ec1e0167beb49e1c0dfeb96830d6c4dab.tar.gz | |
Documentation update.
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@8176 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/ref')
| -rw-r--r-- | docutils/docs/ref/rst/restructuredtext.txt | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docutils/docs/ref/rst/restructuredtext.txt b/docutils/docs/ref/rst/restructuredtext.txt index 87f8710f0..8a1b3b660 100644 --- a/docutils/docs/ref/rst/restructuredtext.txt +++ b/docutils/docs/ref/rst/restructuredtext.txt @@ -831,7 +831,7 @@ directives in `reStructuredText Directives`_. Field lists are mappings from *field names* to *field bodies*, modeled on RFC822_ headers. A field name may consist of any characters, but colons (":") inside of field names must be backslash-escaped -when followed by whitespace. +when followed by whitespace.\ [#]_ Inline markup is parsed in field names, but care must be taken when using `interpreted text`_ with explicit roles in field names: the role must be a suffix to the interpreted text. Field names are @@ -875,6 +875,8 @@ Syntax diagram (simplified):: | (body elements)+ | +-----------------------------------+ +.. [#] Up to Docutils 0.14, field markers were not recognized when + containing a colon. Bibliographic Fields ```````````````````` @@ -2510,15 +2512,17 @@ No escaping is required inside the following inline markup examples: It may be desirable to use `inline literals`_ for some of these anyhow, especially if they represent code snippets. It's a judgment call. -These cases *do* require either literal-quoting or escaping to avoid +The following terms *do* require either literal-quoting or escaping to avoid misinterpretation:: - \*4, class\_, \*args, \**kwargs, \`TeX-quoted', \*ML, \*.txt + *4, class_, *args, **kwargs, `TeX-quoted', *ML, *.txt In most use cases, `inline literals`_ or `literal blocks`_ are the best -choice (by default, this also selects a monospaced font):: +choice (by default, this also selects a monospaced font). Alternatively, the +inline markup characters can be escaped:: + + \*4, class\_, \*args, \**kwargs, \`TeX-quoted', \*ML, \*.txt - *4, class_, *args, **kwargs, `TeX-quoted', *ML, *.txt For languages that don't use whitespace between words (e.g. Japanese or Chinese) it is recommended to set `simple-inline-markup`_ to True and |