The Goal:

Create a help system for Exponent that will put links in convienent places for users to click that will pop up a new window showing help documentation.

Overview:

We will create a "Help" module that will be hosted on oicgroup.net and exponentcms.org. The module will allow an editor to create a version #.  After the version the number is created we can start adding docs.  The docs will have a "Title" and "Body" field. The title will be used in the links the users hit to find the right help.  For example, a help link be look like http://www.oicgroup.net/help/version/2.0/module/text. The "text" part of the url will be the title of the piece of content. The module should allow an editor/admin to create a new version.  In doing so, it will copy all the docs for the current version, including attachable items and mark the copies with the version number of the new version.

To go along with the Help Module we will also need a smarty plugin that will probably look like {help module="text"}. The plugin will create the link to the help site (pulling the domain from the site config, the version from exponent_version.php and the module from the parameter passed to the plugin. Also, we will hard code a help link into the chrome or menu in the container module that is "aware" of what module it is.  The plugin can be used to put help links in other views throughout the system.

Steps to Implement:

• Create Help Module with Title, Body and attachable screenshots & videos
• Create a tabbed view to display the help to the users.  3 tabs..overview has the text, screenshots for images, and videos for screencasts.
• Create the "help" smarty plugin
• Update the container module to place help links in the chrome or fly down menus

Areas of Exponent Affected By the Change:

Container module and any views we place "help" plugin in. We will probably only place it in edit and config views for now.