Help System is an open source Yii framework extension which provide a custom help tool for your web page. You can place the widget any where in the view with just a few lines of code and configuration. The help text can be categorized into "Sections" and "Topics". You can add N-number of "Topics" under each "Section" and each "Topic" in turn can have N-number of child topics.
The application supports both Bootstrap 2 and 3. The user can switch between the versions by simply giving the Bootstrap version number in the configuration.
The application is divided into two separate modules, "Admin" and "Client".
Help System client provides a dynamic widget that can be placed anywhere on your web page. The widget provides a link which when clicked will open up a popup window which displays the "Sections" and "Topics".
In the Admin section there is a content management system which you can use to add help content.
Note – If URL rewrite is on this will be different.
This allows you to see the list of existing sections, add new sections, edit or delete existing ones. Note that you cannot delete sections which have topics under it.
Topic Management consist of topic add area , topic listing , topic edit and delete and topic reordering. Note that when you delete a topic all child topics of that topic will also be deleted.
Topic reorder section displays a tree structure of topics. Here you can change the order of the topic listing and you can even change the parent of a topic. This is based on the section you have chosen from the filter.
'helpSystem'=>array( class'=>'ext.helpSystem.HelpSystemModule', 'modules'=>array( 'admin'=>array( 'class'=>'ext.helpSystem.modules.admin.AdminModule' ), 'client'=>array( 'class'=>'ext.helpSystem.modules.client.ClientModule',), ), 'dmEditor'=>array( 'class'=>'ext.helpSystem.extensions.dmEditor.DMEditorModule', 'allowedImageSize'=>2, // add the maximum upload size in MB. Enter int value. 'imageUploadPath'=>'images/EditorImages',// the path to which image uploaded. 'allowedImageTypes'=>array('gif', 'jpeg', 'jpg', 'png') // allowed images types ) 'bootstrapVersion'=>'3',// Pass the current bootstrap version 2 or 3 'userRole'=>array()//Add roles if any. eg array('admin','editor') 'pageLayout'=>'///layouts/column1' )
Pass the bootstrap version number here. If you skip this it will take 2 as default bootstrap version number.
This configuration is an array. Here you can pass the RBAC role to manage the permission in admin level. To work with this you need to implement RBAC in your application.
This is an optional field. We can set the page layout path here. If we place null as value, it will take the application layout.
Run the following MySql scripts
<?php $this->widget( 'application.extensions.helpSystem.modules.client.components.HelpWidget', array('title'=>'HELP', 'linkClass'=>'btn btn', 'sectionId'=>your Section Id, 'topicId'=> <your topic id>, //if you want to see specific topic than topic index, 'header'=>'Help System', 'headerBackGroundColor'=>'#99FF33', ) );?>