User:Johan G/Template:Informative template with preloaded text
This template is a draft on a userpage.
See also discussion page
|
1 is not empty use 1 doc is empty /doc exist use /doc /doc do not exist doc is not empty doc point to /doc use doc doc do not point to /doc use doc throw error 1 is empty doc is empty /doc exist use /doc /doc do not exist encourage writing doc doc is not empty doc point to /doc use doc doc do not point to /doc use doc throw error
[[{{FULLPAGENAME}}/doc]]
User:Johan G/Template:Informative template with preloaded text/doc
{{#ifexist: {{{doc|-{{FULLPAGENAME}}/doc}}} <!-- Does /doc or page in doc exist? --> | Yes, /doc or page in doc exist yes | No, /doc or page in doc does not exist no }}
no
{{#ifeq: {{{doc|-{{FULLPAGENAME}}/doc}}} | {{FULLPAGENAME}}/doc <!-- If defined, does doc point to /doc? --> | equal | {{error|Page '''{{FULLPAGENAME}}/doc''' exist, but parameter '''doc''' points to '''{{{doc}}}'''|User:Johan G/Template:Informative template with preloaded text}} }}
{{User:Johan G/Template:Informative template with preloaded text}}: Page User:Johan G/Template:Informative template with preloaded text/doc exist, but parameter doc points to {{{doc}}}
1
This template is used when documenting templates.
Optionally the documentation can be put on a separate page, typically a subpage to the template, named /doc
.
If the template is put on a page without a /doc
subpage, or no link is given to a subpage with documentation, clicking a link labeled "Click here to create documentation for this template" will open a skeleton page for template documentation.
Usage
The template is used with one variable and must be put between <noinclude></noinclude>
tags.
Note Please put the <noinclude>
tag right behind the intended contents of the template, as an empty line or extra spaces will alter the way the template is rendered.
{{User:Johan G/Template:Informative template with preloaded text | 1= | doc= | link box= }}
If documentation is the same page as the template 1 is mandatory. Otherwise all parameters are optional.
- For some content the text in 1 and link box must start on a new line (see examples below). Some formatting will otherwise fail.
- 1
- Will allow wiki markup to be used above or instead of a separate documentation page.
- doc
- Name of page with documentation
- If content is empty doc will default to
{{FULLPAGENAME}}/doc
- link box
- Will add content to the link box at the bottom
Examples
{{User:Johan G/Template:Informative template with preloaded text}}
Template loop detected: User:Johan G/Template:Informative template with preloaded text
{{User:Johan G/Template:Informative template with preloaded text | 1= Test }}
Template loop detected: User:Johan G/Template:Informative template with preloaded text
{{User:Johan G/Template:Informative template with preloaded text | 1= Test | link box=Test text}}
Template loop detected: User:Johan G/Template:Informative template with preloaded text
{{User:Johan G/Template:Informative template with preloaded text |doc=User:Johan G/Template:Informative template with preloaded text/doc}}
Template loop detected: User:Johan G/Template:Informative template with preloaded text
Technical details
When creating a template with the "Create documentation" link, the new page is preloaded from User:Johan G/Template:Informative template with preloaded text/preload text.
Known issues
This template is still under development.
Related templates
The above documentation is transcluded from User:Johan G/Template:Informative template with preloaded text/doc. (Edit | History)562