Textpattern CMS

#1 2008-08-21 14:01:14

tameboy

Plugin Author

Registered: 2006-06-29

Posts: 48

boy_enduser_docs

Adds a ‘help’ tab to the ‘Content’ area of admin. Intended to be used to provide documentation and help for end users/site editors.

It is easily edited (by those with ‘publisher’ privileges) from the administration section. It integrates with hak_tinymce to allow convenient WYSIWYG editing, and has its own style sheet (see configuration below).

Download

Currently on Google Code

Installation

The plugin should be installed in the same way as other plugins. It will automatically add the a MySQL table (txp_tame_enduser_docs) to your database when you first use it. This should not cause any problems but you are advised to back up your database before making any alterations to it, including installing this plugin.

Upgrading

Upgrading from previous versions requires a little tinkering. I would advised the following process:

1. Copy the HTML source from your current boy_enduser_docs documentation. If you have used hak_tinyMCE you can either use the HTML button on the tinyMCE tool bar or just switch hak_tinyMCE integration off (see below) so that you can view the HTML source code.

2. Paste this into a new file on your hard drive and save it somewhere you will remember. 3. Delete the txp_boy_enduser_docs (txp_tame_enduser_docs pre v0.5) table from your MySQL database. You can either do this via whatever application you usually use to administer your database or use one of these MySQL queries:

• DROP TABLE txp_boy_enduser_docs or
• DROP TABLE txp_tame_enduser_docs (for versions pre 0.5)

Configuration

Once you have installed you can view the configuration options in the Extensions -> end user docs tab.

NEW in 0.6: You can configure the hak_tinymce WYSIWYG tool bars.

NEW in 0.6: You chose to automatically direct clients to your help page when they sign in.

NEW in 0.6: You can edit the title of the tab (default title is ‘Help’) which is added to the clients ‘Content’ area in txp admin.

You can switch integration with hak_tinymce on and off.

You can style your help documents using a style sheet called boy_enduser_docs. Create this within textpattern as you would any standard style sheet and name it boy_enduser_docs. Your help documentation will automatically link to this style sheet.