Difference between revisions of "Template:Documentation/doc"

From Project: Gorgon Wiki
Jump to: navigation, search
m (updating to latest version on http://templates.wikia.com/wiki/Template:Documentation/doc)
m (→‎On the Template/doc page: Making BASEPAGENAME call work incase template version not exist)
 
(8 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
===On the Template page===
 
===On the Template page===
 
<pre>
 
<pre>
−
Template code<noinclude>
+
<noinclude>{{Underconstruction}}
 +
</noinclude><!-- Template code --><noinclude>
 
{{documentation}}
 
{{documentation}}
 
</noinclude>
 
</noinclude>
Line 23: Line 24:
  
 
===On the Template/doc page===
 
===On the Template/doc page===
−
:''See also<nowiki>:</nowiki>''
+
{{Ambox
−
:*[[Template:Documentation/preload]]
+
|border=blue
−
:*[[Template:Documentation/preload-sandbox]]
+
|type=Preloading
−
:*[[Template:Documentation/preload-testcases]]
+
|info=Not needed when using the <i>preload functionality</i> provided by the <b>create</b> link when using the {{t|Documentation}} template.<br/>
 +
The preload version will be more enhanced and is <b><u>recommended</u></b>.<br/>
 +
To make use of the <i>preload functionality</i> click the <b>create</b> link provided when using the {{t|Documentation}} template.<br/>
 +
<b>Don't</b> forget to save the generated doc page without alterations first before making any changes to it !
 +
}}
 
<pre>
 
<pre>
−
{{SPW|name={{subst:BASEPAGENAME}}}}
+
{{SPW|name={{subst:msg:BASEPAGENAME}}}}
−
;Description
+
<includeonly><!-- Any categories for the template itself -->
 +
</includeonly><noinclude>
 +
[[Category:Template documentation]]
 +
</noinclude>
 +
==Description==
 
:This template is used to do something.
 
:This template is used to do something.
−
;Dependencies:
+
==Dependencies==
 
:* Uses (some CSS, JS, file, or other template).
 
:* Uses (some CSS, JS, file, or other template).
−
;Syntax
+
==Syntax==
 
:Type <code>{{t|templatename}}</code> somewhere.
 
:Type <code>{{t|templatename}}</code> somewhere.
−
;Sample output
+
==Sample output==
 
:<code>&lt;nowiki>{{templatename|foo}}</nowiki></code> gives...
 
:<code>&lt;nowiki>{{templatename|foo}}</nowiki></code> gives...
 
:{{templatename|foo}}
 
:{{templatename|foo}}
−
 
−
<includeonly>Any categories for the template itself
 
−
</includeonly><noinclude>
 
−
[[Category:Template documentation]]
 
−
</noinclude>
 
 
</pre>
 
</pre>
 +
*Use any or all of the above description/syntax/sample output sections.
 +
*:You may also want to add "see also" or further usage information sections.
 +
*Note that the above example also uses {{t|T}}.
  
−
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.
+
== Dependencies ==
−
 
+
:*[[Template:Documentation/preload]]
−
Note that the above example also uses {{t|T}}.
+
:*[[Template:Documentation/preload-sandbox]]
−
 
+
:*[[Template:Documentation/preload-testcases]]
 +
:*[[Template:T]] + [[Template:T/doc]]
 +
:*[[Template:Tocright]] + [[Template:Tocright/doc]]
 +
:*[[Template:SPW]] + [[Template:SPW/doc]]
 +
:*[[Template:Underconstruction]]
 +
<dl>
 +
<dt>Site-wide CSS:</dt>
 +
<dd><pre>.template-documentation .color1,
 +
#bodyContent .template-documentation .color1 a,
 +
#bodyContent .template-documentation .color1 a.external
 +
{
 +
    background-color:#36C;
 +
    color:white;
 +
}</pre></dd>
 +
</dl>
 
<includeonly>
 
<includeonly>
 
[[Category:General wiki templates]]
 
[[Category:General wiki templates]]
−
 
−
[[ja:テンプレート:Documentation]]
 
−
[[zh:Template:Documentation]]
 
 
</includeonly><noinclude>
 
</includeonly><noinclude>
 
[[Category:Template documentation]]
 
[[Category:Template documentation]]
−
 
−
[[ja:テンプレート:Documentation/doc]]
 
−
[[zh:Template:Documentation/doc]]
 
 
</noinclude>
 
</noinclude>

Latest revision as of 05:58, 1 May 2016

Wiki.pngThis template was copied from Template:Documentation on Wikia Templates.
That wiki should periodically be checked for a new version of this template.
Description
This template is used to insert documentation on template pages.
Syntax
Type <noinclude>{{documentation}}</noinclude> at the end of the template page.

General usage

On the Template page

<noinclude>{{Underconstruction}}
</noinclude><!-- Template code --><noinclude>
{{documentation}}
</noinclude>

On the Template/doc page

Wiki.png Preloading

Not needed when using the preload functionality provided by the create link when using the {{Documentation}} template.
The preload version will be more enhanced and is recommended.
To make use of the preload functionality click the create link provided when using the {{Documentation}} template.
Don't forget to save the generated doc page without alterations first before making any changes to it ! 

{{SPW|name={{subst:msg:BASEPAGENAME}}}}
<includeonly><!-- Any categories for the template itself -->
</includeonly><noinclude>
[[Category:Template documentation]]
</noinclude>
==Description==
:This template is used to do something.
==Dependencies==
:* Uses (some CSS, JS, file, or other template).
==Syntax==
:Type <code>{{t|templatename}}</code> somewhere.
==Sample output==
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}
  • Use any or all of the above description/syntax/sample output sections.
    You may also want to add "see also" or further usage information sections.
  • Note that the above example also uses {{T}}.

Dependencies

Site-wide CSS:
.template-documentation .color1,
#bodyContent .template-documentation .color1 a,
#bodyContent .template-documentation .color1 a.external
{
    background-color:#36C;
    color:white;
}
Retrieved from "http://wiki.projectgorgon.com/w/index.php?title=Template:Documentation/doc&oldid=14913"