NAME
Text::Amuse::Document - core parser for Text::Amuse (internal)
SYNOPSIS
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.
METHODS
- new(file => $filename, include_paths => \@paths )
- include_paths
-
The return the list of directories where the included files need to be searched.
- included_files
-
The return the list of files actually included.
- filename
-
Return the filename of the processed file
- attachments
-
Return the list of the filenames of the attached files, as linked. With an optional argument, store that file in the list.
- bidi_document
-
Return true if the document uses a bidirectionl marker.
- set_bidi_document
-
Internal, set the bidi flag on.
- language_code
-
The language code of the document. This method will looks into the header of the document, searching for the keys
langorlanguage, defaulting toen. - language
-
Same as above, but returns the human readable version, notably used by Babel, Polyglossia, etc.
- parse_directives
-
Return an hashref with the directives found in the document.
- raw_header
-
Accessor to the raw header of the muse file. The header is returned as hash, with key/value pairs. Please note: NOT an hashref.
- raw_body
-
Accessor to the raw body of the muse file. The body is returned as a list of lines.
- directives_array
-
This is very similar to raw_header, but store them in an array, so the header can be rewritten.
- elements
-
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).
- get_footnote
-
Accessor to the internal footnotes hash. You can access the footnote with a numerical argument or even with a string like [123]