Changeset 3278

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:

• trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml (modified) (2 diffs)

trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

@@ -373 +373 @@
   &lt;helptext external_id="<replaceable>helptexts.external.id</replaceable>" title="<replaceable>The title</replaceable>"&gt;
     <replaceable>The text that also should be used as a helptext in the program.</replaceable>
+    &lt;seeother&gt;
+    &lt;other external_id="<replaceable>other.external.id</replaceable>"&gt;
+      <replaceable>Related info here...</replaceable>&lt;/other&gt;
+    &lt;/seeother&gt;
   &lt;/helptext&gt;
 &lt;/sect1&gt;
         </programlisting>
       </example>
+      
+      <para>
+        You can use <sgmltag>seeother</sgmltag> and <sgmltag>other</sgmltag>
+        to create links between different help texts. The <sgmltag>seeother</sgmltag>
+        tag doesn't have any attributes and is just a container for one or more
+        <sgmltag>other</sgmltag> tags. Each tag requires a single attribute.
+      </para>
+        <variablelist>
+          <varlistentry>
+            <term>
+              <sgmltag class="attribute">external_id</sgmltag>
+            </term>
+            <listitem>
+              <para>
+                The external ID of the other help text to link to.
+              </para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
+        
+      
       <para>
         Import the generated XML-file manually by uploading it from the
@@ -383 +408 @@
         plugin to import the help text items from that file.
       </para>
+      
+      <para>
+        The help texts can also be imported by running the TestHelp
+        test program. In short, here are the commands you need to
+        import the help texts:
+      </para>
+      
+      <programlisting>
+ant docbook
+ant test
+cd build/test
+./run.sh TestHelp
+</programlisting>
+      
     </sect2>
     <sect2 id="write_docbook_doc.begin.generate">