Changeset 3278


Ignore:
Timestamp:
Apr 26, 2007, 2:13:43 PM (14 years ago)
Author:
Nicklas Nordborg
Message:

References #555: Added info about <seeother> and <other> tags and about importing help texts with
the help program.

File:
1 edited

Legend:

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

    r3274 r3278  
    373373  &lt;helptext external_id="<replaceable>helptexts.external.id</replaceable>" title="<replaceable>The title</replaceable>"&gt;
    374374    <replaceable>The text that also should be used as a helptext in the program.</replaceable>
     375    &lt;seeother&gt;
     376    &lt;other external_id="<replaceable>other.external.id</replaceable>"&gt;
     377      <replaceable>Related info here...</replaceable>&lt;/other&gt;
     378    &lt;/seeother&gt;
    375379  &lt;/helptext&gt;
    376380&lt;/sect1&gt;
    377381        </programlisting>
    378382      </example>
     383     
     384      <para>
     385        You can use <sgmltag>seeother</sgmltag> and <sgmltag>other</sgmltag>
     386        to create links between different help texts. The <sgmltag>seeother</sgmltag>
     387        tag doesn't have any attributes and is just a container for one or more
     388        <sgmltag>other</sgmltag> tags. Each tag requires a single attribute.
     389      </para>
     390        <variablelist>
     391          <varlistentry>
     392            <term>
     393              <sgmltag class="attribute">external_id</sgmltag>
     394            </term>
     395            <listitem>
     396              <para>
     397                The external ID of the other help text to link to.
     398              </para>
     399            </listitem>
     400          </varlistentry>
     401        </variablelist>
     402       
     403     
    379404      <para>
    380405        Import the generated XML-file manually by uploading it from the
     
    383408        plugin to import the help text items from that file.
    384409      </para>
     410     
     411      <para>
     412        The help texts can also be imported by running the TestHelp
     413        test program. In short, here are the commands you need to
     414        import the help texts:
     415      </para>
     416     
     417      <programlisting>
     418ant docbook
     419ant test
     420cd build/test
     421./run.sh TestHelp
     422</programlisting>
     423     
    385424    </sect2>
    386425    <sect2 id="write_docbook_doc.begin.generate">
Note: See TracChangeset for help on using the changeset viewer.