Text::Amuse::Document - core parser for Text::Amuse (internal)
The module is used internally by Text::Amuse, so everything here is pretty much internal only (and underdocumented). The useful stuff is accessible via the Text::Amuse class.
The return the list of directories where the included files need to be searched.
The return the list of files actually included.
Return the filename of the processed file
Return the list of the filenames of the attached files, as linked. With an optional argument, store that file in the list.
Return true if the document uses a bidirectionl marker.
Internal, set the bidi flag on.
Return true if the document uses the ruby
Internal, set the ruby flag on.
The language code of the document. This method will looks into the header of the document, searching for the keys lang or language, defaulting to en.
lang
language
en
Same as above, but for other languages declared with the experimental tag <[en>
<[en
Same as above, but returns the human readable version, notably used by Babel, Polyglossia, etc.
Same as above, for the other languages
Return an hashref with the directives found in the document.
Accessor to the raw header of the muse file. The header is returned as hash, with key/value pairs. Please note: NOT an hashref.
Accessor to the raw body of the muse file. The body is returned as a list of lines.
This is very similar to raw_header, but store them in an array, so the header can be rewritten.
Return the list of the elements which compose the body, once they have properly parsed and packed. Footnotes are removed. (To get the footnotes use the accessor below).
Accessor to the internal footnotes hash. You can access the footnote with a numerical argument or even with a string like [123]
To install Text::Amuse, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Text::Amuse
CPAN shell
perl -MCPAN -e shell install Text::Amuse
For more information on module installation, please visit the detailed CPAN module installation guide.