User:Johan G/Template:Informative template with preloaded text: Difference between revisions
m (fix: - "-" to trigger an if statement for debugging) |
m (fix: Also check for /doc subpage) |
||
Line 16: | Line 16: | ||
</noinclude><includeonly> | </noinclude><includeonly> | ||
<div class="sjabdocnoot" style="color:grey; text-align:center; margin-top:1em;"><small>'''The following template description is not displayed when the template is inserted in an article.'''</small></div> | <div class="sjabdocnoot" style="color:grey; text-align:center; margin-top:1em;"><small>'''The following template description is not displayed when the template is inserted in an article.'''</small></div> | ||
{{#if: {{{1|{{{ | {{#if: {{{content|{{{1|{{#ifexist: {{FULLPAGENAME}}/doc | yes}}}}}}}} <!-- Is both 1= and content= empty and there is no /doc subpage? --> | ||
| <!-- | | <!-- No, at least one of them is is there. --> | ||
<div class="toccolours template-documentation" style="background: #FFFFEE; border: 1px solid #FFDAB9;font-size:100%;"> | <div class="toccolours template-documentation" style="background: #FFFFEE; border: 1px solid #FFDAB9;font-size:100%;"> | ||
__NOEDITSECTION__ | __NOEDITSECTION__ | ||
Line 32: | Line 32: | ||
}} | }} | ||
</div> | </div> | ||
| <!-- | | <!-- Yes, none of them is there. Throw a message to the reader. --> | ||
<div class="toccolours template-documentation" style="background: #FFFFEE; border: 1px solid #FFDAB9;font-size:100%;"> | <div class="toccolours template-documentation" style="background: #FFFFEE; border: 1px solid #FFDAB9;font-size:100%;"> | ||
Please [{{fullurl:{{FULLPAGENAME}}/doc|action=edit&preload=User:Johan_G/Template:Informative_template_with_preloaded_text/preloaded_text}} add documentation]. | Please [{{fullurl:{{FULLPAGENAME}}/doc|action=edit&preload=User:Johan_G/Template:Informative_template_with_preloaded_text/preloaded_text}} add documentation]. |
Revision as of 17:19, 22 June 2019
This template is a draft on a userpage.
See also comments in the source
|
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)