phalcana/userguide

Userguide module for Phalcana project based of the module for Kohana of the same name

v0.8.1 2015-09-16 01:46 UTC

Requires

• michelf/php-markdown: ^1.5
• phalcana/core: ^0.8
• phalcana/installer: ^0.8

BSD-3-Clause

• Neil Brayfield

• kohana
• phalcon
• Phalcana

README

Phalcon Userguide Module

Userguide module for the Phalcana project based on the one for Kohana.

Installation

This module is installed by default with the Phalcana project by composer when dev modules are included for more information see the Phalcana Project.

In order for the module to be loaded into Phalcana the module needs to be added into the modules config. This can be found in the app/config/static.php or in the local version app/config/setup.php. For example.

'modules' => array(
  'email' => MODPATH.'email/',
  'userguide' => MODPATH.'userguide/',
),

Basic Usage

Once the module is sucessfully installed you can access it in your project by accessing the URL at /guide.

Adding To The Guide

Files for the guide are added inside each module and the system folder in guide/module-name. Files added are added in the Markdown syntax. See below about Markdown for more info.

The homepage for each module should be name index.md and the menu structure to connect the files together should be added in a menu.md file.

API Browser

The user guide also contains an API browser assembled from DOC blocks within the code. This works much the same as PHPDocumentor and is organised by using the main class DOC blocks sorting first by @package then by @category. Code blocks use Markdown to format documentation for the class and each individual function. For more details on the Markdown syntax please see below.

Markdown

Most of the markdown parsing is handled by PHP Markdown. For detailed information please visit the documentation. There are modifications that allow rewriting of local links