Permalink
Browse files

Updated userguide documentation to be up-to-date, resolves #35

  • Loading branch information...
1 parent a634113 commit 0546c604067e22b309d826f4c3b05765a2518918 @vimofthevine committed Jun 22, 2010
Showing with 21 additions and 2 deletions.
  1. +2 −0 README.md
  2. +14 −0 guide/admin.gettingstarted.md
  3. +4 −2 guide/admin.template.md
  4. +1 −0 guide/menu.admin.md
View
@@ -4,6 +4,8 @@ The admin module is meant to facilitate the rapid development of an end-user
administration site. There are essentially two aspects provided by the module,
the template and the framework.
+** The admin template submodule has to be initialized/downloaded **
+
## Features
- Template integration, courtesy of Colonel-Rosa
- Resource handling
@@ -0,0 +1,14 @@
+# Getting Started
+
+1. Fetch the admin template submodule
+
+ cd MODPATH/kohana-admin
+ git submodule update
+
+1. Enable the admin module in bootstrap.php
+1. Copy MODPATH/kohana-admin/config/admin.php to the application folder
+1. Modify APPPATH/config/admin.php to create the desired navigation menu
+1. Copy MODPATH/A2/config/a2.php to APPPATH/config/auth.php and modify accordingly
+1. Set up the desired authentication library and user model
+1. Go to myhost/admin in a web browser and log in
+
View
@@ -19,7 +19,9 @@ The only configurable aspect of the template is the main navigation. The config
);
A controller may designate any of the links in the navigation as the active page by
-including the following line, replacing "Display text" with the appropriate value.
+setting the protected variable, `_current_nav`, with the URL of the navigation item.
- $this->_config['menu']['Display text'] = NULL;
+ $this->_current_nav = 'admin/foo';
+ // OR
+ protected $_current_nav = 'admin/bar';
View
@@ -1,5 +1,6 @@
1. **Admin**
- [Overview](admin.overview)
+ - [Getting Started](admin.gettingstarted)
- [The Template](admin.template)
- [Working with Resources](admin.resources)
- [Access Control](admin.acl)

0 comments on commit 0546c60

Please sign in to comment.