X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FWeb%2FSimple.pm;h=0e4797c5736a44a9f3c1bf9701d29300fe756a0b;hb=6a4808bf0d52746eec29e8335002600600ea07c4;hp=9d4135c5858338ba384de6f10cdbd4a911c4cf0b;hpb=32d29dcd27e2b021ba40a6e39b2fcdff601b9742;p=catagits%2FWeb-Simple.git diff --git a/lib/Web/Simple.pm b/lib/Web/Simple.pm index 9d4135c..0e4797c 100644 --- a/lib/Web/Simple.pm +++ b/lib/Web/Simple.pm @@ -74,12 +74,12 @@ If you save this file into your cgi-bin as C and then visit: http://my.server.name/cgi-bin/hello-world.cgi/ you'll get the "Hello world!" string output to your browser. For more complex -examples and non-CGI deployment, see below. To get help with Web::Simple, +examples and non-CGI deployment, see below. To get help with L, please connect to the irc.perl.org IRC network and join #web-simple. =head1 DESCRIPTION -The philosophy of L is to keep to an absolute bare minimum, for +The philosophy of L is to keep to an absolute bare minimum for everything. It is not designed to be used for large scale applications; the L web framework already works very nicely for that and is a far more mature, well supported piece of software. @@ -88,17 +88,17 @@ However, if you have an application that only does a couple of things, and want to not have to think about complexities of deployment, then L might be just the thing for you. -The only public interface the Web::Simple module itself provides is an -import based one: +The only public interface the L module itself provides is an +C based one: use Web::Simple 'NameOfApplication'; -This setups up your package (in this case "NameOfApplication" is your package) +This sets up your package (in this case "NameOfApplication" is your package) so that it inherits from L and imports L, as well as installs a C constant for convenience, as well as some other subroutines. -Importing L will automatically make you code use the C and +Importing L will automatically make your code use the C and C pragma, so you can skip the usual: use strict; @@ -118,6 +118,10 @@ the the equivalent of: extends 'Web::Simple::Application'; } +So you can use L features in your application, such as creating attributes +using the C subroutine, etc. Please see the documentation for L for +more information. + It also exports the following subroutines for use in dispatchers: response_filter { ... }; @@ -136,7 +140,7 @@ is encountered in other code. =head1 DISPATCH STRATEGY -L dispite being straightforward to use, has a powerful system +L despite being straightforward to use, has a powerful system for matching all sorts of incoming URLs to one or more subroutines. These subroutines can be simple actions to take for a given URL, or something more complicated, including entire L applications, L @@ -328,10 +332,9 @@ Finally, sub (/foo/...) { -will match /foo/ on the beginning of the path -and- strip it, much like -.html strips the extension. This is designed to be used to construct -nested dispatch structures, but can also prove useful for having e.g. an -optional language specification at the start of a path. +Will match /foo/ on the beginning of the path -and- strip it. This is designed +to be used to construct nested dispatch structures, but can also prove useful +for having e.g. an optional language specification at the start of a path. Note that the '...' is a "maybe something here, maybe not" so the above specification will match like this: @@ -344,8 +347,8 @@ specification will match like this: sub (.html) { -will match and strip .html from the path (assuming the subroutine itself -returns something, of course). This is normally used for rendering - e.g. +will match .html from the path (assuming the subroutine itself returns +something, of course). This is normally used for rendering - e.g. sub (.html) { response_filter { $self->render_html($_[1]) } @@ -355,8 +358,7 @@ Additionally, sub (.*) { -will match any extension and supplies the stripped extension as a match -argument. +will match any extension and supplies the extension as a match argument. =head3 Query and body parameter matches @@ -652,7 +654,7 @@ None required yet. Maybe this module is perfect (hahahahaha ...). =head1 COPYRIGHT -Copyright (c) 2009 the Web::Simple L and L +Copyright (c) 2010 the Web::Simple L and L as listed above. =head1 LICENSE