Nucleus 5: Help System

A more usefull helpsystem would certainly improve user experience and stop those ever-returning questions on the forum. Some ideas:

• All help could be made available as separate files by subject. These files should have a format and structure that facilitates a search-feature, build an index, add new pages without having to modify already existing pages and jump to a specific subject in the Help-system. When we would have such a system, we could add a help-link on every page in the admin area, which opens the Help-popup and immediately jumps to relevant info for the things, you are doing (according to which page you are browsing). It should display the index and thus give a nice overview of all available help + searchbox.

• Also plug-ins should add their docs to this system so that they integrate very nicely. API 2 plugins could use the plugin.meta file to specify their docs-folder inside the tar to let Nucleus copy these files into the right directory (for jEdit users this is the same system as with plugins for jEdit, each plugin adds its docs into the main help-system, which is extremely easy to use, you always know where to find docs for a plugin).

• It should be possible to use the documentation from a remote site (by default help.nucleuscms.org or someting like that) so that users can choose not to upload the docs to save space (when installing an API2 plugin Nucleus will check this setting and only extract the docs if necessary).

These are part of the Nucleus 5 plans. Read more about the project.