---
name: "Embperl::TOC"
section: "3pm"
platform: "linux"
package: "libembperl-perl"
version: "2.5.0-17"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/Embperl::TOC"
---

# Embperl::TOC(3pm)

Embperl Documentation: Table of Contents

## NAME

Embperl::TOC - Embperl Documentation: Table of Contents

## 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 [**perldoc**(1)](/perldoc/1.md) or [**man**(1)](/man/1.md):

## CONTENT

```
  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
```

## INSTALLATION DOCUMENTATION

See perldoc INSTALL.pod in the distribution archive.

## OVERVIEW DOCUMENTATION

Introductionary texts

## Embperl::Features (perldoc Features.pod)

List of the main features of Embperl 2.0

## Embperl::Intro (perldoc Intro.pod)

Embperl basics: What is Embperl? How to embed perl code in HTML documents; Flow Control; Dynamic Tables; Form Processing; Maintaining persistent (session) data; Breaking up your code in components; Debugging; Database Access; Security; Escaping/Unescaping.

## Embperl::IntroEmbperl2 (perldoc IntroEmbperl2.pod)

Introduction to the new features in Embperl 2 considering the Embperl homepage as example.

## Embperl::IntroEmbperlObject (perldoc IntroEmbperlObject.pod)

Introduction to building object-oriented websites and web applications with Embperl

## FULL DOCUMENTATION

Detailed references

## Embperl::Config (perldoc Config.pod)

Using Embperl with mod\_perl, CGI, FastCGI, offline or from Perl. Includes documentation for **Embperl::Execute()** and documentation for all Embperl internal objects and their methods. You also find here all of Embperl's Apache configuration directives.

## Embperl

Describes syntax, semantic, predefined variables, session handling, etc.

## Embperl::Object

Building object-oriented websites and web applications with Embperl

## Embperl::Form

## Embperl::Form::Validate

Automatically creating and verifying forms with Embperl

## Embperl::Mail

Sending mails generated with Embperl, e.g. results of submitted forms.

## Embperl::Inline

Using Embperl syntax in Perl modules.

## Embperl::Recipe

Defining Embperl recipes and provider

## Embperl::Syntax

Defining Embperl syntax.

Modules derived from Embperl::Syntax and shipped with Embperl:

### Embperl::Syntax::ASP

ASP syntax module (\<% ... %\>)

### Embperl::Syntax::Embperl

Embperl syntax module: provides the default syntax, includes Embperl::Syntax::EmbperlBlocks, Embperl::Syntax::EmbperlHTML and Embperl::Syntax::MsgIdExtract..

### Embperl::Syntax::EmbperlBlocks

Syntax module for Embperl blocks

### Embperl::Syntax::HTML

### Embperl::Syntax::EmbperlHTML

Syntax module for dynamic tables, forms, etc.

### Embperl::Syntax::Mail

Taglib providing an HTML like syntax for sending mail

### Embperl::Syntax::MsgIdExtract

Syntax module for internationalisation via Embperl's \[= =\] blocks.

### Embperl::Syntax::Perl

Perl syntax module, allowing Embperl to execute files with normal Perl syntax.

### Embperl::Syntax::POD

POD syntax module, converting Perl Plain Old Documentation files on the fly into XML.

### Embperl::Syntax::RTF

Syntax module to define the syntax for Rich Text Format (RTF) files

### Embperl::Syntax::SSI

Syntax module to emulate Apache's mod\_include syntax with Embperl.

### Embperl::Syntax::Text

Syntax module to literally include any file without interpretation.

## TIPS, TRICKS AND EXAMPLES

## Embperl::TipsAndTricks (perldoc TipsAndTricks.pod)

Alternative way to do global variables; Global variables via namespaces; Handling queries in DBI; Handling exits; Handling errors; Development and production websites.

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 "README" in eg of the Embperl distribution archive for an overview.

## Sourcecode encryption

See "README" in crypto of the Embperl distribution archive.

## CHANGES

See perldoc Changes.pod

## AUTHOR

G. Richter (richter at embperl dot org), A. Beckert (beckert@ecos.de)