Template:Documentation/doc - Revision history

TehCupcakes: 4 revisions imported

2023-11-07T15:29:18Z

4 revisions imported

← Older revision	Revision as of 11:29, 7 November 2023
(No difference)

starcitizen>Alistar Bot: /* Note */Hygiene, removed: {{Documentation}}

2020-03-17T22:04:44Z

Note: Hygiene, removed: {{Documentation}}

← Older revision		Revision as of 18:04, 17 March 2020
Line 11:		Line 11:
	==Note==		==Note==
	This template links to a /doc that may appear useless, however, it exists in order to link navboxes and userboxes to their base template's documentation.		This template links to a /doc that may appear useless, however, it exists in order to link navboxes and userboxes to their base template's documentation.
	<includeonly>~~[[Category:Template documentation\| ]]~~</includeonly>		<includeonly></includeonly>

	==TemplateData==		==TemplateData==

starcitizen>Alistair3149: 1 revision imported

2020-03-17T19:54:03Z

1 revision imported

← Older revision	Revision as of 15:54, 17 March 2020
(No difference)

en>Alistair3149 at 10:14, 15 March 2020

2020-03-15T10:14:15Z

← Older revision		Revision as of 06:14, 15 March 2020
Line 1:		Line 1:
	~~;Description~~		{{Documentation}}
	~~:This~~ template is ~~used to insert descriptions on~~ template ~~pages.~~		The '''documentation''' template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".
	~~;Syntax~~
	~~:Type <code><nowiki><noinclude><~~/~~nowiki>{{t\|~~documentation~~}}<nowiki></noinclude></nowiki></code> at the end of the~~ template ~~page~~.

	==~~General usage~~==		==Usage==
	~~===On the Template page===~~		Place {{t\|documentation}} at the top of the documentation page.
	~~<pre>~~
	~~Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>~~
	{{documentation}}~~</noinclude>~~
	~~</pre>~~

	~~Note that, depending on~~ the ~~template, you may need~~ to ~~add~~ a ~~clear or complete a table/div just before <code><nowiki>~~{{documentation}}</~~nowiki><~~/~~code> is inserted (within the noinclude tags)~~.		If the page to be documented is a subpage, use {{t\|documentation\|pagename of page to be documented}} at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{t\|documentation\|Template:Foo/bar}}.

	The ~~line break is also useful as it helps prevent~~ the ~~documentation template "running into" previous~~ code.		The template will attempt to auto detect and link <code><nowiki>{{#Invoke:}}</nowiki></code> calls on template documentations or the <code>require()</code>/<code>mw.loadData()</code> depedency list on module documentations. If you want to supress the auto generated dependency list, use {{t\|documentation\|DependencyList=no}}

	===~~On the Template/doc page~~===		==Note==
	~~<pre>~~		This template links to a /doc that may appear useless, however, it exists in order to link navboxes and userboxes to their base template's documentation.
	~~;Description~~		<includeonly>[[Category:Template documentation\| ]]</includeonly>
	:This template ~~is used~~ to ~~do something~~.
	~~;Syntax~~
	~~:Type <code>{{t\|templatename}}~~<~~/code~~> ~~somewhere.~~
	~~;Sample output~~
	:~~<code><nowiki>{{templatename~~\|~~foo}}</nowiki>~~</~~code~~> ~~gives...~~
	~~:{{templatename\|foo}}~~

	<~~includeonly~~>~~Any categories for the template itself</includeonly><noinclude>[[Category~~:~~Template documentation\|{~~{~~PAGENAME}~~}~~]]</noinclude>~~		==TemplateData==
	~~</pre>~~		<templatedata>
			{
	~~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.~~		"params": {},
			"description": "The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled \"doc\"."
	~~Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates~~.		}
			</templatedata>
	~~<includeonly>[[Category:General wiki templates\|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation\|{{PAGENAME}}]]~~</~~noinclude~~>

starcitizen>Treefroog: Created page with ";Description :This template is used to insert descriptions on template pages. ;Syntax :Type `{{t|documentation}}<..."`


2016-08-29T04:56:04Z
Created page with ";Description :This template is used to insert descriptions on template pages. ;Syntax :Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki><..."
New page
;Description

:This template is used to insert descriptions on template pages.

;Syntax

:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.



==General usage==

===On the Template page===

<pre>

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>

{{documentation}}</noinclude>

</pre>



Note that, depending on the template, you may need to add a clear or complete a table/div just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).



The line break is also useful as it helps prevent the documentation template "running into" previous code.



===On the Template/doc page===

<pre>

;Description

:This template is used to do something.

;Syntax

:Type <code>{{t|templatename}}</code> somewhere.

;Sample output

:<code>&lt;nowiki>{{templatename|foo}}&lt;/nowiki></code> gives...

:{{templatename|foo}}



<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

</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 the [[Template:T]] and [[Template:T/piece]] templates.



<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Template:Documentation/doc - Revision history

TehCupcakes: 4 revisions imported

starcitizen>Alistar Bot: /* Note */Hygiene, removed: {{Documentation}}

starcitizen>Alistair3149: 1 revision imported

en>Alistair3149 at 10:14, 15 March 2020

starcitizen>Treefroog: Created page with ";Description :This template is used to insert descriptions on template pages. ;Syntax :Type {{t|documentation}}<..."

starcitizen>Treefroog: Created page with ";Description :This template is used to insert descriptions on template pages. ;Syntax :Type `{{t|documentation}}<..."`