#This is the Wiki related to the Help Plugin for TinyMCE3.

Introduction

The help plugin is supposed to replace TinyMCE3's current "about" dialogue in a manner like the former 2.x version of TinyMCE did, which used to also offer in-editor help documents for end users. This new help plugin also offers context-sensitive help in the editor's dialogue windows by displaying the "question mark icon" in the dialogues if a suitable help document is available. In addition it enables the inclusion of plugin-specific help files into the "general" help file table of contents.

Details

As of now (creation of this Google Code Project on 2009-06-06 using TinyMCE3.2.4 as code base) a modified tiny_mce_popup.js is needed in order to allow "access" to the dialogue initialization. Maybe Moxiecode will implement this idea in future versions of tiny_mce_popup.js?

The help plugin expects a subdirectory "docs" in every plugin's directory. This directory contains other subdirectories with other languages - at least a subdirectory "en" for the English help files which also serve as a fallback if help files in the editor's language setting's language aren't available.

The help plugin's own "docs" directory contains help files which basically focus on the advanced theme's generic functionalities (formerly in TinyMCE2.x these files were in the advanced theme's "docs" subdirectory) and more general help sections.

A demonstration of this plugin's initial draft can be tested here: Demo Page