|
|
| (254 intermediate revisions by 21 users not shown) |
| Line 1: |
Line 1: |
| − | __NOTOC__
| + | {{Warning|header=Warning|body=This page is deprecated. It is left here for reference.}} |
| − | 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. | |
| | | | |
| − | == Information or configuration files that the user has to type or read ==
| + | Read the new content in [http://docs.openstack.org/contributor-guide/writing-style/general-writing-guidelines.html the Documentation Contributor Guide]. |
| | | | |
| − | | + | {{OpenStack_Documentation_Navbar}} |
| − | <pre><nowiki>
| + | {{OpenStack_Conventions_Navbar}} |
| − | <literallayout class="monospaced">
| |
| − | right command to type
| |
| − | </literallayout>
| |
| − | | |
| − | <literallayout class="monospaced">
| |
| − | # wrong command to type
| |
| − | </literallayout>
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | == Inline configuration information ==
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | <para>
| |
| − | <code>
| |
| − | --use_deprecated_auth
| |
| − | </code
| |
| − | </para>
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | == Command to type into a specific shell ==
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | <literallayout class="monospaced">
| |
| − | (mysql) # wrong command to type
| |
| − | </literallayout>
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | <literallayout class="monospaced">
| |
| − | (mysql) right command to type
| |
| − | </literallayout>
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | == Result of the command ==
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | <programlisting>
| |
| − | --- result
| |
| − | ---result
| |
| − | </programlisting>
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | == File names ==
| |
| − | | |
| − | <pre><nowiki>
| |
| − | <literallayout class="monospaced">/my/file/is/here</literallayout>
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | == File contents ==
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | <programlisting>
| |
| − | --- result
| |
| − | ---result
| |
| − | </programlisting>
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | == Ordered procedure to follow (where step 2 needs to be done after step 1) ==
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | <orderedlist>
| |
| − | <listitem></listitem>
| |
| − | </orderedlist>
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | == Instructions to follow with no critical dependency across steps ==
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | <itemizedlist>
| |
| − | <listitem></listitem>
| |
| − | </itemizedlist>
| |
| − | </nowiki></pre>
| |
Warning
