xslt.base.common.dbfunctions.xsl Maven / Gradle / Ivy
DocBook Functions Reference
Walsh
Norman
2004
Norman Walsh
Introduction
These are functions that require the DocBook parameters.
Return the writing direction of a particular element
The dir function returns the value of the nearest
dir attribute or the $writing-mode
parameter if no such attribute can be found.
element
The element for which writing direction is desired.
The writing direction.
Return true if blank lines should be trimmed off the end of the verbatim element
The verbatim-trim-blank-lines tests to see if trailing blank
lines should be removed from the specified verbatim environment.
verbatim
The verbatim environment.
True if they should, false otherwise
Returns the label for a bibliography entry
This template formats the label for a bibliography entry
(biblioentry or bibliomixed ).
node
The node containing the bibliography entry, defaults to the current
context node.
The bibliography entry label.
Returns the title element of the specified node
This function returns the string value of the
title (or the element
that serves as the title) of the specified node. If the node does
not have a title, it returns “???”.
node
The node for which the title will be extracted.
The string value of the title of the specified node.
Some Title
Some Chapter Title
My para.
'Some Title'
Unrecognized value in f:fake-eval-avt():
???
Warning: no title for root element:
Unrecognized unit of measure:
; using pt.
Returns the ordinal number of index group to which supplied term belongs.
Returns the ordinal number of index group to which supplied term belongs in a given language.
This number is used to group index terms and to define order of groups.
term
The string for which the group index should be calculated.
lang
Language of term.
Index of group to which specified term belongs in a given language.
No "
" localization of index grouping letters exists
.
; using "en".
0
Returns the label of specified index group.
Returns the label of specified index group in a given language.
The label is used to label corresponding index group. The label is usually just one letter, but
it can be also longer text like "Symbols" or "Ch".
index
The index of group for which label should be generated.
lang
Language of label.
Label for specified index group in a given language.
No "
" localization of index grouping letters exists
.
; using "en".
Returns true if the specified section should be labelled
(numbered).
This function return true if the specified section should be
labelled. Broadly speaking this is true if sections should be labelled
and the section-level of this section is less than
section.autolabel.max.depth .
section
The section element to test.
True if the section should be labelled, false otherwise.
Returns the numeration style for procedure steps
This function returns the numeration style for procedure steps.
The style returned depends on procedure nesting depth.
The procedure.step.numeration.styles parameter
controls the order and number of numeration styles that will be used.
context
The context element; must be substeps
or steps .
Numeration style.
Unexpected context in f:procedure-step-numeration:
Returns the next symbol style
This function uses the
itemizedlist.numeration.symbols
parameter to calculate the next symbol style. The default style
is the first style in that list.
symbol
The current symbol style.
The next symbol style.
Returns the mark that should be used for the specified
listitem or itemizedlist
This function returns the mark that should be used for the
specified list item or itemized list. This will be:
The value of override , if
it is specified.
The value of mark , if
it is specified.
An symbol appropriate for the list's current nesting depth.
Or the default style (the first style listed in
itemizedlist.numeration.symbols ).
node
The itemizedlist or listitem in an
itemizedlist for which a mark should be calculated.
The item symbol.
Returns the next numeration style
This function uses the orderedlist.numeration.styles
parameter to calculate the next numeration style. The default style
is the first style in that list.
numeration
The current numeration style.
The next numeration style.
Returns the next numeration style
This function returns the orderedlist numeration style
for the specified list. If an explicit style is specified (using
numeration on the list), that style will
be returned. Otherwise, the style returned depends on list nesting depth.
The orderedlist.numeration.styles parameter
controls the order and number of numeration styles that will be used.
list
The orderedlist for which a numeration style should
be calculated.
Numeration style.
Returns the item number of the specified listitem
in an orderedlist
This function returns the number of the specified list item.
This will be:
The value of override , if
it is specified.
One more than the number of the preceding item, if there is one.
One more than the number of the last item in the preceding list, if
continuation is “continues ”
and this is the first item.
Or 1.
node
The listitem in an orderedlist for which a number
style should be calculated.
The item number.
Returns an ID for the specified node
This function returns the id or
xml:id of the specified node. If the
node does not have an ID, the XSLT
generate-id() function is used to create one.
node
The node for which an ID will be generated.
The ID.
'id'
'id'
'R.1'
Some Title
Some Chapter Title
My para.
'R.1.2.2'
Some Title
Some Chapter Title
My para.
'R.1.2.2'