[Openinteract-commits] CVS: OpenInteract2/doc/Manual Changes.pod,1.70,1.71

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/openinteract/OpenInteract2/doc/Manual
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv9308/Manual

Modified Files:
	Changes.pod 
Log Message:
latest changes, should be it for _06

Index: Changes.pod
===================================================================
RCS file: /cvsroot/openinteract/OpenInteract2/doc/Manual/Changes.pod,v
retrieving revision 1.70
retrieving revision 1.71
diff -C2 -d -r1.70 -r1.71
*** Changes.pod	17 Mar 2005 14:57:53 -0000	1.70
--- Changes.pod	18 Mar 2005 05:26:10 -0000	1.71
***************
*** 21,34 ****

  OI2 is currently at 1.99_06, equivalent to 2.0 beta 6. The next
! release will be a release candidate (1.99_07/2.0 RC1) -- its new
  features should only be minor; everything else should be bugfixes or
  pushed off to 2.01.

! =head1 1.99_06

  =head2 Upgrade Notes

  The following all apply to an existing server configuration -- if
! you're creating a new site you don't need to worry:

  Modify how two 'action_info' keys are set:
--- 21,38 ----

  OI2 is currently at 1.99_06, equivalent to 2.0 beta 6. The next
! release should be a release candidate (1.99_07/2.0 RC1) -- its new
  features should only be minor; everything else should be bugfixes or
  pushed off to 2.01.

! =head1 1.99_06 (2.0 beta 6), 18 March 2005

  =head2 Upgrade Notes

  The following all apply to an existing server configuration -- if
! you're creating a new site you don't need to worry.
! 
! =over 4
! 
! =item 1.

  Modify how two 'action_info' keys are set:
***************
*** 48,51 ****
--- 52,83 ----
   not_found = page

+ =item 2.
+ 
+ Optional - add the following server keys:
+ 
+  [login]
+  ...
+  initial_login_expires = 24h
+ 
+ =item 3.
+ 
+ In your C<$WEBSITE_DIR/conf/startup.pl> change the following:
+ 
+   use OpenInteract2::Config::Base;
+     to
+   use OpenInteract2::Config::Bootstrap;
+ 
+   my $BASE_CONFIG_FILE = '$WEBSITE_DIR/conf/base.conf';
+     to
+   my $BASE_CONFIG_FILE = '$WEBSITE_DIR/conf/bootstrap.ini';
+ 
+   my $base_config = OpenInteract2::Config::Base->new({ 
+       filename => $BASE_CONFIG_FILE }); 
+     to
+   my $base_config = OpenInteract2::Config::Bootstrap->new({ 
+       filename => $BASE_CONFIG_FILE }); 
+ 
+ =back
+ 
  =head2 Major Changes

***************
*** 54,65 ****
  =item *

! OIN-121 - You can now create an OI2 website without a 'source_dir' --
! all our resources are held as data in class files under
! L<OpenInteract2::Brick>, and the parent class has methods to write
! these resources to the filesystem after an optional initial
  evaluation.

! This includes packages which are stored in Base64-encoding in the
! class.

  =item *
--- 86,105 ----
  =item *

! OIN-129 - Be able to create a simple application with Create, Remove,
! Update, Display and Search functionality based on a database table --
! see L<OpenInteract2::Manage::Package::CreatePackageFromTable>, or run:
! 
!   oi2_manage task_info --task=easy_app
! 
! =item *
! 
! OIN-121 - You can now create an OI2 website or package without an
! external 'source_dir' -- all our resources are held as data in class
! files under L<OpenInteract2::Brick>, and the parent class has methods
! to write these resources to the filesystem after an optional initial
  evaluation.

! Core package files, previously included as .zip files, are now stored
! as bricks using Base64 encoding.

  =item *
***************
*** 70,101 ****
  =item *

  OIN-115 - Break L<OpenInteract2::Setup> into individual tasks and
  create a framework so that new setup tasks will get discovered at
  runtime. We get a name from each task and its dependencies and
! determine the order they should be run. See L<OpenInteract2::Setup>
! for more information.

  =item *

! OIN-129 - Be able to create a simple application with Create, Update,
! Delete and Search functionality based on a database table -- see
! L<OpenInteract2::Manage::Package::CreatePackageFromTable>, or:

!   oi2_manage task_info --task=easy_app

  =item *

! OIN-54 - Make configuration of your database easier; it's now about as
! simple as a DBI-E<gt>connect() call...

  =item *

! Add support for FastCGI -- use /cgi-bin/oi2.fcgi and see
  conf/httpd_cgi_solo.conf for tiny configuration change.

  =back

  =head2 Minor Changes

  L<OpenInteract2::Action>

--- 110,190 ----
  =item *

+ OIN-141: Create little objects and an organizer to figure out which
+ OI2::Action object to run based on the URL (or whatever). This allows
+ very simple customization so you can create your own URL-to-action
+ mappings. See L<OpenInteract2::ActionResolver> for more.
+ 
+ =item *
+ 
  OIN-115 - Break L<OpenInteract2::Setup> into individual tasks and
  create a framework so that new setup tasks will get discovered at
  runtime. We get a name from each task and its dependencies and
! determine the order they should be run. This also allows very simple
! customization so you can initialize custom services at server startup.
! See L<OpenInteract2::Setup> for more information.

  =item *

! OIN-54 - Make configuration of your database easier; it's now about as
! simple as a DBI-E<gt>connect() call...

! =item *
! 
! OIN-136 and OIN-137: replace 'base.conf' with 'bootstrap.ini' and
! 'package.conf' with 'package.ini'. INI is not only OI2's preferred
! configuration format, it's the B<only> configuration format. Sites
! using 'base.conf' have to upgrade -- a 15-second job -- as do packages
! using 'package.conf', but there's a script 'translate_package_to_ini'
! in the 'script/' directory to help with the latter.

  =item *

! OIN-135: OI2 can now parse additional URL parameters (aka, REST
! parameters) into action parameters. So you can use something like:
! 
!   http://www.foo.com/news/display/39
! 
! instead of:
! 
!   http://www.foo.com/news/display/?news_id=39
! 
! or:
! 
!   http://www.foo.com/news/archive/2005/03
! 
! instead of:
! 
!   http://www.foo.com/news/archive/?year=2005&month=03
! 
! Further, mapping of REST param to action param is done through
! configuration -- see property 'url_additional' under
! L<OpenInteract2::Action>.

  =item *

! Add initial support for FastCGI -- use /cgi-bin/oi2.fcgi and see
  conf/httpd_cgi_solo.conf for tiny configuration change.

+ =item *
+ 
+ OIN-35: Severe errors are now written to the filesystem rather than
+ the database, and the error browser (in C<base_error> package) was
+ totally rewritten.
+ 
+ =item *
+ 
+ OIN-143: Read localization messages from PO/MO files in addition to
+ our custom format.
+ 
  =back

+ 
  =head2 Minor Changes

+ See all the JIRA issues raised during this release just in case we
+ missed some:
+ 
+ L<http://jira.openinteract.org/secure/ReleaseNote.jspa?projectId=10010&styleName=Html&version=10036>
+ 
  L<OpenInteract2::Action>

***************
*** 104,108 ****
  =item *

! Use L<OpenInteract2::ParamContainer> for C<param()> and related methods.

  =back
--- 193,198 ----
  =item *

! Use new L<OpenInteract2::ParamContainer> for C<param()> and related
! methods.

  =back
***************
*** 126,130 ****

  Pass C<$object> and C<\%old_data> to C<_update_post_action()> callback
! rather than forcing the user to get them from parameters..

  =back
--- 216,220 ----

  Pass C<$object> and C<\%old_data> to C<_update_post_action()> callback
! rather than forcing the user to get them from parameters.

  =back
***************
*** 142,154 ****
  =item *

! Break down the process of matching a URL (or other identifier) with
! the action object that generates its content. The parent class
! instantiates all classes under its namespace into a chain of
! responsibility. Each link looks at the URL (or other data) and decides
! if it should create an action from it; if not the next link is
  invoked.

  =back

  L<OpenInteract2::Config>

--- 232,256 ----
  =item *

! OIN-141: Break down the process of matching a URL (or other
! identifier) with the action object that generates its content. The
! parent class instantiates all classes under its namespace into a chain
! of responsibility. Each link looks at the URL (or other data) and
! decides if it should create an action from it; if not the next link is
  invoked.

  =back

+ L<OpenInteract2::App>
+ 
+ =over 4
+ 
+ =item *
+ 
+ OIN-72: Added base class for package classes to do installation and
+ report other metdata about the package. (Part of making them
+ CPAN-installable.)
+ 
+ =back
+ 
  L<OpenInteract2::Config>

***************
*** 190,194 ****

  OIN-140: Move class from base_security package; modify it to create
! action security; add documentation.

  =back
--- 292,309 ----

  OIN-140: Move class from base_security package; modify it to create
! action security.
! 
! =back
! 
! L<OpenInteract2::I18N::Initializer>
! 
! =over 4
! 
! =item *
! 
! OIN-143: Using L<Locale::Maketext::Lexicon>, read localization keys
! from gettext (PO/MO) files in addition to our custom format. A package
! does not have to standardize on a format and can have messages in
! multiple formats.

  =back
***************
*** 213,216 ****
--- 328,343 ----
  =back

+ L<OpenInteract2::Manage::Website::CleanOrphanedUsers>
+ 
+ =over 4
+ 
+ =item *
+ 
+ OIN-91: New management task to remove all users whose 'removal_date'
+ has passed. This means they've registered for an account but haven't
+ logged in.
+ 
+ =back
+ 
  L<OpenInteract2::Manage::Website::Create>

***************
*** 254,257 ****
--- 381,393 ----
  =item *

+ OIN-117: When installing a package to a website copy the package
+ configuration files to C<$WEBSITE_DIR/conf/$PACKAGE>. This becomes the
+ permanent home for configuration and package upgrades B<WILL NOT>
+ overwrite these files. If the upgraded configuration files are
+ different they're copied to an 'updates/' subdirectory and identified
+ with the package version they came from.
+ 
+ =item *
+ 
  OIN-102: Ensure that if any modules declared in the package.conf fail
  we don't read in any perl modules. The errors found when bringing in
***************
*** 274,277 ****
--- 410,418 ----
  because they were identical.

+ =item *
+ 
+ OIN-72: Remove method C<get_doc_files()> since we're moving
+ doc/$package.pod to OI2::App::$Package
+ 
  =back

***************
*** 282,286 ****
  =item *

! Simple class to provide storage and manipulation of arbitrary
  parameters. (Previously four separate classes had implementations of a
  'param' method...)
--- 423,427 ----
  =item *

! Add simple class to provide storage and manipulation of arbitrary
  parameters. (Previously four separate classes had implementations of a
  'param' method...)
***************
*** 294,298 ****
  =item *

! Move URL parsing into action/task to
  L<OpenInteract2::ActionResolver::NameAndTask>; also remove
  'action_name' and 'task_name' properties.
--- 435,439 ----
  =item *

! OIN-141: Move URL parsing into action/task to
  L<OpenInteract2::ActionResolver::NameAndTask>; also remove
  'action_name' and 'task_name' properties.
***************
*** 334,337 ****
--- 475,495 ----
  =back

+ L<OpenInteract2::SPOPS>
+ 
+ =over 4
+ 
+ =item *
+ 
+ OIN-154: override C<object_description()> from SPOPS and add our own
+ URL-handling features; also add 'date' so that objects can expose a
+ created-on/updated-on date and make generic object listings more
+ useful.
+ 
+ =item *
+ 
+ OIN-38: get rid of object keys
+ 
+ =back
+ 
  L<OpenInteract2::SQLInstall>

***************
*** 342,346 ****
  OIN-134: Allow C<install_structure()> to optionally take one or more
  files as arguments. If specified the installer will only process files
! by that name. This allows for incremental upgrades.

  =back
--- 500,505 ----
  OIN-134: Allow C<install_structure()> to optionally take one or more
  files as arguments. If specified the installer will only process files
! by that name. This allows for incremental upgrades where you add
! tables/sequences.

  =back
***************
*** 381,384 ****
--- 540,548 ----
  and modify it to assume @INC in unless other directories given.

+ =item *
+ 
+ Move code from L<OpenInteract2::Action> (where we determined cache
+ expiration) to C<time_duration_in_seconds()>.
+ 
  =back

***************
*** 390,409 ****
     OpenInteract     1.99_05 -> 1.99_06
     -----------------------------------
!    base:            2.11    -> 2.12
!    base_box:        2.17    -> 2.17
!    base_error:      2.10    -> 3.00
!    base_group:      2.16    -> 2.16
!    base_page:       2.28    -> 2.28
!    base_security:   2.18    -> 2.18
!    base_template:   3.15    -> 3.15
!    base_theme:      2.10    -> 2.10
!    base_user:       2.35    -> 2.36
!    comments:        1.18    -> 1.19
!    full_text:       2.58    -> 2.58
!    lookup:          2.07    -> 2.07
!    news:            2.20    -> 2.20
!    object_activity: 2.11    -> 2.11
!    system_doc:      2.08    -> 2.08
!    whats_new:       2.10    -> 2.10

--- 554,573 ----
     OpenInteract     1.99_05 -> 1.99_06
     -----------------------------------
!    base:            2.11    -> 2.15
!    base_box:        2.17    -> 2.20
!    base_error:      2.10    -> 3.02
!    base_group:      2.16    -> 2.19
!    base_page:       2.28    -> 2.31
!    base_security:   2.18    -> 2.21
!    base_template:   3.15    -> 3.17
!    base_theme:      2.10    -> 2.13
!    base_user:       2.35    -> 2.40
!    comments:        1.18    -> 1.23
!    full_text:       2.58    -> 2.61
!    lookup:          2.07    -> 2.09
!    news:            2.20    -> 2.24
!    object_activity: 2.11    -> 2.13
!    system_doc:      2.08    -> 2.10
!    whats_new:       2.10    -> 2.12