XSLT Explorer: docbook.xsl
48 imports, 1 include, 778 templates, 225 functions, 101 variables, 208 params, 3 FIXME: comments
- main.xsl
- param.xsl
- VERSION.xsl
- modules/variable.xsl
- modules/space.xsl
- modules/unhandled.xsl
- modules/errors.xsl
- modules/head.xsl
- modules/titles.xsl
- modules/numbers.xsl
- modules/units.xsl
- modules/gentext.xsl
- modules/l10n.xsl
- modules/functions.xsl
- modules/toc.xsl
- modules/divisions.xsl
- modules/components.xsl
- modules/refentry.xsl
- modules/bibliography.xsl
- modules/biblio690.xsl
- modules/glossary.xsl
- modules/index.xsl
- modules/sections.xsl
- modules/templates.xsl
- modules/titlepage.xsl
- modules/info.xsl
- modules/lists.xsl
- modules/blocks.xsl
- modules/admonitions.xsl
- modules/programming.xsl
- modules/msgset.xsl
- modules/objects.xsl
- modules/footnotes.xsl
- modules/verbatim.xsl
- modules/tablecals.xsl
- modules/tablehtml.xsl
- modules/inlines.xsl
- modules/xlink.xsl
- modules/links.xsl
- modules/xref.xsl
- modules/attributes.xsl
- modules/publishers.xsl
- modules/annotations.xsl
- modules/chunk.xsl
- modules/chunk-cleanup.xsl
- modules/chunk-output.xsl
- modules/xform-locale.xsl
- tp:orderedlist-properties
- tp:process-list
- tp:apply-localization-template
- tp:format-number
- tp:group-or-arg
- t:inline
- tp:filter-callouts
- tp:verbatim
- tp:verbatim-array
- tp:verbatim-lines
- tp:verbatim-plain
- tp:verbatim-raw
- tp:verbatim-table
- t:generate-index
- t:index-zone-reference
- tp:indexed-section
- t:mediaobject-img
- tp:viewport
- t:table-footnotes
- tp:resolve-persistent-toc-uris
- t:chunk-cleanup
- t:chunk-output
- t:docbook
- tp:cals-colspec
- tp:cell
- tp:list-of-titles
- tp:toc
- tp:tocentry-link
- tp:link
- tp:xref
- t:person-name
- t:person-name-family-given
- t:person-name-first-last
- t:person-name-last-first
- t:person-name-list
- t:glossary-divisions
- t:biblioentry
- tp:out-of-line-xlink
- tp:simple-xlink
- t:xlink
- t:bottom-nav
- t:chunk-footnotes
- t:top-nav
- fp:estimated-term-length()
- fp:select-vert-members()
- f:l10n-token()
- f:l10n-token()
- fp:l10n-token()
- fp:minified-css()
- f:attributes()
- f:attributes()
- f:date-format()
- f:generate-id()
- f:generate-id()
- f:gentext-letters()
- f:gentext-letters-for-language()
- f:href()
- f:id()
- f:is-true()
- f:l10n-language()
- f:label-separator()
- f:orderedlist-item-number()
- f:orderedlist-item-numeration()
- f:orderedlist-startingnumber()
- fp:css-properties()
- fp:lookup-string()
- fp:parse-key-value-pairs()
- fp:parse-key-value-pairs()
- fp:properties()
- fp:replace-element()
- fp:replace-element()
- fp:separator()
- f:refsection()
- f:relative-path()
- f:section()
- f:section-depth()
- f:spaces()
- f:step-number()
- f:step-numeration()
- f:target()
- f:tokenize-on-char()
- f:translate-attribute()
- f:unique-id()
- f:uri-scheme()
- fp:common-attributes()
- fp:common-attributes()
- fp:nearest-relevant-ancestor()
- fp:title-properties()
- fp:title-properties-override()
- f:absolute-length()
- f:empty-length()
- f:equal-lengths()
- f:is-empty-length()
- f:length-string()
- f:length-units()
- f:make-length()
- f:make-length()
- f:make-length()
- f:parse-length()
- f:relative-length()
- f:highlight-verbatim()
- fp:array-append()
- fp:array-pad()
- fp:balance-line()
- fp:balance-markup()
- fp:balance-markup()
- fp:contains()
- fp:following()
- fp:inject()
- fp:inject-array()
- fp:inject-into-chars()
- fp:inject-into-line()
- fp:injection-array()
- fp:line-number()
- fp:line-to-chars()
- fp:make-lines()
- fp:make-lines-array()
- fp:open()
- fp:unflatten()
- fp:unflatten()
- fp:unflatten-line()
- fp:unflatten-line()
- fp:up-to()
- fp:validate-injection-array()
- fp:verbatim-properties()
- f:verbatim-highlight()
- f:verbatim-numbered()
- f:verbatim-style()
- f:verbatim-trim-leading()
- f:verbatim-trim-trailing()
- fp:fix-text()
- fp:iso690()
- fp:optional-sep()
- f:available-bibliographies()
- f:available-bibliographies()
- f:available-glossaries()
- f:available-glossaries()
- f:biblioentries()
- f:biblioentries()
- f:citations()
- f:citations()
- f:glossentries()
- f:glossentries()
- f:glossrefs()
- f:glossrefs()
- f:pi()
- f:pi()
- f:pi-attributes()
- fp:available-bibliographies()
- fp:available-glossaries()
- fp:baseform()
- fp:pi-attributes()
- fp:pi-from-list()
- fp:pi-pi-attributes()
- fp:group-index()
- fp:group-label()
- fp:nearest-section()
- fp:nearest-section-id()
- fp:primary()
- fp:scope()
- fp:secondary()
- fp:tertiary()
- f:chunk()
- f:chunk-filename()
- fp:chunk-exclude()
- fp:chunk-include()
- fp:chunk-navigation()
- fp:matches-expr()
- fp:root-base-uri()
- fp:trim-common-parts()
- fp:trim-common-prefix()
- f:css-length()
- f:css-property()
- f:mediaobject-amend-uri()
- f:mediaobject-input-base-uri()
- f:mediaobject-type()
- f:mediaobject-viewport()
- f:object-align()
- f:object-contentheight()
- f:object-contentwidth()
- f:object-height()
- f:object-properties()
- f:object-properties()
- f:object-scale()
- f:object-scalefit()
- f:object-valign()
- f:object-width()
- f:in-scope-language()
- f:languages()
- fp:localization()
- fp:localization-list()
- fp:localization-template()
- fp:lookup-localization-list()
- fp:lookup-localization-template()
- fp:footnote-mark()
- fp:footnote-number()
- fp:resolve-persistent-toc()
- fp:resolve-persistent-toc-prefix()
- fp:run-transforms()
- fp:run-transforms()
- f:cals-colsep()
- f:cals-rowsep()
- fp:align-char-pad()
- fcals:align()
- fcals:align-colspec()
- fcals:align-spanspec()
- fcals:cell()
- fcals:cell-decoration()
- fcals:cell-overhang()
- fcals:char()
- fcals:char-colspec()
- fcals:char-spanspec()
- fcals:colsep()
- fcals:colsep-colspec()
- fcals:colsep-spanspec()
- fcals:colspan()
- fcals:colspec()
- fcals:colspec-column-number()
- fcals:colspec-for-column()
- fcals:column-number()
- fcals:decrement-overhang()
- fcals:empty-cell-colsep()
- fcals:empty-cell-rowsep()
- fcals:next-empty-cell()
- fcals:overhang()
- fcals:overhang-into-row()
- fcals:rowsep()
- fcals:rowsep-colspec()
- fcals:rowsep-spanspec()
- fcals:rowspan()
- fcals:spanspec()
- fcals:table-columns()
- fcals:tgroup()
- fcals:valign()
- fcals:zeros()
- fp:colspec-for-colnum()
- fp:only-initial-pis()
- fp:number()
- fp:localization-template-from-xrefstyle()
- fp:collapse-years()
- fp:collapse-years()
- fp:syntax-highlight()
- fp:syntax-highlight()
- f:syntax-highlight()
- f:syntax-highlight()
- f:syntax-highlight()
- fp:construct-templates()
- fp:pick-template()
- f:template()
- fp:find-xlink-nodes()
- fp:pmuj()
- fp:pmuj-enabled()
- fp:xlink-sources()
- fp:xlink-targets()
- fp:xlink-xmlns-scheme()
- fp:xlink-xpath-scheme()
- f:xlink-style()
- f:xpointer-idref()
- f:chunk-title()
- fp:chunk-output-filename()
- fp:footnote-mark()
- fp:footnote-number()
- fp:navigable()
- fp:relative-link()
- fp:relative-uri()
- fp:root-base-uri()
- fp:trim-common-parts()
- fp:trim-common-prefix()
docbook.xsl
1 import
main.xsl
46 imports
param.xsl
2 variables (2 used only in one other module), 207 params (1 unused)
$additional-languages$align-char-default as xs:string$align-char-pad$align-char-width$allow-eval as xs:string$annotate-toc$annotation-collection as xs:string$annotation-mark$annotation-placement$annotation-style$annotations-js$auto-toc as xs:string$bibliography-collection as xs:string$bibliography-style as xs:string$callout-default-column$callout-unicode-start$chunk as xs:string?$chunk-exclude as xs:string*$chunk-include as xs:string*$chunk-output-base-uri as xs:string$chunk-renumber-footnotes$chunk-section-depth$classsynopsis-indent$component-numbers as xs:string$component-numbers-inherit as xs:string$control-js as xs:string$copyright-collapse-years$copyright-year-range-separator$copyright-year-separator$date-date-format$date-dateTime-format$dc-metadata as xs:string$debug as xs:string [static]$default-float-style$default-language$default-length-magnitude$default-length-unit$personal-name-style$default-theme as xs:string$division-numbers as xs:string$division-numbers-inherit as xs:string$docbook-transclusion$dynamic-profile-error$dynamic-profiles as xs:string$experimental-pmuj$footnote-numeration$formal-object-title-placement$mediaobject-details-placement$formalgroup-nested-object-title-placement$funcsynopsis-default-style$funcsynopsis-table-threshold$funcsynopsis-trailing-punctuation$generate-html-page as xs:string$generate-index$generate-nested-toc as xs:string$generate-toc as xs:string$generate-trivial-toc as xs:string$generated-id-root$generated-id-sep$generator-metadata as xs:string$gentext-language$glossary-collection as xs:string$glossary-sort-entries$glossary-automatic-divisions$html-extension$image-ignore-scaling as xs:boolean$image-nominal-height$image-nominal-width$image-property-warning$index-on-type$index-on-role$index-show-entries$indexed-section-groups$lists-of-equations as xs:string$lists-of-examples as xs:string$lists-of-figures as xs:string$lists-of-procedures as xs:string$lists-of-tables as xs:string$local-conventions as xs:string?$mathml-js$mediaobject-accessibility as xs:string$mediaobject-exclude-extensions as xs:string$mediaobject-input-base-uri as xs:string?$mediaobject-grouped-by-type as xs:string$mediaobject-output-base-uri as xs:string?$mediaobject-output-paths as xs:string$mediaobject-video-element as xs:string$nominal-page-width$number-single-appendix$olink-databases as xs:string$orderedlist-item-numeration$othername-in-middle$output-media$oxy-markup$pagetoc-elements$pagetoc-dynamic$pagetoc-js$page-style as xs:string$paper-size as xs:string?$persistent-toc$persistent-toc-css$persistent-toc-filename as xs:string?$persistent-toc-js$persistent-toc-search$pixels-per-inch$procedure-step-numeration$productionset-lhs-rhs-separator$profile-arch$profile-audience$profile-condition$profile-conformance$profile-lang$profile-os$profile-outputformat$profile-revision$profile-revisionflag$profile-role$profile-security$profile-separator$profile-userlevel$profile-vendor$profile-wordsize$theme-picker as xs:string$transclusion-id-fixup as xs:string$transclusion-link-scope as xs:string$transclusion-prefix-separator as xs:string$transclusion-suffix as xs:string$qandadiv-default-toc$qandaset-default-label$qandaset-default-toc$relax-ng-grammar as xs:string?$refentry-generate-name$refentry-generate-title$resource-base-uri$revhistory-style$section-numbers as xs:string$section-numbers-inherit$section-toc-depth$segmentedlist-style$show-remarks$sort-collation$table-accessibility as xs:string$table-footnote-numeration$use-docbook-css as xs:string$use-minified-css as xs:string$user-css-links$variablelist-termlength-threshold$verbatim-callouts as xs:string$verbatim-line-style$verbatim-number-every-nth$verbatim-number-first-line$verbatim-number-minlines$verbatim-number-separator$verbatim-numbered-elements$verbatim-plain-style as xs:string$verbatim-space$verbatim-style-default$verbatim-syntax-highlight-css$verbatim-syntax-highlight-languages$verbatim-syntax-highlighter as xs:string$verbatim-table-style$verbatim-trim-leading-blank-lines$verbatim-trim-trailing-blank-lines$xlink-arclist-before$xlink-arclist-after$xlink-arclist-titlesep$xlink-arclist-sep$xlink-icon-closed$xlink-icon-open$xlink-js$xlink-style$xlink-style-default$xspec as xs:string$transform-original$transform-before$transform-after$dynamic-profile-variables as map(xs:QName, item()*)?$warn-about-missing-localizations as xs:string$sets-number-from as xs:string$books-number-from as xs:string$divisions-number-from as xs:string$components-number-from as xs:string$sections-number-from as xs:string$formal-objects-number-from as xs:string$sets-inherit-from as xs:string$books-inherit-from as xs:string$divisions-inherit-from as xs:string$components-inherit-from as xs:string$sections-inherit-from as xs:string$formal-objects-inherit-from as xs:string$unwrap-paragraphs as xs:string$fallback-js$message-level as xs:integer$copy-verbatim-js$translate-suppress-elements$varlistentry-separate-terms$presentation-mode$presentation-js$presentation-css$inline-xlink-href as xs:string$transformed-docbook-input as xs:string?$transformed-docbook-output as xs:string?$titleabbrev-passthrough as xs:string$variablelist-panelset as xs:string$vp:static-parameters as map(xs:QName, item()*)$vp:dynamic-parameters as map(xs:QName, item()*)Acknowledgements
Acknowledgements
I’d like to thank The Academy, the…no, wrong event.
diff --git a/guide/2.2.1/ch-building.html b/guide/2.2.1/ch-building.html index 56bd3d47b..216da9d8f 100644 --- a/guide/2.2.1/ch-building.html +++ b/guide/2.2.1/ch-building.html @@ -1,4 +1,4 @@ -Chapter 6. Building the stylesheets
If you wish, you can also clone the distribution and build them +
Chapter 6. Building the stylesheets
If you wish, you can also clone the distribution and build them yourself. The distribution is designed to be self contained. In a Unix or Mac environment, running:
./gradlew distdiff --git a/guide/2.2.1/ch-customizing.html b/guide/2.2.1/ch-customizing.html index 4b5315a4d..88349ce3d 100644 --- a/guide/2.2.1/ch-customizing.html +++ b/guide/2.2.1/ch-customizing.html @@ -1,4 +1,4 @@ -
Chapter 3. Customizing the stylesheets
In many circumstances, the stylesheets can be used “out of the +
Chapter 3. Customizing the stylesheets
In many circumstances, the stylesheets can be used “out of the box” without any customization. But sometimes you may need to change the formatting of certain elements. One common reason is to change the formatting of title pages or navigational features. In other cases, it @@ -161,13 +161,13 @@ produce is intended to be clean, robust markup for styling with CSS. Exactly how you control which stylesheet links are produced has changed several times. The current scheme is this:
If syntax highlighting is enabled, a link to the -
$verbatim-syntax-highlight-cssstylesheet is +$verbatim-syntax-highlight-cssstylesheet is included. -If
$persistent-tocis true -a link to the$persistent-toc-cssstylesheet +a link to the$persistent-toc-cssstylesheet is included. -If
$use-docbook-cssis true, +If
$use-docbook-cssis true, links to the standard DocBook stylesheets are included. Those stylesheets aredocbook.css(for all media),docbook-screen.css(for screen media), and @@ -178,7 +178,7 @@ generated is processed in them:html-head-linksmode. By default, that template does nothing, but you can change that in a customization layer.If any CSS stylesheets are defined in -
$user-css-links, they are included. +$user-css-links, they are included.The DocBook element that is the context element when the HTML
headis being generated is processed in them:html-head-lastmode. @@ -586,9 +586,9 @@ Jackfruit, since there is no correspondingglosstermorfirsttermin the main part of your text.You can also use external glossaries for this task, which can be identified by the -
$glossary-collectionparameter, or the -dbprocessing instructions with a -glossary-collectionpseudo-attribute in the root element.If you use external glossaries, you can leave the internal, +
$glossary-collectionparameter, or the +dbprocessing instructions with a +glossary-collectionpseudo-attribute in the root element.If you use external glossaries, you can leave the internal, automatic glossary completely empty. As long as there are entries for Apple and Pear in one of your external glossaries, you will end up with those two entries in diff --git a/guide/2.2.1/ch-implementation.html b/guide/2.2.1/ch-implementation.html index fca1e87ef..fd75726e7 100644 --- a/guide/2.2.1/ch-implementation.html +++ b/guide/2.2.1/ch-implementation.html @@ -1,4 +1,4 @@ -
Chapter 5. Implementation details Chapter 5. Implementation details
This section sketches out some features of the implementation. +
Chapter 5. Implementation details Chapter 5. Implementation details
This section sketches out some features of the implementation. It would probably be better to build an annotated Definitive Guide or something, but this will have to do for now. @@ -124,15 +124,15 @@ authoring environment that weren’t always easy to work with. Starting in version 2.0.6, the mechanisms for finding sources and producing references in the output has changed. Three parameters -are used:
$mediaobject-input-base-uriIf the
$mediaobject-input-base-uriis empty (the default), +are used:$mediaobject-input-base-uriIf the
$mediaobject-input-base-uriis empty (the default), then URIs in the source document are assumed to be relative to the base URI on which they occur. This is the usual case if you mix XML and media into the same -directory structure on the filesystem.If the
$mediaobject-input-base-uriis not empty, it is +directory structure on the filesystem.If the
$mediaobject-input-base-uriis not empty, it is used to resolve all media URIs. If it’s initialized with a relative URI, that URI will -be made absolute against the base URI if the input document.$mediaobject-output-base-uriIf the
$mediaobject-output-base-uriis empty (the default), +be made absolute against the base URI if the input document.$mediaobject-output-base-uriIf the
$mediaobject-output-base-uriis empty (the default), then URIs in the output are treated as parallel to the URIs in the input. If the reference../image.pngworks in the source document, it’s assumed -that will also work in the output document.If the
$mediaobject-output-base-uriis not empty, it is +that will also work in the output document.If the
$mediaobject-output-base-uriis not empty, it is the base URI used for media objects. If this is a relative URI, it is taken to be relative to the root of the output hierarchy.Suppose the output base URI is
https://images.example.com/, then a reference toimage.pngwill appear as @@ -143,7 +143,7 @@image.pngappears in a chunk that will be located atback/appendix.html, then the media URI will be../media/image.png. -$mediaobject-output-pathsThis parameter controls whether the relative paths in the input URIs apply +
$mediaobject-output-pathsThis parameter controls whether the relative paths in the input URIs apply to the output URIs as well. If the parameter is true, the output base URI is
media/, and the input URI ispath/to/image.png, then the output reference will be to @@ -187,7 +187,7 @@ (with anannotatesattribute). These are documented as ID/IDREF links but they are notIDREFSattributes because annotations may be stored separately.Starting in version 1.5.1, the DocBook xslTNG -Stylesheets⌖1 support a non-standard extension: if you place +Stylesheets⌖1 support a non-standard extension: if you place the string
xpath:in theannotatesattribute of anannotation, then the rest of the attribute is assumed to contain an XPath expression that points to the element(s) to which the annotation @@ -242,20 +242,20 @@Process XLink link bases.
Validate. Only occurs if the appropriate extension function is available and the stylesheet specifies a -
$relax-ng-grammar. +$relax-ng-grammar.Process Oxygen change markup. Only occurs if
$oxy-markupis true and the document contains Oxygen change markup processing instructions.A customization can introduce transformations to the original -document using three parameters:
$transform-originalThis transform runs before step 1 in the standard transformations. +document using three parameters:
$transform-originalThis transform runs before step 1 in the standard transformations. If this transformation is used, it must take special care to preserve the base URI of the original document by adding an
xml:baseattribute to the root element (if it doesn’t already have one).Only the first transformation in the list has access to the original base URI. If it isn’t preserved, relative references to other documents will be resolved against the static base URI of the stylesheet and not the URI of the original document. That’s -unlikely to be correct.
$transform-beforeThis transformation runs after step 10. Its +unlikely to be correct.
$transform-beforeThis transformation runs after step 10. Its input is the DocBook document that will be transformed into HTML. -
$transform-afterThis transformation runs after the DocBook document has been transformed into HTML. +
$transform-afterThis transformation runs after the DocBook document has been transformed into HTML. The resulting HTML document is not valid HTML, but contains islands of valid HTML that will be separated out into chunks by subsequent processing.
(If you need @@ -273,7 +273,7 @@ standard DocBook stylesheet.
functionsA list of functions (expressed as EQNames). The transformation will only be run if every extension function listed is available. testAn arbitrary XPath expression. The expression will be evaluated with the document as the context item. If it returns an effective boolean value of true, -the transformation will be run.