Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 SCons Project
Copyright The SCons Foundation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
# scons-docbook
docbook-xsl code and stylesheets for SCons
This repo holds the 'scons_docbook_xsl' package for SCons. It's an optional package that
contains the Docbook XSLT stylesheets for creating the documentation of an SCons release. It works
closely together with the "docbook" Tool and happened to be an integral part of its
directory for quite a while.

However, it was finally decided to move these files out of the main repo, because

* not every SCons user needs them, and
* some online tools would falsely recognize and list SCons as an XSLT project.
44 changes: 44 additions & 0 deletions scons_docbook_xsl/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# MIT License
#
# Copyright The SCons Foundation
#
# 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.
#
# 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 THE AUTHORS OR COPYRIGHT HOLDERS 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.

import pkg_resources

# Local folder for the collection of DocBook XSLs
db_xsl_folder = pkg_resources.resource_filename('scons_docbook_xsl', 'docbook-xsl-1.79.1')

# Local folder for the Docbook slides package
db_slides_folder = pkg_resources.resource_filename('scons_docbook_xsl', 'docbook-slides-3.4.0')


def getXslDir():
""" Return the path to the local installation
of the Docbook XSL stylesheets.
"""
return db_xsl_folder

def getSlidesDir():
""" Return the path to the local installation
of the Docbook slides stylesheets.
"""
return db_slides_folder

Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
########################################################################
# CatalogManager provides an interface to the catalog properties.
# Properties can come from two places: from system properties or
# from a CatalogManager.properties file. This class provides a
# transparent interface to both, with system properties preferred
# over property file values.

#######################################################################
# Catalog Files:
# The semicolon-delimited list of catalog files.
# Example: catalogs=/etc/xml/catalog;~/catalog.xml

catalogs=

#######################################################################
# Relative Catalogs:
# If false, relative catalog URIs are made absolute with respect to the
# base URI of the CatalogManager.properties file. This setting only
# applies to catalog URIs obtained from the catalogs property in the
# CatalogManager.properties file
# Example: relative-catalogs = [yes|no]

relative-catalogs=yes

#######################################################################
# Verbosity:
# If non-zero, the Catalog classes will print informative and debugging
# messages. The higher the number, the more messages.
# Example: verbosity = [0..99]

verbosity=2

#######################################################################
# Prefer:
# Which identifier is preferred, "public" or "system"?
# Example: xml.catalog.prefer = [public|system]

prefer=system

#######################################################################
# Static-catalog:
# Should a single catalog be constructed for all parsing, or should a
# different catalog be created for each parser?
# Example: static-catalog = [yes|no]

static-catalog=yes

#######################################################################
# Allow-oasis-xml-catalog-pi
# If the source document contains "oasis-xml-catalog" processing
# instructions, should they be used?
# Example: allow-oasis-xml-catalog-pi = [yes|no]

allow-oasis-xml-catalog-pi=yes

#######################################################################
# catalog-class-name
# If you're using the convenience classes
# org.apache.xml.resolver.tools.*, this setting allows you to specify
# an alternate class name to use for the underlying catalog.
# Example: catalog-class-name=org.apache.xml.resolver.Resolver
6 changes: 6 additions & 0 deletions scons_docbook_xsl/docbook-slides-3.4.0/.urilist
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
schema/dtd/slides.dtd http://docbook.sourceforge.net/release/slides/3.4/schema/dtd/slides.dtd
schema/dtd/slides-full.dtd http://docbook.sourceforge.net/release/slides/3.4/schema/dtd/slides-full.dtd
schema/dtd/slides.dtd http://docbook.sourceforge.net/release/slides/current/schema/dtd/slides.dtd
schema/dtd/slides-full.dtd http://docbook.sourceforge.net/release/slides/current/schema/dtd/slides-full.dtd
xsl/ http://docbook.sourceforge.net/release/slides/3.4.0/xsl/
xsl/ http://docbook.sourceforge.net/release/slides/current/xsl/
2 changes: 2 additions & 0 deletions scons_docbook_xsl/docbook-slides-3.4.0/AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
DocBook Slides is maintained by Norman Walsh, <ndw@nwalsh.com>,
and members of the DocBook Project, <docbook-developers@sf.net>
4 changes: 4 additions & 0 deletions scons_docbook_xsl/docbook-slides-3.4.0/BUGS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
For information about open DocBook Slides bugs, see the
following:

http://sourceforge.net/tracker/?atid=397263&group_id=21935&func=browse
47 changes: 47 additions & 0 deletions scons_docbook_xsl/docbook-slides-3.4.0/COPYING
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@

Copyright
---------

Copyright (C) 1999-2005 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
---------------------

DocBook Slides is maintained by Norman Walsh, <ndw@nwalsh.com>,
and members of the DocBook Project, <docbook-developers@sf.net>
96 changes: 96 additions & 0 deletions scons_docbook_xsl/docbook-slides-3.4.0/INSTALL
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
$Id: INSTALL,v 1.2 2005/04/27 14:29:51 xmldoc Exp $

INSTALL file for the DocBook Slides distribution

----------------------------------------------------------------------
Case #1: Installation using a package management system
----------------------------------------------------------------------
If you have installed the Slides distribution using "apt-get",
"yum", "urpmi", or some similar package-management front-end,
then, as part of the package installation, the Slides DTDs, Relax
NG schemas, and XSL stylesheets have already been automatically
installed in the appropriate locations for your system, and your
XML catalog environment was updated to use those locations.

However, note that this release also includes a locatingrules.xml
file to simplify authoring of Slides documents in Emacs/nXML.
There are not yet any cross-distro standards for handling
installation of locating-rules files. So, for specific
instructions about how to make use of the locatingrules.xml file
with your distro, see the distro-specific documentation installed
along with the package. For example, on a Debian system, check the
/usr/share/doc/docbook-slides/README.Debian.gz file.

----------------------------------------------------------------------
Case #2: Installing manually
----------------------------------------------------------------------
If you have downloaded a docbook-slides 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-slides-$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 Slides distribution. You are NOT REQUIRED
to complete these remaining steps. However, if you do not, and you
want to use XML catalogs with Slides, you will need to manually
update your XML catalog environment

3. Change to the docbook-slides-$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 Slides.

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
install.sh script before running the uninstall.sh script.


----------------------------------------------------------------------
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 Slides manually.

The catalog, catalog.xml, and locatingrules.xml file should be
packaged, and your package installation should automatically
update your system configuration to make use of them.

If your package doesn't automatically update your system Emacs
configuration to make use of the locatingrules.xml file, the
distro-specific documentation for your package should include
instructions explaining to users how to make use of the
locatingrules.xml file -- and/or the package installation should
emit a message with similar instructions during installation.
Loading