Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/docutils/parsers/rst/languages/en.py: 86%

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""" 

11English-language mappings for language-dependent features of 

12reStructuredText. 

13""" 

14 

15__docformat__ = 'reStructuredText' 

16 

17 

18directives = { 

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 'rst-class': 'class', # Sphinx compatibility alias 

58 'role': 'role', 

59 'default-role': 'default-role', 

60 'title': 'title', 

61 'contents': 'contents', 

62 'sectnum': 'sectnum', 

63 'section-numbering': 'sectnum', 

64 'header': 'header', 

65 'footer': 'footer', 

66 # 'footnotes': 'footnotes', 

67 # 'citations': 'citations', 

68 'target-notes': 'target-notes', 

69 'restructuredtext-test-directive': 'restructuredtext-test-directive'} 

70"""Mapping of English directive name to registered directive names 

71 

72Cf. https://docutils.sourceforge.io/docs/ref/rst/directives.html 

73and `_directive_registry` in ``directives/__init__.py``. 

74""" 

75 

76roles = { 

77 # language-dependent: fixed 

78 'abbreviation': 'abbreviation', 

79 'ab': 'abbreviation', 

80 'acronym': 'acronym', 

81 'ac': 'acronym', 

82 'code': 'code', 

83 'emphasis': 'emphasis', 

84 'literal': 'literal', 

85 'math': 'math', 

86 'pep-reference': 'pep-reference', 

87 'pep': 'pep-reference', 

88 'rfc-reference': 'rfc-reference', 

89 'rfc': 'rfc-reference', 

90 'strong': 'strong', 

91 'subscript': 'subscript', 

92 'sub': 'subscript', 

93 'superscript': 'superscript', 

94 'sup': 'superscript', 

95 'title-reference': 'title-reference', 

96 'title': 'title-reference', 

97 't': 'title-reference', 

98 'raw': 'raw', 

99 # the following roles are not implemented in Docutils 

100 'index': 'index', 

101 'i': 'index', 

102 'anonymous-reference': 'anonymous-reference', 

103 'citation-reference': 'citation-reference', 

104 'footnote-reference': 'footnote-reference', 

105 'named-reference': 'named-reference', 

106 'substitution-reference': 'substitution-reference', 

107 'uri-reference': 'uri-reference', 

108 'uri': 'uri-reference', 

109 'url': 'uri-reference', 

110 'target': 'target', 

111 } 

112"""Mapping of English role names to canonical role names for interpreted text. 

113 

114Cf. https://docutils.sourceforge.io/docs/ref/rst/roles.html 

115"""