Ignore:
Timestamp:
May 8, 2007, 1:57:25 PM (15 years ago)
Author:
Nicklas Nordborg
Message:

Added option to not include <helptext> sections in the HTML or PDF documentation.

File:
1 edited

Legend:

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

    r3301 r3305  
    351351        The parts of the text that also should be used as help texts in the web must be
    352352        inside
    353         <sgmltag>helptext</sgmltag>
    354         tags.These texts will be exported to a XML-file at the same time as the
    355         HTML-documentation is generated.The generated XML-file is compatible with the help
     353        <sgmltag class="starttag">helptext</sgmltag>
     354        tags. These texts will be exported to a XML-file at the same time as the
     355        HTML-documentation is generated. The generated XML-file is compatible with the help
    356356        text importer in BASE2 and will be imported when running the update script or
    357357        installation script.
     
    369369      </note>
    370370      <para>
    371         Each tag requires two different attributes
     371        The tag supports the following attributes
    372372        <variablelist>
    373373          <varlistentry>
     
    377377            <listitem>
    378378              <para>
    379                 is used to identify and to find a help text in the web client.
    380                 BASE2's web client already has a several of IDs to help texts that
    381                 are defined, it could therefore be a good idea to have a look in the
     379                Is used to identify and to find a help text in the web client.
     380                BASE2's web client already has several IDs to help texts defined,
     381                it could therefore be a good idea to have a look in the
    382382                program to see if there already is an external id to use for the
    383383                particular help text.
     
    391391            <listitem>
    392392              <para>
    393                 is directly connected to the name/title property for a help text
     393                Is directly connected to the name/title property for a help text
    394394                item in BASE2.
     395              </para>
     396            </listitem>
     397          </varlistentry>
     398          <varlistentry>
     399            <term>
     400              <sgmltag class="attribute">webonly</sgmltag>
     401            </term>
     402            <listitem>
     403              <para>
     404                If set to a non-zero value, the contents of the tag
     405                will not be outputted in the HTML or PDF documentation.
     406                This is useful for minor functionality that is not
     407                important enough to be mentioned in the documentation but has
     408                a help icon in the web client.
    395409              </para>
    396410            </listitem>
Note: See TracChangeset for help on using the changeset viewer.