cvsuser 02/11/01 12:18:23
Modified: App-Context/lib/App exceptions.pod faq.pod installguide.pod
perlstyle.pod
App-Context/lib/App/installguide win32.pod
Removed: App-Context/lib/App/Response HTML.pm
Log:
convert from P5EEx::Blue to App::Context
Revision Changes Path
1.2 +2 -5 p5ee/App-Context/lib/App/exceptions.pod
Index: exceptions.pod
===================================================================
RCS file: /cvs/public/p5ee/App-Context/lib/App/exceptions.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- exceptions.pod 9 Sep 2002 01:34:10 -0000 1.1
+++ exceptions.pod 1 Nov 2002 20:18:22 -0000 1.2
@@ -6,7 +6,7 @@
=head1 NAME
-P5EEx::Blue::exceptions - P5EE Programming with Exceptions
+App::exceptions - Programming with Exceptions
=head1 INTRODUCTION
@@ -20,10 +20,7 @@
This document was written to explain the support within the Perl
language for programming using exceptions in general. It also explains
-the standards for exception programming in the P5EE framework.
-
-This document represents the recommendations and collective wisdom
-from the P5EE developers.
+the standards for exception programming in the App-Context framework.
The short answer is that we recommend the following modules
to assist in exception programming.
1.2 +33 -33 p5ee/App-Context/lib/App/faq.pod
Index: faq.pod
===================================================================
RCS file: /cvs/public/p5ee/App-Context/lib/App/faq.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- faq.pod 9 Sep 2002 01:34:10 -0000 1.1
+++ faq.pod 1 Nov 2002 20:18:22 -0000 1.2
@@ -6,12 +6,12 @@
=head1 NAME
-P5EEx::Blue::faq - P5EE Frequently Asked Questions
+App::faq - App Frequently Asked Questions
=head1 INTRODUCTION
This is the FAQ for the
-P5EE (Perl 5 Enterprise Environment).
+App (Perl 5 Enterprise Environment).
You can find out more background to the project on the web.
http://www.officevision.com/pub/p5ee
@@ -19,7 +19,7 @@
=head1 GENERAL
-=head2 Why should I use P5EE rather than J2EE or .NET?
+=head2 Why should I use App rather than J2EE or .NET?
Perhaps it's because you prefer writing in Perl?
But besides that, there are other reasons.
@@ -60,20 +60,20 @@
a blueprint for large-scale development and deployment of
high-performance, high-availability systems (i.e. enterprise
systems) along with guides of discipline for coding and
-documentation. The P5EE fills this gap.
+documentation. The App fills this gap.
-So that's the explanation of "why P5EE?"
+So that's the explanation of "why App?"
-For an explanation of "why not P5EE?" you might consider that it
+For an explanation of "why not App?" you might consider that it
is still largely vaporware.
-=head2 How well does the P5EE fit into a .NET technical strategy?
+=head2 How well does the App fit into a .NET technical strategy?
-It may seem that P5EE is most at home with the following technologies.
+It may seem that App is most at home with the following technologies.
* Perl, Linux, Apache, CGI, and MySQL.
-However, the P5EE abstracts much of the
+However, the App abstracts much of the
runtime environment, so that it is just as easy to use:
* Perl, Windows NT, IIS, ISAPI, and SQLServer.
@@ -96,20 +96,20 @@
to run on the .NET CLR.
http://www.parrotcode.org/faq/
-=head2 What is the relation between P5EE and mod_perl?
+=head2 What is the relation between App and mod_perl?
The people who have been developing and working on mod_perl have done
an incredible service to Enterprise Perl in general, and therefore
-the P5EE in particular. Other efforts that dramatically enhance
+the App in particular. Other efforts that dramatically enhance
Enterprise Perl are SOAP projects, XML projects, DBD/DBI::*,
Templating projects, etc. These are all making dramatic contributions,
and they need not change anything they are doing in order to continue
to do so.
-On the contrary, the responsibility is on the designers of the P5EE
+On the contrary, the responsibility is on the designers of the App
to accommodate and incorporate these many enterprise-class technologies
-into an integrates whole. Browse the classes envisioned for P5EE
-by P5EEx::Blue to see one way that these might fit together. Take
+into an integrates whole. Browse the classes envisioned for App
+by App to see one way that these might fit together. Take
special note of the "Classes (Planned)" at the bottom of the
"All Classes" frame.
@@ -118,37 +118,37 @@
As for mod_perl, it would seem to be the container of choice for
web applications and SOAP services.
- http://www.officevision.com/pub/p5ee/software/htdocs/P5EEx/Blue/Context.html
+ http://www.officevision.com/pub/p5ee/software/htdocs/Appx/Blue/Context.html
There is no need for the mod_perl project to explicitly
-integrate with P5EE. However, in the spirit of community,
-as the P5EE grows in its capabilities, I would imagine a
-natural cross-fertilization of ideas would occur so that if P5EE needed
+integrate with App. However, in the spirit of community,
+as the App grows in its capabilities, I would imagine a
+natural cross-fertilization of ideas would occur so that if App needed
any specific feature in mod_perl it would be implemented without
too much trouble.
-However, P5EE reaches further than just running in a mod_perl Context.
-P5EE is equipped with (when they are written, of course) a variety of
-Context classes which allow P5EE software to run in many other Contexts
+However, App reaches further than just running in a mod_perl Context.
+App is equipped with (when they are written, of course) a variety of
+Context classes which allow App software to run in many other Contexts
besides mod_perl.
-=head2 What does it mean for P5EE to support Perl 5.5.3 if some of its components
require a higher version of Perl?
+=head2 What does it mean for App to support Perl 5.5.3 if some of its components
require a higher version of Perl?
-The P5EE (as envisioned in P5EEx::Blue) is like a software backplane
+The App (as envisioned in App) is like a software backplane
for many services required by an enterprise application. Into that
-backplane plug the P5EE Services. There may be many implementations
-of each of the P5EE Services, making for an almost limitless array
+backplane plug the App Services. There may be many implementations
+of each of the App Services, making for an almost limitless array
of possible combinations. (Hopefully, favorites will emerge.)
The Context is a Core Service, like Session and Config.
-(A Core Service is one that is not derived from P5EEx::Blue::Service
+(A Core Service is one that is not derived from App::Service
but maintains the concept of "a pluggable implementation of an
-abstract service".) An examination of the P5EEx::Blue::Context
+abstract service".) An examination of the App::Context
documentation will show that there are many Contexts from which
the implementer may choose to deploy the software, and the software
could reasonably run on all of them. The fact that (the envisioned)
-P5EEx::Blue::Context::Modperl2 depends on 5.6.0 does not invalidate
-the fact that the P5EE depends only on 5.5.3. Implementers who
+App::Context::Modperl2 depends on 5.6.0 does not invalidate
+the fact that the App depends only on 5.5.3. Implementers who
choose to deploy with Services that have higher Perl version
dependencies must of course satisfy those dependencies.
@@ -163,17 +163,17 @@
functions as long as there is some other Service implementation
(perhaps lower performing) which meets the cross-platform requirement.
-i.e. P5EEx::Blue::Context::Modperl2 may require 5.6.0, but
-P5EEx::Blue::Context::Modperl and P5EEx::Blue::Context::CGI will
+i.e. App::Context::Modperl2 may require 5.6.0, but
+App::Context::Modperl and App::Context::CGI will
both run on 5.5.3.
Sometimes when we think about Enterprise Systems, we think about
big budget projects with the latest new hardware. My experience
with customers who are large enterprises is that they have an
incredible mish-mash of systems and legacy environments. I envision
-that P5EE software could be installed on every platform they own
+that App software could be installed on every platform they own
(isn't Perl almost the most-ported language on the planet?).
-That is why I believe that P5EE must support 5.5.3 (or perhaps
+That is why I believe that App must support 5.5.3 (or perhaps
earlier, but I won't go there yet until I see a real need to
and understand exactly what I would be giving up).
1.2 +19 -19 p5ee/App-Context/lib/App/installguide.pod
Index: installguide.pod
===================================================================
RCS file: /cvs/public/p5ee/App-Context/lib/App/installguide.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- installguide.pod 9 Sep 2002 01:34:10 -0000 1.1
+++ installguide.pod 1 Nov 2002 20:18:22 -0000 1.2
@@ -6,24 +6,24 @@
=head1 NAME
-P5EEx::Blue::installguide - P5EE Installation Guide
+App::installguide - App Installation Guide
=head1 INTRODUCTION
This is the Installation Guide to the
-P5EE (Perl 5 Enterprise Environment).
+App (Perl 5 Enterprise Environment).
You can find out more background to the project on the web.
http://www.officevision.com/pub/p5ee
http://p5ee.perl.org
-Installation of the P5EE requires the following:
+Installation of the App requires the following:
* install Perl (at least 5.5.3) (5.005_03)
(you can test this by typing "perl -v")
* install Apache or other web server
* install dependent Perl modules from CPAN
- * install P5EE software
+ * install App software
We will discuss the last item first, because it is assumed
that most people know how to do the first three or they
@@ -35,12 +35,12 @@
wherever your Perl is installed. In that case, skip this section.
If however, you are setting up a development environment, or
-if you wish to install multiple versions of the P5EE software,
+if you wish to install multiple versions of the App software,
it is advisable you choose an approach as follows.
=head2 Set Up a Development Environment (Unix)
-Choose a directory that will be the base of all P5EE
+Choose a directory that will be the base of all App
environments (i.e. /usr/mycompany, any base directory will do).
/usr/mycompany
@@ -60,7 +60,7 @@
/usr/mycompany/qagroup
These are independent development "sandboxes".
-Later, when we start making releases of the software (which includes the P5EE
+Later, when we start making releases of the software (which includes the App
framework), we will create other environment directories like this.
/usr/mycompany/0.5.0
@@ -136,17 +136,17 @@
If anyone finds other dependent modules, please let me know.
-=head1 GET P5EE SOFTWARE
+=head1 GET App SOFTWARE
-=head2 Get P5EE From CPAN
+=head2 Get App From CPAN
-The P5EE is not yet on CPAN.
+The App is not yet on CPAN.
Try one of the other methods.
-=head2 Get P5EE from CVS (to develop P5EE)
+=head2 Get App from CVS (to develop App)
You should use this method if you *do* have commit access
-on the P5EE CVS repository. (Note, substitute your CVS
+on the App CVS repository. (Note, substitute your CVS
user id for "LOGIN" below.)
cd $PREFIX/src
@@ -163,11 +163,11 @@
See a CVS document to find out how to create, delete, and modify files
and then submit changes.
-=head2 Get P5EE from CVS (anonymous, read-only access to latest P5EE)
+=head2 Get App from CVS (anonymous, read-only access to latest App)
You should use this method if you do *not* have commit access
-on the P5EE CVS repository but you do want to stay up to date with the
-latest P5EE software (recommended, because there are no releases yet).
+on the App CVS repository but you do want to stay up to date with the
+latest App software (recommended, because there are no releases yet).
cd $PREFIX/src
cvs -d :pserver:[EMAIL PROTECTED]:/cvs/public login
@@ -182,7 +182,7 @@
The "cvs update" method is the preferred way to get updates.
-=head2 Get P5EE from a Snapshot
+=head2 Get App from a Snapshot
If you do not have CVS on your system, you can still get reasonably
recent sources from http://cvs.perl.org/snapshots/p5ee/.
@@ -198,11 +198,11 @@
perl -MLWP::Simple -e
'getstore("http://cvs.perl.org/snapshots/p5ee/p5ee-latest.tar.gz";,
"tar/p5ee-latest.tar.gz")'
gunzip < tar/p5ee-latest.tar.gz | tar xvf -
-=head1 INSTALL P5EE SOFTWARE
+=head1 INSTALL App SOFTWARE
=head2 Install Perl Modules, Man Pages, HTML Pages
- cd $PREFIX/src/p5ee/P5EEx/Blue
+ cd $PREFIX/src/p5ee/Appx/Blue
make
make test (these may or may not work. the tests themselves are under
development.)
make install
@@ -211,7 +211,7 @@
You will need to do this one time.
- cd $PREFIX/src/p5ee/P5EEx/Blue/cgi-bin
+ cd $PREFIX/src/p5ee/Appx/Blue/cgi-bin
cp demo.conf p5ee.conf
vi p5ee.conf
# edit the following lines:
1.2 +45 -39 p5ee/App-Context/lib/App/perlstyle.pod
Index: perlstyle.pod
===================================================================
RCS file: /cvs/public/p5ee/App-Context/lib/App/perlstyle.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- perlstyle.pod 9 Sep 2002 01:34:10 -0000 1.1
+++ perlstyle.pod 1 Nov 2002 20:18:22 -0000 1.2
@@ -1,15 +1,15 @@
#############################################################################
-## $Id: perlstyle.pod,v 1.1 2002/09/09 01:34:10 spadkins Exp $
+## $Id: perlstyle.pod,v 1.2 2002/11/01 20:18:22 spadkins Exp $
#############################################################################
=head1 NAME
-P5EEx::Blue::perlstyle - P5EE Style Guide
+App::perlstyle - App Style Guide
=head1 INTRODUCTION
-All code and documentation that is submitted to be included in the P5EE
+All code and documentation that is submitted to be included in the App
distribution should follow the style in this document. This is not to
try to stifle your creativity, but to make life easier for everybody who
has to work with your code, and to aid those who are not quite sure how
@@ -18,22 +18,22 @@
These conventions below apply to perl modules, web (CGI/mod_perl) programs,
command-line programs, specifically, but also might apply to some
-degree to any Perl code written for use in P5EE.
+degree to any Perl code written for use in App.
Note that these are all guidelines, not unbreakable rules. If you have
a really good need to break one of the rules herein, however, then it is
-best to ask the core P5EE team first.
+best to ask the core App team first.
Note that with much of this document, it is not so much the Right Way as
it is Our Way. We need to have conventions in order to make life easier
for everyone.
-If you have any questions, please ask us on the P5EE-development
+If you have any questions, please ask us on the App-development
mailing list, [EMAIL PROTECTED]
http://lists.perl.org/showlist.cgi?name=p5ee
-Documentation for the P5EE project is at the following sites.
+Documentation for the App project is at the following sites.
http://p5ee.perl.org
http://www.officevision.com/pub/p5ee
@@ -48,7 +48,7 @@
We code everything to perl 5.005_03. Some day we may switch to take
advantage of perl 5.6 features. Regardless, all code should run on perl
-5.005_03 or any later version of perl 5. All of the core P5EE code has
+5.005_03 or any later version of perl 5. All of the core App code has
been tested on perl 5.005_03 and perl 5.6.0, though it has probably
been used more on perl 5.6.0.
@@ -105,11 +105,11 @@
number is the subversion. Odd-numbered versions are development
versions. Examples:
- 1.0.0 First release of P5EE 1
- 1.0.1 Second release of P5EE 1.0
+ 1.0.0 First release of App 1
+ 1.0.1 Second release of App 1.0
1.0.10 etc.
- 1.1.0 First development release of P5EE 1.2 (or 2.0)
- 2.0.0 First release of P5EE 2
+ 1.1.0 First development release of App 1.2 (or 2.0)
+ 2.0.0 First release of App 2
Versions can be modified with a hyphen followed by some text, for
special versions, or to give extra information. Examples:
@@ -154,8 +154,8 @@
really need to do it that way are remote.
The one exception is the "Use of uninitialized variable" warnings.
-We have those disabled in P5EE.pm, so by including "use
-P5EE" you are disabling that warning in your code, too, and you don't
+We have those disabled in App.pm, so by including "use
+App" you are disabling that warning in your code, too, and you don't
need to worry about them.
@@ -184,7 +184,7 @@
Do not export anything from a module by default.
Feel free to put anything you
want to in @EXPORT_OK, so users of your modules can explicitly ask
-for symbols (e.g., "use P5EE::Something qw(getFoo setFoo)"), but
+for symbols (e.g., "use App::Something qw(getFoo setFoo)"), but
do not export them by default.
@@ -247,7 +247,7 @@
=head2 STDIN/STDOUT
-Always report errors using the (yet-to-be-defined) P5EE logging
+Always report errors using the (yet-to-be-defined) App logging
facility. Never print directly to STDERR.
Do not print directly to STDOUT, unless you need to
print directly to the user's browser.
@@ -304,11 +304,11 @@
=over 4
-=item P5EE
+=item App
-The name of the project is "P5EE".
-There is no "P5EE1" or "P5EE2".
-To specify a version, use "P5EE 2.0" or "P5EE 2.0.1".
+The name of the project is "App".
+There is no "App1" or "App2".
+To specify a version, use "App 2.0" or "App 2.0.1".
=item function vs. sub(routine) vs. method
@@ -406,28 +406,28 @@
Package names begin with a capital letter in each word, followed by
lower case letters.
- P5EE::Standard # good
- P5EE::Authz # good
- P5EE::MainCode # good
+ App::Standard # good
+ App::Authz # good
+ App::MainCode # good
Use all lower case for POD files which are documentation only.
- P5EE::styleguide # good for doc only
+ App::styleguide # good for doc only
Naming for modules should be according to the following general rules.
- All P5EE services which have *broad* support from the
- [EMAIL PROTECTED] list would go into the "P5EE" package
+ All App services which have *broad* support from the
+ [EMAIL PROTECTED] list would go into the "App" package
Naming style is similar to other modules on CPAN
Naming choice draws from precedent of other modules on CPAN
Naming choice draws from precedent of J2EE
Packages which aren't intended to be instantiated as objects may
have an "adjective" or "concept" for a name
-(i.e. P5EE::Standard). Packages which are
+(i.e. App::Standard). Packages which are
Modules/Classes and are intended to be instantiated as objects
should be nouns, potentially accompanied by modifying adjectives
-(i.e. P5EE::Authen::Principal).
+(i.e. App::Authen::Principal).
=head2 Indents
@@ -748,13 +748,13 @@
This is for new programs, modules, specific APIs, or anything else.
-Contact for core team is the P5EE-development mailing list.
+Contact for core team is the App-development mailing list.
Discuss all ideas there.
-The basic process for a new P5EE service is:
+The basic process for a new App service is:
- get the blessing from the P5EE list for a top-level package name
- (i.e. "P5EE::NewModule")
+ get the blessing from the App list for a top-level package name
+ (i.e. "App::NewModule")
begin a CPAN-able source directory skeleton
write the spec (no code) as POD inside the target module(s)
publish HTML to the web
@@ -777,21 +777,27 @@
lots
-
=head1 ACKNOWLEDGEMENTS
This style guide was based on the slashcode style guide.
-
-It is also in conformance with the mod_perl style guide
-and is in the spirit of the C-language Apache style guide.
+It is in conformance with the general Perl style guide
+(perldoc perlstyle) and the mod_perl style guide.
http://slashcode.com/docs/slashstyle.html
-
http://cvs.apache.org/viewcvs.cgi/modperl-docs/src/devel/modperl_style/modperl_style.pod?rev=1.5
- http://dev.apache.org/styleguide.html
+ http://search.cpan.org/author/JHI/perl/pod/perlstyle.pod
+ http://perl.apache.org/docs/2.0/devel/modperl_style/modperl_style.html
+
+It is also in the spirit of the C-language Apache style guide.
+
+ http://httpd.apache.org/dev/styleguide.html
+
=head1 CHANGES
$Log: perlstyle.pod,v $
+ Revision 1.2 2002/11/01 20:18:22 spadkins
+ convert from P5EEx::Blue to App::Context
+
Revision 1.1 2002/09/09 01:34:10 spadkins
first import
@@ -808,6 +814,6 @@
=head1 VERSION
-$Id: perlstyle.pod,v 1.1 2002/09/09 01:34:10 spadkins Exp $
+$Id: perlstyle.pod,v 1.2 2002/11/01 20:18:22 spadkins Exp $
1.2 +5 -5 p5ee/App-Context/lib/App/installguide/win32.pod
Index: win32.pod
===================================================================
RCS file: /cvs/public/p5ee/App-Context/lib/App/installguide/win32.pod,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- win32.pod 9 Sep 2002 01:34:11 -0000 1.1
+++ win32.pod 1 Nov 2002 20:18:23 -0000 1.2
@@ -6,18 +6,18 @@
=head1 NAME
-P5EEx::Blue::installguide::win32 - P5EE Installation Guide for Win32
+App::installguide::win32 - App Installation Guide for Win32
=head1 INTRODUCTION
This is the Installation Guide to the
-P5EE (Perl 5 Enterprise Environment) for the Microsoft Windows platform.
+App (Perl 5 Enterprise Environment) for the Microsoft Windows platform.
You can find out more background to the project on the web.
http://www.officevision.com/pub/p5ee
http://p5ee.perl.org
-You should also consult the general P5EEx::Blue::installguide
+You should also consult the general App::installguide
before consulting this specialized guide.
This will describe how to get
@@ -91,7 +91,7 @@
C:\>
The following commands are to install package which are
-necessary in order for any of P5EE to run.
+necessary in order for any of App to run.
C:\> ppm
PPM> install TimeDate # Date::Parse and Date::Format
@@ -113,7 +113,7 @@
C:\>
The following commands are to install packages which used
-to be required by earlier versions of P5EE. They are shown
+to be required by earlier versions of App. They are shown
just in case a dependence on them were restored in the future.
C:\> ppm
