Actions

Template

Relatedhelp/doc

From Joomla! Documentation

< Template:Relatedhelp
Revision as of 16:21, 5 February 2014 by Tom Hutchison (Talk | contribs)

This is a documentation subpage for Template:Relatedhelp.
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:Relatedhelp.

Functions/Features

This template will allow related help screens, with a table of links and page descriptions to be called easily while suppressing the current page's name. This template uses the DPL extension and is a requirement for it to function properly.

Automatic Namespace detection, intended for use on Help Screen namespaces. Could be used on other Namespaces, but the results may not be expected as the template is looking for the 'Description' section of pages for inclusion.

Usage

{{relatedhelp|newsfeed}}

Extension:DynamicPageList (DPL), version 2.3.0 : Error: Wrong 'namespace' parameter: 'Help32'! Help: namespace= empty string (Main) | API15 | API15_talk | API16 | API16_talk | API17 | API17_talk | Archived | Archived_talk | Category | Category_talk | Chunk | Chunk16 | Chunk16_talk | Chunk17 | Chunk17_talk | Chunk25 | Chunk25_talk | Chunk30 | Chunk30_talk | Chunk_talk | CodeExample | CodeExample_talk | Description | Description_talk | File | File_talk | Framework | Framework_talk | Help | Help15 | Help15_talk | Help16 | Help16_talk | Help17 | Help17_talk | Help25 | Help25_talk | Help34 | Help34_talk | Help_talk | J1.5 | J1.5_talk | J2.5 | J2.5_talk | J3.x | J3.x_talk | JDOC | JDOC_talk | Joomla | Joomla_talk | MediaWiki | MediaWiki_talk | Portal | Portal_talk | SeeAlso | SeeAlso_talk | Talk | Template | Template_talk | Translations | Translations_talk | Transwiki | Transwiki_talk | Tutorials | Tutorials_talk | User | User_talk | VEL | VEL_talk | Widget | Widget_talk.

{{relatedhelp|article}}

Extension:DynamicPageList (DPL), version 2.3.0 : Error: Wrong 'namespace' parameter: 'Help32'! Help: namespace= empty string (Main) | API15 | API15_talk | API16 | API16_talk | API17 | API17_talk | Archived | Archived_talk | Category | Category_talk | Chunk | Chunk16 | Chunk16_talk | Chunk17 | Chunk17_talk | Chunk25 | Chunk25_talk | Chunk30 | Chunk30_talk | Chunk_talk | CodeExample | CodeExample_talk | Description | Description_talk | File | File_talk | Framework | Framework_talk | Help | Help15 | Help15_talk | Help16 | Help16_talk | Help17 | Help17_talk | Help25 | Help25_talk | Help34 | Help34_talk | Help_talk | J1.5 | J1.5_talk | J2.5 | J2.5_talk | J3.x | J3.x_talk | JDOC | JDOC_talk | Joomla | Joomla_talk | MediaWiki | MediaWiki_talk | Portal | Portal_talk | SeeAlso | SeeAlso_talk | Talk | Template | Template_talk | Translations | Translations_talk | Transwiki | Transwiki_talk | Tutorials | Tutorials_talk | User | User_talk | VEL | VEL_talk | Widget | Widget_talk.

Use of not= to not include Help screens with a word or phrase.
{{relatedhelp|article|not=menu}}

Extension:DynamicPageList (DPL), version 2.3.0 : Error: Wrong 'namespace' parameter: 'Help32'! Help: namespace= empty string (Main) | API15 | API15_talk | API16 | API16_talk | API17 | API17_talk | Archived | Archived_talk | Category | Category_talk | Chunk | Chunk16 | Chunk16_talk | Chunk17 | Chunk17_talk | Chunk25 | Chunk25_talk | Chunk30 | Chunk30_talk | Chunk_talk | CodeExample | CodeExample_talk | Description | Description_talk | File | File_talk | Framework | Framework_talk | Help | Help15 | Help15_talk | Help16 | Help16_talk | Help17 | Help17_talk | Help25 | Help25_talk | Help34 | Help34_talk | Help_talk | J1.5 | J1.5_talk | J2.5 | J2.5_talk | J3.x | J3.x_talk | JDOC | JDOC_talk | Joomla | Joomla_talk | MediaWiki | MediaWiki_talk | Portal | Portal_talk | SeeAlso | SeeAlso_talk | Talk | Template | Template_talk | Translations | Translations_talk | Transwiki | Transwiki_talk | Tutorials | Tutorials_talk | User | User_talk | VEL | VEL_talk | Widget | Widget_talk.

Parameters

Parameter Parameter description req./opt.
{{{1}}} common title name fragment required
{{{not}}} common title name fragment optional

Known Issues

  • Should be used in Help Screen namespaces.
  • Title fragment, pay attention to plurals. 'Article' may yield more than 'articles' when used. To single out a word, and only a full word use underscore to force a space before and after, example: _word_.