Template

Documentation/preload: Difference between revisions

From Joomla! Documentation

CirTap (talk | contribs)
No edit summary
Tom Hutchison (talk | contribs)
m fixing
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
Purpose of this template...
Enter the purpose of this template...


== Functions/Features ==
== Functions/Features ==
Describe its features ...


== Usage ==
== Usage ==
<!-- examples should be given using any of the following formats -->
Provide examples such as ....
{{tlx|template name|foo|param&#61;bar}}
* via {{tl|tl}}  for templates w/o params: {{xpd|tl|template name}}
<pre>{{template name|foo|param=bar}}</pre>
* via {{tl|tlx}} for templates with params &amp; complex output: {{xpd|tlx|template name|foo|param&#61;bar}}
* via {{tl|xpd}} for templates with simple &amp; output: {{xpd|template name|foo|param&#61;bar}}
 
== Parameters ==
== Parameters ==
{|class="wikitable"
{|class="prettytable parameters"
|-
|-
!Parameter Name
!Parameter
!Parameter Description
!Parameter description
!req./opt.
!req./opt.
|-
|-
|<nowiki>{{{1}}}</nowiki>
|<nowiki>{{{1}}}</nowiki>
|description of unnamed parameter 1
|description of unnamed parameter 1
|'''Required.'''
|class="req"|required
|-
|-
|<nowiki>{{{foobar}}}</nowiki>
|<nowiki>{{{foobar}}}</nowiki>
|description of named parameter 'foobar'
|Default: "batbaz". Description of named parameter 'foobar'
|'''Optional.'''
|class="opt"|optional
|}
|}


== Known Issues ==
== Known Issues ==
? limitations, technical probs, namespace restrictions, rendering issues
Include notes about ...
* dependencies (templates, extensions, assets)
* limitations, technical probs, namespace restrictions
* rendering issues
 
== See also ==
Provide links to ...
* related templates
* supplemental documentation
* style guides
* example pages
 
== Stylesheet ==
Provide CSS selectors ... for [[MediaWiki::joomla.css]] (or [[MediaWiki::common.css]])
some.class


<!-- REMOVE BLANKS in includeonly-tags and edit *calling* TEMPLATE CATEGORIES BELOW THIS LINE -->
<!-- REMOVE BLANKS in includeonly-tags and edit *calling* TEMPLATE CATEGORIES BELOW THIS LINE  
<includeonly >[[Category:Typing-aid templates |{{PAGENAME}}]]< /includeonly>
  noteworthy: [[Category:Wiki templates using Extensions]]
-->
<include<includeonly></includeonly>only>
[[Category:Wiki Template stubs|{{PAGENAME}}]]
<include<includeonly></includeonly>only>
<noinclude>[[Category:Wiki Preloading templates]]</noinclude>

Latest revision as of 15:47, 28 July 2014

Enter the purpose of this template...

Functions/Features

Describe its features ...

Usage

Provide examples such as ....

  • via {{tl}} for templates w/o params: {{tl|template name}} gives {{template name}}
  • via {{tlx}} for templates with params & complex output: {{tlx|template name|foo|param=bar}} gives {{template name|foo|param=bar}}
  • via {{xpd}} for templates with simple & output: {{template name|foo|param=bar}} gives
    General Information

    This is a dummy template with absolutely no value except as a placeholder for demo of JDOC's templates. You should return to the page you just came from by clicking on the back button of your browser.

Parameters

Parameter Parameter description req./opt.
{{{1}}} description of unnamed parameter 1 required
{{{foobar}}} Default: "batbaz". Description of named parameter 'foobar' optional

Known Issues

Include notes about ...

  • dependencies (templates, extensions, assets)
  • limitations, technical probs, namespace restrictions
  • rendering issues

See also

Provide links to ...

  • related templates
  • supplemental documentation
  • style guides
  • example pages

Stylesheet

Provide CSS selectors ... for [[MediaWiki::joomla.css]] (or [[MediaWiki::common.css]])

some.class

<includeonly> <includeonly>