Kohana 3 CheatSheet Module

Суббота, 24 октября 2009 г.
Рубрика: Web frameworks
Метки: |
Просмотров: 3501
Подписаться на комментарии по RSS

I want to share my module that can be useful for developers: CheatSheet for Kohana 3.0. It is very simple, generates list of classes with parameters/methods in present Kohana 3 installation. For me it is often more useful to see all accessible stuff altogether instead of looking for some method in API Reference. My module also can show parameter/method description and params if they exist. See screenshot:

To install unpack folder in modules/, than activate it in application/bootstrap.php (Kohana Userguide module should be present and activated):

'userguide'   => MODPATH.'userguide',
'cheatsheet'   => MODPATH.'cheatsheet',

In modules/cheatsheet/config/cs.php enumerate classes to omit in the cheatsheet (lowercase!), for example:

return array
(
'class' => array ('kodoc','kodoc_method','kodoc_property','kodoc_markdown'),
);

Browse  <Kohana baseurl>/cs — and try to enjoy. I18n is not supported yet, planned in later releases. 

More structured documentation in Russian and English can be found in distributive (see README files). 

I thought about pdf export, but decided it would be redundant.

Module uses jQuery and Columnizer jQuery Plugin

Скачать/Download CheatSheet v. 0.2 186 (zipped ~32K) Info page

[dc]Download v. 0.1[/dc] (zipped ~30K)

Русскоязычная страница модуля

I love critics!

UPD2 See live example

UPD Tested in FF 3.5 and Opera 10.

twitter.com facebook.com vkontakte.ru odnoklassniki.ru mail.ru ya.ru rutvit.ru myspace.com technorati.com digg.com friendfeed.com pikabu.ru blogger.com liveinternet.ru livejournal.ru memori.ru google.com bobrdobr.ru mister-wong.ru yahoo.com yandex.ru del.icio.us

Комментариев: 2

  1. Tried your module, its a great one superb idea and well executed, much much better than a PDF cheatsheet.

  2. 2009-10-26 в 12:03:51 | Александр Купреев

    Thanks for reply, NetChaos! I'll try to make some improvements a little bit later.

Оставьте комментарий!

Используйте нормальные имена.

Если вы уже зарегистрированы как комментатор или хотите зарегистрироваться, укажите пароль и свой действующий email. При регистрации на указанный адрес придет письмо с кодом активации и ссылкой на ваш персональный аккаунт, где вы сможете изменить свои данные, включая адрес сайта, ник, описание, контакты и т.д., а также подписку на новые комментарии.

Авторизация: MaxSiteAuth. Войти через loginza

(обязательно)