INSTALL #1

  • //
  • guest/
  • paul_allen/
  • p4convert-maven/
  • docs/
  • docbook-xsl-ns-1.78.1/
  • INSTALL
  • View
  • Commits
  • Open Download .zip Download (3 KB)
$Id: INSTALL 6145 2006-08-06 13:13:03Z xmldoc $

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 stylesheets have
already been automatically installed in the appropriate location
for your system, and your XML catalog environment has probably
been 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.

     To instead run it non-interactively without being prompted
     for confirmation of the changes it makes, invoke it with the
     "--batch" switch, like this:

       ./install.sh --batch

     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 the stylesheets.

  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.

  5. (UNINSTALLING) If/when you want to uninstall the release,
     execute the uninstall.sh script.

       ./uninstall.sh

     To instead run it non-interactively without being prompted
     for confirmation of the changes it makes, invoke it with the
     "--batch" switch, like this:

       ./uninstall.sh --batch

     NOTE: The uninstall.sh file is not created until the install.sh
           file is run for the first time.


----------------------------------------------------------------------
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 the stylesheets manually.

The catalog.xml file should be packaged.
# Change User Description Committed
#1 13895 Paul Allen Copying using p4convert-docbook
//guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/INSTALL
#1 12728 eedwards Upgrade ANT doc build infrastructure to assemble PDFs:

- remove non-namespaced DocBook source and add
  namespaced DocBook source.

- add Apache FOP 1.1

- copy fonts, images, XSL into _build, establishing new
  asset structure. The original structure remains until
  all guides using it can be upgraded, and several other
  issues can be resolved.

- updated build.xml to allow for per-target build properties.

- upgraded the P4SAG to use the new infrastructure.

- tweaked admonition presentation in PDFs to remove
  admonition graphics, and resemble closely the
  presentation used in the new HTML layout, including
  the same colors.

With these changes, building PDFs involves using a
shell, navigating into the guide's directory (just P4SAG
for now), and executing "ant pdf".

Issues still to be resolved:

- PDF generation encounters several warnings about
  missing fonts (bold versions of Symbol and ZapfDingbats),
  and a couple of locations where the page content
  exceeds the defined content area.

- Due to issues within Apache FOP, PDF generation emits
  a substantial amount of output that is not easily suppressed
  without losing important warning information.

- Apache FOP's interface to ANT does not expose a way
  to set the font base directory. The current configuration does
  work under Mac OSX, but further testing on Windows will
  need to be done to determine if the relative paths defined
  continue to work. The workaround is for Windows users to
  customize the fop-config.xml to provide absolute system
  paths to the required fonts.

- HTML generation needs further browser testing, and
  exhibits broken navigation on iOS browsers within the
  TOC sidebar.

- A number of PDF and HTML presentation tweaks still
  need to be made, for example: sidebars, gui* DocBook
  tags, whitespace, section separation, etc.