]> granicus.if.org Git - docbook-dsssl/commitdiff
Deleted wordml/README, template/README, and manpages/README, and
authorMichael Smith <xmldoc@users.sourceforge.net>
Tue, 12 Sep 2006 01:42:11 +0000 (01:42 +0000)
committerMichael Smith <xmldoc@users.sourceforge.net>
Tue, 12 Sep 2006 01:42:11 +0000 (01:42 +0000)
merged their contents into the main README file. Removed mention
of doc directory from main README and created doc/README,
doc/AUTHORS, and doc/COPYING files (because the doc distribution
is now packaged separately).

xsl/README
xsl/doc/AUTHORS [new file with mode: 0644]
xsl/doc/COPYING [new file with mode: 0644]
xsl/doc/README [new file with mode: 0644]
xsl/manpages/README [deleted file]
xsl/template/README [deleted file]
xsl/wordml/README [deleted file]

index bab86c82d0721ec10c7598fef5e67d827ba92b66..e31654d1f7aa1673be0d2e4cb4c849a29e313957 100644 (file)
@@ -41,39 +41,59 @@ of the following:
 
     /usr/share/xml/docbook/stylesheet/nwalsh/html/chunk.xsl
 
-To transform documents created with the standard DocBook schema/DTD
-(or DocBook NG schema/DTD, use one of the following stylesheets:
+To transform documents created with the standard DocBook
+schema/DTD, use one of the following stylesheets:
+
+  fo/docbook.xsl              - for XSL-FO
+  fo/profile-docbook.xsl      - for XSL-FO (single-pass profiled)
+
+  html/docbook.xsl            - for HTML (as a single file)
+  html/chunk.xsl              - for HTML (chunked into multiple files)
+  html/onechunk.xsl           - for HTML (chunked output in single file)
+  html/profile-*              - for HTML (single-pass profiled versions)
+
+  xhtml/*.xsl                 - for XHTML versions of the above
 
-  fo/docbook.xsl          - for XSL-FO
-  fo/profile-docbook.xsl  - for XSL-FO (single-pass profiled)
+  htmlhelp/htmlhelp.xsl       - for HTML Help
+  javahelp/javahelp.xsl       - for JavaHelp
+  eclipse/eclipse.xsl         - for Eclipse Help
 
-  html/docbook.xsl        - for HTML (as a single file)
-  html/chunk.xsl          - for HTML (chunked into multiple files)
-  html/onechunk.xsl       - for HTML (chunked output in single file)
-  html/profile-*          - for HTML (single-pass profiled versions)
+  manpages/docbook.xsl        - for groff/nroff man pages[1]
+  [1] more information at http://wiki.docbook.org/topic/ManPages
 
-  xhtml/*.xsl             - for XHTML versions of the above
+  wordml/docbook.xsl          - DocBook XML to WordML
+  wordml/docbook-pages.xsl    - DocBook XML to Pages index.xml
+  wordml/pages-normalise.xsl  - Pages index.xml to (1a)
 
-  htmlhelp/htmlhelp.xsl   - for HTML Help
-  javahelp/javahelp.xsl   - for JavaHelp
-  eclipse/eclipse.xsl     - for Eclipse Help
+To convert WordML into DocBook, use the following chain of stylesheets:
 
-  manpages/docbook.xsl    - for groff/nroff man pages
+  wordml/wordml-normalise.xsl - WordML to (1w)
+  wordml/wordml-sections.xsl  - (1a or 1w) to (2)
+  wordml/wordml-blocks.xsl    - (2) to (3)
+  wordml/wordml-final.xsl     - (3) to DocBook XML
 
 To transform documents created with the DocBook Slides schema/DTD,
 use one of the following stylesheets:
 
-  slides/html/*.xsl       - for HTML slides of various kinds
-  slides/xhtml/*.xsl      - for XHTML slides of various kinds
-  slides/fo/plain.xsl     - for XSL-FO slides
-  slides/htmlhelp/...     - for HTML Help slides
+  slides/html/*.xsl           - for HTML slides of various kinds
+  slides/xhtml/*.xsl          - for XHTML slides of various kinds
+  slides/fo/plain.xsl         - for XSL-FO slides
+  slides/htmlhelp/...         - for HTML Help slides
 
 To transform documents created with the DocBook Website
 schema/DTD, use one of the following stylesheets:
 
-  website/website.xsl     - for non-tabular, non-chunked output
-  website/tabular.xsl     - for tabular, non-chunked output
-  website/chunk-*         - for chunked output
+  website/website.xsl         - for non-tabular, non-chunked output
+  website/tabular.xsl         - for tabular, non-chunked output
+  website/chunk-*             - for chunked output
+
+To generate a titlepage customization layer from a titlepage spec:
+
+  template/titlepage.xsl
+
+For details about creating titlepage spec files and generating and
+using titlepage customization layers, see "DocBook XSL: The
+Complete Guide" <http://www.sagehill.net/docbookxsl/>
 
 ----------------------------------------------------------------------
 Manifest
@@ -90,24 +110,24 @@ VERSION       the current version number (note that this is an XSL stylesheet,
 NEWS          changes since the last public release (for a cumulative list of
               changes, see the ChangeHistory.xml file)
 
-common/       contains code common to both the HTML and FO stylesheets
-doc/          documentation
+common/       code used among several output formats (HTML, FO, manpages,...)
 docsrc/       documentation sources
-eclipse/      stylesheet that produces Eclipse Help
-extensions/   Java extensions
-fo/           stylesheets that produce XSL FO
-highlighting  files used for adding code syntax-highlighting in output
-html/         stylesheets that produce HTML
-htmlhelp/     stylesheets that produce HTML Help
-images/       images
-javahelp/     stylesheets that produce Java Help
-lib/          contains schema-independent functions
-manpages/     stylesheets for producing groff/nroff man pages
-profiling/    stylesheets for profiling (omitting/including conditional text)
-slides/       stylesheets for producing slides (from DocBook Slides source)
-template/     contains templates for building stylesheet customization layers
-website/      stylesheets for producing a website (from DocBook Website source)
-xhtml/        stylesheets that produce XHTML
+eclipse/      for producing Eclipse Help
+extensions/   Java XSLT extensions
+fo/           for producing XSL-FO
+highlighting  files used for adding source-code syntax highlighting in output
+html/         for producing HTML
+htmlhelp/     for producing HTML Help
+images/       images used in callouts and graphical admonitions
+javahelp/     for producing Java Help
+lib/          utility stylesheets with schema-independent functions
+manpages/     for producing groff/nroff man pages
+profiling/    for profiling (omitting/including conditional text)
+slides/       for producing slides output (from Slides source)
+template/     templates for building stylesheet customization layers
+website/      for producing website output (from Website source)
+wordml/       for "round trip" conversion between DocBook XML and WordML
+xhtml/        for producing XHTML
 
 ----------------------------------------------------------------------
 Changes
diff --git a/xsl/doc/AUTHORS b/xsl/doc/AUTHORS
new file mode 100644 (file)
index 0000000..635ae51
--- /dev/null
@@ -0,0 +1,3 @@
+The reference documentation for the DocBook XSL stylesheets is
+maintained by Norman Walsh, <ndw@nwalsh.com>, and members of the
+DocBook Project, <docbook-developers@sf.net>
diff --git a/xsl/doc/COPYING b/xsl/doc/COPYING
new file mode 100644 (file)
index 0000000..0061c27
--- /dev/null
@@ -0,0 +1,47 @@
+Copyright
+---------
+
+Copyright (C) 1999, 2000, 2001, 2002 Norman Walsh
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the ``Software''), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+Except as contained in this notice, the names of individuals
+credited with contribution to this software shall not be used in
+advertising or otherwise to promote the sale, use or other
+dealings in this Software without prior written authorization
+from the individuals in question.
+
+Any stylesheet derived from this Software that is publically
+distributed will be identified with a different name and the
+version strings in any derived Software will be changed so that
+no possibility of confusion between the derived package and this
+Software will exist.
+
+Warranty
+--------
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT.  IN NO EVENT SHALL NORMAN WALSH OR ANY OTHER
+CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+Contacting the Author
+---------------------
+
+The reference documentation for the DocBook XSL stylesheets is
+maintained by Norman Walsh, <ndw@nwalsh.com>, and members of the
+DocBook Project, <docbook-developers@sf.net>
diff --git a/xsl/doc/README b/xsl/doc/README
new file mode 100644 (file)
index 0000000..ddd9aeb
--- /dev/null
@@ -0,0 +1,34 @@
+----------------------------------------------------------------------
+  README file for the DocBook XSL Stylesheets reference documentation
+----------------------------------------------------------------------
+$Id$
+
+This is generated reference documentation for the DocBook XSL
+stylesheets, primarily documentation on the parameters you can
+adjust to control the behavior of the stylesheets.
+
+This is purely reference documentation, not how-to documentation.
+For a thorough step-by-step how-to guide to publishing content
+using the DocBook XSL stylesheets, see Bob Stayton's "DocBook XSL:
+The Complete Guide", available online at
+
+  http://www.sagehill.net/docbookxsl/
+
+----------------------------------------------------------------------
+Manifest
+----------------------------------------------------------------------
+AUTHORS            - contact information
+COPYING            - copyright, license, and warranty information
+README             - this file
+copyright.html     - copyright and license information (HTML)
+index.html         - documentation start page
+reference.html     - documentation start page (same as index.html)
+reference.pdf.gz   - documentation in PDF form (gzipped)
+reference.txt.gz   - documentation in plain-text form (gzipped)
+warranty.html      - warranty information (HTML)and 
+
+The subdirectories all contain documentation on individual DocBook
+XSL stylesheets parameters, in HTML form. You don't need to access
+the subdirectories directly, because the content in all the
+subdirectories is accessible through the index.html (and
+reference.html) start page.
diff --git a/xsl/manpages/README b/xsl/manpages/README
deleted file mode 100644 (file)
index fb44afd..0000000
+++ /dev/null
@@ -1,73 +0,0 @@
-$Id$
-
------------------------------------------------------------------
-Notes
------------------------------------------------------------------
-
-Here are some minimal details (contributed by Barry Rountree)
-about the behavior of the manpages stylesheets.
-
-  The first <refname> found is used to create the
-  file name of the man page.
-
-  The contents of <refentrytitle> are converted to
-  ALL CAPS and used, with <manvolnum>, to decorate the
-  bottom right and top corners of the page.
-
-  Any <indexterm> is not used in man-page output.
-
-  In order to document two or more items using the
-  same page, add additional refnames to <refnamediv>.
-  Each addtiona. refname will generate a small file
-  that points to (via the magic of *roff)
-
-    man[manvolnum]/[primaryRefname].gz
-
-More detailed how-to information about processing DocBook XML
-documents for man-page output will be available in the future.
-Somewhere. Written by someone...
-
------------------------------------------------------------------
-A short history of the DocBook manpages stylesheets
------------------------------------------------------------------
-
-October 2001 - September 2002: "The Silver Age"
-  Martijn van Beers <lotr@users.sourceforge.net> contributes XSL
-  stylesheets[1] for converting DocBook documents to *roff man pages,
-  and maintains them in the [cvs]/docbook/contrib/xsl/db2man area
-  of the project source-code repository, with frequent application
-  of patches from Tim Waugh <twaugh@users.sourceforge.net>.
-
-  [1] http://sourceforge.net/tracker/download.php?group_id=21935&atid=373749&file_id=11659&aid=468779
-      http://docbook.sourceforge.net/archive/db2man.tar.gz
-
-September 2002 - March 2003: "The Joe Orton Era"
-  The man-pages stylesheets are moved to [cvs]/docbook/xsl/manpages
-  and become a standard part of all subsequent DocBook XSL
-  Stylesheets releases. Joe Orton <jorton@users.sourceforge.net>
-  takes over manpages maintenance; more patches from Tim Waugh.
-
-March 2003 - May 2005: "Tim Waugh At the Helm"
-  Tim Waugh, eventually realizing that the possibility exists to
-  commit changes to to a source-code repository *directly*, joins
-  the project and takes over manpages maintenance, making a lot of
-  fixes and refinements.
-
-May 2005 - present: "Journey Into Mystery"
-  A sense of apprehension and uncertainty sets in as the
-  least-skilled and most frequently inebriated member of the
-  project takes over manpages maintenance.
-
------------------------------------------------------------------
-Original circa 2001 README contributed by Martijn van Beers
------------------------------------------------------------------
-
-README for db2man by Martijn van Beers (lotr@users.sourceforge.net)
-
-I've been working on some stylesheets to convert <refentry>s to man
-format. I thought I'd submit what I have for inclusion in the
-docbook-xsl package.
-
-See also:
-
-  http://sourceforge.net/tracker/index.php?func=detail&aid=468779&group_id=21935&atid=373749
diff --git a/xsl/template/README b/xsl/template/README
deleted file mode 100644 (file)
index a84d084..0000000
+++ /dev/null
@@ -1,15 +0,0 @@
-This directory contains rudimentary support for the notion of
-stylesheet templates.
-
-The idea is that if you want to change the behavior of the
-stylesheets, for example, processing different bibliography
-elements, you will construct a tempate document that describes
-what you want and then process that template with the "template"
-stylesheet.
-
-The result of this processing will be a customization layer for
-the DocBook XSL Stylesheets that does what you want. This
-removes the stylesheet customizer from the burdon of figuring
-out how the stylesheets work and modifying them.
-
-In theory, anyway...
\ No newline at end of file
diff --git a/xsl/wordml/README b/xsl/wordml/README
deleted file mode 100644 (file)
index ed8a972..0000000
+++ /dev/null
@@ -1,13 +0,0 @@
-       DocBook to/from WordML
-
-       Steve Ball, Bob Stayton
-
-docbook.xsl            Accepts DocBook XML and produces WordML
-docbook-pages.xsl      Accepts DocBook XML and produces a Pages index.xml
-pages-normalise.xsl    Accepts Pages index.xml and produces (1a)
-wordml-normalise.xsl   Accepts WordML and produces (1w)
-wordml-sections.xsl    Accepts (1a or 1w) and produces (2)
-wordml-blocks.xsl      Accepts (2) and produces (3)
-wordml-final.xsl       Accepts (3) and produces DocBook XML
-
-wordml-*.xsl form a chain of XSL stylesheets to convert WordML into DocBook.