Do It Yourself CMS » Blog » DiY-CMS Updates


New DiY-CMS documentation and admin area tutorials

  By: admin   tags Date Added: Friday 16-04-2010 02:57 pm | Readers: 994 | Comments: 2

Hi
I have two updates in this post.
First, I have added a doucumentation for DiY-CMS 1.0 using phpDocumenter. It prases comments within files and in order to gnerate documentation.
I have commented most of the files, classes and functions of the DiY-CMS execpt for the modules part which hopefully I will be commenting in the future and then upload it to the documentation.

Docuemntation can be found at: http://code.diy-cms.com/

I divided DiY-CMS into four packages:
Global: includes the main classes in the cms.
Modules: includes all the files in the modules folder.
Admin: Includes all main classes in the admin folder.
Admin Sections: Includes all files under the admin section folder in the admin area.

The style of comment will be used as the standard style of commenting files, classes or functions. For any one who is intrested to delvope additions to cms use this style.
At the page level and for classes, use this style:

/**
* Short description of the file.
*
* Long desciption: you have to leave an empty line before and after this description.
*
* @package Name of the pacakge
* @subpackage Name of Subpackage
* @author Authour name
* @copyright Copyright notice
* @version Version Number
*/


To comment a function you might use this style:
/**
* Short description of the file.
*
* Long desciption: you have to leave an empty line before and after this description.
*
* @param parameter type Description of parameter. You can add as many as lines as much parameters you have in the function

* @return return type Type of the returned values
*/


You can use other tags recognised by phpDocumenter, but I have included the minimum.

Second update is that uploaded three tutorials explaining settings and module parts of the admin area:
1- Configuring general settings in admin area

2- Modules managment, part 1

3- Modules managment, part 2

All the videos are recodered using HD.

I hope these updated will help anyone who uses DiY-CMS to make them navigate easily throught the cms. If you have any comments about the tutorials or doucmentation please do not hestiate to tell me.


Tags: diy-cms, cms, updates, phpdocumenter, documentation, tutirals, videos