| 1 |
Embperl - Building dynamic Websites with Perl |
| 2 |
|
| 3 |
Copyright (c) 1997-2008 Gerald Richter / ecos gmbh www.ecos.de |
| 4 |
Copyright (c) 2008-2014 Gerald Richter |
| 5 |
|
| 6 |
You may distribute under the terms of either the GNU General Public |
| 7 |
License or the Artistic License, as specified in the Perl README file. |
| 8 |
|
| 9 |
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED |
| 10 |
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF |
| 11 |
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. |
| 12 |
|
| 13 |
|
| 14 |
|
| 15 |
|
| 16 |
OVERVIEW |
| 17 |
======== |
| 18 |
|
| 19 |
Embperl gives you the power to embed Perl code in your HTML documents |
| 20 |
and the ability to build your Web site out of small reusable objects in |
| 21 |
an object-oriented style. You can also take advantage of all the |
| 22 |
usual Perl modules, (including DBI for database access) use their |
| 23 |
functionality and easily include their output in your web pages. |
| 24 |
Additionally Embperl support including XML, XSLT tranformations and |
| 25 |
a lot of other sources formats. |
| 26 |
|
| 27 |
Embperl has several features which are especially useful for creating |
| 28 |
HTML, including dynamic tables, form field processing and validation, URL |
| 29 |
escaping/unescaping, session handling, and more. |
| 30 |
|
| 31 |
Embperl is a server-side tool, which means that it's browser-independent. |
| 32 |
It can run in various ways: under mod_perl, as a CGI script, or offline. |
| 33 |
|
| 34 |
For database access, there is a module called DBIx::Recordset, which |
| 35 |
works well together with Embperl and simplifies creating web pages |
| 36 |
with database content. |
| 37 |
|
| 38 |
|
| 39 |
DOCUMENTATION |
| 40 |
============= |
| 41 |
|
| 42 |
The following documentation is available within the distribution |
| 43 |
|
| 44 |
Detailed list of documenation: perldoc TOC.pod |
| 45 |
Features of Embperl: perldoc Features.pod |
| 46 |
Introduction to basic Embperl: perldoc Intro.pod |
| 47 |
Introduction to Embperl 2 |
| 48 |
advanced features: perldoc IntroEmbperl2.pod |
| 49 |
Introduction to EmbperlObject: perldoc IntroEmbperlObject.pod |
| 50 |
Installation of Embperl: perldoc INSTALL.pod |
| 51 |
Full documentation: perldoc Config.pod |
| 52 |
perldoc Embperl.pod |
| 53 |
perldoc Embperl/Object.pm |
| 54 |
perldoc Embperl/Mail.pm |
| 55 |
perldoc Embperl/Inline.pm |
| 56 |
Tips and Tricks: perldoc TipsAndTricks.pod |
| 57 |
Changes: perldoc Changes.pod |
| 58 |
Examples: eg/README |
| 59 |
Sourcecode encryption: crypto/README |
| 60 |
Documentation and example for |
| 61 |
Embperl::Form can be found at: eg/forms |
| 62 |
|
| 63 |
|
| 64 |
All the above and further information can be found at the Embperl website |
| 65 |
|
| 66 |
http://perl.apache.org/embperl/ |
| 67 |
|
| 68 |
All the above and further information can be found at the german Embperl website |
| 69 |
|
| 70 |
http://www.ecos.de/embperl/ |
| 71 |
|
| 72 |
|
| 73 |
---> See README.v2 if you upgrade from 1.x <--- |
| 74 |
|
| 75 |
|
| 76 |
FEATURES |
| 77 |
======== |
| 78 |
|
| 79 |
* Embperl facilitates embedding Perl code into HTML/XML or other text documents. |
| 80 |
Perl code is evaluated at the server side and the result is sent to the browser. |
| 81 |
All available Perl modules can be used without any restriction. |
| 82 |
|
| 83 |
* Allows one to build Web sites out of small reusable components in an object-oriented way. |
| 84 |
Components can call and/or embed each other and inherit from other objects. |
| 85 |
|
| 86 |
* Standard layout of a web-site site can be defined once and the content can be |
| 87 |
dynamically generated by these components based on the uri. The documents need only |
| 88 |
contain the variable portions but not the common items which define the |
| 89 |
layout like headers/footers or navigation bars which normally form the template. |
| 90 |
Also these common elements can be overwritten in each sub-directory. |
| 91 |
|
| 92 |
* Embperl 2.0 thus facilitates separating code, layout and creating MVC (Model-View-Controller) |
| 93 |
applications. Control logic can be moved into an application object, |
| 94 |
which controls further execution of the request, while the actual pages are |
| 95 |
containing the display code. Simple applications can still embed all the code in the pages. |
| 96 |
|
| 97 |
* Source-code for each component can come from a different source, eg. |
| 98 |
from file, memory or sub-request which allows one to act on the output from another Apache |
| 99 |
application like PHP, JSP, CGI Script etc. |
| 100 |
|
| 101 |
* Each component can be in a different source format (e.g. HTML, WML, XML, POD, ...) |
| 102 |
and can be transformed to other output formats, say by using via XSLT. |
| 103 |
|
| 104 |
* Supports one or more scripting syntax using Embperl, ASP, Text, Perl and others. |
| 105 |
|
| 106 |
* Output generation is divided into small steps where each is processed by a plugable provider. |
| 107 |
The interaction of the providers can be individually configured for each component via recipes. |
| 108 |
|
| 109 |
* Supports caching of intermediate results and output. |
| 110 |
|
| 111 |
* Embperl encompasses several features that ease the task of dynamic web-site content generation, |
| 112 |
including dynamic-tables, form-field-processing, escaping/unescaping, etc. |
| 113 |
|
| 114 |
* Contains a module for easy form input validation, which is able to validate user input |
| 115 |
at the server side and on the client side by one definition of rules. |
| 116 |
|
| 117 |
* Handles per-user and per-module persistent session requiring only storage and retrieval of |
| 118 |
the session data from a special hash. |
| 119 |
|
| 120 |
* UTF-8 Support (honours Perl's internal UTF-8 flag during in- and output) |
| 121 |
|
| 122 |
* Offers flexible configuration options to suite individual tastes and needs. |
| 123 |
|
| 124 |
* Fully integrated into Apache and mod_perl to acheive the best performance. |
| 125 |
Can also run as a free standing CGI-script, off-line or can be called from another Perl program. |
| 126 |
|
| 127 |
* The Perl module DBIx::Recordset offers high level, easy to use database access for Embperl. |
| 128 |
|
| 129 |
* Embperl::Mail enables redirecting the result output to a mail-recipient. |
| 130 |
|
| 131 |
* Embperl::Inline allows one to embedd Embperl code in normal Perl code |
| 132 |
|
| 133 |
* Embperl::Form is a sophisticated library for building HTML forms |
| 134 |
|
| 135 |
|
| 136 |
|
| 137 |
COMPATIBILITY |
| 138 |
============= |
| 139 |
|
| 140 |
I have tested Embperl successfully |
| 141 |
|
| 142 |
on Linux 2.x with |
| 143 |
|
| 144 |
perl5.005_01/02/03 |
| 145 |
perl5.6.1 |
| 146 |
perl5.8.x |
| 147 |
perl5.10.x |
| 148 |
perl5.12.x |
| 149 |
perl5.14.x |
| 150 |
perl5.16.x |
| 151 |
perl5.18.x |
| 152 |
apache_1.3.x, apache 2.0.x, apache 2.2.x, apache 2.4.x |
| 153 |
apache + mod_ssl |
| 154 |
apache_ssl (Ben SSL) |
| 155 |
Stronghold 2.2 |
| 156 |
Stronghold 2.4.1 |
| 157 |
|
| 158 |
on Windows NT 4.0 with |
| 159 |
|
| 160 |
perl5.004_04 |
| 161 |
perl5.005_xx |
| 162 |
perl5.6.1 |
| 163 |
perl5.8.x |
| 164 |
apache_1.3.0 - apache_1.3.31 |
| 165 |
|
| 166 |
Apache 2 is currently not supported on Windows. |
| 167 |
This is planned for Embperl 3 |
| 168 |
|
| 169 |
on Windows 95/98 with |
| 170 |
|
| 171 |
perl5.004_02 (binary distribution) |
| 172 |
Offline mode |
| 173 |
perl5.005_03 + apache_1.3.6 |
| 174 |
|
| 175 |
I know from other people that it works on many other UNIX systems |
| 176 |
|
| 177 |
|
| 178 |
FEEDBACK and BUG REPORTS |
| 179 |
======================== |
| 180 |
|
| 181 |
Please let me know if you use or test this module. Bugs, questions, |
| 182 |
suggestions for things you would find useful, etc., are discussed on |
| 183 |
the Embperl mailing list. If you have a site that is using Embperl, |
| 184 |
I would love to mention it in the list of sites using Embperl |
| 185 |
(http://perl.apache.org/embperl/db/sites/sites.htm). Please go |
| 186 |
to the Embperl website and add your site. |
| 187 |
|
| 188 |
|
| 189 |
The Embperl mailing list ([email protected]) is available for Embperl users |
| 190 |
and developers to share ideas, solve problems and discuss things related to Embperl |
| 191 |
To subscribe to this list, send mail to [email protected]. |
| 192 |
To unsubscribe send email to [email protected] . |
| 193 |
|
| 194 |
There is an archive for the Embperl mailing list at |
| 195 |
http://mail-archives.apache.org/mod_mbox/perl-embperl |
| 196 |
|
| 197 |
For mod_perl related questions you may search the mod_perl mailing list |
| 198 |
archive at http://mail-archives.apache.org/mod_mbox/perl-modperl |
| 199 |
|
| 200 |
|
| 201 |
|
| 202 |
|
| 203 |
COMMERICAL SUPPORT |
| 204 |
================== |
| 205 |
|
| 206 |
You can get free support on the Embperl mailing list (see above). If |
| 207 |
you need commercial support, ecos can provide it for you. We offer: |
| 208 |
|
| 209 |
* Consulting, assitance and training for you and your programmers |
| 210 |
|
| 211 |
* Planning of your dynamic website |
| 212 |
|
| 213 |
* Creating of parts or a whole website |
| 214 |
|
| 215 |
* Fixing bugs in Embperl (also available for mod_perl) |
| 216 |
|
| 217 |
* Adding new features |
| 218 |
|
| 219 |
You can reach us via http://www.ecos.de or richter at embperl dot org |
| 220 |
|
| 221 |
|
| 222 |
|
| 223 |
HOW TO SUPPORT THE DEVELOPMENT OF EMBPERL |
| 224 |
========================================= |
| 225 |
|
| 226 |
If you use and like Embperl and want to support it's ongoing development |
| 227 |
you have two possibilities: |
| 228 |
|
| 229 |
1. Send me patches for things you like to see in Embperl |
| 230 |
|
| 231 |
2. Donate money to Embperl. See http://perl.apache.org/donate.htm |
| 232 |
|
| 233 |
3. Buy commercial support (see above). Also you _may_ get the same answers |
| 234 |
to your questions on the mailing list, by buying the commercial support |
| 235 |
you not only buy support for yourself and can be sure you get an answer, |
| 236 |
you also give us the possibility to put more power in the further |
| 237 |
development of Embperl. |
| 238 |
|
| 239 |
|
| 240 |
LOGO |
| 241 |
==== |
| 242 |
|
| 243 |
The Embperl distribution contains a "Powered by Embperl" Logo |
| 244 |
(EmbperlLogo.gif) which you may place at your Web-site if you like. |
| 245 |
|
| 246 |
|
| 247 |
AUTHOR |
| 248 |
====== |
| 249 |
|
| 250 |
G. Richter (richter at embperl dot org) |
| 251 |
|
| 252 |
|