Prepared WebHelp reference documentation :)

Not clear about parameters brandname and branding: Should they renamed
to "webhelp.branding" and "webhelp.brandname"?
Currently, docsrc/reference.xml contains only a comment for the WebHelp
ref doc to be non-intrusive.
Idea is to enable it when it is ready

diff --git a/xsl/docsrc/reference.xml b/xsl/docsrc/reference.xml
index f52cfdb4e69300324e0baf2f767a489bb1309645..d250848f0cafdc9a3325a44c75da4c8756884b0e 100644 (file)
--- a/xsl/docsrc/reference.xml
+++ b/xsl/docsrc/reference.xml
@@ -146,7 +146,18 @@
       </partintro>
       <xi:include href="../website/param.xml" xpointer="xpointer(/book/reference)" />
     </part>
+   <!-- Prepare WebHelp output
+    <part xml:id="webhelp">
+      <?dbhtml dir="webhelp"?>
+      <?dbhtml filename="index.html"?>
+      <xi:include href="../webhelp/param.xml" xpointer="xpointer(/book/info/title)" />
+      <partintro xml:id="webhelpintro">
+        <xi:include href="../webhelp/param.xml" xpointer="xpointer(/book/info/abstract/node())" />
+      </partintro>
+      <xi:include href="../webhelp/param.xml" xpointer="xpointer(/book/reference)" />
+    </part>
   </book>
+  -->
   <book xml:id="pi"><title>DocBook XSL Stylesheets User Reference: PIs</title>
     <?dbhtml dir="pi"?>
     <?dbhtml filename="index.html"?>

diff --git a/xsl/params/webhelp.autolabel.xml b/xsl/params/webhelp.autolabel.xml
new file mode 100644 (file)
index 0000000..dee426f
--- /dev/null
+++ b/xsl/params/webhelp.autolabel.xml
@@ -0,0 +1,25 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="autolayout-file">
+<refmeta>
+<refentrytitle>webhelp.autolabel</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname></refname>
+<refpurpose></refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="webhelp.autolabel.frag">
+<xsl:param name="webhelp.autolabel">0</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+<para></para>
+</refsection>
+</refentry>

diff --git a/xsl/params/webhelp.base.dir.xml b/xsl/params/webhelp.base.dir.xml
new file mode 100644 (file)
index 0000000..a0e4979
--- /dev/null
+++ b/xsl/params/webhelp.base.dir.xml
@@ -0,0 +1,25 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="autolayout-file">
+<refmeta>
+<refentrytitle>webhelp.base.dir</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>webhelp.base.dir</refname>
+<refpurpose></refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="webhelp.base.dir.frag">
+<xsl:param name="webhelp.base.dir">docs</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+<para></para>
+</refsection>
+</refentry>

diff --git a/xsl/params/webhelp.common.dir.xml b/xsl/params/webhelp.common.dir.xml
new file mode 100644 (file)
index 0000000..ec84006
--- /dev/null
+++ b/xsl/params/webhelp.common.dir.xml
@@ -0,0 +1,25 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="autolayout-file">
+<refmeta>
+<refentrytitle>webhelp.common.dir</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>webhelp.common.dir</refname>
+<refpurpose></refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="webhelp.common.dir.frag">
+<xsl:param name="webhelp.common.dir">../common/</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+<para></para>
+</refsection>
+</refentry>

diff --git a/xsl/params/webhelp.default.topic.xml b/xsl/params/webhelp.default.topic.xml
new file mode 100644 (file)
index 0000000..4fa089a
--- /dev/null
+++ b/xsl/params/webhelp.default.topic.xml
@@ -0,0 +1,25 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="autolayout-file">
+<refmeta>
+<refentrytitle>webhelp.default.topic</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>webhelp.default.topic</refname>
+<refpurpose></refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="webhelp.default.topic.frag">
+<xsl:param name="webhelp.default.topic">index.html</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+<para></para>
+</refsection>
+</refentry>

diff --git a/xsl/params/webhelp.include.search.tab.xml b/xsl/params/webhelp.include.search.tab.xml
new file mode 100644 (file)
index 0000000..7e4dd73
--- /dev/null
+++ b/xsl/params/webhelp.include.search.tab.xml
@@ -0,0 +1,25 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="autolayout-file">
+<refmeta>
+<refentrytitle>webhelp.include.search.tab</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>webhelp.include.search.tab</refname>
+<refpurpose></refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="webhelp.include.search.tab.frag">
+<xsl:param name="webhelp.include.search.tab">true</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+<para></para>
+</refsection>
+</refentry>

diff --git a/xsl/params/webhelp.indexer.language.xml b/xsl/params/webhelp.indexer.language.xml
new file mode 100644 (file)
index 0000000..5067904
--- /dev/null
+++ b/xsl/params/webhelp.indexer.language.xml
@@ -0,0 +1,25 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="autolayout-file">
+<refmeta>
+<refentrytitle>webhelp.indexer.language</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype"></refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>webhelp.indexer.language</refname>
+<refpurpose></refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="webhelp.indexer.language.frag">
+<xsl:param name="webhelp.indexer.language">en</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+<para></para>
+</refsection>
+</refentry>

diff --git a/xsl/params/webhelp.start.filename.xml b/xsl/params/webhelp.start.filename.xml
new file mode 100644 (file)
index 0000000..93618b7
--- /dev/null
+++ b/xsl/params/webhelp.start.filename.xml
@@ -0,0 +1,25 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="autolayout-file">
+<refmeta>
+<refentrytitle>webhelp.start.filename</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>webhelp.start.filename</refname>
+<refpurpose></refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="webhelp.start.filename.frag">
+<xsl:param name="webhelp.start.filename">index.html</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+<para></para>
+</refsection>
+</refentry>

diff --git a/xsl/params/webhelp.tree.cookie.id.xml b/xsl/params/webhelp.tree.cookie.id.xml
new file mode 100644 (file)
index 0000000..9af1926
--- /dev/null
+++ b/xsl/params/webhelp.tree.cookie.id.xml
@@ -0,0 +1,25 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="autolayout-file">
+<refmeta>
+<refentrytitle>webhelp.tree.cookie.id</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>webhelp.tree.cookie.id</refname>
+<refpurpose></refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="webhelp.tree.cookie.id.frag">
+<xsl:param name="webhelp.tree.cookie.id" select="concat( 'treeview-', count(//node()) )"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+<para></para>
+</refsection>
+</refentry>

diff --git a/xsl/webhelp/param.ent b/xsl/webhelp/param.ent
new file mode 100644 (file)
index 0000000..eb6e1a1
--- /dev/null
+++ b/xsl/webhelp/param.ent
@@ -0,0 +1,11 @@
+<!ENTITY webhelp.include.search.tab SYSTEM "../params/webhelp.include.search.tab.xml">
+<!ENTITY webhelp.start.filename SYSTEM "../params/webhelp.start.filename.xml">
+<!ENTITY webhelp.base.dir SYSTEM "../params/webhelp.base.dir.xml">
+<!ENTITY webhelp.common.dir SYSTEM "../params/webhelp.common.dir.xml">
+<!ENTITY webhelp.tree.cookie.id SYSTEM "../params/webhelp.tree.cookie.id.xml">
+<!ENTITY webhelp.indexer.language SYSTEM "../params/webhelp.indexer.language.xml">
+<!ENTITY webhelp.default.topic SYSTEM "../params/webhelp.default.topic.xml">
+<!ENTITY webhelp.autolabel SYSTEM "../params/webhelp.autolabel.xml">
+<!ENTITY branding SYSTEM "../params/webhelp.branding.xml">
+<!ENTITY brandname SYSTEM "../params/webhelp.brandname.xml">
+

diff --git a/xsl/webhelp/param.xweb b/xsl/webhelp/param.xweb
new file mode 100644 (file)
index 0000000..b01c3bb
--- /dev/null
+++ b/xsl/webhelp/param.xweb
@@ -0,0 +1,77 @@
+<!DOCTYPE book [
+<!ENTITY % param.ent SYSTEM "param.ent">
+%param.ent;
+]>
+
+<book xmlns="http://docbook.org/ns/docbook" version="5.0"
+   xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+   xmlns:xlink="http://www.w3.org/1999/xlink">
+   <info>
+      <title>WebHelp Parameter Reference</title>
+      <releaseinfo role="meta"> $Id: $ </releaseinfo>
+      <authorgroup>
+         <author>
+            <personname>
+               <surname>Kasun</surname>
+               <firstname>Gajasinghe</firstname>
+            </personname>
+            <email>kasunbg AT gmail DOT com</email>
+         </author>
+         <author>
+            <personname>
+               <surname>David</surname>
+               <firstname>Cramer</firstname>
+            </personname>
+            <email>david AT thingbag DOT net</email>
+         </author>
+      </authorgroup>
+
+      
+      <abstract>
+         <para>This is reference documentation for all user-configurable
+            parameters in the DocBook XSL WebHelp stylesheet (for
+            generating websites from DocBook XML sources). Note that the
+            WebHelp stylesheet is a customization layer of the DocBook
+            XSL (X)HTML stylesheet. Therefore, in addition to the
+            WebHelp-specific parameters listed in this section, you can
+            also use a number of <link xlink:href="../html/">(X)HTML
+               stylesheet parameters</link> to control WebHelp
+            output.</para>
+      </abstract>
+   </info>
+   <reference xml:id="webhelp.general">
+      <title>General Parameters</title>
+      &webhelp.include.search.tab;
+   </reference>
+   
+   <appendix xml:id="stylesheet">
+      <title>The Stylesheet</title>
+
+      <para>The <filename>param.xsl</filename> stylesheet is just a
+         wrapper around all these parameters.</para>
+
+      <src:fragment xml:id="top" mundane-result-prefixes="xsl">
+
+         <!-- This file is generated from param.xweb -->
+         <xsl:stylesheet exclude-result-prefixes="src" version="1.0">
+
+            <src:fragref linkend="webhelp.include.search.tab.frag"/>
+            <src:fragref linkend="webhelp.start.filename.frag"/>
+            <src:fragref linkend="webhelp.base.dir.frag"/>
+            <src:fragref linkend="webhelp.common.dir.frag"/>
+            <src:fragref linkend="webhelp.tree.cookie.id.frag"/>
+            <src:fragref linkend="webhelp.indexer.language.frag"/>
+            <src:fragref linkend="webhelp.default.topic.frag"/>
+            <src:fragref linkend="webhelp.autolabel.frag"/>
+            <!-- FIXME:
+               What about brandname and branding? Shouldn't they
+               better renamed to webhelp.brandname and webhelp.branding?
+            <src:fragref linkend="webhelp.branding.frag"/>
+            <src:fragref linkend="webhelp.brandname.frag"/>
+            -->
+         </xsl:stylesheet>
+      </src:fragment>
+
+   </appendix>
+</book>