Changeset 3265


Ignore:
Timestamp:
Apr 23, 2007, 5:01:35 PM (14 years ago)
Author:
Martin Svensson
Message:

References #555. Started to describe the most common tags that are used in the BASE documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

    r3263 r3265  
    372372  </sect1>
    373373
    374 
    375374  <sect1 id="write_docbook_doc.usedtags">
    376375    <title>Elements to use</title>
    377     <para>
    378       Which docbook tags are used in the documentation and when to use what......
    379     </para>
     376    <para>Which docbook tags are used in the documentation and when to use what......</para>
     377    <sect2 id="write_docbook_doc.usedtags.text">
     378      <title>Text</title>
     379      <para>
     380        Here is described which tag to use for different kinds of format and text layout.
     381        There will not be any detailed explanation of the tags, the reader is recommended to
     382        get more information from
     383        <ulink url="http://www.docbook.org/tdg/en/html/docbook.html">
     384          docbook's documentation
     385        </ulink>
     386        or other references instead.
     387      </para>
     388     
     389      <sect3 id="write_docbook_doc.usedtags.text.keywords">
     390        <title>Markup special words</title>
     391        <para></para>
     392      </sect3>
     393    </sect2>
     394    <sect2 id="write_docbook_doc.usedtags.images">
     395      <title>Images and figures</title>
     396      <para></para>
     397    </sect2>
     398    <sect2 id="write_docbook_doc.usedtags.examples">
     399      <title>Examples</title>
     400      <para></para>
     401    </sect2>
     402    <sect2 id="write_docbook_doc.usedtags.admonitions">
     403      <title>Admonitions</title>
     404      <para></para>
     405      <variablelist>
     406        <varlistentry>
     407          <term>
     408            <sgmltag class="starttag">note</sgmltag>
     409          </term>
     410          <listitem>
     411            <para></para>
     412          </listitem>
     413        </varlistentry>
     414        <varlistentry>
     415          <term>
     416            <sgmltag class="starttag">warning</sgmltag>
     417          </term>
     418          <listitem>
     419            <para></para>
     420          </listitem>
     421        </varlistentry>
     422        <varlistentry>
     423          <term>
     424            <sgmltag class="starttag">tip</sgmltag>
     425          </term>
     426          <listitem>
     427            <para></para>
     428          </listitem>
     429        </varlistentry>
     430        <varlistentry>
     431          <term>
     432            <sgmltag class="starttag">important</sgmltag>
     433          </term>
     434          <listitem>
     435            <para></para>
     436          </listitem>
     437        </varlistentry>
     438        <varlistentry>
     439          <term>
     440            <sgmltag class="starttag">caution</sgmltag>
     441          </term>
     442          <listitem>
     443            <para></para>
     444          </listitem>
     445        </varlistentry>
     446      </variablelist>
     447    </sect2>
     448    <sect2 id="write_docbook_doc.usedtags.lists">
     449      <title>Lists</title>
     450      <para></para>
     451    </sect2>
    380452  </sect1>
    381453</chapter>
Note: See TracChangeset for help on using the changeset viewer.