Content last modified Monday 5 May 2008
hop to #bottom
Categories:
Author:
Current version:
0.4
About It:
Get it:
Rate it:
  • Helpful?
  • 0 Yes
  • 0 No
Flag it:
Contact Reason [ ? ]

tame_enduser_docs

Update v0.4 14th September 2007

  • Now adds MySQL table automatically.
  • Option to toggle integration with hak_tinymce on and off.
  • Help documents have their own style sheet.
  • Improved documentation.

Overview

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.

Integrates with hak_tinymce plugin, so you can edit your documentation using this WYSIWYG interface.

Installation

Problems with errors in plugin file fixed, thanks Pat for highlighting the problems.

During installation a table will be added to your MySQL database (see the plugin’s help section or readme.txt). Whilst I do not anticipate any problems with this installation it is always wise to make backups of your database before making any such alterations.

Configuration

You can now style the help pages using textpattern css styling options. Simply add a css ‘file’ called tame_enduser_docs to the textpattern styles section.

Optional Configuration

I would also suggest you add the lines below to the following file

\textpattern\tiny_mce\themes\advanced\css\editor_ui.css

to facilitate editing your end user documentations (makes the editing textarea wider).

/* tame_enduser_docs addition */
.mceEditor { width:700px}
/* end of tame_enduser_docs addition */

At present there is only the option to add one help page. The ability to add pages may be possible in future releases.

Plans

Future versions will come with ready made basic documentation for end users on how to use Textpattern and the hak_tinymce WYSIWYG interface.

Article Request Count:
Keywords/tags:
Initially released:
1st May 2007
Posted here:
01 May 2007
Article modified:
15 Nov 2007

If there is a comment form at the Information URL, you may want to leave your comments/questions there for quicker feedback. Otherwise, comment away:

Your comment will NOT be submitted until you click the 'Submit' button on the next pageload.

Commented (4)

This is a really cool plugin!

I managed the SQL-statement, but it would be much more convenient, if you could include the script into the plugin.

Excellent Plugin. I used to create additional admin sections for the website for this purpose, which were never very effective.

Would it be possible to allow textile editing for this page? That would be nice.

Anyway, thanks a lot, this is great!

Hi thanks for you comments. I have now automated the addition of the SQL table.

Unfortunately I don’t think I am likely to be able to add integration with textile.

See the link to my website for the latest version.

Will not run when having prefixes in the database. I fixed this manually for me in the plugin code. Great plugin, though.

Subscribe to this article's comments RSS feed. [ ? ]   View Recent Comments across the site. Get a Gravatar.

You know you want to visit the Archives.

Browse

Categories


Articles

There are also tag clouds, 'cause those are fun.
TxP · TxD · GG