Ignore:
Timestamp:
May 8, 2007, 2:22:10 PM (14 years ago)
Author:
Nicklas Nordborg
Message:

Allow parts of texts inside <helptext> tag to be skipped when generating help texts.

File:
1 edited

Legend:

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

    r3305 r3306  
    427427      </example>
    428428     
    429       <para>
    430         You can use <sgmltag>seeother</sgmltag> and <sgmltag>other</sgmltag>
    431         to create links between different help texts. The <sgmltag>seeother</sgmltag>
     429      <sect3 id="write_docbook_doc.begin.helptext.nohelp">
     430        <title>Skip parts of a help text</title>
     431        <para>
     432          From time to time, it may happen that you find that
     433          some parts of the text inside a <sgmltag class="starttag">helptext</sgmltag>
     434          tag doesn't make sense. It may, for example, be a reference to
     435          an image or an example, or a link to another chapter or
     436          section. Put a <sgmltag class="starttag">nohelp</sgmltag>
     437          tag around the problematic part to avoid it from beeing
     438          outputted to the help texts.
     439        </para>     
     440        <programlisting>
     441&lt;nohelp&gt;see &lt;xref linkend="chapter11" /&gt;&lt;/nohelp&gt;</programlisting>
     442      </sect3>
     443     
     444      <sect3 id="write_docbook_doc.begin.helptext.link">
     445      <title>Link to other help texts</title>
     446     
     447      <para>
     448        You can use <sgmltag class="starttag">seeother</sgmltag> and
     449        <sgmltag class="starttag">other</sgmltag>
     450        to create links between different help texts. The
     451        <sgmltag  class="starttag">seeother</sgmltag>
    432452        tag doesn't have any attributes and is just a container for one or more
    433         <sgmltag>other</sgmltag> tags. Each tag requires a single attribute.
     453        <sgmltag  class="starttag">other</sgmltag> tags. Each tag requires a single attribute.
    434454      </para>
    435455        <variablelist>
     
    445465          </varlistentry>
    446466        </variablelist>
    447        
     467      </sect3>
    448468     
     469      <sect3 id="write_docbook_doc.begin.helptext.import">
     470      <title>Import help texts into BASE</title>
    449471      <para>
    450472        Import the generated XML-file manually by uploading it from the
     
    466488./run.sh TestHelp
    467489</programlisting>
     490      </sect3>
    468491     
    469492    </sect2>
Note: See TracChangeset for help on using the changeset viewer.