Free perlpoint software for linux

PerlPoint::Parser Perl module is a PerlPoint Parser.

SYNOPSIS

# load the module:
use PerlPoint::Parser;

# build the parser and run it
# to get intermediate data in @stream
my ($parser)=new PerlPoint::Parser;
$parser->run(
stream => @stream,
files => @files,
);

The PerlPoint format, initially designed by Tom Christiansen, is intended to provide a simple and portable way to generate slides without the need of a proprietary product. Slides can be prepared in a text editor of your choice, generated on any platform where you find perl, and presented by any browser which can render the chosen output format.

To sum it up, PerlPoint Software takes an ASCII text and transforms it into slides written in a certain document description language. This is, by tradition, usually HTML, but you may decide to use another format like XML, SGML, TeX or whatever you want.

Well, this sounds fine, but how to build a translator which transforms ASCII into the output format of your choice? Thats what PerlPoint::Parser is made for. It performs the first translation step by parsing ASCII and transforming it into an intermediate stream format, which can be processed by a subsequently called translator backend. By separating parsing and output generation we get the flexibility to write as many backends as necessary by using the same parser frontend for all translators.

PerlPoint::Parser supports the complete GRAMMAR with exception of certain tags. Tags are supported the most common way: the parser recognizes any tag which is declared by the author of a translator. This way the parser can be used for various flavours of the PerlPoint language without having to be modified. So, if there is a need of a certain new flag, it can quickly be added without any change to PerlPoint::Parser.

The following chapters describe the input format (GRAMMAR) and the generated stream format (STREAM FORMAT). Finally, the class methods are described to show you how to build a parser.

PerlPoint::Tags::XML is a PerlPoint tag set used by pp2sdf.

SYNOPSIS

# declare tags used by pp2sdf
use PerlPoint::Tags::XML;

This module declares PerlPoint tags used by XML converters. Tag declarations are used by the parser to determine if a used tag is valid, if it needs options, if it needs a body and so on. Please see PerlPoint::Tags for a detailed description of tag declaration.

Every PerlPoint translator willing to handle the tags of this module can declare this by using the module in the scope where it built the parser object.

# declare basic tags
use PerlPoint::Tags::XML;

# load parser module
use PerlPoint::Parser;

...

# build parser
my $parser=new PerlPoint::Parser(...);

...

PerlPoint::Tags::CPPP is a PerlPoint tag set used by pp2cppp.

SYNOPSIS

# declare tags used by pp2cppp
use PerlPoint::Tags::CPPP;

This module declares PerlPoint tags used by pp2cppp. Tag declarations are used by the parser to determine if a used tag is valid, if it needs options, if it needs a body and so on. Please see PerlPoint::Tags for a detailed description of tag declaration.

Every PerlPoint translator willing to handle the tags of this module can declare this by using the module in the scope where it built the parser object.

# declare basic tags
use PerlPoint::Tags::CPPP;

# load parser module
use PerlPoint::Parser;

...

# build parser
my $parser=new PerlPoint::Parser(...);

...

TAGS

PerlPoint::Tags::CPPP declares all the tags of PerlPoint::Tags::Basic.

Additionally, the PerlPoint::Tags::HTML tags L and U are supported. pp2cppp might interprete them slightly different to pp2html, please read its documentation for details.

PerlPoint::Import::POD is a standard PerlPoint import filter for POD.

SYNOPSIS

# command line: process a POD file
perlpoint ... IMPORT:file.pod

...

# or, in a PerlPoint source:

// include a POD file with "pod" extension
INCLUDE{import=1 file="example.pod"}

// include a POD file without "pod" extension
INCLUDE{import=pod file="example"}

// import a snippet in POD,
// which in turn contains some PerlPoint
EMBED{import=pod}

=head2 Embedded PerlPoint

A POD paragraph.

=for perlpoint It I !

END_EMBED

Standard import filters are loaded automatically by the Parser when you import a POD file in one of the ways shown in the SYNOPSIS.

FUNCTION

According to the standard import filter API (see PerlPoint::Parser) this module provides one function, importFilter(). I transforms a POD file into PerlPoint.

PerlPoint::Converters is a Perl module that contains a README and common functions for PerlPoint converters.

PerlPoint is a simple text format which allows easy typing of text with headlines, bullet lists, normal text paragraphs, indented paragraphs for code examples etc., from which slides for presentations can be generated by a script without the need of proprietary software.

Since there is a large variety of platforms which provide web browsers, HTML is a good choice for the output format. In principle, however, it is possible to generate each output format whose specification is known. At the moment there exist converters for HTML, LaTeX (alpha software) and SDF. The latter both may be used to generate printable output or to provide the basis for further processing.

PerlPoint::Generator::SDF is a generic SDF generator.

METHODS

new()

Parameters:

class

The class name.

Returns: the new object.

PerlPoint::Template::Traditional is a PerlPoint template processor for traditional pp2html layouts.