Yii 1.1: onlinehelp

Manage Online Help for Yii Applications
24 followers

yii-onlinehelp

Onlinehelp is a module for the Yii PHP framework that provides a web user interface to generate and maintain an online help system.

Onlinehelp was developed to provide a modern and responsive user interface for managing online help text in Yii projects. To achieve its goals it was built using the popular Twitter Bootstrap extension.

Onlinehelp is written according to Yii's conventions.

Links

Requirements

Usage

Setup

Download the latest release from Yii extensions.

Unzip the module under protected/modules/onlinehelp and add the following to your application config:

// protected/config/main.php:
return array(
  ...
  'modules' => array(
    'onlinehelp',
  ),
  ...
);

Please note that the module requires you to use a database, if you wish to use Onlinehelp you need it's schema (it can be found in the module directory under /data/...schema.sql).

Configuration

Configure the module to suit your needs. Here's a list of the available configurations (with default values).

'modules'=>array(
  ...
  'onlinehelp' => array(
    'users' => array('admin'), // a list of users who has access to the module.
    'userIdColumn' => 'id', // the name of the user id column.
    'layout' => 'application.views.layouts.main', // the layout used by the module.
  ),
  ...

Showing the Online Help Widget

Insert the following code in your views/layouts/column...php file, just after <?php $this->beginContent('//layouts/main'); ?>:

<?php
// Get path info
$pathInfo = array();
if(!is_null(Yii::app()->controller->module))
    $pathInfo[] = Yii::app()->controller->module->id;
$pathInfo[] = Yii::app()->controller->id;
$pathInfo[] = Yii::app()->controller->action->id; 
$this->widget('application.modules.onlinehelp.components.OnlineHelpWidget',array('pathInfo'=>join('/',$pathInfo)));
?>

This will display a ? link before the main content, aligned to the right. If clicked, the online help area for the current request will be toggled.
Alternatively press the H key to toggle the online help area (the H key might not work on some browsers).

Adding Help Text

If there is no online help yet for a single page, a link to create the new help text is shown inside the online help area.

Create and save the help text in the form. The module returns to the calling page, and by clicking on ?, the new help text is shown.

You may also manage help texts via the ...?r=onlinehelp/editor URL.

Guiders

By default, Page Help text is shown as a popup dialog, when the page is opened.

You may also want to add guiders to some specific elements on your page, not just a general help text for the whole page.

To do so, create entries in the onlinehelp table, where Page Help is not checked and an Element ID is specified.
The element-specific help will be shown in consecutive popups after the page-help popup.
Use the Sequence No. field to define the sequence of popups.
For Element ID, you can use any valid jQuery selectors.

Internationalization

Do you wish to use a translation for Onlinehelp? If so, please copy onlinehelp/messages/* folders to protected/messages.
Translations should be placed in the messages folder under a folder named according to its locale (e.g. en_us).

Donate

If you like this extension and would like to buy me a coffee, please consider to donate.

Donate with PayPal

Thanks To

Total 9 comments

#17089 report it
keiny at 2014/05/01 06:26pm
File not found

The demo does not work :(

#15035 report it
Headshaker at 2013/09/30 05:54pm
Guiders not fired up

Hi There. I found that Guiders are not fired up when there is no help for entire page.

Is there possibility to change that behaviour to be able to se Guiders without general page help ?

Thanks

#11452 report it
jwerner at 2013/01/14 12:44pm
Re: Demo

I have switched the default page in the demo to the blog posts and added a note in the first post where the online help can be seen.

Hope this is e clear now...

Regards,

Joachim

#11448 report it
WebDevPT at 2013/01/14 09:44am
Link working on the menu!

I tested again and after i logged in "admin/admin" using the link provided here for the demo

the "demo page" link provided in the main text does not work. What does work is the menu. Someone should post this info as well or fix the text link.

#11443 report it
jacmoe at 2013/01/14 07:32am
Re: Fix the demo link

I was about to complain about this too, when it occurred to me that I probably should log into the site first.

And after doing that, the demo worked.

Try that.

It should probably be written down somewhere.. >)

#11440 report it
WebDevPT at 2013/01/14 07:07am
Fix the demo link

Hi, please fix the demo link because it's not working. I would like to "preview" this extension. Thank you and keep up the good work.

#11410 report it
jwerner at 2013/01/11 01:31pm
Demo Link

@Raoul Thanks for pointing to the wrong demo link.

The link is http://www.diggin-data.de/demos/onlinehelp .

Regrads, Joachim

#11408 report it
Raoul at 2013/01/11 11:45am
sounds nice

...and I'll definitely try it (now the Demo link returns a 404)

I hope you had no problem using eguiders ;)

Thanks for sharing

#11404 report it
skworden at 2013/01/11 08:51am
FYI

The demo says

Warning! The install directory still exists. Please remove this directory and re-open this page.

Leave a comment

Please to leave your comment.

Create extension
Downloads
No downloadable files yet