7.7 References

7.7.1 Reference to external manual

The references are produced with two function references, one for the hypertextual reference construction, the other for the full reference to external manual.

Function Reference: $href external_href $node $node_identifier $xml_node_identifier $manual_file_name

$node is the node name, with @-commands. $node_identifer is the node name mapped to an identifier acceptable as a file name. $xml_node_identifier is the node name mapped to an identifier acceptable as an XML identifier. Those identifiers are built as explained in (texinfo)HTML Xref section `HTML Xref' in GNU Texinfo, thus allowing for cross references to external manuals. $file is the manual or file name of the external reference. This function should return an href leading to the external manual.

The default for this function is to make a reference compatible with makeinfo (see (texinfo)HTML Xref section `HTML Xref' in GNU Texinfo).

Function Reference: $text external_ref $command $section $book $node_and_file $href $cross_ref_name

This function formats a reference to an external texinfo manual. The $command is the ref command (ref, xref or pxref, in text, at sentence beginning or in parenthesis). The optionnal $section argument is the section in the book and book is the book title. $node_and_file is the node and file name formatted according to the convention used in info: ‘(file)node’. $href it an hypertextual reference to the distant manual constructed using the above function. $cross_ref_name is an optionnal cross reference name appearing in the reference command. This function returns the text corresponding with the external html manual reference. This function returns the full formatted text of the external reference.

7.7.2 Reference to an internal node

A function reference is available for internal references.

Function Reference: $text internal_ref $command $href $short_name $name $is_section

This function formats a reference to a node in the current manual. The $command is the ref command (ref, xref or pxref, in text, at sentence beginning or in parenthesis). $href it an hypertextual reference linking to the corresponding node or section. $short_name and $name hold the text for the reference but $short_name can be the node name which is assumed to be shorter than the section name. $is_section is a boolean true if the reference is a reference to a section. This function returns the full formatted text of the internal reference.

Doku-Base