From: Chris W. <la...@us...> - 2005-03-17 02:29:25
|
Update of /cvsroot/openinteract/OpenInteract2/doc/Manual In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv28544/doc/Manual Modified Files: Conversion.pod Log Message: some conversion updates, including package.ini Index: Conversion.pod =================================================================== RCS file: /cvsroot/openinteract/OpenInteract2/doc/Manual/Conversion.pod,v retrieving revision 1.13 retrieving revision 1.14 diff -C2 -d -r1.13 -r1.14 *** Conversion.pod 28 Nov 2004 16:19:25 -0000 1.13 --- Conversion.pod 17 Mar 2005 02:29:13 -0000 1.14 *************** *** 106,121 **** =back ! There is no structural change necessary for these files to ! work. However, depending on your scenario you may wish to upgrade your ! package by a whole version number to indicate that it will only work ! with OI2. This also allows you to maintain two source trees for a ! particular package, just in case you need to support both of them. B<package.conf> ! The only structural change is that the 'template_blocks' directive has ! been removed from the package configuration. ! To change: =over 4 --- 106,123 ---- =back ! Except for C<package.conf> there is no structural change necessary for ! these files to work. However, depending on your scenario you may wish ! to upgrade your package by a whole version number to indicate that it ! will only work with OI2. This also allows you to maintain two source ! trees for a particular package, just in case you need to support both ! of them. B<package.conf> ! This has been replaced by C<package.ini>; the script ! C<scripts/translate_package_to_ini.pl> shipped with OI2 will do this ! for you. ! Additionally, you'll need to change: =over 4 *************** *** 142,146 **** You can also use the L<ExtUtils::Manifest|ExtUtils::Manifest> trick: ! [% INCLUDE examples/conversion_eu_manifest | indent 2 %] =head2 Configuration (conf/) --- 144,148 ---- You can also use the L<ExtUtils::Manifest|ExtUtils::Manifest> trick: ! $ perl -MExtUtils::Manifest -e 'ExtUtils::Manifest::mkmanifest()' =head2 Configuration (conf/) *************** *** 204,218 **** =head2 Documentation (doc/) ! Documentation is pretty much the same. The system documentation tool ! under C</SystemDoc/> will pick up all POD files in a package's C<doc/> ! directory. Instead of using an index (C<titles>) that always, always ! got out of sync, we instead just parse all the docs and grab the title ! out of it. Yes, it's more expensive, but how often are you browsing ! package docs? (And you have fast disk drives and/or an aggressively ! caching filesystem, right?) ! ! And because OI no longer has error handlers you can delete the ! C<ERRORS> section from your POD. (Packages generated with OI had this ! by default.) To change: --- 206,213 ---- =head2 Documentation (doc/) ! Documenation has moved to the C<OpenInteract2::App> subclass. And ! because OI no longer has error handlers you can delete the C<ERRORS> ! section from your POD. (Packages generated with OI had this by ! default.) To change: *************** *** 226,232 **** =item * ! C<package.pod> - If you have a file of this name, rename it to ! 'packagename'.pod -- e.g., 'gallery.pod' if you're modifying the ! 'gallery' package, etc. =back --- 221,226 ---- =item * ! C<package.pod> - Copy the content into ! C<OpenInteract2::App::YourPackage>. =back *************** *** 276,280 **** =head2 Template (template/) ! =head2 Examples (eg/) --- 270,274 ---- =head2 Template (template/) ! These should remain the same. =head2 Examples (eg/) *************** *** 311,320 **** --- 305,329 ---- =head2 Request vs. Context + In OpenInteract 1.x the omnipresent object was C<$R>. In OpenInteract + 2.x it's C<CTX>, imported from L<OpenInteract2::Context>. The main + difference is that we now have a clear separation of concerns -- the + context holds data that lives from request to request; per-request + data are held in the objects returned by the C<request()> and + C<response()> methods, represented by L<OpenInteract2::Request> and + L<OpenInteract2::Response> classes. + =head2 Logging + We now use the L<Log::Log4perl> package from CPAN -- see + L<OpenInteract2::Manual::Logging> for more information. + =head2 Libraries (OpenInteract/) + These get moved to C<OpenInteract2/> + =head2 Handlers (OpenInteract/Handler) + These get moved to C<OpenInteract2/Action>. + =head1 COPYRIGHT |