Jump to: navigation, search

Difference between revisions of "I18nTeam/rst-markups"

(Created page with "== RST Markups == 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....")
 
(RST Markups)
Line 1: Line 1:
== RST Markups ==
+
== Quick reference: 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.
 
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.
Line 5: Line 5:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Name !! Example !! Translated sample strings
+
! Name !! Example !! Translated sample strings !! Similar markups
 
|-
 
|-
| Notes || .. note::
+
| Notes  
   This is a sample string || .. note::
+
||
 +
.. 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``
 +
|| *emphasis*, **strong emphasis**, `interpreted text`
 +
|-
 +
| 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`
 +
||
 
|}
 
|}

Revision as of 07:26, 15 April 2015

Quick reference: 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``
*emphasis*, **strong emphasis**, `interpreted text`
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`