Hi fellow wiki editors!

To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).

I have tried to keep the template short, but meaningful. /Johan G

User:Johan G/Template:Informative template with preloaded text/doc

From FlightGear wiki
Jump to: navigation, search
This is a draft on a userpage.

Please suggest changes to this draft on the discussion page.

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}}


The following template description is not displayed when the template is inserted in an article.
12
{{User:Johan G/Template:Informative template with preloaded text
  | 1=
Test
}}


The following template description is not displayed when the template is inserted in an article.
1

The above documentation is transcluded from User:Johan G/Template:Informative template with preloaded text/doc/doc. (Edit | History)562

{{User:Johan G/Template:Informative template with preloaded text
| 1=
Test
| link box=Test text}}


The following template description is not displayed when the template is inserted in an article.
1

The above documentation is transcluded from User:Johan G/Template:Informative template with preloaded text/doc/doc. (Edit | History)5
Test text62

{{User:Johan G/Template:Informative template with preloaded text |doc=User:Johan G/Template:Informative template with preloaded text/doc}}


The following template description is not displayed when the template is inserted in an article.
1

Template documentation3 [ [User:Johan G/Template:Informative template with preloaded text/doc View] ] [ [User:Johan G/Template:Informative template with preloaded text/doc Edit] ] [ [User:Johan G/Template:Informative template with preloaded text/doc History] ] [ [User:Johan G/Template:Informative template with preloaded text/doc Purge] ] 4


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. ([User:Johan G/Template:Informative template with preloaded text/doc Edit] | [User:Johan G/Template:Informative template with preloaded text/doc History])562

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