Changeset 469 for trunk/modules/user_guide

Timestamp:

09/02/2007 09:34:20 AM (15 months ago)

Author:

OscarB

Message:

UG updates, added cookie helper, updated installation and configuration, added code rule to css

Location:

trunk/modules/user_guide/views/user_guide

Files:

• content/general/configuration.php (modified) (2 diffs)
• content/helpers/cookie.php (added)
• content/kohana/installation.php (modified) (1 diff)
• css/layout.php (modified) (1 diff)
• menu.php (modified) (1 diff)

trunk/modules/user_guide/views/user_guide/content/general/configuration.php

@@ -1 @@
-Article status [Draft] requires [Writing] Configuring the Framework, add remaining entries
+Article status [Draft] requires [Editing] Configuring the Framework, add remaining entries
 # Configuration
 Kohana adopts the philosophy of *convention* over *configuration*. The goal is to minimize user  configuration. Where configuration is required or enabled, sensible defaults are utilised.
 
-System configuration is specified by entries in files located in folder */application/config/*.
+System configuration is specified by entries in files located in folder */application/config/*
 
 Configuration files are ordinary text files with a default *php* file extension. 
 
-The primary configuration file is <file>/application/config/config</file> System wide configuration is
+The primary configuration file is <file>application/config/config</file> System wide configuration is
 specified here and is required for every new installation.
 
@@ -15 +15 @@
 ### Base URL
 Specifies the url which points to the base or root of your application. 
-Format:
-<pre>config item                domain name             /[subdirectory/]</pre>
+<pre>
+base_url                        domain name/[subdirectory/]
 <code>
 $config['base_url'] = 'http://'.$_SERVER['SERVER_NAME'].'/kohana/';
 </code>
+</pre>
 *base_url* is **mandatory** and requires a correct server domain that **must** terminate with a "**/**"
 
 ### Front Controller
-Specifies the name of the system *Front Controller*, usually <file>index</file>, but may be renamed.
-Format:
-<pre>config item                [front controller name]</pre>
+Specifies the name of the system <definition>Front Controller</definition>, usually <file>index</file>, but may be renamed.
+<pre>
+index_page                      [front controller name]
 <code>
 $config['index_page'] = 'index.php';
 </code>
-*index_page* is **optional**. If your web server supports dynamic url re-writing. The front controller
-may be dynamically removed fron the uri path. Set this item to blank if you are using re-writes.
+</pre>
+*index_page* is **optional**. If your web server supports dynamic URL re-writing. The front controller
+may be dynamically removed fron the URI path. Set this item to blank if you are using re-writes.
 
-### Url Suffix
-Specifies the suffix which should be dynamically added to the uri path.
-Format:
-<pre>*url_suffix*               [suffix]</pre>
+### URL Suffix
+Specifies the suffix which should be dynamically added to the URI path.
+<pre>
+url_suffix              [suffix]
 <code>
 $config['url_suffix'] = '.html';
 </code>
-*url_suffix* is **optional** You may specify any valid extension as a suffix. Set to blank to remove.
+</pre>
+*url_suffix* is **optional**. You may specify any valid extension as a suffix. Set to blank to remove.
 
 ### Permitted URI Characters
 Specifies the characters which the system will allow as part of a uniform resource indicator.
-Format:
-<pre>*permitted_uri_chars*              character set</pre>
+<pre>
+permitted_uri_chars             character set
 <code>
 $config['permitted_uri_chars'] = 'a-z 0-9~%.:_-';
 </code>
-*permitted_uri_chars* is **mandatory** A minimal character set must be specified or the system cannot function.
+</pre>
+*permitted_uri_chars* is **mandatory**. A minimal character set must be specified or the system cannot function.
 
 **Security Note:** It is recommended that the default character set be used, to secure the system against
-hacking attempts. Additional characters may be configured, but please be aware of the security implication. 
+hacking attempts. Additional characters may be configured, but please be aware of the security implication.
+
+### Locale
+Specifies the system locale using the standard two letter abbreviation.
+<pre>
+locale                  international language abbreviation
+<code>
+$config['locale'] = 'en';
+</code>
+</pre>
+*locale* is **mandatory**. Kohana default is English.
+
+### Include Paths
+Specifies additional locations the system should search for resources. 
+<pre>
+include_paths                   [file path names]
+<code>
+$config['include_paths'] = array
+(
+        'modules/user_guide'
+);
+</code>
+</pre>
+*include_paths* is **optional**. Kohana will always search the application path first, then any defined
+include paths, and finally the system path. Primary resources are libraries, helpers and views.
+
+### Enable Hooks
+Specifies the enabling of system Hooks  
+<pre>
+enable_hooks                    boolean
+<code>
+$config['enable_hooks'] = FALSE;
+</code>
+</pre>
+*enable_hooks* is **mandatory**. By default Hooks are disabled. If you plan to add to hooks into your
+application, you will activate them by setting this entry to *TRUE*.
+
+### SubClass Prefix
+Specifies the prefix for user extensions to Core Kohana classes.
+<pre>
+subclass_prefix                 prefix_
+<code>
+$config['subclass_prefix'] = 'MY_';
+</code>
+</pre>
+*subclass_prefix* is **mandatory**. Core class extensions must be prefixed. 
+By convention the prefix "My_" is used. You may change this prefix, provided it terminates with an *underscore*. If you are not extending Core classes, you may safely leave the default setting.
+
+### Timezone
+Specifies an standard international timezone for the system.
+<pre>
+timezone                        [zone/location]
+<code>
+$config['timezone'] = '';
+</code>
+</pre>
+*timezone* is **optional**. By default, the setting is blank and Kohana will use the timezone supplied by
+PHP on the server. An example timezone would be "Africa/Johannesburg".
+
+## Autoloader Entries
+To maintain a small footprint, resources are manually loaded in your Controller. In Applications where
+a resource is utilised across many Controllers, you may specify that Kohana automatically loads the resource and makes it available to all Controllers.
+ 
+Such resources would typically be databases, libraries (session), and helpers (url).
+<pre>
+resource type                   [resource name[,resource name&hellip;]]
+<code>
+$config['libraries'] = 'session, encrypt';
+</code>
+</pre>
+Note: If you are specifying that a resource is autoloaded, you still need to ensure that the resource is
+correctly configured, via it's own configuration file. For example, if you autoload the Cookie Helper,
+then you must check that cookies are correctly configured for your system in <file>application/config/cookie</file>
+
+## Configuration Files
+The following files are used for Class configuration.
+
+* <file>application/config/cookie</file> configures Cookies, used by the [Cookie helper](<?php echo url::base(TRUE).'user_guide/helpers/cookie' ?>) class.
+* <file>application/config/database</file> configures Databases, used by the Database class.
+* <file>application/config/encryption</file> configures Encryption, used by the Encryption class.
+* <file>application/config/log</file> configures Logging, used by the Log class.
+* <file>application/config/pagination</file> configures Pagination, used by the Pagination class.
+* <file>application/config/routes</file> configures Routing, used by the Routing class.
+* <file>application/config/session</file> configures Sessions, used by the Session class.
+
+
+<p></p>
+*[PHP]: PHP Hypertext Processor
+*[URI]: Uniform Resource Indicator
+*[URL]: Uniform Resource Locator

trunk/modules/user_guide/views/user_guide/content/kohana/installation.php

@@ -5 +5 @@
 If you are new to Kohana, we suggest following the steps below:
 
-1. Unzip the Kohana package you downloaded, into a temporary directory. (Eg. /kohana)
+1. Unzip the Kohana package you downloaded, into a temporary directory. (Eg. */kohana*)
 2. Prepare a place on your web server to upload the Kohana files to.
     * Examples:
-    * /var/www/html (Using the web server *DOCUMENT ROOT*)
-    * /var/www/html/kohana (Using a sub-directory of root)
+    * */var/www/html* (Using the web server *DOCUMENT ROOT*)
+    * */var/www/html/kohana* (Using a sub-directory of root)
 3. Using an FTP client, upload the Kohana files to your web server.
     * Your server directory should now contain the following files and folders<br />
-<code>
-            index.php <br />
-                  -- application<br />
-                  -- modules<br />
-                  -- system
-</code>
-4. Using a Text Editor, open the file <file>/application/config/config</file>
+        <code>
+        index.php<br />
+          -- application<br />
+          -- modules<br />
+          -- system
+        </code>
+4. Using a Text Editor, open the file <file>application/config/config</file>
     * Set the configuration item *base_url* to the name of the directory you uploaded Kohana into
     * Examples:
-                1. The sub directory *kohana* of the server named *localhost*<br />
-<code>
-$config['base_url'] = 'http://'.$_SERVER['SERVER_NAME'].'/kohana/';<br />
-can be accessed via this url: http://localhost/kohana
-</code>
-                2. The *DOCUMENT ROOT* of the server named *example.com*<br />
-<code>
-$config['base_url'] = 'http://'.$_SERVER['SERVER_NAME'].'/';<br />
-can be accessed via this url: http://example.com
-</code>
+                1. The sub directory *kohana* of the server named *localhost* can be accessed via this URL: http://localhost/kohana
+    <code>
+        $config['base_url'] = 'http://'.$_SERVER['SERVER_NAME'].'/kohana/';
+    </code>
+                2. The *DOCUMENT ROOT* of the server named *example.com* can be accessed via this URL: http://example.com
+    <code>
+        $config['base_url'] = 'http://'.$_SERVER['SERVER_NAME'].'/';
+    </code>
 5. Test your Installation
     * Open your favourite web browser and point it at the URL defined in *base_url*
-        * Your should now be viewing the "Welcome page" of the Kohana User Guide, on your server
+        * You should now be viewing the "Welcome page" of the Kohana User Guide, on your server.
 
 
 **Congratulations!** <br />
 You can explore your new Kohana Framework by reading the User Guide, a good place
-to start would be [Getting Started](<?php echo url::base().'user_guide/kohana/starting'?>)
+to start would be [Getting Started](<?php echo url::base(TRUE).'user_guide/kohana/starting'?>)
 
 ## Experiencing Problems?
 If you were not able to view the Kohana User Guide on your server after installing, we recommend
-reading the [Toubleshooting](<?php echo url::base().'user_guide/troubleshoot'?>) page of the user 
+reading the [Toubleshooting](<?php echo url::base(TRUE).'user_guide/troubleshoot'?>) page of the user 
 guide for more help.
 

trunk/modules/user_guide/views/user_guide/css/layout.php

@@ -41 +41 @@
 #body ul { list-style: circle; }
 #body li { padding: 0.1em 0; }
+#body code { background: #eee; font-size: 1.1em; border: dotted 1px; padding: 0.5em; font-family: monospace; display: block; }
 #footer { padding: 0 1em; background: #fff; line-height: 2em; }
 #loading { position: absolute; top: 0; right: 0; z-index: 9999; width: 32px; height: 32px; background: transparent url(spinner.gif) center center no-repeat; }

trunk/modules/user_guide/views/user_guide/menu.php

@@ -45 +45 @@
         'Helpers' => array
         (
+                'Cookie',
                 'File',
                 'Html',