Jump to: navigation, search

I18nTeam/rst-markups

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 Translate example 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: