NAME

PerlPoint::Constants - public PerlPoint module constants

VERSION

This manual describes version 0.19.

DESCRIPTION

The module declares a number of constants shared between other PerlPoint::... modules.

SYNOPSIS

The usage of the provided constants is described in the manuals of the using modules PerlPoint::Parser and PerlPoint::Backend.

CONSTANTS

Stream directive constants

These constants are built into directives which the parser produces in its output (that is, the representation format it translates an ASCII text in to be subsequently processed by a backend).

DIRECTIVE_BLOCK: flags a block paragraph;
DIRECTIVE_COMMENT: flags a comment;
DIRECTIVE_COMPLETE: a format entity is completed;
DIRECTIVE_DOCUMENT: flags a complete document (made from one ASCII file);
DIRECTIVE_DLIST: flags a "definition list";
DIRECTIVE_DPOINT: flags a "definition point" paragraph;
DIRECTIVE_DPOINT_ITEM: flags a "definition point" item (the stuff to be defined);
DIRECTIVE_DPOINT_TEXT: flags a "definition point" text (the definition part);
DIRECTIVE_DSTREAM_ENTRYPOINT: flags the switch into another document stream;
DIRECTIVE_HEADLINE: flags a headline;
DIRECTIVE_LIST_LSHIFT: control directive, shift a list left;
DIRECTIVE_LIST_RSHIFT: control directive, shift a list right;
DIRECTIVE_NEW_LINE: a backend hint to inform about a new source line;
DIRECTIVE_OLIST: flags an "ordered list";
DIRECTIVE_OPOINT: flags an "ordered point" paragraph;
DIRECTIVE_SIMLPE: a pseudo directive, used to flag simple strings in backends;
DIRECTIVE_START: a format entity starts;
DIRECTIVE_TAG: flags a tag;
DIRECTIVE_TEXT: flags a text paragraph;
DIRECTIVE_ULIST: flags an "unordered list";
DIRECTIVE_UPOINT: flags an "unordered point" paragraph;
DIRECTIVE_VARRESET: a backend hint flagging that all variables are deleted;
DIRECTIVE_VARSET: a backend hint propagating a variable setting;
DIRECTIVE_VERBATIM: flags a verbatim block paragraph;

Parser constants

control how the parser continues processing, usually used by tag hooks.

PARSING_COMPLETED: We read all we need. Stop parsing successfully.
PARSING_ERASE: Ignore the tag and all its contents (which means its body).
PARSING_ERROR: A semantic error occurred. Parsing will usually be continued to possibly detect even more errors.
PARSING_FAILED: A syntactic error occured. Parsing will be stopped immediately.
PARSING_IGNORE: Ignore the tag as if it was not written.
PARSING_OK: Input ok, parsing can be continued.

Tag definition constants

flagging mode of tag components.

TAGS_OPTIONAL: the item can be used but is not required.
TAGS_MANDATORY: the item is an essential tag part.
TAGS_DISABLED: the item must not be used.

Stream data structure part constants

index constants to access parts of the intermediate data structure produced by the parser and processed by backends. Intended to be used by "PerlPoint::Parser" and "PerlPoint::Backend".

STREAM_IDENT: stream data identifier - a string identifying the data structure as a PerlPoint stream.
STREAM_DOCSTREAMS: a list of all detected document stream identifiers.
STREAM_TOKENS: token stream.
STREAM_HEADLINES: headline stream.

Stream directive data structure index constants

index constants to access parts of a stream directive.

STREAM_DIR_HINTS: a hash filled by the parser to control backend behaviour.
STREAM_DIR_TYPE: directive type constant ("DIRECTIVE_HEADLINE", "DIRECTIVE_TAG" etc.)
STREAM_DIR_STATE: start/completion flag ("DIRECTIVE_START", "DIRECTIVE_COMPLETE").
STREAM_DIR_DATA: beginning of the data part, depends on directive type.

Document stream handling constants

declare how document streams should be handled by the parser.

DSTREAM_DEFAULT: Document stream entry points are streamed directly - so the backend can handle them.
DSTREAM_IGNORE: Document streams (except of the main stream) are completely ignored.
DSTREAM_HEADLINES: Document stream entry points are streamed as headlines.

Trace constants

They activate trace code.

TRACE_ACTIVE: activates the traces of active contents evaluation.
TRACE_BACKEND: activates backend traces;
TRACE_LEXER: activates the traces of the lexical analysis.
TRACE_NOTHING: deactivates all trace codes. (In fact, it does not activate any trace. If you decide to combine it with other trace constants, it will cause nothing.)
TRACE_PARAGRAPHS: activates traces which show the paragraphs recognized when they are entered or completed.
TRACE_PARSER: activates the traces of the syntactical analysis.
TRACE_SEMANTIC: activates the traces of the semantic analysis.
TRACE_TMPFILES: deactivates the removal of temporary files.

Display constants

determine if information messages should be suppressed.

DISPLAY_ALL: all messages are displayed. (More correctly, no message is suppressed. If you combine this constant with other display constants, it will take no effect.)
DISPLAY_NOINFO: suppresses information messages;
DISPLAY_NOWARN: suppresses warnings;

Cache constants

specify how presentation files shall be cached.

CACHE_OFF: Files are reparsed completely regardless of cache data. Existing cache data remain untouched.
CACHE_ON: While reading the presentation descriptions, cached and unchanged paragraphs are reloaded from the cache if possible. New or modified paragraphs are stored to accelerate repeated reading.
Please note that this will not overwrite or remove previously stored cache data for modified or deleted paragraphs. Old cache data remains in the cache, while new data is added - the cache size continously grows.
CACHE_CLEANUP: Cleans up an existing cache before the parser starts (and possibly rebuilds it).

Template action constants

flag which way a template engine should perform an action.

TEMPLATE_ACTION_DOC: Produce files which are needed once (per document).
TEMPLATE_ACTION_INDEX: Processes the index page.
TEMPLATE_ACTION_PAGE: Produce a page.
TEMPLATE_ACTION_PAGE_SUPPLEMENTS: Produce additional files belonging to a page.
TEMPLATE_ACTION_TOC: Processes the table of contents page.

String constants

used for various purposes.

DUMMY_TOKEN: a pseudo token added for reasons of parsing, which the backend can delete from the stream.

SUPPORT

A PerlPoint mailing list is set up to discuss usage, ideas, bugs, suggestions and translator development. To subscribe, please send an empty message to perlpoint-subscribe@perl.org.

If you prefer, you can contact me via perl@jochen-stenzel.de as well.

AUTHOR

This module is free software, you can redistribute it and/or modify it under the terms of the Artistic License distributed with Perl version 5.003 or (at your option) any later version. Please refer to the Artistic License that came with your Perl distribution for more details.

The Artistic License should have been included in your distribution of Perl. It resides in the file named "Artistic" at the top-level of the Perl source tree (where Perl was downloaded/unpacked - ask your system administrator if you dont know where this is). Alternatively, the current version of the Artistic License distributed with Perl can be viewed on-line on the World-Wide Web (WWW) from the following URL: http://www.perl.com/perl/misc/Artistic.html

DISCLAIMER

This software is distributed in the hope that it will be useful, but is provided "AS IS" WITHOUT WARRANTY OF ANY KIND, either expressed or implied, INCLUDING, without limitation, the implied warranties of MERCHANTABILITY and FITNESS FOR A PARTICULAR PURPOSE.

The ENTIRE RISK as to the quality and performance of the software IS WITH YOU (the holder of the software). Should the software prove defective, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT WILL ANY COPYRIGHT HOLDER OR ANY OTHER PARTY WHO MAY CREATE, MODIFY, OR DISTRIBUTE THE SOFTWARE BE LIABLE OR RESPONSIBLE TO YOU OR TO ANY OTHER ENTITY FOR ANY KIND OF DAMAGES (no matter how awful - not even if they arise from known or unknown flaws in the software).

Please refer to the Artistic License that came with your Perl distribution for more details.