To get the id of a footnote in the main document, use
footnote_location_target:
$target = $converter->footnote_location_target (\%footnote_element) ¶Return the id for the location of the footnote \%footnote_element in the main document (where the footnote number or symbol appears).
To get an href to link to a footnote location in the main document, use
footnote_location_href:
$href = $converter->footnote_location_href (\%footnote_element, $source_filename, $specified_target, $target_filename) ¶Return string for linking to \%footnote_element location
in the main document with <a href>. $source_filename is the file
the link comes from. If not set, the current file name is used.
$specified_target is an optional identifier that overrides the
target identifier if set. $target_filename is an optional file name
that overrides the file name href part if set.
See Target Commands Links, Texts and Associated Commands to get link information for the location where footnote text is output.
To get id and link href of sectioning commands in table of contents
and short table of contents, use command_contents_target and
command_contents_href:
$target = $converter->command_contents_target (\%sectioning_element, $contents_or_shortcontents) ¶Returns the id for the location of \%sectioning_element sectioning element in the table of contents, if $contents_or_shortcontents is ‘contents’, or in the short table of contents, if $contents_or_shortcontents is set to ‘shortcontents’ or ‘summarycontents’.
$href = $converter->command_contents_href (\%sectioning_element, $contents_or_shortcontents, $source_filename) ¶Return string for linking to the \%sectioning_element sectioning element location in the table of contents, if $contents_or_shortcontents is ‘contents’ or in the short table of contents, if $contents_or_shortcontents is set to ‘shortcontents’ or ‘summarycontents’. $source_filename is the file the link comes from. If not set, the current file name is used.
To determine if a tree unit element is the top element, use
element_is_tree_unit_top:
$is_tree_unit_top = $converter->element_is_tree_unit_top (\%element) ¶Returns true if the \%element Texinfo tree element is the tree unit
Top element (see Output Element Units) and is either associated with the
@top sectioning command or with the Top @node.
To get information on the special element variety associated with
an @-command command name, use command_name_special_element_information:
($special_element_variety, \%special_element, $class_base, $special_element_direction) = $converter->command_name_special_element_information ($command_name) ¶$command_name is an @-command name without the leading @.
If the $command_name is not associated with a special element, returns
undef. Otherwise, return the $special_element_variety
(see Table 15.1), the \%special_element texinfo tree
unit, a $class_base string for HTML class attribute and the
$special_element_direction direction corresponding to that special
elements (see Directions).
In the current setup, special elements are associated with @contents,
@shortcontents and @summarycontents and with @footnote.