Quick Reference Chart OUTDATED |
|||
|---|---|---|---|
| Date: | 10/01/2008 | Severity: | Minor |
| Status: | Resolved | Reporter: | Rodrigo Volponi |
| Version: | 1.6.3 | ||
| Keywords: | User Guide | ||
Description
The Quick Reference Chart in the user guide is way too outdated.
It doesn’t have trivial things like get_where() and img(), for example. It is the reference guide for version 1.3, so it’s time to renew it, I think.
As a new user (I’m using CodeIgniter at the first “real” project right now), this kind of quick reference is absolutely helpful.
Code Sample
[SITE]
http://codeigniter.com/user_guide/general/quick_reference.html
[PDF]
http://codeigniter.com/download_files/ci_quick_ref.pdf
Expected Result
All functions listed at the reference chart.
Actual Result
Some functions like “get_where” and “img” are not in the reference chart.
Comment on Bug Report
| Posted by: Rodrigo Volponi on 1 October 2008 11:36am | |
|
It seems that an user had made his own version of the reference chart: Although I don’t know if this chart is correct or can be “oficially” used, it shows the need for an updated chart. Best, |
| Posted by: Pascal Kriete on 2 October 2008 7:35am | |
|
It’s not ‘official’, although I would hope most of it is correct. It will be outdated by the next release though, as things have changed (particularly validation). I think the easiest way to tackle this issue is for someone to write a small app that exports to PDF. Keeping up with a pages file and fixing layout issues every time becomes incredibly cumbersome. Maybe a designer out there wants to tackle a nice html display, I’d be willing to write a backend to quickly add/remove functions. Heck, EE core could probably be coerced to handle it. |
| Posted by: Derek Allard on 2 October 2008 4:41pm | |
|
We’ve removed the quick reference guide in the new version (1.7 in the SVN). I absolutely think it’s a great resource, but inparo is right that keeping it up to date is difficult - and time consuming, particularly in light of the fact that the user guide is generally very complete and easy to get around. Rodrigo, welcome to CI. |
