.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TOC 3pm"
.TH TOC 3pm "2020-11-09" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Embperl::TOC \- Embperl Documentation: Table of Contents
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Embperl can be used in many ways and it's documentation doesn't fit in
one man pages. The following documentation is available within the
distribution and the installed system using \fBperldoc\fR\|(1) or \fBman\fR\|(1):
.SH "CONTENT"
.IX Header "CONTENT"
.Vb 10
\&  Installation Documentation
\&  Embperl::Features
\&  Embperl::Intro
\&  Embperl::IntroEmbperl2
\&  Embperl::Config
\&  Embperl
\&  Embperl::Object
\&  Embperl::Form
\&  Embperl::Form::Validate
\&  Embperl::Mail
\&  Embperl::Inline
\&  Embperl::Recipe
\&  Embperl::Syntax
\&  Embperl::Syntax::ASP
\&  Embperl::Syntax::Embperl
\&  Embperl::Syntax::EmbperlBlocks
\&  Embperl::Syntax::HTML
\&  Embperl::Syntax::EmbperlHTML
\&  Embperl::Syntax::Mail
\&  Embperl::Syntax::MsgIdExtract
\&  Embperl::Syntax::Perl
\&  Embperl::Syntax::POD
\&  Embperl::Syntax::RTF
\&  Embperl::Syntax::SSI
\&  Embperl::Syntax::Text
\&  Embperl::TipsAndTricks
\&  Sourcecode encryption
\&  Changes
.Ve
.SH "INSTALLATION DOCUMENTATION"
.IX Header "INSTALLATION DOCUMENTATION"
See perldoc \s-1INSTALL\s0.pod in the distribution archive.
.SH "OVERVIEW DOCUMENTATION"
.IX Header "OVERVIEW DOCUMENTATION"
Introductionary texts
.SH "Embperl::Features (perldoc Features.pod)"
.IX Header "Embperl::Features (perldoc Features.pod)"
List of the main features of Embperl 2.0
.SH "Embperl::Intro (perldoc Intro.pod)"
.IX Header "Embperl::Intro (perldoc Intro.pod)"
Embperl basics: What is Embperl? How to embed perl code in \s-1HTML\s0
documents; Flow Control; Dynamic Tables; Form Processing; Maintaining
persistent (session) data; Breaking up your code in components;
Debugging; Database Access; Security; Escaping/Unescaping.
.SH "Embperl::IntroEmbperl2 (perldoc IntroEmbperl2.pod)"
.IX Header "Embperl::IntroEmbperl2 (perldoc IntroEmbperl2.pod)"
Introduction to the new features in Embperl 2 considering the Embperl
homepage as example.
.SH "Embperl::IntroEmbperlObject (perldoc IntroEmbperlObject.pod)"
.IX Header "Embperl::IntroEmbperlObject (perldoc IntroEmbperlObject.pod)"
Introduction to building object-oriented websites and web applications
with Embperl
.SH "FULL DOCUMENTATION"
.IX Header "FULL DOCUMENTATION"
Detailed references
.SH "Embperl::Config (perldoc Config.pod)"
.IX Header "Embperl::Config (perldoc Config.pod)"
Using Embperl with mod_perl, \s-1CGI,\s0 FastCGI, offline or from
Perl. Includes documentation for \fBEmbperl::Execute()\fR and
documentation for all Embperl internal objects and
their methods. You also find here all of Embperl's Apache
configuration directives.
.SH "Embperl"
.IX Header "Embperl"
Describes syntax, semantic, predefined variables, session handling,
etc.
.SH "Embperl::Object"
.IX Header "Embperl::Object"
Building object-oriented websites and web applications with Embperl
.SH "Embperl::Form"
.IX Header "Embperl::Form"
.SH "Embperl::Form::Validate"
.IX Header "Embperl::Form::Validate"
Automatically creating and verifying forms with Embperl
.SH "Embperl::Mail"
.IX Header "Embperl::Mail"
Sending mails generated with Embperl, e.g. results of submitted forms.
.SH "Embperl::Inline"
.IX Header "Embperl::Inline"
Using Embperl syntax in Perl modules.
.SH "Embperl::Recipe"
.IX Header "Embperl::Recipe"
Defining Embperl recipes and provider
.SH "Embperl::Syntax"
.IX Header "Embperl::Syntax"
Defining Embperl syntax.
.PP
Modules derived from Embperl::Syntax and shipped with Embperl:
.SS "Embperl::Syntax::ASP"
.IX Subsection "Embperl::Syntax::ASP"
\&\s-1ASP\s0 syntax module (<% ... %>)
.SS "Embperl::Syntax::Embperl"
.IX Subsection "Embperl::Syntax::Embperl"
Embperl syntax module: provides the default syntax, includes
Embperl::Syntax::EmbperlBlocks, Embperl::Syntax::EmbperlHTML and
Embperl::Syntax::MsgIdExtract..
.SS "Embperl::Syntax::EmbperlBlocks"
.IX Subsection "Embperl::Syntax::EmbperlBlocks"
Syntax module for Embperl blocks
.SS "Embperl::Syntax::HTML"
.IX Subsection "Embperl::Syntax::HTML"
.SS "Embperl::Syntax::EmbperlHTML"
.IX Subsection "Embperl::Syntax::EmbperlHTML"
Syntax module for dynamic tables, forms, etc.
.SS "Embperl::Syntax::Mail"
.IX Subsection "Embperl::Syntax::Mail"
Taglib providing an \s-1HTML\s0 like syntax for sending mail
.SS "Embperl::Syntax::MsgIdExtract"
.IX Subsection "Embperl::Syntax::MsgIdExtract"
Syntax module for internationalisation via Embperl's [= =] blocks.
.SS "Embperl::Syntax::Perl"
.IX Subsection "Embperl::Syntax::Perl"
Perl syntax module, allowing Embperl to execute files with normal Perl
syntax.
.SS "Embperl::Syntax::POD"
.IX Subsection "Embperl::Syntax::POD"
\&\s-1POD\s0 syntax module, converting Perl Plain Old Documentation files on
the fly into \s-1XML.\s0
.SS "Embperl::Syntax::RTF"
.IX Subsection "Embperl::Syntax::RTF"
Syntax module to define the syntax for Rich Text Format (\s-1RTF\s0) files
.SS "Embperl::Syntax::SSI"
.IX Subsection "Embperl::Syntax::SSI"
Syntax module to emulate Apache's mod_include syntax with Embperl.
.SS "Embperl::Syntax::Text"
.IX Subsection "Embperl::Syntax::Text"
Syntax module to literally include any file without interpretation.
.SH "TIPS, TRICKS AND EXAMPLES"
.IX Header "TIPS, TRICKS AND EXAMPLES"
.SH "Embperl::TipsAndTricks (perldoc TipsAndTricks.pod)"
.IX Header "Embperl::TipsAndTricks (perldoc TipsAndTricks.pod)"
Alternative way to do global variables; Global variables via
namespaces; Handling queries in \s-1DBI\s0; Handling exits; Handling errors;
Development and production websites.
.PP
As an example how Embperl can be used, the sourcecode of the Embperl
website (see http://perl.apache.org/embperl/) is contained in the
directory eg/ of the Embperl distribution archive. Read \*(L"\s-1README\*(R"\s0 in eg
of the Embperl distribution archive for an overview.
.SH "Sourcecode encryption"
.IX Header "Sourcecode encryption"
See \*(L"\s-1README\*(R"\s0 in crypto of the Embperl distribution archive.
.SH "CHANGES"
.IX Header "CHANGES"
See perldoc Changes.pod
.SH "AUTHOR"
.IX Header "AUTHOR"
G. Richter (richter at embperl dot org), A. Beckert (beckert@ecos.de)