14.2 Shared Conversion State in Default Formatting

The following shared conversion state information is defined in the default formatting functions:

CommandNameSelectorsValue
abbrexplained_commandsstring (first argument)string
acronymexplained_commandsstring (first argument)string
footnotefootnote_numberinteger
footnotefootnote_id_numbersstring (footnote id)integer
listoffloatsformatted_listoffloatsstring (normalized argument)integer
menuhtml_menu_entry_indexinteger
printindexformatted_index_entriesindex_entry (index entry hash)integer
topin_skipped_node_topinteger
nodedescriptionformatted_nodedescriptionselement (@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.