To get the current output unit being converted, use current_output_unit
:
$output_unit =
$converter->current_output_unit ()
¶Return the output unit being converted, or undef
if there is no
output unit.
To get the file name of the current output unit being converted,
use current_filename
:
$filename =
$converter->current_filename ()
¶Return the file name of the current output unit being converted.
To get the text filling and alignement context, determined by @flushleft
or @center
, use in_align
:
$align_context =
$converter->in_align ()
¶If the alignment context is the default alignement context, return undef
.
Otherwise, returns the command name of the alignment context.
To determine if the conversion is in a context converted multiple times,
use in_multiple_conversions
:
$multiple_conversion =
$converter->in_multiple_conversions ()
¶Return true if the Texinfo tree being converted is converted multiple times and the current conversion is not the main conversion.
For example, return true if a node name is converted as part of a direction
string formating in a navigation panel, which is not the
main expansion of the @node
. The main @node
element
expansion occurs where the @-command is located.
To determine if the a mutiple expansion context is set, use
in_multi_expanded
:
$multi_expanded_context_information =
$converter->in_multi_expanded ()
¶Return a string representing the multiple expanded context, or undef
if
not in a multiple expanded context.
A multiple expanded context implies to be in multiple conversions. However, it is possible to be in multiple conversions without being in a multiple expanded context, as a multiple expanded context needs to be set explicitly, and is not always needed.
To get the current paragraph and preformatted number, use paragraph_number
or preformatted_number
:
$number =
$converter->paragraph_number ()
¶$number =
$converter->preformatted_number ()
¶Return the current paragraph or preformatted container number in the current formatting context.
To get the topmost block @-command being converted, use top_block_command
:
$command_name =
$converter->top_block_command ()
¶Return the most recent block @-command seen in the current formatting context.