docutils/docutils/parsers/rst/languages/en.py

   1 # $Id$
   2 # Author: David Goodger <goodger@python.org>
   3 # Copyright: This module has been placed in the public domain.
   4
   5 # New language mappings are welcome.  Before doing a new translation, please
   6 # read <https://docutils.sourceforge.io/docs/howto/i18n.html>.
   7 # Two files must be translated for each language: one in docutils/languages,
   8 # the other in docutils/parsers/rst/languages.
   9
  10 """
  11 English-language mappings for language-dependent features of
  12 reStructuredText.
  13 """
  14
  15 __docformat__ = 'reStructuredText'
  16
  17
  18 directives = {
  19       # language-dependent: fixed
  20       'attention': 'attention',
  21       'caution': 'caution',
  22       'danger': 'danger',
  23       'error': 'error',
  24       'hint': 'hint',
  25       'important': 'important',
  26       'note': 'note',
  27       'tip': 'tip',
  28       'warning': 'warning',
  29       'admonition': 'admonition',  # advice/advisory/remark, not reprimand
  30       'sidebar': 'sidebar',
  31       'topic': 'topic',
  32       'line-block': 'line-block',
  33       'parsed-literal': 'parsed-literal',
  34       'code': 'code',
  35       'code-block': 'code',
  36       'sourcecode': 'code',
  37       'math': 'math',
  38       'rubric': 'rubric',
  39       'epigraph': 'epigraph',
  40       'highlights': 'highlights',
  41       'pull-quote': 'pull-quote',
  42       'compound': 'compound',
  43       'container': 'container',
  44       'table': 'table',
  45       'csv-table': 'csv-table',
  46       'list-table': 'list-table',
  47       'meta': 'meta',
  48       # 'imagemap': 'imagemap',
  49       'image': 'image',
  50       'figure': 'figure',
  51       'include': 'include',
  52       'raw': 'raw',
  53       'replace': 'replace',
  54       'unicode': 'unicode',
  55       'date': 'date',
  56       'class': 'class',
  57       'role': 'role',
  58       'default-role': 'default-role',
  59       'title': 'title',
  60       'contents': 'contents',
  61       'sectnum': 'sectnum',
  62       'section-numbering': 'sectnum',
  63       'header': 'header',
  64       'footer': 'footer',
  65       # 'footnotes': 'footnotes',
  66       # 'citations': 'citations',
  67       'target-notes': 'target-notes',
  68       'restructuredtext-test-directive': 'restructuredtext-test-directive'}
  69 """Mapping of English directive name to registered directive names
  70
  71 Cf. https://docutils.sourceforge.io/docs/ref/rst/directives.html
  72 and `_directive_registry` in ``directives/__init__.py``.
  73 """
  74
  75 roles = {
  76     # language-dependent: fixed
  77     'abbreviation': 'abbreviation',
  78     'ab': 'abbreviation',
  79     'acronym': 'acronym',
  80     'ac': 'acronym',
  81     'code': 'code',
  82     'emphasis': 'emphasis',
  83     'literal': 'literal',
  84     'math': 'math',
  85     'pep-reference': 'pep-reference',
  86     'pep': 'pep-reference',
  87     'rfc-reference': 'rfc-reference',
  88     'rfc': 'rfc-reference',
  89     'strong': 'strong',
  90     'subscript': 'subscript',
  91     'sub': 'subscript',
  92     'superscript': 'superscript',
  93     'sup': 'superscript',
  94     'title-reference': 'title-reference',
  95     'title': 'title-reference',
  96     't': 'title-reference',
  97     'raw': 'raw',
  98     # the following roles are not implemented in Docutils
  99     'index': 'index',
 100     'i': 'index',
 101     'anonymous-reference': 'anonymous-reference',
 102     'citation-reference': 'citation-reference',
 103     'footnote-reference': 'footnote-reference',
 104     'named-reference': 'named-reference',
 105     'substitution-reference': 'substitution-reference',
 106     'uri-reference': 'uri-reference',
 107     'uri': 'uri-reference',
 108     'url': 'uri-reference',
 109     'target': 'target',
 110     }
 111 """Mapping of English role names to canonical role names for interpreted text.
 112
 113 Cf. https://docutils.sourceforge.io/docs/ref/rst/roles.html
 114 """