Previous: Define, Get and Set Shared Conversion State, Up: Shared Conversion State [Contents][Index]
The following shared conversion state information is defined in the default formatting functions:
Command | Name | Selectors | Value |
---|---|---|---|
abbr | explained_commands | string (first argument) | string |
acronym | explained_commands | string (first argument) | string |
footnote | footnote_number | integer | |
footnote | footnote_id_numbers | string (footnote id) | integer |
listoffloats | formatted_listoffloats | string (normalized argument) | integer |
menu | html_menu_entry_index | integer | |
printindex | formatted_index_entries | index_entry (index entry hash) | integer |
top | in_skipped_node_top | integer | |
nodedescription | formatted_nodedescriptions | element (@nodedescription tree element) | integer |
These shared information data correspond to:
explained_commands
¶Associate the explanation given in a previous @abbr
or
@acronym
second argument to first @abbr
or
@acronym
arguments.
footnote_number
¶The current number of footnotes formatted in document.
footnote_id_numbers
¶Associate a footnote identifier, typically used in hyperlink reference,
to the number of time the corresponding footnote was formatted. More than
one corresponds to very rare cases, for instance a footnote in @copying
and multiple @insertcopying
.
formatted_listoffloats
¶Associate a list of float type to the number of time it was formatted.
html_menu_entry_index
¶Current number of menu entries in a menu. Reset to 0 at @menu
beginning.
formatted_index_entries
¶Associate an index entry to the number of time it was formatted.
in_skipped_node_top
¶Set to 1 in a Top
node being skipped, in case
NO_TOP_NODE_OUTPUT
is set.
formatted_nodedescriptions
¶Associate a @nodedescription
tree element to the number of time
it was formatted.
Previous: Define, Get and Set Shared Conversion State, Up: Shared Conversion State [Contents][Index]