Revision as of 18:48, 2 March 2012

DocBook markup conventions

This page offers conventions for DocBook markup. Please modify this page as you come across more markup you need for the docs.openstack.org site.

General style conventions

Use "OpenStack", not Openstack or openstack.

Information or configuration files that the user has to type or read

<literallayout class="monospaced">
right command to type 
</literallayout>

<literallayout class="monospaced">
# wrong command to type
</literallayout>

Inline configuration information

<para>
<code>
--use_deprecated_auth
</code
</para>

Command to type into a specific shell

<literallayout class="monospaced">
(mysql) # wrong command to type
</literallayout>

<literallayout class="monospaced">
(mysql) right command to type
</literallayout>

Result of the command

<programlisting>
--- result
---result
</programlisting>

File names

<literallayout class="monospaced">/my/file/is/here</literallayout>

File contents

<programlisting>
--- result
---result
</programlisting>

Ordered procedure to follow (where step 2 needs to be done after step 1)

<orderedlist>
       <listitem></listitem>
</orderedlist>

Instructions to follow with no critical dependency across steps

<itemizedlist>
      <listitem></listitem>
</itemizedlist>