Changeset 3282 for trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

Timestamp:

Apr 27, 2007, 2:58:24 PM (16 years ago)

Author:

Martin Svensson

Message:

Added link elements to used elements

File:

• trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml (modified) (1 diff)

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

@@ -1062 +1062 @@
       </example>
     </sect2>
+    
+    <sect2 id="write_docbook_doc.usedtags.links">
+      <title>Link elements</title>
+      <para></para>
+      <informaltable frame="none">
+        <tgroup cols="3" rowsep="1" colsep="1">
+          <colspec align="left" />
+          <colspec align="center" />
+          <colspec align="left" />
+          <thead>
+            <row>
+              <entry>Define</entry>
+              <entry>Element</entry>
+              <entry>Comment</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry>Cross reference</entry>
+              <entry>
+                <sgmltag class="starttag">xref linkend=""</sgmltag>
+              </entry>
+              <entry>Use this to linke to other parts of the document.</entry>
+            </row>
+            <row>
+              <entry>Cross reference with own text</entry>
+              <entry>
+                <sgmltag class="starttag">link</sgmltag>
+              </entry>
+              <entry>
+                Can be used as an alternative to
+                <sgmltag>xref</sgmltag>
+              </entry>
+            </row>
+            <row>
+              <entry>External URLs</entry>
+              <entry>
+                <sgmltag class="starttag">ulink url=""</sgmltag>
+              </entry>
+              <entry></entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+      <example id="write_docbook_doc.examples.links">
+        <title>Links</title>
+        <programlisting>
+&hellip;
+&lt;xref linkend="write_docbook_doc.usedtags.links" /&gt;
+&lt;link linkend="write_docbook_doc.usedtags.links"&gt;Link to this section&lt;/link&gt;
+&lt;ulink url="http://base.thep.lu.se"&gt;Base2's homepage&lt;/ulink&gt;
+&hellip;
+        </programlisting>
+        <para>
+          The first element will autogenerate the linked section's/chapter's title as a
+          hyperlinked text. As an alternative to
+          <sgmltag>xref</sgmltag>
+          is
+          <sgmltag>link</sgmltag>
+          that lets you write your own hyperlinked text. The third and last one should be
+          used to link to any URL outside the document.
+        </para>
+      </example>
+    </sect2>
   </sect1>
 </chapter>