From e7303f61b44f03e139a2372a99e7df63e609686d Mon Sep 17 00:00:00 2001 From: =?utf8?q?G=C3=A1bor=20K=C3=B6vesd=C3=A1n?= Date: Thu, 23 Aug 2012 16:44:54 +0000 Subject: [PATCH] - Merge the content of the 6 README-alike files into 2 - Update content to reflect reality - Installing notes mostly cover catalogs, which is not applicable any more --- slides/AUTHORS | 2 - slides/BUGS | 4 -- slides/COPYING | 5 ++- slides/INSTALL | 96 --------------------------------------------- slides/README | 103 +++---------------------------------------------- slides/TODO | 4 -- 6 files changed, 8 insertions(+), 206 deletions(-) delete mode 100644 slides/AUTHORS delete mode 100644 slides/BUGS delete mode 100644 slides/INSTALL delete mode 100644 slides/TODO diff --git a/slides/AUTHORS b/slides/AUTHORS deleted file mode 100644 index ddfa70da2..000000000 --- a/slides/AUTHORS +++ /dev/null @@ -1,2 +0,0 @@ -DocBook Slides is maintained by Norman Walsh, , -and members of the DocBook Project, diff --git a/slides/BUGS b/slides/BUGS deleted file mode 100644 index 4b81b8ccf..000000000 --- a/slides/BUGS +++ /dev/null @@ -1,4 +0,0 @@ -For information about open DocBook Slides bugs, see the -following: - - http://sourceforge.net/tracker/?atid=397263&group_id=21935&func=browse diff --git a/slides/COPYING b/slides/COPYING index c28bbea2f..b7ceb2fe4 100644 --- a/slides/COPYING +++ b/slides/COPYING @@ -3,6 +3,7 @@ Copyright --------- Copyright (C) 1999-2005 Norman Walsh +Copyright (C) 2012 Gabor Kovesdan Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation @@ -43,5 +44,5 @@ OTHER DEALINGS IN THE SOFTWARE. Contacting the Author --------------------- -DocBook Slides is maintained by Norman Walsh, , -and members of the DocBook Project, +DocBook Slides is maintained by the members of the +DocBook Project, . diff --git a/slides/INSTALL b/slides/INSTALL deleted file mode 100644 index fea7bbdf4..000000000 --- a/slides/INSTALL +++ /dev/null @@ -1,96 +0,0 @@ -$Id$ - -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. diff --git a/slides/README b/slides/README index 6f3c8f6c1..0870eecf1 100644 --- a/slides/README +++ b/slides/README @@ -2,103 +2,10 @@ $Id$ README for the DocBook Slides distribution -For installation information, see the INSTALL file. This README -file provides some minimal documentation on authoring, validating, -and transforming Slides documents. +For a more detailed manual on Slides, please see the doc +directory. ----------------------------------------------------------------------- -Slides how-to and reference documentation ----------------------------------------------------------------------- -Some minimal how-to documentation on Slides is available at: +For information about open DocBook Slides bugs and +pending feature requests, see the following: - http://docbook.sourceforge.net/release/slides/current/doc/ - -Reference documentation on XSL stylesheet parameters is at: - - http://docbook.sourceforge.net/release/slides/current/doc/param.html - -The same documentation is also in the doc/ subdirectory in the -Slides distribution. - ----------------------------------------------------------------------- -Authoring and validating with DTDs (slides.dtd or slides-full.dtd) ----------------------------------------------------------------------- -To do DTD-driven authoring and validation of DocBook Slides -documents, add a DOCTYPE to your documents using either a PUBLIC -or SYSTEM ID with the appropriate URI for either the included -slides.dtd (based on Simplified DocBook) or slides-full.dtd -(based on full DocBook) DTD. - -For example: - - - -IMPORTANT: The example above may not be up-to-date. For the - current PUBLIC ID and URI see the actual slides.dtd - and slides-full.dtd files. - ----------------------------------------------------------------------- -Authoring with RELAX NG (slides.rnc and slides-full.rnc) ----------------------------------------------------------------------- -To do RNC-driven authoring of DocBook Slides content with a -"RELAX NG aware" XML editing application such as Emacs/nXML, -oXygen XML Editor, XMLBuddy, or Exchanger XML Editor, point your -editing application at the included slides.rnc (based on -Simplified DocBook) or slides-full.rnc (based on full DocBook) -schema files. - -Alternatively, if you are authoring with an editor such as -Emacs/nXML mode that supports schema "locating rules", use the -included locatingrules.xml file. It tells your editor to -automatically associate any documents whose root element is -"slides" (DocBook Slides documents), with (by default) the -slides.rnc schema. To have "slides" documents instead associated -with the slides-full.rnc, edit the locatingrules.xml file. - -To use the locating-rules.xml file with Emacs/nXML mode, either - - - do M-x customize-variable rng-schema-locating-files and then - add the absolute path to the locatingrules.xml file there - - OR - - - put the following into your .emacs file: - - (setq rng-schema-locating-files - (append - '("~/docbook-slides/locatingrules.xml"))) - - Of course, replace the ~/docbook-slides/locatingrules.xml - pathname with the appropriate location for your system. - ----------------------------------------------------------------------- -Validating with RELAX NG (slides.rnc and slides-full.rnc) ----------------------------------------------------------------------- -To validate Slides documents using RELAX NG, do either of the -following: - - 1. Use RNV[1]; for example: - - rnv ~/docbook-slides/slides.rnc foo.xml - - 2. Use the xmllint tool from libxml2[1]; for example: - - xmllint --noout --relaxng ~/docbook-slides/slides.rng foo.xml - - IMPORTANT: If you use xmllint, you need to validate against - the *.rng versions of the schemas, not the *.rnc - versions. - -[1] http://davidashen.net/rnv.html -[2] http://xmlsoft.org/ - ----------------------------------------------------------------------- -Transforming your Slides documents to HTML and PDF ----------------------------------------------------------------------- -See the documentation at: - - http://docbook.sourceforge.net/release/slides/current/doc/ - -The same documentation is also in the doc/ subdirectory in the -Slides distribution. + http://sourceforge.net/search/?group_artifact_id=373747&type_of_search=artifact&group_id=21935&words=slides diff --git a/slides/TODO b/slides/TODO deleted file mode 100644 index fc34e636b..000000000 --- a/slides/TODO +++ /dev/null @@ -1,4 +0,0 @@ -For information about pending DocBook Slides feature requests, -see the following: - - http://sourceforge.net/tracker/?func=browse&group_id=21935&atid=397263 -- 2.40.0