view release on metacpan or  search on metacpan

demo/pp2ppresenter  view on Meta::CPAN

active contents,

=item thirtytwo (32)

backend traces.

=back

Using different levels may cause unexpected results.

Several levels are combined by addition.

 # activate lexer and parser traces
 -trace 6

=back

=head2 Option files

Options may be loaded from files where they are stored exactly as you write them in the
command line, but may be spread to several lines and extended by comment lines which start
with a "#" character. To mark an option file in the commandline, simply enter its (path and)
name prededed by a "@" character, for example

  pp2ppresenter @myOptions ppfile

  where the file myOptions could look like

  # suppress infos
  -noinfo

Option files may be nested. To avoid endless recursion, every option file is resolved only
the first time it is detected.

  # this is an option file which
  # refers to another option file
  -noinfo @moreOptions

The script also takes care of I<default option files> which means that usual options can
be stored in files named C<.pp2ppresenter>. If such a file is placed in the directory where the script itself
resides, options in the file are read in automatically by all pp2ppresenter calls. These are global
settings. If you place such a file in your home directory, it is read automatically as well
but only if pp2ppresenter is called under your account, so this is for personal preferences.

A personal default option file overwrites global settings, and all default options are
overwritten by options passed to the script call.


=head1 SUPPORTED TAGS

All supported tags are declared by B<PerlPoint::Tags::SDF> (currently, this shall become
C<PerlPoint::Tags::XML>). Please see there for a complete list.

B<pp2ppresenter> supports several foreign tags initially introduced by C<pp2html>.
Support means that they are handled, but possibly different to the original handling.

At the moment, the only tag of this type is C<\L>, which is translated into an HTML
like hyperlink. Note: PPresenter support of hyperlinks is only assumed yet.


=head1 EMBEDDING TARGET CODE

There may be things you want to see in the target document but find no way to express
them in PerlPoint. Well, PerlPoint lets you embed target code very easily directly into
the PerlPoint script. Nevertheless, it is recommended to use native PerlPoint wherever
possible ;-).

Please note that embedded target code intended for certain translators like B<pp2ppresenter>
may be B<I<ignored>> if the PerlPoint document is processed by I<other> translators.
pp2html, for example, accepts embedded HTML but ignores embedded XML.

=head2 Embedding XML

Just use the B<\EMBED> and B<\END_EMBED> tags to place native XML if really
necessary:

  This is \I<PerlPoint> with embedded
  \EMBED{lang=xml}<B>XML<B/>\END_EMBED.

  \EMBED{lang=xml}

  <UL>

    <LI>This ...<LI/>

    <LI>... and that.<LI/>

  <UL/>

  \END_EMBED

You may as well I<include> complete XML files by B<\INCLUDE>.

  \INLUDE{type=xml file="snippet.xml"}


=head2 Embedding other languages

B<pp2ppresenter> will ignore any other embedded or included target language than XML.


=head1 PREDECLARED VARIABLES

B<pp2ppresenter> predeclares several variables which can be used like any user defined PerlPoint
variable.

=over 4

=item CONVERTER_NAME

The name of the converter currently processing the document ("pp2ppresenter").

=item CONVERTER_VERSION

The version of the running converter.

=back


=head1 FILES

=head1 ENVIRONMENT

=over 4

=item SCRIPTDEBUG

may be set to a numeric value to activate certain trace levels. You can use option I<-trace>
alternatively (note that a used option overwrites an environment setting). The several levels
are described with this option.

=back

=head1 NOTES

PerlPoint allows to process a document by all of its converters. Nevertheless,
possibly several foreign tags might be ignored. See above for details.

This is a I<demo>. Not all PPresenter features might be supported, but feel free
to make this software the base of an improved implementation. Just let me know.


=head1 FILES

B<pp2ppresenter> activates the PerlPoint parser cache to accelerate repeated translations.
Because of this the usual PerlPoint parser cache files will be written next to the
parsed sources (as ".<source file name>.ppcache" in the source directory).


=head1 SEE ALSO