X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Manual.git;a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FComponents.pod;h=3641ade05dcfc0a1c3e3b3d307b33a74b178495c;hp=295733b1cd9c98e42a0c2c4a6abe70e18f7cf610;hb=e7cfb0cc7b727def160a320e0329ad866d6b2607;hpb=bbddff000787154dd9130f45634da8ef06529d86 diff --git a/lib/Catalyst/Manual/Components.pod b/lib/Catalyst/Manual/Components.pod index 295733b..3641ade 100644 --- a/lib/Catalyst/Manual/Components.pod +++ b/lib/Catalyst/Manual/Components.pod @@ -1,6 +1,6 @@ =head1 NAME -Catalyst::Manual::Component - Reuseable components for Catalyst applications. +Catalyst::Manual::Components - Reuseable components for Catalyst applications =head1 DESCRIPTION @@ -9,12 +9,12 @@ available to extend the runtime functionality of Catalyst. Most components are not distributed with Catalyst but should be available from CPAN. They typically require additional modules from CPAN. -This list may well be outdated by the time you read this and some -plugins may be deprecated or now part of core L. Be sure to -check the Catalyst:: and CatalystX:: namespaces for additional components and consult -the mailing list ( L ) for -advice on the current status or preferred use of your chosen -plugin/framework. +This list may well be outdated by the time you read this, and some +plugins may be deprecated, or, conversely, may now part of core +L. Be sure to check the Catalyst:: and CatalystX:: namespaces +for additional components, and consult the mailing list ( +L ) for advice on the current +status or preferred use of your chosen plugin/framework. =head1 PLUGINS @@ -52,8 +52,8 @@ This, however, has involved deprecated all classes in the C and C namespaces. -These plugins are still useable, however they have mostly been -replaced with new modules in the new namespace which will work together. +These plugins are still usable, but they have mostly been replaced with +new modules in the new namespace which will work together. =head3 Available Credential modules: @@ -63,7 +63,7 @@ Allows you to use the L module with Catalyst. =head4 L -Allows you to authenticate facebook users using the FBConnect API. +Allows you to authenticate Facebook users using the FBConnect API. =head4 L @@ -84,13 +84,13 @@ Allows you to authenticate your users against a Kerberos server. =head4 L -Allows you to authenticate users using their login on other websites supporting -the OAuth protocol. +Allows you to authenticate users using their login on other websites +supporting the OAuth protocol. =head4 L -Allows you to authenticate users using their login on other websites supporting -the OpenID protocol. +Allows you to authenticate users using their login on other websites +supporting the OpenID protocol. =head4 L @@ -100,28 +100,28 @@ Part of the Authentication Framework L. =head4 L -Allows you to autheticate users using the RPX protocol. +Allows you to authenticate users using the RPX protocol. =head4 L -Allows you to authenticate users in Catalyst which have already been -authenticated by your web server - this is useful for authenticating +Allows you to authenticate users in Catalyst that have already been +authenticated by your web server. This is useful for authenticating users with SSL Client certificates, and using NTLM or any other authentication protocol natively supported by your web server. =head4 L -Allows you to set the same password for all users, which is useful -when you want to test logging in as multiple users / types of user, -without having to mock things, or set all users passwords in your -test suite. +Allows you to set the same password for all users, which is useful when +you want to test logging in as multiple users or multiple types of user, +without having to mock things, or set all users' passwords in your test +suite. =head4 L Allows any of the L family of modules to be used to authenticate users in Catalyst. -=head3 LAvailable Store modules: +=head3 Available Store modules: =head4 L @@ -129,8 +129,8 @@ Does authentication and authorization against a L model. =head4 L -Uses L to let your application use C<.htpasswd> files for its -authentication storage. +Uses L to let your application use C<.htpasswd> files +for its authentication storage. =head4 L @@ -142,12 +142,12 @@ Allows you to use a plain L database connection to identify users. =head4 L -Allows you to use an apache htpassed type file to authenticate users from. +Allows you to use an Apache htpasswd type file to authenticate users. =head4 L -Authenticate users stored as objects in the L object graph storage -engine system. +Authenticate users stored as objects in the L object graph +storage engine system. =head4 L @@ -160,9 +160,9 @@ config hash. Great for getting up and running quickly. =head4 L -The Null store is a transparent store where any supplied user data is accepted. -This is mainly useful for remotely authenticating credentials (e.g. OpenID) which -may not be tied to any local storage. +The Null store is a transparent store where any supplied user data is +accepted. This is mainly useful for remotely authenticating credentials +(e.g. OpenID) which may not be tied to any local storage. =head4 L @@ -170,11 +170,13 @@ Allows access to authentication information stored in a database via a L -Allows access to authentication information stored in a database via a L class. +Allows access to authentication information stored in a database via a +L class. =head4 L -Allows access to authentication information stored in a database via a L class. +Allows access to authentication information stored in a database via a +L class. =head4 L @@ -193,11 +195,14 @@ namespace, at least at the moment. =head2 L -L provides role based authorization -for Catalyst based on L. +L provides role-based +authorization for Catalyst based on L. =head2 L +L enables specified request parameters +to generate session variables. + =head2 L Extends L by adding the capability of browser @@ -225,6 +230,8 @@ the C<< Cache:: >> APO, such as: =head2 L +Provides specific charset handlers for the Japanese charsets. + =head2 L =head2 L @@ -326,11 +333,13 @@ A plugin for pluggable Catalyst applications. =head2 L -A plugin for the Prototype JavaScript library. This Plugin allows you to +A plugin for the Prototype JavaScript library. This plugin allows you to easily implement AJAX functionality without actually knowing Javascript. =head2 L +Allows for easy redirecting with the Catalyst app. + =head2 L =head2 L @@ -407,18 +416,24 @@ for portal software and such. An interface to the L module, enabling easy HTML form creation. -=head2 L +=head2 L Provides a Unicode-aware Catalyst. On request, it decodes all params from UTF-8 octets into a sequence of logical characters. On response, it encodes the body into UTF-8 octets. -=head2 L +=head2 L + +Disrecommended plugin which tries to autodetect the uft8ness of the output +and do the correct thing. This may work in some cases, but if it helps, +you've already painted yourself into a corner - try to avoid! =head2 L =head2 L +Computes the MD5 message digest of uploaded files. + =head2 L =head2 L