Open Stack

Hi to all!

Thanks much, Ying Chun Guo, for the table. It will be very helpful not only
for the translators but also for the writers who migrate or create new
content.

As I worked on the migration of the user guides, I can probably add more
markups I used myself or run across while reviewing patches of other
contributors.

So, they are as follows:

1) :guilabel:`tab`    (for any labels such as tabs, buttons, etc.)
2) :menuselection:`Start > Programs`
3) :code:`code_samp`    (if some code is wrapped in text)
4) :doc:`doc_name`  (another kind of an external reference)
5) :option:`--option`  (could you please mention that it can be used only
if there are "-" or "--" in the word it marks, otherwise an error occurs)
6) :term:`glossterm_name`  (I believe it already works, thanks to Andreas
efforts)
7) |  (a vertical bar: I am not sure about this, but this symbol usage
allows the creation of an additional blank line if needed)
8) :kbd:`Control-C Control-V`  for a sequence of keystrokes

If there are any that should not be used, please let us know. Thanks!

Best regards,
Olga

On Thu, Apr 16, 2015 at 9:47 AM, Olga Gusarenko <ogusarenko at mirantis.com>
wrote:

> Hi to all!
>
> Thanks much, Ying Chun Guo, for the table. It will be very helpful not
> only for the translators but also for the writers who migrate or create new
> content.
>
> As I worked on the migration of the user guides, I can probably add more
> markups I used myself or run across while reviewing patches of other
> contributors.
>
> So, they are as follows:
>
> 1) :guilabel:`tab`    (for any labels such as tabs, buttons, etc.)
> 2) :menuselection:`Start > Programs`
> 3) :code:`code_samp`    (if some code is wrapped in text)
> 4) :doc:`doc_name`  (another kind of an external reference)
> 5) :option:`--option`  (could you please mention that it can be used only
> if there "-" or "--" in it, otherwise an error occurs)
> 6) :term:`glossterm_name`  (I believe it already works, thanks to Andreas
> efforts)
> 7) |  (a vertical bar: I am not sure about this, but this symbol usage
> allows the creation of an additional blank line if needed)
> 8) :kbd:`Control-C Control-V`  for a sequence of keystrokes
>
> If there are any that should not be used, please let us know. Thanks!
>
> Best regards,
> Olga
>
> On Wed, Apr 15, 2015 at 10:42 AM, Ying Chun Guo <guoyingc at cn.ibm.com>
> wrote:
>
>> Thank you all for the inputs.
>>
>> I have created a wiki page for translators to reference.
>> https://wiki.openstack.org/wiki/I18nTeam/rst-markups
>>
>> If I missed any topical markups used in our manuals,
>> please let me know.
>>
>> Jeremy Stanley <fungi at yuggoth.org> wrote on 2015/04/11 00:11:09:
>>
>> > From: Jeremy Stanley <fungi at yuggoth.org>
>> > To: openstack-i18n at lists.openstack.org,
>> openstack-docs at lists.openstack.org
>> > Date: 2015/04/11 00:11
>> > Subject: Re: [Openstack-i18n] [OpenStack-docs] Status of the RST
>> > Documentation Toolchain
>> >
>> > On 2015-04-10 23:18:21 +0900 (+0900), Bernd Bausch wrote:
>> > [...]
>> > > What might be useful is a pocket reference of those RST markups
>> > > that we want to use in our docs, perhaps added to the wiki page.
>> >
>> > See <http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt>
>> > --
>> > Jeremy Stanley
>> >
>> > _______________________________________________
>> > Openstack-i18n mailing list
>> > Openstack-i18n at lists.openstack.org
>> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n
>> >
>>
>> _______________________________________________
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150416/bad95246/attachment.html>