====== 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 [[userguide:|Guidelines]] are adhered to. Use the [[userguide:guidelines:sample|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:2.2|Changelog]] also provides update information.
The todo items reflect **only** the documentation that must be updated to bring it **up to date.**
===== To Do List =====
==== These entries require updating ====
**Installation**
* Requirements - PHP >= 5.2.0
* [[installation:deployment|Deployment]] - log config is now in main config. (nickuk)
* [[installation:migration|Migration]] - Major updates required to describe moving from Codeigniter.
**General**
* [[general:configuration|Configuration]] - **important** update main config.php entries, and config file list. update config set items once included in Kohana (nickuk)
* [[general:urls|URLs]] - update references to ''_default()'' and ''allowed_characters'' (spirit)
* [[general:routing|Routing]] - update references to ''allowed_characters'' and remove ''shortcuts'', replace with regex example, add explanation of public Router properties (Router::$method etc.)
* [[general:controllers|Controllers]] - change references to ''_default'' and ''_remap'' to ''__call(method, args)''
* [[general:libraries|Libraries]] - remove references to ''this->load'' (nickuk)
* [[general:views|Views]] - remove references to ''this->load'' (nickuk)
* [[general:hooks|Hooks]] - remove references to ''core/Log.php'' and ''core/Config.php'' (nickuk)
* [[general:errorhandling|Error Handling]] - remove references Log class, link to Kohana logging methods
* [[general:i18n|Internationalisation]] - ??? not sure about this one. (seems OK)
**Core**
* [[core:view|View]] - remove 2.2 only red box
* [[core:view|View]] -- needs update for passing data into views (set, with an array, with $view->somevar)
**Addons**
* [[addons:auth|Auth]] updates, needs example usage - rewrite currently in-progess (neovive spirit :D)
**Libraries**
* [[libraries:database|Database]] updates ??? document syntax changes and new methods remove any references to ''this->load'', update config
* [[libraries:image|Image]] - Add ''render'' method, update Image::AUTO dimension documentation, add ''_ _get() properties'' Add a config example for ImageMagick
* [[libraries:input|Input]] - Move ''user_agent'' method docs to [[core:kohana]] and update it with its parameters. Also, remove 2.2 red boxes (spirit)
* [[libraries:orm|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.
* [[libraries:pagination|Pagination]] - Change ''create_links'' to ''render'' (spirit)
* [[libraries:profiler|Profiler]] - document additional functionality and usage
* [[libraries:session|Session]] - change ''del'' to ''delete'', document new session configuration for cache and database. New session table schema
* [[libraries:uri|URI]] - document ''build_array'', remove red box (spirit)
**Helpers**
* [[helpers:arr|Array]] document the ''range'' ''merge'' ''overwrite'' ''map_recursive'' ''unshift_assoc'' methods
* [[helpers:cookie|Cookie]] remove reference to ''prefix'' (spirit)
* [[helpers:html|HTML]] remove reference to ''query_string'' document additional methods (spirit)
* [[helpers:inflector|Inflector]] document additional methods (spirit)
* [[helpers:valid|Valid]] document changes (spirit)
==== These entries require re-writing ====
**Installation**
* [[upgrading:2.2|Upgrading]] - **important** Complete instructions required. (oscarb)
**General**
* [[general:loading|Loading]] - remove all reference to ''this->load'' describe Kohana's autoloading methodology: describe factory usage and singleton instance usage (oscarb)
**Core**
* [[core:kohana|Kohana]] - **important** Merge Log and Config class docs into Kohana class docs. Fix styling and missing method names (oscarb)
**Libraries**
* [[libraries:validation|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)
* [[libraries:calendar|Calendar]] - Requires re-write for new implementation
==== These entries are new and require writing ====
**Addons**
* [[addons::archive|Archive]] - Copied from library page, needs to be converted to module (spirit)
* [[addons::gmaps|Gmaps]] - stub, needs write up.
* [[addons::kodoc|Kodoc]] - stub, needs write up.
* [[addons::payment|Payment]] - Copied from library page, needs to be converted to module, methods need to meet the proper style guidelines
**Helpers**
* [[helpers:format|format]] - stub, needs write up.
* [[helpers:request|request]] - stub, needs write up.
* [[helpers:remote|remote]] - stub, needs write up.
* [[helpers:upload|upload]] - stub, needs write up.
**Libraries**
* [[libraries:captcha|Captcha]] - introduction, configuration (spirit), methods, proof read (spirit)
==== These entries are obsolete and will be removed ====
**Libraries**
* [[libraries:user_agent|User agent]] - **important** The documented functionality must be moved to [[core:kohana|Kohana]] (oscarb) (half done)
==== Miscellaneous ====
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 [[general:logging|Logging]] and move the logging configuration part [[libraries:log|log config]] there
The Log library functionality must be merged into [[core:kohana|Kohana]]