1. Zoom Quiet
  2. sphinx_zh


Zoom Quiet  committed 5fada41

+ 0.5H rst 完成100%

  • Participants
  • Parent commits 97a904a
  • Branches doc-zh

Comments (0)

Files changed (1)

File rest.rst

View file
-明确标记 Explicit Markup
+直解标记 Explicit Markup
 "Explicit markup" (:duref:`ref <explicit-markup-blocks>`) is used in reST for
 most constructs that need special handling, such as footnotes,
 specially-highlighted paragraphs, comments, and generic directives.
-"明确标记" (:duref:`参考 <explicit-markup-blocks>`)
-用以 reST 中需要特殊处理的内容,
+"直解标记" (Explicit markup, :duref:`参考 <explicit-markup-blocks>`)
+用以 reST 中需要特殊处理的各种内容,
 An explicit markup block begins with a line starting with ``..`` followed by
 paragraphs.  This may all sound a bit complicated, but it is intuitive enough
 when you write it.)
+图片 Images
 reST 支持图片指令 (:dudir:`ref <image>`), 这样使用::
 引证 的使用基本和脚注相同,
 不过使用的标签不是数字或是以 ``#`` 开始.
+替换 Substitutions
-reST supports "substitutions" (:duref:`ref <substitution-definitions>`), which
-are pieces of text and/or markup referred to in the text by ``|name|``.  They
-are defined like footnotes with explicit markup blocks, like this::
+reST 支持 "替换" (:duref:`参考 <substitution-definitions>`), 
+以 ``|name|`` 形式来定义替换的文本或是标记对象.
    .. |name| replace:: replacement *text*
-or this::
    .. |caution| image:: warning.png
                 :alt: Warning!
-See the :duref:`reST reference for substitutions <substitution-definitions>`
-for details.
+详参 :duref:`reST 替换参考 <substitution-definitions>` .
 If you want to use some substitutions for all documents, put them into
 :confval:`rst_prolog` or put them into a separate file and include it into all
 sure to give the include file a file name extension differing from that of other
 source files, to avoid Sphinx finding it as a standalone document.)
+把它们置入 :confval:`rst_prolog` 或放入一个单独的文件,
+并在所有相关文件中使用 :rst:dir:`incluse` 指令引入,
+(请将此定义文件,使用和内容文件不同的后缀,否则,Sphinx 将视其为独立文章来尝试解析)
 Sphinx defines some default substitutions, see :ref:`default-substitutions`.
+Sphinx 本身有些默认替换,参考 :ref:`default-substitutions` .
+注释  Comments
 Every explicit markup block which isn't a valid markup construct (like the
 footnotes above) is regarded as a comment (:duref:`ref <comments>`).  For
+没有有效标记(如脚注)的直解标记文本块就是注释(:duref:`参考 <comments>`)
    .. This is a comment.
-You can indent text after a comment start to form multiline comments::
       This whole indented block
       Still in the comment.
-Source encoding
+源文本编码 Source encoding
 Since the easiest way to include special characters like em dashes or copyright
 signs in reST is to directly write them as Unicode characters, one has to
 specify an encoding.  Sphinx assumes source files to be encoded in UTF-8 by
 default; you can change this with the :confval:`source_encoding` config value.
+由于最简单的方式,是在 reST 中将包括特殊字符(如长划线或版权标记)都直接写成Unicode字符.
+Sphinx 默认假设源文件是 utf-8 编码.
+你可以用配置项 :confval:`source_encoding` 来指定别的编码.
+嗯嗯嗯 Gotchas
 There are some problems one commonly runs into while authoring reST documents:
+通常运用 reST 进行撰写时会遇见几个问题:
-* **Separation of inline markup:** As said above, inline markup spans must be
-  separated from the surrounding text by non-word characters, you have to use a
-  backslash-escaped space to get around that.  See `the reference
-  <http://docutils.sf.net/docs/ref/rst/restructuredtext.html#inline-markup>`_
-  for the details.
+* **对在线标记的分隔:** 如前所述,内联标记必须用非单词字符和周围的文字进行区隔,
+  要解决这个问题你必须使用反斜杠转义空格,详见 `参考 <http://docutils.sf.net/docs/ref/rst/restructuredtext.html#inline-markup>`_ .
-* **No nested inline markup:** Something like ``*see :func:`foo`*`` is not
-  possible.
+* **在线标记不能嵌套:** 但是形如 ``*see :func:`foo`*`` 是没问题的.
 .. rubric:: Footnotes
-.. [1] When the default domain contains a :rst:dir:`class` directive, this directive
-       will be shadowed.  Therefore, Sphinx re-exports it as :rst:dir:`rst-class`.
+.. [1] 当默认域包含 :rst:dir:`class` 指令时,该指令将被掩蔽,
+        因此 Sphinx 转而使用 :rst:dir:`rst-class`.