Difference between revisions of "Template:Documentation/preload"
From Project: Gorgon Wiki
m (Moving category logic to top) |
m (→Sample output: Added overflow:auto;) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
[[Category:Template documentation|{{PAGENAME}}]] | [[Category:Template documentation|{{PAGENAME}}]] | ||
<<noinclude/>/noinclude></includeonly> | <<noinclude/>/noinclude></includeonly> | ||
| − | == Description == | + | <dl> |
| − | + | == <dt>Description</dt> == | |
| − | == Dependencies ==<!-- delete if N/A --> | + | <dd>This template is used to do something.</dd> |
| − | + | == <dt>Dependencies</dt> ==<!-- delete if N/A --> | |
| + | <dd> | ||
| + | *Uses (some CSS, JS, file, or other template).<!-- delete if N/A --> | ||
| + | *Uses for this documentation: | ||
| + | **{{t|SPW}} = Wikia specific to link back to original. | ||
| + | **{{t|t}} = To show clickable template mentions. | ||
| + | **{{t|para}} = To show parameter usage. | ||
| + | **{{t|-}} and {{t|Lorem ipsum}} = To format the output of the samples. | ||
| + | </dd> | ||
| − | == Syntax == | + | == <dt>Syntax</dt> == |
| − | + | <dd>Type {{t|{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}|param1<!-- delete if N/A -->|namedparam=<!-- delete if N/A -->|style=code}} somewhere. | |
| − | == Sample output == | + | </dd> |
| + | ===<dt>Parameters</dt>=== | ||
| + | <dd> | ||
| + | *<i>Recommended | Required | Optional</i>: {{para|namedparameter}} | ||
| + | *:Your explanation here. | ||
| + | *:Default: {{para|namedparameter|<var>value</var>}} | ||
| + | </dd> | ||
| + | == <dt>Sample output</dt> == | ||
| + | <!-- Use one or the other layout versions below --> | ||
| + | <!-- /start: For a tabular sample output --> | ||
| + | <dd> | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ Sample output | |+ Sample output | ||
! Code !! Output | ! Code !! Output | ||
|- | |- | ||
| − | | style="background-color:silver;" | <code> | + | | style="background-color:silver; overflow:auto;" | <code> |
<nowiki>{{</nowiki>{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}<nowiki>|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}}</nowiki> | <nowiki>{{</nowiki>{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}<nowiki>|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}}</nowiki> | ||
</code> | </code> | ||
:gives... | :gives... | ||
| − | | style="background-color:silver;" | | + | | style="background-color:silver; overflow:auto;" | |
{{{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}} | {{{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}} | ||
|} | |} | ||
| + | </dd> | ||
| + | <!-- /end: For a tabular sample output --> | ||
| − | == See also ==<!-- delete if N/A --> | + | <!-- /start: For a vertical sample output --> |
| − | + | <dd><dl> | |
| − | + | ===Sample:1=== | |
| + | <dt style="font-family:monospace,Courier; font-weight:normal; border:2px solid teal; border-radius:1em; overflow:auto;"> | ||
| + | <nowiki>{{</nowiki>{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}<nowiki>|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}}</nowiki> | ||
| + | </dt> | ||
| + | <dd>gives...</dd> | ||
| + | <dd style="border:2px solid teal; border-radius:1em; overflow:auto;"> | ||
| + | {{{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}} | ||
| + | </dd> | ||
| + | |||
| + | </dl></dd> | ||
| + | <!-- /end: For a vertical sample output --> | ||
| + | |||
| + | == <dt>See also</dt> ==<!-- delete if N/A --> | ||
| + | <dd> | ||
| + | *{{t|<!-- Some other template's name -->}}<!-- delete if N/A --> | ||
| + | *[[<!-- Some other related page -->]]<!-- delete if N/A --> | ||
| + | </dd> | ||
| + | |||
| + | </dl> | ||
Latest revision as of 17:53, 10 May 2016
- Description
- This template is used to do something.
- Dependencies
-
- Uses (some CSS, JS, file, or other template).
- Uses for this documentation:
- {{SPW}} = Wikia specific to link back to original.
- {{t}} = To show clickable template mentions.
- {{para}} = To show parameter usage.
- {{-}} and {{Lorem ipsum}} = To format the output of the samples.
- Syntax
- Type
{{Documentation|param1|namedparam=}}somewhere. - Parameters
-
- Recommended | Required | Optional:
|namedparameter=- Your explanation here.
- Default:
|namedparameter=value
- Recommended | Required | Optional:
- Sample output
-
Sample output Code Output {{Documentation|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}}
- gives...
Template documentation (for the above template, sometimes hidden or invisible) [create]- This template doesn't have any documentation yet! Help out by writing some. There may also be documentation on Wikia Templates which can be copied.
This template currently doesn't have any documentation; you can create it if you know how the template is used. (What is this?)
If you're done making changes, please refresh the text.
Please add categories and interwikis to foo1. (View all subpages of this page.) - {{Documentation|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}}
- gives...
-
Template documentation (for the above template, sometimes hidden or invisible) [create]
- This template doesn't have any documentation yet! Help out by writing some. There may also be documentation on Wikia Templates which can be copied.
This template currently doesn't have any documentation; you can create it if you know how the template is used. (What is this?)
If you're done making changes, please refresh the text.
Please add categories and interwikis to foo1. (View all subpages of this page.)
Sample:1
- See also
-
- {{[[Template:|]]}}
- [[]]
