Changeset 3306

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.

Location:

trunk

Files:

• doc/src/docbook/developerdoc/write_docbook_doc.xml (modified) (3 diffs)
• lib/docbook/preprocess/dweiss-docbook-extensions.dtd (modified) (1 diff)
• lib/docbook/preprocess/webclient_helptext.xsl (modified) (1 diff)

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

@@ -427 +427 @@
       </example>
       
-      <para>
-        You can use <sgmltag>seeother</sgmltag> and <sgmltag>other</sgmltag>
-        to create links between different help texts. The <sgmltag>seeother</sgmltag>
+      <sect3 id="write_docbook_doc.begin.helptext.nohelp">
+        <title>Skip parts of a help text</title>
+        <para>
+          From time to time, it may happen that you find that
+          some parts of the text inside a <sgmltag class="starttag">helptext</sgmltag>
+          tag doesn't make sense. It may, for example, be a reference to
+          an image or an example, or a link to another chapter or
+          section. Put a <sgmltag class="starttag">nohelp</sgmltag>
+          tag around the problematic part to avoid it from beeing
+          outputted to the help texts.
+        </para>     
+        <programlisting>
+&lt;nohelp&gt;see &lt;xref linkend="chapter11" /&gt;&lt;/nohelp&gt;</programlisting>
+      </sect3>
+      
+      <sect3 id="write_docbook_doc.begin.helptext.link">
+      <title>Link to other help texts</title>
+      
+      <para>
+        You can use <sgmltag class="starttag">seeother</sgmltag> and 
+        <sgmltag class="starttag">other</sgmltag>
+        to create links between different help texts. The 
+        <sgmltag  class="starttag">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.
+        <sgmltag  class="starttag">other</sgmltag> tags. Each tag requires a single attribute.
       </para>
         <variablelist>
@@ -445 +465 @@
           </varlistentry>
         </variablelist>
-        
+      </sect3>
       
+      <sect3 id="write_docbook_doc.begin.helptext.import">
+      <title>Import help texts into BASE</title>
       <para>
         Import the generated XML-file manually by uploading it from the
@@ -466 +488 @@
 ./run.sh TestHelp
 </programlisting>
+      </sect3>
       
     </sect2>

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

@@ -36 +36 @@
 <!ATTLIST helptext webonly (0|1) "0">
 
+<!ELEMENT nohelp ANY>
+
 <!ELEMENT seeother (other*)>
 <!ELEMENT other (#PCDATA)>

trunk/lib/docbook/preprocess/webclient_helptext.xsl

@@ -65 +65 @@
   </xsl:template>
 
+  <!--  skip text marked with <nohelp> tag -->
+  <xsl:template match="nohelp">
+  </xsl:template>
+
   <xsl:template match="seeother">
     <h4>See also</h4>