couchbase-git-scribe 0.1.1.1

data/docbook-xsl/manpages/ChangeLog.20020917

@@ -0,0 +1,195 @@
+Note: This changelog is a record of descriptions of all changes
+made to the DocBook XSL manpages stylesheets during the time when
+they were maintained in their original home in the
+[cvs]/docbook/contrib/xsl/db2man area of the DocBook Project
+source-code repository at Sourceforge; that is, from October 2001
+(when they were contributed to the project by Martijn van Beers)
+until September 2002 (when they were moved to the
+[cvs]/docbook/xsl/manpages area and became a standard part of all
+subsequent DocBook XSL Stylesheets releases).
+
+2002-09-17  Norman Walsh <nwalsh@users.sourceforge.net>
+
+	* README, db2man.xsl, lists.xsl, sect23.xsl, synop.xsl, xref.xsl: 
+	Moved to docbook/xsl/manpages
+
+	* db2man.xsl, synop.xsl: Patch from Joe Orton
+
+2002-06-16  <lotr@users.sourceforge.net>
+
+	* db2man.xsl: commit patch sent by Joe Orton:
+	
+	  This patch adds support for using the productname, date and title out of
+	  a <referenceinfo> if one is present, rather than having to add each of
+	  these individually for every refentry.
+
+	* db2man.xsl: Tim Waugh sent:
+	
+	  This patch normalizes space in each refname before displaying it in
+	  the name section.
+
+2002-05-21  <lotr@users.sourceforge.net>
+
+	* xref.xsl: from Joe Orton:
+	this patch allows cross-referencing to a specific refname.  I
+	need this since I'm documenting several different (but related)
+	functions per refentry, and want to cross-reference them individually,
+	rather than just by the title used for the refentry as a whole.
+
+2002-05-17  <lotr@users.sourceforge.net>
+
+	* lists.xsl: apply glosslist support patch from twaugh
+
+2002-05-15  <lotr@users.sourceforge.net>
+
+	* db2man.xsl: slightly sanitize the filenames we generate. again from twaugh
+
+	* db2man.xsl: Apply twaugh's fix for making the entity transform stuff work
+
+2002-05-14  <lotr@users.sourceforge.net>
+
+	* db2man.xsl: generalize the tip template for all admonitions
+	(caution,important,note,tip,warning)
+
+	* db2man.xsl: Apply Joe Orton's <tip> patch, modified to be indented. Also show "Tip"
+	in the title.
+	
+	so if <tip><title>foo</title></tip>, you get
+	      Tip: foo
+
+	* synop.xsl: rewrote funcprototype. It used to convert all its children to a single
+	string and the split it up again through recursion. Now has a nice
+	foreach loop for the paramdefs, which seems much cleaner than throwing
+	everything in a big string before processing it.
+
+2002-05-10  <lotr@users.sourceforge.net>
+
+	* db2man.xsl: add support for simpara
+
+	* db2man.xsl, lists.xsl: fix refsect2 titles
+
+	* synop.xsl: also from twaugh:
+	
+	I found some input that goes wrong with the synop.xsl we have in CVS:
+	
+	<group choice="opt">
+	  <arg>-o <replaceable>FILE</replaceable></arg>
+	  <arg>--output=<replaceable>FILE</replaceable></arg>
+	</group>
+	
+	It gets rendered as (with *bold* and _italic_):
+	
+	[*-o FILE* | *--output=FILE*]
+	
+	The desired markup should look like:
+	The following macro does the trick:
+	
+	[\fB-o \fIFILE\fR\fR | \fB--output=\fIFILE\fR\fR]
+	
+	The trouble is that the named template 'bold' uses value-of, and so
+	strips <replaceable> of its significance.
+	
+	Another thing I found is that the arg/replaceable template is
+	superfluous altogether: db2man.xsl has a 'replaceable' template which
+	does the same thing.
+	
+	Here is a patch to make those two modifications.
+	
+	NOTE TO SELF: must try to fix bold template so we can use it everywhere
+
+2002-05-09  <lotr@users.sourceforge.net>
+
+	* db2man.xsl: oops, removed too much
+
+	* db2man.xsl: remove stuff that's apparently left-over from sect23.xsl
+
+	* db2man.xsl, lists.xsl, synop.xsl: batch of patches from twaugh:
+	* This patch (based on one from Jirka Kosek) adds support for
+	  block-level elements inside <para>s---<screen>s for example, or lists.
+	* This patch replaces entities (like '&#x8212;') with sensible
+	  characters or groups of characters.
+	* This patch adds support for sbr.
+	* This patch normalizes spaces in varlistentry terms.
+	* This patch normalizes spaces in terminal varlistentry terms.
+	* This patch allows variable lists to be nested (once).
+	* This patch prevents variable list item paragraphs from merging into
+	  one another.
+	* This patch improves the rendering of itemized lists, and adds support
+	  for ordered lists and procedures.
+	* This patch makes some small adjustments to group/arg: don't put extra
+	  spaces in where they aren't needed, and normalize the space of $arg.
+	* This patch makes adjustments to cmdsynopsis elements.  In particular,
+	  they can now be wrapped if no <sbr/> is provided.
+	* This patch adds funcsynopsis//* support.  Again, wrapping is done
+	  automatically.
+
+	* synop.xsl: make synopsises work for --arg=foo <arg>s too
+
+	* synop.xsl: remove unneccesary adding of whitespace for arg/replaceable
+
+2002-05-01  <lotr@users.sourceforge.net>
+
+	* db2man.xsl: This patch adds support for multiple refnames.
+	
+	(another twaugh patch)
+
+	* db2man.xsl: modified ulink patch from twaugh. Be nice to content-less ulinks. But we
+	don't accomodate silly people who don't understand ulink and put the
+	url as the content too.
+
+	* db2man.xsl, synop.xsl: db2man.xsl:
+	  * temporarily add some params that chunker.xsl needs
+	  * fix bold/italic templates
+	  * update calls to bold/italic templates for new syntax
+	synop.xsl:
+	  * add support for synopfragment
+	  * update calls to bold/italic templates for new syntax
+
+2002-04-30  <lotr@users.sourceforge.net>
+
+	* db2man.xsl: Add twaug's patch for xref support
+
+	* db2man.xsl: This patch adds support for:
+	
+	- Multiple authors.
+	- A (single) man page editor.
+	
+	(another patch from twaugh)
+
+	* db2man.xsl: more twaugh patches:
+	- Use refentrytitle, not refname[1], for title.
+	- Upper-case it.
+	- Use date, productname, and title.
+	- Pick up author from main document if not contained in refentry.
+	- Use refname[1] for man page filename, not refentrytitle.
+
+	* db2man.xsl: add varname support
+
+	* db2man.xsl: This patch makes userinput (an inline element) have inline formatting.
+
+	* db2man.xsl: This patch adds support for the top-level document being something
+	other than an article.
+	
+	It also emits a helpful warning if no refentry elements are found.
+
+	* db2man.xsl: next twaugh patch:
+	  Instead of writing to stdout, create a file for each
+	  refentry.  Plus, for bonus points, a file for each additional refname
+	  within that entry (pointing to the main page).
+
+	* db2man.xsl: Add named templates for bold-ifying and italicizing stuff. Inspired
+	by yet another twaugh patch
+
+	* db2man.xsl, lists.xsl, sect23.xsl: consistently use &#10; instead of a newline
+
+	* db2man.xsl, synop.xsl: * add support for informalexample, screen, errorcode, constant, type,
+	  quote, programlisting and citerefentry
+	* use the 'bold' and 'italic' named templates
+
+	* xref.xsl: New file.
+
+2001-12-01  Norman Walsh <nwalsh@users.sourceforge.net>
+
+	* README, db2man.xsl, lists.xsl, sect23.xsl, synop.xsl: 
+	New file.
+

data/docbook-xsl/manpages/block.xsl

@@ -0,0 +1,393 @@
+<?xml version='1.0'?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+                xmlns:exsl="http://exslt.org/common"
+                exclude-result-prefixes="exsl"
+                version='1.0'>
+
+<!-- ********************************************************************
+     $Id: block.xsl 7960 2008-03-29 01:37:08Z xmldoc $
+     ********************************************************************
+
+     This file is part of the XSL DocBook Stylesheet distribution.
+     See ../README or http://docbook.sf.net/release/xsl/current/ for
+     copyright and other information.
+
+     ******************************************************************** -->
+
+<!-- ==================================================================== -->
+
+<xsl:template match="caution|important|note|tip|warning">
+  <xsl:call-template name="roff-if-start">
+    <xsl:with-param name="condition">n</xsl:with-param>
+  </xsl:call-template>
+  <xsl:text>.sp&#10;</xsl:text>
+  <xsl:call-template name="roff-if-end"/>
+  <xsl:text>.RS 4&#10;</xsl:text>
+  <xsl:text>.BM yellow&#10;</xsl:text>
+  <xsl:call-template name="pinch.together"/>
+  <xsl:text>.ps +1&#10;</xsl:text>
+  <xsl:call-template name="make.bold.title"/>
+  <xsl:text>.ps -1&#10;</xsl:text>
+  <xsl:text>.br&#10;</xsl:text>
+  <xsl:apply-templates/>
+  <xsl:text>.sp .5v&#10;</xsl:text>
+  <xsl:text>.EM yellow&#10;</xsl:text>
+  <xsl:text>.RE&#10;</xsl:text>
+</xsl:template> 
+
+<xsl:template match="formalpara">
+  <xsl:variable name="title.wrapper">
+    <xsl:value-of select="normalize-space(title[1])"/>
+  </xsl:variable>
+  <xsl:text>.PP&#10;</xsl:text>
+  <!-- * don't put linebreak after head; instead render it as a "run in" -->
+  <!-- * head, that is, inline, with a period and space following it -->
+  <xsl:call-template name="bold">
+    <xsl:with-param name="node" select="exsl:node-set($title.wrapper)"/>
+    <xsl:with-param name="context" select="."/>
+  </xsl:call-template>
+  <xsl:text>. </xsl:text>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="formalpara/para">
+  <xsl:call-template name="mixed-block"/>
+  <xsl:text>&#10;</xsl:text>
+</xsl:template>
+
+<xsl:template match="para">
+  <!-- * FIXME: Need to extract the ancestor::footnote, etc. checking and -->
+  <!-- * move to named template so that we can call it from templates for -->
+  <!-- * other block elements also -->
+  <xsl:choose>
+    <!-- * If a para is a descendant of a footnote, etc., then indent it -->
+    <!-- * (unless it is the first child, in which case don't generate -->
+    <!-- * anything at all to mark its start). -->
+    <!-- * FIXME: *blurb checking should not be munged in here the way -->
+    <!-- * it currently is; this probably breaks blurb indenting. -->
+    <xsl:when test="ancestor::footnote or
+                    ancestor::annotation or
+                    ancestor::authorblurb or
+                    ancestor::personblurb or
+                    ancestor::callout">
+      <xsl:if test="preceding-sibling::*[not(name() ='')]">
+        <xsl:text>.sp</xsl:text>
+        <xsl:text>&#10;</xsl:text>
+        <xsl:text>.RS 4n</xsl:text>
+        <xsl:text>&#10;</xsl:text>
+      </xsl:if>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:text>.PP</xsl:text>
+      <xsl:text>&#10;</xsl:text>
+    </xsl:otherwise>
+  </xsl:choose>
+  <xsl:call-template name="mixed-block"/>
+    <xsl:if test="ancestor::footnote or
+                  ancestor::annotation or
+                  ancestor::authorblurb or
+                  ancestor::personblurb">
+      <xsl:if test="preceding-sibling::*[not(name() ='')]">
+        <xsl:text>&#10;</xsl:text>
+        <xsl:text>.RE</xsl:text>
+        <xsl:text>&#10;</xsl:text>
+      </xsl:if>
+    </xsl:if>
+  <xsl:text>&#10;</xsl:text>
+</xsl:template>
+
+<xsl:template match="simpara">
+  <xsl:if test="not(ancestor::authorblurb)
+    and not(ancestor::personblurb)
+    and not(ancestor::callout)"
+    >
+    <xsl:text>.sp&#10;</xsl:text>
+  </xsl:if>
+  <xsl:variable name="content">
+    <xsl:apply-templates/>
+  </xsl:variable>
+  <xsl:value-of select="normalize-space($content)"/>
+  <xsl:text>&#10;</xsl:text>
+</xsl:template>
+
+<!-- ==================================================================== -->
+
+<!-- * Yes, address, synopsis, and funcsynopsisinfo are verbatim environments. -->
+<xsl:template match="literallayout|programlisting|screen|
+                     address|synopsis|funcsynopsisinfo">
+  <xsl:param name="indent">
+    <!-- * Only indent this verbatim if $man.indent.verbatims is -->
+    <!-- * non-zero and it is not a child of a *synopsis element or a -->
+    <!-- * descendant of a refsynopsisdiv -->
+    <xsl:if test="not($man.indent.verbatims = 0)
+      and not(substring(local-name(..),
+      string-length(local-name(..))-7) = 'synopsis')
+      and not(ancestor::*[local-name() = 'refsynopsisdiv'])
+      ">
+      <xsl:text>Yes</xsl:text>
+    </xsl:if>
+  </xsl:param>
+
+  <!-- * if this verbatim environment starts with a newline/linebreak -->
+  <!-- * (that is, if there is a linebreak after the opening tag), that -->
+  <!-- * break would otherwise show up in output; that does not seem to -->
+  <!-- * be what most users would expect, so we check to see if it does -->
+  <!-- * indeed start with a leading newline. if so, later in this -->
+  <!-- * template, we adjust for the leading new line by doing some -->
+  <!-- * monkeyshines with "sp -1" vertical spacing -->
+  <xsl:variable name="adjust-for-leading-newline">
+    <xsl:if test="substring(., 1, 1) = '&#10;'">Yes</xsl:if>
+  </xsl:variable>
+
+  <xsl:choose>
+    <!-- * Check to see if this verbatim item is within a parent element that -->
+    <!-- * allows mixed content. -->
+    <!-- * -->
+    <!-- * If it is within a mixed-content parent, then a line space is -->
+    <!-- * already added before it by the mixed-block template, so we don't -->
+    <!-- * need to add one here. -->
+    <!-- * -->
+    <!-- * If it is not within a mixed-content parent, then we need to add a -->
+    <!-- * line space before it. -->
+    <xsl:when test="parent::caption|parent::entry|parent::para|
+                    parent::td|parent::th" /> <!-- do nothing -->
+    <xsl:otherwise>
+      <xsl:text>&#10;</xsl:text>
+      <xsl:text>.sp&#10;</xsl:text>
+    </xsl:otherwise>
+  </xsl:choose>
+  <xsl:if test="$indent = 'Yes'">
+    <!-- * start indented section -->
+    <xsl:call-template name="roff-if-start"/>
+    <!-- * only indent in TTY output, not in non-TTY/PS -->
+    <xsl:text>.RS</xsl:text> 
+    <xsl:if test="not($man.indent.width = '')">
+      <xsl:text> </xsl:text>
+      <xsl:value-of select="$man.indent.width"/>
+    </xsl:if>
+    <xsl:text>&#10;</xsl:text>
+    <xsl:call-template name="roff-if-end"/>
+  </xsl:if>
+  <xsl:choose>
+    <xsl:when test="self::funcsynopsisinfo">
+      <!-- * All Funcsynopsisinfo content is by default rendered in bold, -->
+      <!-- * because the man(7) man page says this: -->
+      <!-- * -->
+      <!-- *   For functions, the arguments are always specified using -->
+      <!-- *   italics, even in the SYNOPSIS section, where the rest of -->
+      <!-- *   the function is specified in bold -->
+      <!-- * -->
+      <!-- * Look through the contents of the man/man2 and man3 directories -->
+      <!-- * on your system, and you'll see that most existing pages do follow -->
+      <!-- * this "bold everything in function synopsis" rule. -->
+      <!-- * -->
+      <!-- * Users who don't want the bold output can choose to adjust the -->
+      <!-- * man.font.funcsynopsisinfo parameter on their own. So even if you -->
+      <!-- * don't personally like the way it looks, please don't change the -->
+      <!-- * default to be non-bold - because it's a convention that's -->
+      <!-- * followed is the vast majority of existing man pages that document -->
+      <!-- * functions, and we need to follow it by default, like it or no. -->
+      <xsl:text>.ft </xsl:text>
+      <xsl:value-of select="$man.font.funcsynopsisinfo"/>
+      <xsl:text>&#10;</xsl:text>
+      <xsl:call-template name="verbatim-block-start"/>
+      <xsl:text>.nf&#10;</xsl:text>
+      <xsl:apply-templates/>
+      <xsl:text>&#10;</xsl:text>
+      <xsl:text>.fi&#10;</xsl:text>
+      <xsl:call-template name="verbatim-block-end"/>
+      <xsl:text>.ft&#10;</xsl:text>
+    </xsl:when>
+    <xsl:otherwise>
+      <!-- * Other verbatims do not need to get bolded -->
+      <xsl:call-template name="verbatim-block-start"/>
+      <xsl:text>.nf&#10;</xsl:text>
+      <xsl:choose>
+        <xsl:when test="self::literallayout|self::programlisting|self::screen
+          and not(ancestor::*[local-name() = 'refsynopsisdiv'])
+          ">
+          <!-- * if this is a literallayout|programlisting|screen, then -->
+          <!-- * we put a background behind it in non-TTY output; except -->
+          <!-- * if it’s a descendant of a refsynopsisdiv (as can be -->
+          <!-- * found in the git docs) -->
+          <xsl:choose>
+            <!-- * if content has a leading newline, we need to back up -->
+            <!-- * one line vertically to get it boxed correctly -->
+            <xsl:when test="not($adjust-for-leading-newline = '')">
+              <xsl:call-template name="roff-if-start">
+                <xsl:with-param name="condition">t</xsl:with-param>
+              </xsl:call-template>
+              <xsl:text>.sp -1&#10;</xsl:text>
+              <xsl:call-template name="roff-if-end"/>
+              <xsl:text>.BB lightgray</xsl:text>
+              <xsl:text> </xsl:text>
+              <xsl:text>adjust-for-leading-newline&#10;</xsl:text>
+              <!-- * in non-TTY output, for the case where we have a -->
+              <!-- * leading newline, we need to also back up one line -->
+              <!-- * vertically inside the background box -->
+              <xsl:text>.sp -1&#10;</xsl:text>
+            </xsl:when>
+            <xsl:otherwise>
+              <xsl:text>.BB lightgray&#10;</xsl:text>
+            </xsl:otherwise>
+          </xsl:choose>
+          <xsl:apply-templates/>
+          <xsl:text>&#10;</xsl:text>
+          <xsl:choose>
+            <xsl:when test="not($adjust-for-leading-newline = '')">
+              <xsl:text>.EB lightgray</xsl:text>
+              <xsl:text> </xsl:text>
+              <xsl:text>adjust-for-leading-newline&#10;</xsl:text>
+              <xsl:call-template name="roff-if-start">
+                <xsl:with-param name="condition">t</xsl:with-param>
+              </xsl:call-template>
+              <!-- * in non-TTY output, for the case where we have a -->
+              <!-- * leading newline, we need to add back at the end of -->
+              <!-- * the content some of the vertical space we chopped -->
+              <!-- * off at the beginning -->
+              <xsl:text>.sp 1&#10;</xsl:text>
+              <xsl:call-template name="roff-if-end"/>
+            </xsl:when>
+            <xsl:otherwise>
+              <xsl:text>.EB lightgray&#10;</xsl:text>
+            </xsl:otherwise>
+          </xsl:choose>
+        </xsl:when>
+        <xsl:otherwise>
+          <!-- * otherwise this is not a literallayout|programlisting|screen, -->
+          <!-- * so we don’t put a background behind -->
+          <xsl:apply-templates/>
+          <xsl:text>&#10;</xsl:text>
+        </xsl:otherwise>
+      </xsl:choose>
+      <xsl:text>.fi&#10;</xsl:text>
+      <xsl:call-template name="verbatim-block-end"/>
+    </xsl:otherwise>
+  </xsl:choose>
+  <xsl:if test="$indent = 'Yes'">
+    <!-- * end indented section -->
+    <xsl:call-template name="roff-if-start"/>
+    <xsl:text>.RE&#10;</xsl:text> 
+    <xsl:call-template name="roff-if-end"/>
+  </xsl:if>
+  <!-- * if this verbatim environment has a following sibling node, -->
+  <!-- * output a line of space to separate the content -->
+  <xsl:if test="following-sibling::text()
+    |following-sibling::para
+    |following-sibling::simpara">
+    <xsl:text>.sp&#10;</xsl:text>
+  </xsl:if>
+</xsl:template>
+
+<!-- ==================================================================== -->
+
+<xsl:template match="table|informaltable">
+  <xsl:apply-templates select="." mode="to.tbl">
+    <!--* we call the to.tbl mode with the "source" param so that we can -->
+    <!--* preserve the context information and pass it down to the -->
+    <!--* named templates that do the actual table processing -->
+    <xsl:with-param name="source" select="ancestor::refentry/refnamediv[1]/refname[1]"/>
+  </xsl:apply-templates>
+</xsl:template>
+
+<!-- ==================================================================== -->
+
+<xsl:template match="informalexample">
+  <xsl:apply-templates/>
+</xsl:template>
+
+<!-- ==================================================================== -->
+
+<xsl:template match="figure|example">
+  <xsl:variable name="param.placement"
+                select="substring-after(normalize-space($formal.title.placement),
+                        concat(local-name(.), ' '))"/>
+
+  <xsl:variable name="placement">
+    <xsl:choose>
+      <xsl:when test="contains($param.placement, ' ')">
+        <xsl:value-of select="substring-before($param.placement, ' ')"/>
+      </xsl:when>
+      <xsl:when test="$param.placement = ''">before</xsl:when>
+      <xsl:otherwise>
+        <xsl:value-of select="$param.placement"/>
+      </xsl:otherwise>
+    </xsl:choose>
+  </xsl:variable>
+
+  <xsl:text>.PP&#10;</xsl:text>
+  <xsl:call-template name="formal.object">
+    <xsl:with-param name="placement" select="$placement"/>
+  </xsl:call-template>
+  <xsl:text>&#10;</xsl:text>
+</xsl:template>
+
+<!-- ==================================================================== -->
+
+<xsl:template match="mediaobject">
+  <xsl:text>.sp</xsl:text>
+  <xsl:text>&#10;</xsl:text>
+  <xsl:text>.RS</xsl:text> 
+  <xsl:if test="not($list-indent = '')">
+    <xsl:text> </xsl:text>
+    <xsl:value-of select="$list-indent"/>
+  </xsl:if>
+  <xsl:text>&#10;</xsl:text>
+  <xsl:apply-templates/>
+  <xsl:text>&#10;</xsl:text>
+  <xsl:text>.RE&#10;</xsl:text>
+</xsl:template>
+
+<xsl:template match="imageobject">
+  <xsl:text>[IMAGE]</xsl:text>
+  <xsl:apply-templates/>
+  <xsl:text>&#10;</xsl:text>
+</xsl:template>
+
+<xsl:template match="textobject[parent::inlinemediaobject]">
+  <xsl:text>[</xsl:text>
+  <xsl:value-of select="."/>
+  <xsl:text>]</xsl:text>
+</xsl:template>
+
+<xsl:template match="textobject">
+  <xsl:apply-templates/>
+</xsl:template>
+
+<!-- ==================================================================== -->
+
+<xsl:template name="formal.object">
+  <xsl:param name="placement" select="'before'"/>
+  <xsl:param name="class" select="local-name(.)"/>
+
+  <xsl:choose>
+    <xsl:when test="$placement = 'before'">
+      <xsl:call-template name="formal.object.heading"/>
+      <xsl:apply-templates/>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:apply-templates/>
+      <xsl:call-template name="formal.object.heading"/>
+    </xsl:otherwise>
+  </xsl:choose>
+</xsl:template>
+
+<xsl:template name="formal.object.heading">
+  <xsl:param name="object" select="."/>
+  <xsl:param name="title">
+    <xsl:apply-templates select="$object" mode="object.title.markup.textonly"/>
+  </xsl:param>
+  <xsl:call-template name="bold">
+    <xsl:with-param name="node" select="exsl:node-set($title)"/>
+    <xsl:with-param name="context" select="."/>
+  </xsl:call-template>
+
+  <xsl:text>&#10;</xsl:text>
+</xsl:template>
+
+<!-- ==================================================================== -->
+
+<!-- * suppress abstract -->
+<xsl:template match="abstract"/>
+
+</xsl:stylesheet>