Debian Codegraph @

README

raw
1 $Id: README,v 1.3 2005/04/27 15:37:37 xmldoc Exp $
2
3 README for the DocBook Slides distribution
4
5 For installation information, see the INSTALL file. This README
6 file provides some minimal documentation on authoring, validating,
7 and transforming Slides documents.
8
9 ----------------------------------------------------------------------
10 Slides how-to and reference documentation
11 ----------------------------------------------------------------------
12 Some minimal how-to documentation on Slides is available at:
13
14 http://docbook.sourceforge.net/release/slides/current/doc/
15
16 Reference documentation on XSL stylesheet parameters is at:
17
18 http://docbook.sourceforge.net/release/slides/current/doc/param.html
19
20 The same documentation is also in the doc/ subdirectory in the
21 Slides distribution.
22
23 ----------------------------------------------------------------------
24 Authoring and validating with DTDs (slides.dtd or slides-full.dtd)
25 ----------------------------------------------------------------------
26 To do DTD-driven authoring and validation of DocBook Slides
27 documents, add a DOCTYPE to your documents using either a PUBLIC
28 or SYSTEM ID with the appropriate URI for either the included
29 slides.dtd (based on Simplified DocBook) or slides-full.dtd
30 (based on full DocBook) DTD.
31
32 For example:
33
34 <!DOCTYPE slides PUBLIC "-//Norman Walsh//DTD Slides V3.4//EN"
35 "http://docbook.sourceforge.net/release/slides/3.4/schema/dtd/slides.dtd">
36
37 IMPORTANT: The example above may not be up-to-date. For the
38 current PUBLIC ID and URI see the actual slides.dtd
39 and slides-full.dtd files.
40
41 ----------------------------------------------------------------------
42 Authoring with RELAX NG (slides.rnc and slides-full.rnc)
43 ----------------------------------------------------------------------
44 To do RNC-driven authoring of DocBook Slides content with a
45 "RELAX NG aware" XML editing application such as Emacs/nXML,
46 oXygen XML Editor, XMLBuddy, or Exchanger XML Editor, point your
47 editing application at the included slides.rnc (based on
48 Simplified DocBook) or slides-full.rnc (based on full DocBook)
49 schema files.
50
51 Alternatively, if you are authoring with an editor such as
52 Emacs/nXML mode that supports schema "locating rules", use the
53 included locatingrules.xml file. It tells your editor to
54 automatically associate any documents whose root element is
55 "slides" (DocBook Slides documents), with (by default) the
56 slides.rnc schema. To have "slides" documents instead associated
57 with the slides-full.rnc, edit the locatingrules.xml file.
58
59 To use the locating-rules.xml file with Emacs/nXML mode, either
60
61 - do M-x customize-variable rng-schema-locating-files and then
62 add the absolute path to the locatingrules.xml file there
63
64 OR
65
66 - put the following into your .emacs file:
67
68 (setq rng-schema-locating-files
69 (append
70 '("~/docbook-slides/locatingrules.xml")))
71
72 Of course, replace the ~/docbook-slides/locatingrules.xml
73 pathname with the appropriate location for your system.
74
75 ----------------------------------------------------------------------
76 Validating with RELAX NG (slides.rnc and slides-full.rnc)
77 ----------------------------------------------------------------------
78 To validate Slides documents using RELAX NG, do either of the
79 following:
80
81 1. Use RNV[1]; for example:
82
83 rnv ~/docbook-slides/slides.rnc foo.xml
84
85 2. Use the xmllint tool from libxml2[1]; for example:
86
87 xmllint --noout --relaxng ~/docbook-slides/slides.rng foo.xml
88
89 IMPORTANT: If you use xmllint, you need to validate against
90 the *.rng versions of the schemas, not the *.rnc
91 versions.
92
93 [1] http://davidashen.net/rnv.html
94 [2] http://xmlsoft.org/
95
96 ----------------------------------------------------------------------
97 Transforming your Slides documents to HTML and PDF
98 ----------------------------------------------------------------------
99 See the documentation at:
100
101 http://docbook.sourceforge.net/release/slides/current/doc/
102
103 The same documentation is also in the doc/ subdirectory in the
104 Slides distribution.