1. Home
  2. ref
Element
ref
Namespace: -

Docserv²-internal reference

ref node0 ref node1 product node0->node1 node4 | node0->node4 node40 ? node0->node40 node44 empty node0->node44 node2 token node1->node2 node3 pattern node2->node3 node5 ? node4->node5 node9 group node4->node9 node6 docset node5->node6 node7 token node6->node7 node8 pattern node7->node8 node10 docset node9->node10 node13 | node9->node13 node11 token node10->node11 node12 pattern node11->node12 node14 group node13->node14 node31 group node13->node31 node15 dc node14->node15 node18 ? node14->node18 node22 ? node14->node22 node16 token node15->node16 node17 pattern node16->node17 node19 subdeliverable node18->node19 node20 token node19->node20 node21 pattern node20->node21 node23 titleformat node22->node23 node24 | node23->node24 node25 title node24->node25 node26 title docset node24->node26 node27 title product node24->node27 node28 title subtitle node24->node28 node29 title subtitle product node24->node29 node30 title subtitle docset node24->node30 node32 link node31->node32 node35 ? node31->node35 node33 token node32->node33 node34 pattern node33->node34 node36 titleformat node35->node36 node37 | node36->node37 node38 title node37->node38 node39 title docset node37->node39 node41 category node40->node41 node42 token node41->node42 node43 pattern node42->node43
  • Child Elements:-

Attributes
productrequired
Namespace: -

Product ID of referenced document or navigational page

Data type token
Parameters pattern: [\-_\.\+a-zA-Z0-9]+
docsetoptional
Namespace: -

Docset ID of referenced navigational page

Data type token
Parameters pattern: [\-_\.\+a-zA-Z0-9]+
docsetrequired
Namespace: -

Docset ID of referenced document

Data type token
Parameters pattern: [\-_\.\+a-zA-Z0-9]+
dcrequired
Namespace: -

DC file name of referenced document

Data type token
Parameters pattern: [\-_\.\+a-zA-Z0-9]+
subdeliverableoptional
Namespace: -

Subdeliverable (DocBook/AsciiDoc ID) of referenced document

Data type token
Parameters pattern: [\-_\.\+a-zA-Z0-9]+
titleformatoptional
Namespace: -

How to display the document title on the product version navigational page, a combination of the following values: * `title`: title as extracted from the document * `subtitle`: subtitle as extracted from the document (can be empty) * `docset`: product and version number as classified in the Docserv² product configuration * `product`: product and version number as extracted from the document (can be empty) Note the following: * `title` is mandatory * `docset` and `product` are mutually exclusive. * the order of values must be `title`, `subtitle`, `docset`/`product` Default: `title subtitle docset`

Data type enum
Parameters -
linkrequired
Namespace: -

Data type token
Parameters pattern: [\-_\.\+a-zA-Z0-9]+
titleformatoptional
Namespace: -

How to display the document title on the product version navigational page, a combination of the following values: * `title`: title as extracted from the document * `docset`: product and version number as classified in the Docserv² product configuration Note the following: * `title` is mandatory * the order of values must be `title`, `docset` Default: `title docset`

Data type enum
Parameters -
categoryoptional
Namespace: -

Data type token
Parameters pattern: ([\-_\.\+a-zA-Z0-9]+ )*[\-_\.\+a-zA-Z0-9]+
[ top ]