WhatsNew
RELEASE-NOTES.html
RELEASE-NOTES.txt
-INSTALL
catalog.xml
+.CatalogManager.properties.example
+NEWS
+install.sh
--- /dev/null
+The DocBook XSL stylesheets are maintained by Norman Walsh,
+<ndw@nwalsh.com>, and members of the DocBook Project,
+<docbook-developers@sf.net>
--- /dev/null
+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
+---------------------
+
+These stylesheets are maintained by Norman Walsh, <ndw@nwalsh.com>.
-#!/bin/bash
-# $Id$
-
-# To "install" this release, execute this INSTALL file by running
-# the following command:
-#
-# sh INSTALL
-#
-# That creates a 'catalog.xml' file in the current directory and
-# generates some further instructions.
-
-# code starts here
-if [ ! "$(xmlcatalog)" ]; then
- cat <<- EOF
-
-$0: Error: Failed to find 'xmlcatalog' command. Stopping.
-
-You must have libxml2 and its associated 'xmlcatalog' utility
-on your system in order to create and use an XML catalog for this
-release. For more information about libxml2, see:
-
- http://xmlsoft.org/
-EOF
- exit 1
-fi
-
-CATALOG=catalog.xml
-URI=http://docbook.sourceforge.net/release/xsl/current/
-DIR=`pwd`
-rm -f $CATALOG
-xmlcatalog --noout --create $CATALOG || exit 1
-xmlcatalog --noout --add rewriteURI $URI $DIR/ $CATALOG || exit 1
-xmlcatalog --noout --add rewriteSystem $URI $DIR/ $CATALOG || exit 1
-xmlcatalog --noout --add delegateURI $URI $DIR/$CATALOG $DIR/$CATALOG || exit 1
-xmlcatalog --noout --add delegateSystem $URI $DIR/$CATALOG $DIR/$CATALOG || exit 1
-
-if [ -n "$XML_CATALOG_FILES" ]; then
- # if $XML_CATALOG_FILES already contains the filename for the
- # catalog we are creating, remove that filename
- if [ "$XML_CATALOG_FILES"//$DIR\/$CATALOG// != "$XML_CATALOG_FILES" ]; then
- export XML_CATALOG_FILES="`echo $XML_CATALOG_FILES | sed "s#$DIR/$CATALOG *##"`";
- fi
-else
- XML_CATALOG_FILES=/etc/xml/catalog
-fi
-
-JAVA_CATALOGS=`echo $XML_CATALOG_FILES | tr " " ";"`
-
-cat <<- EOF
-
- 1. Now edit either your ~/.bash_profile or ~/.cshrc file so it
- sets the XML_CATALOG_FILES environment variable to include
- $DIR/$CATALOG as its first item; example:
-
- # set XML_CATALOG_FILES for bash/ksh shell
- export XML_CATALOG_FILES="$DIR/$CATALOG $XML_CATALOG_FILES"
-
- IMPORTANT: Separate filenames in XML_CATALOG_FILES with spaces
-
- 2. If you have a CatalogManager.properties file, change the
- "catalogs=" line in that file to something like:
-
- catalogs=$DIR/$CATALOG;$JAVA_CATALOGS
-
- IMPORTANT: In that file, separate filenames with a SEMICOLON.
- Also, make sure that your Java CLASSPATH contains the pathname
- to the _directory_ containing CatalogManager.properties file.
-
- 3. If you're using a stylesheet customization layer, make sure
- that it references the canonical URI for the DocBook
- stylesheets; for example, use an xsl:import like this:
-
- <xsl:import href="${URI}html/chunk.xsl"/>
-EOF
+$Id$
+
+INSTALL file for the DocBook XSL stylesheets distribution
+
+----------------------------------------------------------------------
+Case #1: Installation using a package management system
+----------------------------------------------------------------------
+If you have installed the DocBook XSL distribution using "apt-get",
+"yum", "urpmi", or some similar package-management front-end,
+then, as part of the package installation, the XSL stylesheets
+have already been automatically installed in the appropriate
+location for your system, and your XML catalog environment was
+updated to use that location.
+
+----------------------------------------------------------------------
+Case #2: Installing manually
+----------------------------------------------------------------------
+If you have downloaded a docbook-xsl zip, tar.gz, or tar.bz2
+file, use the following steps to install it.
+
+ 1. Move the zip, tar.gz, or tar.bz2 file to the directory where
+ you'd like to install it (not to a temporary directory).
+
+ 2. unzip or untar/uncompress the file
+
+ That will create a docbook-xsl-$VERSION directory (where
+ $VERSION is the version number for the release).
+
+The remaining steps are all OPTIONAL. They are intended to
+automatically update your user environment with XML Catalog
+information about the DocBook XSL distribution. You are NOT
+REQUIRED to complete these remaining steps. However, if you do
+not, and you want to use XML catalogs with the DocBook XSL
+stylesheets, you will need to manually update your XML catalog
+environment
+
+ 3. Change to the docbook-xsl-$VERSION directory and execute the
+ install.sh script:
+
+ ./install.sh
+
+ That will launch an interactive installer, which will emit a
+ series of prompts for you to respond to. After the process is
+ complete, the installer will emit a message with a command
+ you need to run in order to source your environment for use
+ with Website.
+
+ 4. To test that he installation has updated your environment
+ correctly, execute the test.sh script:
+
+ ./test.sh
+
+ That will test your XML catalog environment, using both the
+ xmlcatalog application and the Apache XML Commons Resolver.
+
+ NOTE: The test.sh file is not created until the install.sh
+ file is run for the first time. So you need to run the
+ install.sh script before running the test.sh script.
+
+ 5. (UNINSTALLING) If/when you want to uninstall the release,
+ execute the uninstall.sh script.
+
+ ./uninstall.sh
+
+ That will revert all changes made by the install.sh script.
+
+ NOTE: The uninstall.sh file is not created until the install.sh
+ file is run for the first time. So you need to run the
+
+
+----------------------------------------------------------------------
+Note to packagers
+----------------------------------------------------------------------
+The install.sh, .CatalogManager.properties.example, and .urilist
+files should not be packaged. They are useful only to users who
+are installing Website manually.
+
+The catalog.xml file should be packaged.
Manifest
--------
+AUTHORS contact information
BUGS about known problems
-INSTALL executable script for generating a catalog.xml file
+COPYING copyright information
+INSTALL installation instructions
README this file
RELEASE* per-release cumulative summaries of user-visible changes
TODO about planned features not yet implemented
VERSION the current version number (note that this is an XSL stylesheet,
included by both fo/docbook.xsl and html/docbook.xsl)
-WhatsNew changes since the last public release (for cumulative lists of
+NEWS changes since the last public release (for cumulative lists of
changes, see the ChangeLog files in each subdirectory)
common/ contains code common to both the HTML and FO stylesheets
doc/ documentation
See the ChangeLog in each subdirectory for cumulative lists of all changes.
-See WhatsNew for changes since the last release.
+See the NEWS file for changes made since the previous release.
See the RELEASE-NOTES.html or RELEASE-NOTES.txt file for per-release
cumulative summaries of significant user-visible changes.
Installation
------------
-Unpack the distribution somewhere. Run the INSTALL script and follow the
-instructions it generates.
+See the INSTALL file for information about installing this release.
Use
---
eclipse/eclipse.xsl - for Eclipse Help
htmlhelp/htmlhelp.xsl - for HTML Help
javahelp/javahelp.xsl - for JavaHelp
-
-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
----------------------
-
-These stylesheets are maintained by Norman Walsh, <ndw@nwalsh.com>.
projects / docbook-dsssl / commitdiff