You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by sl...@apache.org on 2003/06/12 21:50:42 UTC

cvs commit: httpd-2.0/docs/manual/style/latex directiveindex.xsl TODO common.xsl html.xsl latex.xsl

slive       2003/06/12 12:50:41

  Modified:    docs/manual/style/latex TODO common.xsl html.xsl latex.xsl
  Added:       docs/manual/style/latex directiveindex.xsl
  Log:
  LaTeX:
  
  - Add directive index.
  - Number the front-matter pages using roman numerals
  - Omit any <br/> that ends a block.
  - Improve the rendering of <indent> by using a
    list environment rather than a minipage.
  - Update the TODO list.
  
  Current draft at:
  http://www.apache.org/~slive/manual/
  
  Revision  Changes    Path
  1.6       +5 -1      httpd-2.0/docs/manual/style/latex/TODO
  
  Index: TODO
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/style/latex/TODO,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -d -b -u -r1.5 -r1.6
  --- TODO	12 Jun 2003 15:13:11 -0000	1.5
  +++ TODO	12 Jun 2003 19:50:41 -0000	1.6
  @@ -1,7 +1,6 @@
   Some things that need to be done with the LaTeX transforms:
   
   - Finish special pages:
  -  * directive index
     * quick reference
     * faq
     [This is a good job for someone who wants to get familiar with LaTeX,
  @@ -21,6 +20,11 @@
     In LaTeX, quotes should be like ``This''.  This may
     not be feasible for us, in which case we could simply replace
     " with \texttt{"} or something, so that the quotes are all straight.
  +
  +- Fix page references on "external" directives
  +  (<directivesynopsis location=...)
  +
  +- External URL references containing a "#" are broken.
   
   - Hundreds of other little problems with presentation, cross-referencing,
     etc.
  
  
  
  1.4       +4 -2      httpd-2.0/docs/manual/style/latex/common.xsl
  
  Index: common.xsl
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/style/latex/common.xsl,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -d -b -u -r1.3 -r1.4
  --- common.xsl	10 Jun 2003 18:29:05 -0000	1.3
  +++ common.xsl	12 Jun 2003 19:50:41 -0000	1.4
  @@ -82,9 +82,11 @@
   <!-- indentations                                                         -->
   <!-- ==================================================================== -->
   <xsl:template match="indent">
  -<xsl:text>\hfill\begin{minipage}{.9\textwidth}{\texttt </xsl:text>
  +<xsl:text>\begin{list}{}{\topsep 0pt\rightmargin 0pt\leftmargin 2em}
  +\item[] </xsl:text>
   <xsl:apply-templates/>
  -<xsl:text>}\end{minipage}</xsl:text>
  +<xsl:text>\end{list}
  +</xsl:text>
   </xsl:template>
   
   <!-- ==================================================================== -->
  
  
  
  1.6       +8 -2      httpd-2.0/docs/manual/style/latex/html.xsl
  
  Index: html.xsl
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/style/latex/html.xsl,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -d -b -u -r1.5 -r1.6
  --- html.xsl	12 Jun 2003 15:12:47 -0000	1.5
  +++ html.xsl	12 Jun 2003 19:50:41 -0000	1.6
  @@ -62,12 +62,18 @@
       <xsl:text>\smallskip </xsl:text>
     </xsl:when>
     <xsl:otherwise>
  +    <!-- Don't put a line break if we are the last thing -->
  +    <xsl:if test="not(position()=last()) and not(position()=last()-1 and normalize-space(following-sibling::node()[1])='')">
       <xsl:text>\\ </xsl:text>
  +    </xsl:if>
     </xsl:otherwise>
     </xsl:choose>
   </xsl:when>
   <xsl:otherwise>
  -<xsl:text>\\ </xsl:text>
  +    <!-- Don't put a line break if we are the last thing -->
  +    <xsl:if test="not(position()=last()) and not(position()=last()-1 and normalize-space(following-sibling::node()[1])='')">
  +      <xsl:text>\\ </xsl:text>
  +    </xsl:if>
   </xsl:otherwise>
   </xsl:choose>
   </xsl:template>
  
  
  
  1.5       +4 -1      httpd-2.0/docs/manual/style/latex/latex.xsl
  
  Index: latex.xsl
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/style/latex/latex.xsl,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -d -b -u -r1.4 -r1.5
  --- latex.xsl	12 Jun 2003 15:12:47 -0000	1.4
  +++ latex.xsl	12 Jun 2003 19:50:41 -0000	1.5
  @@ -17,6 +17,7 @@
   <xsl:include href="html.xsl" />
   <xsl:include href="synopsis.xsl" />
   <xsl:include href="moduleindex.xsl" />
  +<xsl:include href="directiveindex.xsl" />
   
   <xsl:template match="sitemap">
   <xsl:text>
  @@ -28,7 +29,7 @@
   
   % Let LaTeX be lenient about very-bad line wrapping.
   \tolerance=9999 
  -\emergencystretch=40pt
  +\emergencystretch=60pt
   
   % Keep paragraphs flush left (rather than the default of indenting
   % the first line) and put a space between paragraphs.
  @@ -53,8 +54,10 @@
   \date{\today}
   
   \begin{document}
  +\frontmatter
   \maketitle
   \tableofcontents
  +\mainmatter
   </xsl:text>
   
   <xsl:for-each select="category">
  
  
  
  1.1                  httpd-2.0/docs/manual/style/latex/directiveindex.xsl
  
  Index: directiveindex.xsl
  ===================================================================
  <?xml version="1.0"?><!--
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Apache" and "Apache Software Foundation" must
   *    not be used to endorse or promote products derived from this
   *    software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache",
   *    nor may "Apache" appear in their name, without prior written
   *    permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */ -->
  <xsl:stylesheet version="1.0"
                xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
                    xmlns="http://www.w3.org/1999/xhtml">
  
  <!-- ==================================================================== -->
  <!-- <directiveindex>                                                     -->
  <!-- Builds the directive index page                                      -->
  <!-- ==================================================================== -->
  <xsl:template match="directiveindex">
  
      <xsl:variable name="directives"
          select="document(modulefilelist/modulefile)
                  /modulesynopsis[status!='Obsolete']
                  /directivesynopsis[not(@location)]" />
  
  
    <xsl:variable name="metafile" select="document(/*/@metafile)/metafile" /> 
  
    <xsl:text>\section{</xsl:text><xsl:apply-templates select="title"/>
    <xsl:text>}</xsl:text>
    <xsl:text>\label{</xsl:text>
    <xsl:value-of select="$metafile/path"/>
    <xsl:value-of select="$metafile/basename"/>
    <xsl:text>}
  </xsl:text>
  
     <xsl:apply-templates select="summary" />
  
    <xsl:text>\begin{itemize}
  </xsl:text>
    <xsl:for-each select="$directives">
    <xsl:sort select="name" />
  
    <xsl:text>
  \item </xsl:text>
    <xsl:apply-templates select="name" mode="simple"/>
    <xsl:text> (p.\ \pageref{/mod/</xsl:text>
    <xsl:value-of select="../name"/><xsl:text>:</xsl:text>
    <xsl:value-of select="translate(name, $uppercase, $lowercase)"/>
    <xsl:text>})</xsl:text>
  </xsl:for-each>
  
    <xsl:text>\end{itemize}</xsl:text>
  
  </xsl:template>
  <!-- /directiveindex -->
  
  </xsl:stylesheet>