README First!

This is the “official” documentation for the Perl web programming framework called PET.

Summary
README First!This is the “official” documentation for the Perl web programming framework called PET.
First thing to read...actually the second thing to read, becasue this is the first :)

First thing to read

...actually the second thing to read, becasue this is the first :)

If you are new to PET, please start with reading the documentation in the order of appearance!

This is a rather big documentation, some of which is autogenerated from the source code, so you can get lost easily.  On the other hand, if you start up reading the docs in the order as they should be, in about half an hour you will understand the basics of PET (and hopefully will be really wanting to give it a try!)  In general, one hour of reading should be enough to give you a good start.

Introduction

The introduction will give you a brief explanation on what PET is.  Don’t worry if there was anything here you would not understand at first!

See here : Introduction

Basic examples

I have always thought that the best thing to learn a programming language/environment is to see a few examples.  So take a look at a few basic examples!

About PET

The PET Explained document describes how PET is actually working.  It helps a lot and if your read this.

Installation

Installing PET describes ways you can set up PET and the procedure of installing.  You can skip this part until you get familiar with the system through the other docs.

Layout

The Files and directories is a small document about how PET stores its modules, templates, session files, etc.  It’s easy reading.

Configuration parameters

Config, this incomplete documentations shows you all the config parameters you can set to finetune the way how PET works.  It also gives you a brief idea about the features PET have.

Filter chains

The document Filters talks about a built-in feature called filtering.  You don’t have to read this or use filtering at all.  However, it can be a very powerful toy -- for example for creating multilingual sites.

MVC

PET is designed to be used with MVC-style Programming.  To benefit from all the features of PET, you really should use this approach.  Don’t worry, it’s easy!

Other documents

  • Best Practices tells you how you should be using PET and what you should not do.
  • TODO is a list of things still missing from PET.
  • See License for information on the attached license of PET.
  • Tricks and Tips contains many useful examples on what and how you can achieve using PET.

Internals and Extensions

This is the internal documentation of PET.  Only for hackers!

This is the “official” documentation for PET -- a (web) programming framework and application server for Perl.
So how does PET actually look like from the eye of the programmer?
PET has a built-in capability called “filtering”.
While PET can be used as some sort of an “active pages” system, something similar to ASP/PHP/JSP, clearly it is not the recommended usage.
While not strictly necessary, it is very much advised that you read this document about the internals and design of PET.
To make the development and learning of PET easier, PET uses a fixed directory structure.
This document discusses the settings used in PET one can override.
While PET can be used as some sort of an “active pages” system, that is clearly not the recommended usage.
How you should use PET, and what you should not do.
This document is under construction.
The most important thing is : PET is FREE.
Close