Documentation Updates for 2.2 Release

All the documentation listed here requires attention. Anyone is welcome to provide the updates.

If you are making extensive changes to a page, please indicate this by placing your username next to the todo item, until you have finished, to avoid mixups.

Once you have finished, please indicate this by putting a strike through the item.

The ToDo entry on individual pages should be updated, and then the article can be proofed.

Please ensure that the style Guidelines are adhered to. Use the Sample Page as authoritative reference.

NB! This list may be incomplete. Please add any missing items you are aware of which need attention.

The Changelog also provides update information.

The todo items reflect only the documentation that must be updated to bring it up to date.

Installation

• Requirements - PHP >= 5.2.0
• Deployment - log config is now in main config. (nickuk)
• Migration - Major updates required to describe moving from Codeigniter.

General

• Configuration - important update main config.php entries, and config file list. update config set items once included in Kohana (nickuk)
• URLs - update references to _default() and allowed_characters (spirit)
• Routing - update references to allowed_characters and remove shortcuts, replace with regex example, add explanation of public Router properties (Router::$method etc.)
• Controllers - change references to _default and _remap to __call(method, args)
• Libraries - remove references to this→load (nickuk)
• Views - remove references to this→load (nickuk)
• Hooks - remove references to core/Log.php and core/Config.php (nickuk)
• Error Handling - remove references Log class, link to Kohana logging methods
• Internationalisation - ??? not sure about this one. (seems OK)

Core

• View - remove 2.2 only red box
• View – needs update for passing data into views (set, with an array, with $view→somevar)

Addons

• Auth updates, needs example usage - rewrite currently in-progess (neovive spirit :D)

Libraries

• Database updates ??? document syntax changes and new methods remove any references to this→load, update config
• Image - Add render method, update Image::AUTO dimension documentation, add _ _get() properties Add a config example for ImageMagick
• Input - Move user_agent method docs to kohana and update it with its parameters. Also, remove 2.2 red boxes (spirit)
• Orm - Requires filling in missing information, old page can be found at http://docs21.kohanaphp.com/libraries/orm - (reorganized docs and added some new categories - neovive) Shadowhand has been adding new methods and properties.
• Pagination - Change create_links to render (spirit)
• Profiler - document additional functionality and usage
• Session - change del to delete, document new session configuration for cache and database. New session table schema
• URI - document build_array, remove red box (spirit)

Helpers

• Array document the range merge overwrite map_recursive unshift_assoc methods
• Cookie remove reference to prefix (spirit)
• HTML remove reference to query_string document additional methods (spirit)
• Inflector document additional methods (spirit)
• Valid document changes (spirit)

Installation

• Upgrading - important Complete instructions required. (oscarb)

General

• Loading - remove all reference to this→load describe Kohana's autoloading methodology: describe factory usage and singleton instance usage (oscarb)

Core

• Kohana - important Merge Log and Config class docs into Kohana class docs. Fix styling and missing method names (oscarb)

Libraries

• Validation - Requires re-write for new implementation Methods need expanding with parameter list as per guidelines and a very short but complete example - (added examples and more details - neovive)
• Calendar - Requires re-write for new implementation

Addons

• Archive - Copied from library page, needs to be converted to module (spirit)
• Gmaps - stub, needs write up.
• Kodoc - stub, needs write up.
• Payment - Copied from library page, needs to be converted to module, methods need to meet the proper style guidelines

Helpers

• format - stub, needs write up.
• request - stub, needs write up.
• remote - stub, needs write up.
• upload - stub, needs write up.

Libraries

• Captcha - introduction, configuration (spirit), methods, proof read (spirit)

Libraries

• User agent - important The documented functionality must be moved to Kohana (oscarb) (half done)

These do not yet have a home, or are new, or don't fit properly yet.

• Forge module has moved to http://code.google.com/p/kohanamodules/
• Media module has moved to http://code.google.com/p/kohanamodules/

Create an general entry for Logging and move the logging configuration part log config there The Log library functionality must be merged into Kohana