Actions

Template

Cathelp/doc

From Joomla! Documentation

< Template:Cathelp
Revision as of 08:57, 4 April 2013 by Tom Hutchison (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
This is a documentation subpage for Template:Cathelp.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Cathelp.

This template can be used to bulk categorise Help screens, based on a version number, a common screen name (for the underlying component), and their admin menu name.

As of Joomla! 1.5 help screens are typically named after an internal "keyword" that is used to request the online help from within the Back-end. For example, the keyword "screen.templates.15" refers to the "Template Manager" screen. In order to have human readable entries in the various categories, but also preserve the magic keyword for the help system, the wiki page screen.templates.15 contains a redirect to the actual Template Manager. That name will appear in a category index.

If a component consists of several submenus to manage its content and categories, the help screens should be grouped under the name of the "Component Manager", i.e. "Banner Category Manager" => "Banner Manager".

Usage

{{cathelp|version(array if relevant)|Screen name|Menu name}}

Example:

{{cathelp|3.0|Template Manager|Extensions}}
{{cathelp|3.0,3.1,3.2|Template Manager|Extensions}}

Parameters

Parameter Parameter description req./opt.
{{{1}}} a Joomla! major.minor version number (array if relevant) required
{{{2}}} the name of a main screen, that is edit screens all grouped under the same name optional
{{{3}}} the name of the admin mainmenu that screen belongs to optional

To do

  • the version number should pass {{jversion}} for simple "validation"
  • for some future Front-end help, an optional named parameter would be helpful