User:Johan G/Template:Informative template with preloaded text: Difference between revisions
(*Intermediate break* trying to get correct parts rendering in correct circumstance and setting up error messages to help users troubleshoot) |
m (Intermediate save. Sketching out better logic) |
||
Line 8: | Line 8: | ||
--> | --> | ||
<nowiki>1 | <nowiki>1 and doc is empty and /doc do not exist | ||
1 is not empty | |||
use 1 | |||
doc is not empty | |||
/doc exist and doc is not /doc | |||
trow error | |||
use doc | |||
else | |||
/doc exist | |||
doc | use /doc | ||
else | |||
encourage writing /doc</nowiki></noinclude><includeonly> | |||
</noinclude><includeonly> | |||
__NOEDITSECTION__ | __NOEDITSECTION__ | ||
__NOTOC__ | __NOTOC__ |
Revision as of 12:29, 27 June 2019
This template is a draft on a userpage.
See also discussion page
|
1 and doc is empty and /doc do not exist 1 is not empty use 1 doc is not empty /doc exist and doc is not /doc trow error use doc else /doc exist use /doc else encourage writing /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