Difference between revisions of "Relatedhelp/doc"
From Joomla! Documentation
< Template:Relatedhelp
m (update to documenation) |
m (clean up) |
||
| (4 intermediate revisions by one other user not shown) | |||
| Line 12: | Line 12: | ||
{{#dpl: | {{#dpl: | ||
|noresultsheader={{relatedhelp/noresults}} | |noresultsheader={{relatedhelp/noresults}} | ||
| − | |namespace= | + | |namespace=Help33 |
|titlematch=%Newsfeed% | |titlematch=%Newsfeed% | ||
|includepage=#Description, | |includepage=#Description, | ||
| − | |listseparators={{{!}}class="wikitable" id="Help Screens"\n!Related Help Screens\n!Description\n,{{!}}-\n{{!}}style="width:300px;"{{!}}[[%PAGE%|%TITLE%]]\n{{!}}style="font-size:. | + | |listseparators={{{!}}class="wikitable striped" id="Help Screens"\n!Related Help Screens\n!Description\n,{{!}}-\n{{!}}style="width:300px;"{{!}}[[%PAGE%|%TITLE%]]\n{{!}}style="font-size:.85em; width:auto;"{{!}} , \n,{{!}}-\n{{!}}} |
|ordermethod=sortkey | |ordermethod=sortkey | ||
}} | }} | ||
| Line 24: | Line 24: | ||
{{#dpl: | {{#dpl: | ||
|noresultsheader={{relatedhelp/noresults}} | |noresultsheader={{relatedhelp/noresults}} | ||
| − | |namespace= | + | |namespace=Help33 |
|titlematch=%Article% | |titlematch=%Article% | ||
|includepage=#Description, | |includepage=#Description, | ||
| − | |listseparators={{{!}}class="wikitable" id="Help Screens"\n!Related Help Screens\n!Description\n,{{!}}-\n{{!}}style="width:300px;"{{!}}[[%PAGE%|%TITLE%]]\n{{!}}style="font-size:. | + | |listseparators={{{!}}class="wikitable striped" id="Help Screens"\n!Related Help Screens\n!Description\n,{{!}}-\n{{!}}style="width:300px;"{{!}}[[%PAGE%|%TITLE%]]\n{{!}}style="font-size:.85em; width:auto;"{{!}} , \n,{{!}}-\n{{!}}} |
|ordermethod=sortkey | |ordermethod=sortkey | ||
}} | }} | ||
| + | :'''Use of not=''' to not include Help screens with a word or phrase. | ||
| + | <pre> | ||
| + | {{relatedhelp|article|not=menu}} | ||
| + | </pre> | ||
| + | <!--Using markup because of Namespace detection--> | ||
| + | {{#dpl: | ||
| + | |noresultsheader={{relatedhelp/noresults}} | ||
| + | |namespace=Help33 | ||
| + | |titlematch=%Article% | ||
| + | |nottitlematch=%Menu% | ||
| + | |includepage=#Description, | ||
| + | |listseparators={{{!}}class="wikitable striped" id="Help Screens"\n!Related Help Screens\n!Description\n,{{!}}-\n{{!}}style="width:300px;"{{!}}[[%PAGE%|%TITLE%]]\n{{!}}style="font-size:.85em; width:auto;"{{!}} , \n,{{!}}-\n{{!}}} | ||
| + | |ordermethod=sortkey | ||
| + | }} | ||
| + | |||
== Parameters == | == Parameters == | ||
| − | {|class=" | + | {|class="wikitable striped" |
|- | |- | ||
!Parameter | !Parameter | ||
| Line 40: | Line 55: | ||
|common title name fragment | |common title name fragment | ||
|class="req"|required | |class="req"|required | ||
| + | |- | ||
| + | |<nowiki>{{{not}}}</nowiki> | ||
| + | |common title name fragment | ||
| + | |class="opt"|optional | ||
|} | |} | ||
Latest revision as of 06:03, 1 August 2014
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[edit]
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[edit]
{{relatedhelp|newsfeed}}
Extension:DynamicPageList (DPL), version 2.3.0 : Error: Wrong 'namespace' parameter: 'Help33'! Help: <code>namespace= <i>empty string</i> (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 | Chunk4x | Chunk4x_talk | Chunk5x | Chunk5x_talk | Chunk_talk | CodeExample | CodeExample_talk | File | File_talk | Framework | Framework_talk | Gadget | Gadget_definition | Gadget_definition_talk | Gadget_talk | Help15 | Help15_talk | Help16 | Help16_talk | Help17 | Help17_talk | Help25 | Help25_talk | Help3.x | Help3.x_talk | Help310 | Help310_talk | Help4.x | Help4.x_talk | Help5.x | Help5.x_talk | J1.5 | J1.5_talk | J2.5 | J2.5_talk | J3.x | J3.x_talk | J4.x | J4.x_talk | J5.x | J5.x_talk | JDOC | JDOC_talk | JHelp | JHelp_talk | Joomla | Joomla_talk | MediaWiki | MediaWiki_talk | Moved | Portal | Portal_talk | Talk | Template | Template_talk | Translations | Translations_talk | Tutorials | Tutorials_talk | User | User_talk | Widget | Widget_talk</code>.
{{relatedhelp|article}}
Extension:DynamicPageList (DPL), version 2.3.0 : Error: Wrong 'namespace' parameter: 'Help33'! Help: <code>namespace= <i>empty string</i> (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 | Chunk4x | Chunk4x_talk | Chunk5x | Chunk5x_talk | Chunk_talk | CodeExample | CodeExample_talk | File | File_talk | Framework | Framework_talk | Gadget | Gadget_definition | Gadget_definition_talk | Gadget_talk | Help15 | Help15_talk | Help16 | Help16_talk | Help17 | Help17_talk | Help25 | Help25_talk | Help3.x | Help3.x_talk | Help310 | Help310_talk | Help4.x | Help4.x_talk | Help5.x | Help5.x_talk | J1.5 | J1.5_talk | J2.5 | J2.5_talk | J3.x | J3.x_talk | J4.x | J4.x_talk | J5.x | J5.x_talk | JDOC | JDOC_talk | JHelp | JHelp_talk | Joomla | Joomla_talk | MediaWiki | MediaWiki_talk | Moved | Portal | Portal_talk | Talk | Template | Template_talk | Translations | Translations_talk | Tutorials | Tutorials_talk | User | User_talk | Widget | Widget_talk</code>.
- 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: 'Help33'! Help: <code>namespace= <i>empty string</i> (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 | Chunk4x | Chunk4x_talk | Chunk5x | Chunk5x_talk | Chunk_talk | CodeExample | CodeExample_talk | File | File_talk | Framework | Framework_talk | Gadget | Gadget_definition | Gadget_definition_talk | Gadget_talk | Help15 | Help15_talk | Help16 | Help16_talk | Help17 | Help17_talk | Help25 | Help25_talk | Help3.x | Help3.x_talk | Help310 | Help310_talk | Help4.x | Help4.x_talk | Help5.x | Help5.x_talk | J1.5 | J1.5_talk | J2.5 | J2.5_talk | J3.x | J3.x_talk | J4.x | J4.x_talk | J5.x | J5.x_talk | JDOC | JDOC_talk | JHelp | JHelp_talk | Joomla | Joomla_talk | MediaWiki | MediaWiki_talk | Moved | Portal | Portal_talk | Talk | Template | Template_talk | Translations | Translations_talk | Tutorials | Tutorials_talk | User | User_talk | Widget | Widget_talk</code>.
Parameters[edit]
| Parameter | Parameter description | req./opt. |
|---|---|---|
| {{{1}}} | common title name fragment | required |
| {{{not}}} | common title name fragment | optional |
Known Issues[edit]
- 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_.