Welcome to the Lylat Wiki, all about the Star Fox series! If you'd like to help out, please take a look at our community portal.

Difference between revisions of "Template:Documentation shell/doc"

From Lylat Wiki, your source on Star Fox information. By Fans, for Fans.
Jump to navigationJump to search
Line 14: Line 14:
* list related templates and/or project pages under "see also".
* list related templates and/or project pages under "see also".
* give a short and brief description of its information.
* give a short and brief description of its information.


==Usage==
==Usage==
By placing {{tl|documentation shell}} on a page, you automatically transclude in the rest of the template, include a <nowiki>==</nowiki>double heading==
By placing {{tl|documentation shell}} on a page, you automatically transclude in the rest of the template, include a <nowiki>==</nowiki>double heading==


===Example===
Here is some same code for you usage. It is the same as the one used on this page.
<pre>
{{documentation shell
| name = Documentation shell
| info = The shell for all documentation pages.
| see also = taken from [http://www.grifkuba.org/main/wiki/index.php?title=Template:Documentation_shell/doc source] on Februrary 27th, 2010.
}}
</pre>
=== Parameters ===
The parameters of the documentation shell are as follows:
The parameters of the documentation shell are as follows:
=== Parameters ===
{{Parameters-table-top}}
{{Parameters-table-top}}
|-
|-
Line 35: Line 48:
|-
|-
{{parameters-table-bottom}}
{{parameters-table-bottom}}
{{clear}}
 
==Example==
 
{{clear}}
<noinclude>[[Category:Documentation|{{PAGENAME}}]]</noinclude>
<pre>
{{documentation shell
| name = Documentation shell
| info = The shell for all documentation pages.
| see also = taken from [http://www.grifkuba.org/main/wiki/index.php?title=Template:Documentation_shell/doc source] on Februrary 27th, 2010.
}}
</pre>{{clear}}<noinclude>[[Category:Documentation|{{PAGENAME}}]]</noinclude>

Revision as of 14:04, 19 August 2010

Peppy Hare SF0 headshot icon.png Peppy Hare: "Falco, this template's documentation needs to be improved to meet LW:TS."
Falco Lombardi: "Why are you asking me? Isn't that Slippy's job?"
.....
"Fine. I'll do it."
Falco Lombardi SF0 headshot icon.png
Name Documentation shell
Link {{Documentation shell}}
Info The shell for all documentation pages.


Purpose

The purpose of the documentation shell is to put the following on every /doc page:

  • The title of the template.
  • Link to the template based off of the title.
  • link to doucmemation page (down in the v•d•e area) also based off of the title.
  • list related templates and/or project pages under "see also".
  • give a short and brief description of its information.


Usage

By placing Template:Tl on a page, you automatically transclude in the rest of the template, include a ==double heading==

Example

Here is some same code for you usage. It is the same as the one used on this page.

{{documentation shell
| name = Documentation shell
| info = The shell for all documentation pages. 
| see also = taken from [http://www.grifkuba.org/main/wiki/index.php?title=Template:Documentation_shell/doc source] on Februrary 27th, 2010. 
}}


Parameters

The parameters of the documentation shell are as follows:

Name Description Value information
name Name of the Template
info Information on the Template
see also Links to find out more infomation

Notes:

  1. Required parameters are in bold, followed by explanation of usage. Italicized parameters have a related behavior change, when a certain value is inserted.
  2. For if anything happens because a specific related value is not entered.