File: README

package info (click to toggle)
docbook-doc 30d10-3
  • links: PTS
  • area: main
  • in suites: hamm, slink
  • size: 10,104 kB
  • ctags: 2
  • sloc: makefile: 34
file content (110 lines) | stat: -rw-r--r-- 4,077 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
This file describes the layout of the documentation for version 1.0 of
the documentation for DocBook V3.0.

MANIFEST
========

README		The file you're reading now
figures.ent	Entity declarations for the figures
global.ent	Entity declarations for "global" text

figs/		Figures for the overview and user's guide

user/		User's Guide for the DocBook DTD
user00.sgm	Preface
user01.sgm	Chapter 1: Document Hierarchies
user02.sgm	Chapter 2: Object Content in Documents
user03.sgm	Chapter 3: Inline Content in Documents
user04.sgm	Chapter 4: Elements for Nonlinear Relationships
user05.sgm	Chapter 5: Miscellaneous Elements
userbook.sgm	book driver
usercont.sgm	book content
usermeta.sgm	book meta

over/		Overview of the DocBook DTD
over00.sgm	Preface
over01.sgm	Chapter 1: DocBook Introduction and Background
over02.sgm	Chapter 2: Understanding, Using, and Maintaining DocBook
over03.sgm	Chapter 3: DocBook Changes Made and Planned
overbook.sgm	book driver
overcont.sgm	book content
overmeta.sgm	book meta information

ref/		Reference for the DocBook DTD
ref.ent		Entity declarations for the reference pages (see below)
refelemu.ent	Entity declarations for the element reference pages
refelemx.ent	Entity declarations for the element reference pages (expanded)
refpentu.ent	Entity declarations for the element reference pages
refpentx.ent	Entity declarations for the element reference pages (expanded)
ref00.sgm	Preface
refbook.sgm	book driver
refcont.sgm	book content
refmeta.sgm	book meta
refpages.sgm	reference pages driver

refpages/       RefEntry pages for the elements and parameter entities 

maint/		Customizer's Guide for the DocBook DTD
mnt00.sgm	Preface
mnt01.sgm	Chapter 1: Building Variant DTDs Based on DocBook
mntbook.sgm	book driver
mntcont.sgm	book content
mntmeta.sgm	book meta information

set/		The DocBook Users Manual Set
set.sgm		set driver
setmeta.sgm	set meta


PARSING THE FILES
=================

To process an individual book, setup your environment so that the
DocBook 3.0 DTD is accessible and process the *book.sgm file in the
appropriate directory.  To process the entire set, process set.sgm in
the set directory.


PARAMETER ENTITIES FOR THE REFERENCE MANUAL
===========================================

The reference manual can be presented in several ways.  The desired 
presentation is selected with the following parameter entities used in
marked sections in the documentation:

dbre.elements		Marked section: INCLUDE or IGNORE reference pages
			for the elements of the DocBook DTD.

dbre.entities		Marked section: INCLUDE or IGNORE reference pages
			for the parameter entities of the DocBook DTD.  
			(Documentation is provided for meny, but not all
			of the parameter entities.)

The reference pages are available in two flavors: with parameter
entities fully expanded or with parameter entities unexpanded (as they
appear in the DTD).

dbre.expanded           Marked sections: include the expanded or unexpanded
dbre.unexpanded		pages.  These parameter entites are mutually 
			exclusive, you mus set one to INCLUDE and the other
			to IGNORE.

dbre.ms.refmeta                   INCLUDE RefMeta section?
dbre.ms.refsynopsisdiv            INCLUDE RefSynopsisDiv section?
dbre.ms.refsynopsisdiv.incl       INCLUDE Inclusions?
dbre.ms.refsynopsisdiv.excl       INCLUDE Exclusions? 
dbre.ms.refsynopsisdiv.attr       INCLUDE Attribute summary?
dbre.ms.refsynopsisdiv.pe         INCLUDE Parameter Entity list?
dbre.ms.refsynopsisdiv.tagmin     INCLUDE Tag Minimization?
dbre.ms.description               INCLUDE Description section?
dbre.ms.description.parents       INCLUDE list of parents?
dbre.ms.description.children      INCLUDE list of children?
dbre.ms.attrdesc                  INCLUDE Attribute descriptions
dbre.ms.examples                  INCLUDE Examples?

Note: it is an error to turn off all of the sections at the same time
(dbre.ms.description, dbre.ms.attributes, and dbre.ms.example) since
an invalid RefEntry results.

Note also: the parameter entity list (dbre.ms.refsynopsisdiv.pe) occurs
only in the unexpanded pages.