Difference between revisions of "Template:Documentation/preload"

From Project: Gorgon Wiki
Jump to: navigation, search
m (Making all sections a definition list. Enhanced section syntax with deps)
m (→‎Sample output: Added overflow:auto;)
 
(2 intermediate revisions by the same user not shown)
Line 11: Line 11:
 
<dd>
 
<dd>
 
*Uses (some CSS, JS, file, or other template).<!-- delete if N/A -->
 
*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>
 
</dd>
 +
 
== <dt>Syntax</dt> ==
 
== <dt>Syntax</dt> ==
 
<dd>Type {{t|{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}|param1<!-- delete if N/A -->|namedparam&#61;<!-- delete if N/A -->|style=code}} somewhere.
 
<dd>Type {{t|{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}|param1<!-- delete if N/A -->|namedparam&#61;<!-- delete if N/A -->|style=code}} somewhere.
Line 22: Line 28:
 
</dd>
 
</dd>
 
== <dt>Sample output</dt> ==
 
== <dt>Sample output</dt> ==
 +
<!-- Use one or the other layout versions below -->
 +
<!-- /start: For a tabular sample output -->
 
<dd>
 
<dd>
 
{| class="wikitable"
 
{| class="wikitable"
Line 27: Line 35:
 
! 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>
 
</dd>
 +
<!-- /end: For a tabular sample output -->
 +
 +
<!-- /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 -->
 
== <dt>See also</dt> ==<!-- delete if N/A -->
 
<dd>
 
<dd>

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

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.)

Sample:1

{{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.)

See also

  • {{[[Template:|]]}}
  • [[]]

Retrieved from "http://wiki.projectgorgon.com/w/index.php?title=Template:Documentation/preload&oldid=15335"