Difference between revisions of "I18nTeam/rst-markups"

Revision as of 07:39, 15 April 2015

Quick ref: reStructuredText markups in translations

Some of manuals are using RST format. This page lists the RST markups used in OpenStack manuals. These markups should be ignored while translating manuals.

Name	Example	Translated sample strings	Similar markups
Notes	.. note:: This is a sample string	.. note:: 这是例句	caution::, important::, tip::, warning::
Image	.. image:: figures/CFinterfaces.png	.. image:: figures/CFinterfaces.png
Codes	.. code:: python print("Hi")	.. code:: python print("Hi")
Inline markup	Set ``use_syslog = True``	设置 ``use_syslog = True``	`interpreted text`
Strong emphasis	Access the new database	访问新数据库	emphasis
Command	you can use the :command:`nova quota-*` commands	你可以使用:command:`nova quota-*`命令	:option:,:samp:
File name	the :file:`nova.conf` configuration file is installed in the :file:`/etc/nova` folder	配置文件:file:`nova.conf`位于:file:`/etc/nova`目录
Linking	see :ref:`hot_spec_intrinsic_functions`	参见:ref:`hot_spec_intrinsic_functions`

References

If you want to understand more about reStructuredText markups, go to below resources:

@@ Line 14: / Line 14: @@
   .. note::
     这是例句
-|| caution::, important, tip::, warning::
+|| caution::, important::,
+tip::, warning::
 |-
 | Image
@@ Line 37: / Line 38: @@
 ||
   设置 ``use_syslog = True``
-|| *emphasis*, **strong emphasis**, `interpreted text`
+|| `interpreted text`
+|-
+| Strong emphasis
+||
+ **Access the new database**
+||
+ **访问新数据库**
+|| *emphasis*
 |-
 | Command
@@ Line 61: / Line 69: @@
 ||
 |}
+== References ==
+If you want to understand more about reStructuredText markups, go to below resources:
+* [https://wiki.openstack.org/wiki/Documentation/Markup_conventions Documentation/Markup conventions]
+* [http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt The reStructuredText_ Cheat Sheet: Syntax Reminders]