Changeset 3305

Timestamp:

May 8, 2007, 1:57:25 PM (16 years ago)

Author:

Nicklas Nordborg

Message:

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

Location:

trunk

Files:

• doc/src/docbook/developerdoc/write_docbook_doc.xml (modified) (4 diffs)
• lib/docbook/custom-styles/docbook/plain/xsl/customized.chunked.xsl (modified) (1 diff)
• lib/docbook/custom-styles/docbook/plain/xsl/customized.pdf-fop.xsl (modified) (1 diff)
• lib/docbook/preprocess/dweiss-docbook-extensions.dtd (modified) (1 diff)

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

@@ -351 +351 @@
         The parts of the text that also should be used as help texts in the web must be
         inside
-        <sgmltag>helptext</sgmltag>
-        tags.These texts will be exported to a XML-file at the same time as the
-        HTML-documentation is generated.The generated XML-file is compatible with the help
+        <sgmltag class="starttag">helptext</sgmltag>
+        tags. These texts will be exported to a XML-file at the same time as the
+        HTML-documentation is generated. The generated XML-file is compatible with the help
         text importer in BASE2 and will be imported when running the update script or
         installation script.
@@ -369 +369 @@
       </note>
       <para>
-        Each tag requires two different attributes
+        The tag supports the following attributes
         <variablelist>
           <varlistentry>
@@ -377 +377 @@
             <listitem>
               <para>
-                is used to identify and to find a help text in the web client.
-                BASE2's web client already has a several of IDs to help texts that
-                are defined, it could therefore be a good idea to have a look in the
+                Is used to identify and to find a help text in the web client.
+                BASE2's web client already has several IDs to help texts defined, 
+                it could therefore be a good idea to have a look in the
                 program to see if there already is an external id to use for the
                 particular help text.
@@ -391 +391 @@
             <listitem>
               <para>
-                is directly connected to the name/title property for a help text
+                Is directly connected to the name/title property for a help text
                 item in BASE2.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>
+              <sgmltag class="attribute">webonly</sgmltag>
+            </term>
+            <listitem>
+              <para>
+                If set to a non-zero value, the contents of the tag
+                will not be outputted in the HTML or PDF documentation. 
+                This is useful for minor functionality that is not 
+                important enough to be mentioned in the documentation but has
+                a help icon in the web client.
               </para>
             </listitem>

trunk/lib/docbook/custom-styles/docbook/plain/xsl/customized.chunked.xsl

@@ -118 +118 @@
 
 <xsl:template match="helptext">
-  <xsl:apply-templates />
+  <xsl:choose>
+    <xsl:when test="@webonly = '0'">  
+      <xsl:apply-templates />
+    </xsl:when>
+  </xsl:choose>
 </xsl:template>
 

trunk/lib/docbook/custom-styles/docbook/plain/xsl/customized.pdf-fop.xsl

@@ -29 +29 @@
 
 <xsl:template match="helptext">
-  <xsl:apply-templates />
+  <xsl:choose>
+    <xsl:when test="@webonly = '0'">  
+      <xsl:apply-templates />
+    </xsl:when>
+  </xsl:choose>
 </xsl:template>
 

trunk/lib/docbook/preprocess/dweiss-docbook-extensions.dtd

@@ -34 +34 @@
 <!ATTLIST helptext external_id CDATA #REQUIRED>
 <!ATTLIST helptext title CDATA #REQUIRED>
+<!ATTLIST helptext webonly (0|1) "0">
 
 <!ELEMENT seeother (other*)>