Difference between revisions of "Template:Docs"
Jump to navigation
Jump to search
m (try this) |
m (+usage) |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
⚫ | |||
⚫ | |||
+ | |||
+ | This template includes the "top" of the table for any template documents. Calls to this table should be followed by rows which document each of the templates parameters and finally the table should be "closed" by inserting <code><nowiki>|}</nowiki></code> after the final row. |
||
+ | |||
+ | [[category: documentation templates]] |
||
+ | |||
⚫ | |||
<!-- TABLE CAPTION --> |
<!-- TABLE CAPTION --> |
||
− | |+ Template Parameter Documentation Table |
+ | |+ {{{title|Template Parameter Documentation Table}}} |
<!-- COLUMN HEADERS --> |
<!-- COLUMN HEADERS --> |
||
Line 11: | Line 17: | ||
|- |
|- |
||
+ | <noinclude> |
||
− | {{{1}}} |
||
|- |
|- |
||
+ | | <code>title</code> |
||
+ | | the text to put into the document table caption |
||
+ | | this page, for example: <code><nowiki>|title=Template Parameter Documentation Table</nowiki></code> |
||
+ | |- |
||
+ | |||
|} |
|} |
||
+ | |||
⚫ | |||
+ | A full example: |
||
− | {{Special:PrefixIndex/Template:Docs/}} |
||
+ | |||
+ | {| width=100% border=1 |
||
+ | | width=50% | |
||
+ | <pre class="code"> |
||
+ | {{docs|title=demonstration template}} |
||
+ | |||
+ | <!-- test parameter --> |
||
+ | |- |
||
+ | | <code>test</code> |
||
+ | | a testing parameter |
||
+ | | <code><nowiki>|test=testing things</nowiki></code> |
||
+ | |- |
||
+ | |||
+ | <!-- image parameter --> |
||
+ | {{docs/image|eg=File: Test Image.svg}} |
||
+ | |||
+ | |} |
||
+ | </pre> |
||
+ | | width=50% | |
||
+ | |||
+ | {{docs|title=demonstration template}} |
||
+ | |||
+ | <!-- test parameter --> |
||
+ | |- |
||
+ | | <code>test</code> |
||
+ | | a testing parameter |
||
+ | | <code><nowiki>|test=testing things</nowiki></code> |
||
+ | |- |
||
+ | |||
+ | <!-- image parameter --> |
||
+ | {{docs/image|eg=File: Test Image.svg}} |
||
+ | |||
+ | |} |
||
+ | |||
+ | |- |
||
+ | |} |
||
+ | |||
+ | == Common Parameter Rows == |
||
+ | * [[/image|image]] (o) |
||
+ | * [[/world|world]] (r) |
||
+ | * [[/books|books]] (r) |
||
+ | * [[/universe|universe]] (r) |
||
+ | |||
+ | == Row Formatting == |
||
+ | * [[/row/optional|optional]] |
||
+ | * [[/row/required|required]] |
||
+ | |||
+ | == Templates with Documentation == |
||
+ | {{for|Special:WhatLinksHere/{{FULLPAGENAME}}|a full listing|here}} |
||
+ | {{Special:WhatLinksHere/{{FULLPAGENAME}}|namespace=10}} |
Revision as of 20:10, 19 April 2020
This template includes the "top" of the table for any template documents. Calls to this table should be followed by rows which document each of the templates parameters and finally the table should be "closed" by inserting |}
after the final row.
Parameter | Description | Examples |
---|---|---|
title
|
the text to put into the document table caption | this page, for example: |title=Template Parameter Documentation Table
|
A full example:
{{docs|title=demonstration template}} <!-- test parameter --> |- | <code>test</code> | a testing parameter | <code>|test=testing things</code> |- <!-- image parameter --> {{docs/image|eg=File: Test Image.svg}} |} |
|
Common Parameter Rows
Row Formatting
Templates with Documentation
- Template:Infobox (transclusion) (← links | edit)
- Template:Location (transclusion) (← links | edit)
- Template:Group (transclusion) (← links | edit)
- Template:Event (transclusion) (← links | edit)
- Template:Item (transclusion) (← links | edit)
- Template:Tag (transclusion) (← links | edit)
- Template:Literature (transclusion) (← links | edit)
- Template:Food (transclusion) (← links | edit)
- Template:Culture (transclusion) (← links | edit)
- Template:Disease (transclusion) (← links | edit)
- Template:Fabrial (transclusion) (← links | edit)
- Template:Cat tag (transclusion) (← links | edit)
- Template:Architecture (transclusion) (← links | edit)
- Template:Geography (transclusion) (← links | edit)
- Template:Nation (transclusion) (← links | edit)
- Template:Settlement (transclusion) (← links | edit)
- Template:Business (transclusion) (← links | edit)
- Template:Media (transclusion) (← links | edit)
- Template:Docs/universe (transclusion) (← links | edit)
- Template:Docs/image (transclusion) (← links | edit)
- Template:Docs (transclusion) (← links | edit)
- Template:Docs/row/optional (transclusion) (← links | edit)
- Template:Docs/row/required (transclusion) (← links | edit)
- Template:Docs/world (transclusion) (← links | edit)
- Template:Artist (transclusion) (← links | edit)
- Template:Peoples (transclusion) (← links | edit)
- Template:Cover (transclusion) (← links | edit)
- Template:Info/row (transclusion) (← links | edit)
- Template:Metal (transclusion) (← links | edit)
- Template:Metal/art (transclusion) (← links | edit)