8,161
edits
Difference between revisions of "Template:Documentation shell/doc"
Template:Documentation shell/doc (view source)
Revision as of 01:09, 27 October 2018
, 01:09, 27 October 2018Text replacement - "{{tl" to "{{t"
m (Text replacement - "{{tl" to "{{t") |
|||
| (27 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
{{documentation-improvement | date = April 2010 }} | |||
{{documentation shell | {{documentation shell | ||
| name = Documentation shell | | name = Documentation shell | ||
| info = The shell for all documentation pages. | | info = The shell for all documentation pages. | ||
| see also = | | see also = taken from [http://www.grifkuba.org/main/wiki/index.php?title=Template:Documentation_shell/doc source] on Februrary 27th, 2010. | ||
---- | |||
{{template-templates}} | |||
}} | }} | ||
< | |||
==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{{dot}}d{{dot}}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 {{t|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: | |||
{{Parameters-table-top}} | |||
|- | |||
| '''name''' | |||
| Name of the Template | |||
| | |||
|- | |||
| info | |||
| Information on the Template | |||
| | |||
|- | |||
| see also | |||
| Links to find out more infomation | |||
| | |||
|- | |||
{{parameters-table-bottom}} | |||
<noinclude>[[Category:Documentation|{{PAGENAME}}]]</noinclude> | |||