$Id$
Walsh
Norman
19992000
Norman Walsh
Common Template Reference
Introduction
This is technical reference documentation for the DocBook XSL
Stylesheets; it documents (some of) the parameters, templates, and
other elements of the stylesheets.
This is not intended to be user
documentation.
It is provided for developers writing customization layers for the
stylesheets, and for anyone who's interested in how it
works
.
Although I am trying to be thorough, this documentation is known
to be incomplete. Don't forget to read the source, too :-)
Tests if a given node is a component-level element
This template returns '1' if the specified node is a component
(Chapter, Appendix, etc.), and '0' otherwise.
node
The node which is to be tested.
This template returns '1' if the specified node is a component
(Chapter, Appendix, etc.), and '0' otherwise.
1
0
Tests if a given node is a section-level element
This template returns '1' if the specified node is a section
(Section, Sect1, Sect2, etc.), and '0' otherwise.
node
The node which is to be tested.
This template returns '1' if the specified node is a section
(Section, Sect1, Sect2, etc.), and '0' otherwise.
1
0
Returns the hierarchical level of a section.
This template calculates the hierarchical level of a section.
The element sect1 is at level 1, sect2 is
at level 2, etc.
Recursive sections are calculated down to the fifth level.
node
The section node for which the level should be calculated.
Defaults to the context node.
The section level, 1
, 2
, etc.
1
2
3
4
5
6
5
4
3
2
1
2
3
4
5
5
5
4
3
2
1
1
Returns the hierarchical level of a QandASet.
This template calculates the hierarchical level of a QandASet.
The level, 1
, 2
, etc.
1
1
1
2
3
5
4
3
2
1
1
question
answer
qandadiv
qandaset
[FAMILY Given]
,
,
[
]
{
}
[
]
...
|
4pi
Selects and processes an appropriate media object from a list
This template takes a list of media objects (usually the
children of a mediaobject or inlinemediaobject) and processes
the "right" object.
This template relies on a template named
"select.mediaobject.index" to determine which object
in the list is appropriate.
If no acceptable object is located, nothing happens.
olist
The node list of potential objects to examine.
Calls <xsl:apply-templates> on the selected object.
Selects the position of the appropriate media object from a list
This template takes a list of media objects (usually the
children of a mediaobject or inlinemediaobject) and determines
the "right" object. It returns the position of that object
to be used by the calling template.
If the parameter use.role.for.mediaobject
is nonzero, then it first checks for an object with
a role attribute of the appropriate value. It takes the first
of those. Otherwise, it takes the first acceptable object
through a recursive pass through the list.
This template relies on a template named "is.acceptable.mediaobject"
to determine if a given object is an acceptable graphic. The semantics
of media objects is that the first acceptable graphic should be used.
If no acceptable object is located, no index is returned.
olist
The node list of potential objects to examine.
count
The position in the list currently being considered by the
recursive process.
Returns the position in the original list of the selected object.
1
1
0
0
1
0
1
Returns '1' if the specified media object is recognized.
This template examines a media object and returns '1' if the
object is recognized as a graphic.
object
The media object to consider.
0 or 1
0
1
1
1
0
.
.
Warn users about references to non-unique IDs
If passed an ID in linkend,
check.id.unique prints
a warning message to the user if either the ID does not exist or
the ID is not unique.
Error: no ID for constraint linkend:
.
Warning: multiple "IDs" for constraint linkend:
.
Warn users about incorrectly typed references
If passed an ID in linkend,
check.idref.targets makes sure that the element
pointed to by the link is one of the elements listed in
element-list and warns the user otherwise.
Error: linkend (
) points to "
" not (one of):
Unexpected context in procedure.step.numeration:
1
2
loweralpha
lowerroman
upperalpha
upperroman
arabic
arabic
circle
square
disc
Print a set of years with collapsed ranges
This template prints a list of year elements with consecutive
years printed as a range. In other words:
1992
1993
1994]]>
is printed 1992-1994
, whereas:
1992
1994]]>
is printed 1992, 1994
.
This template assumes that all the year elements contain only
decimal year numbers, that the elements are sorted in increasing
numerical order, that there are no duplicates, and that all the years
are expressed in full century+year
(1999
not 99
) notation.
years
The initial set of year elements.
print.ranges
If non-zero, multi-year ranges are collapsed. If zero, all years
are printed discretely.
single.year.ranges
If non-zero, two consecutive years will be printed as a range,
otherwise, they will be printed discretely. In other words, a single
year range is 1991-1992
but discretely it's
1991, 1992
.
This template returns the formatted list of years.
,
,
-
,
,
,
-
,
Search in a table for the "best" match for the node
This template searches in a table for the value that most-closely
(in the typical best-match sense of XSLT) matches the current (element)
node location.
/