Template:Documentation/doc - Revision history

MarkJFox: 5 revisions imported

2025-03-31T20:20:51Z

5 revisions imported

← Older revision	Revision as of 22:20, 31 March 2025
(No difference)

en>桂月August at 13:13, 24 August 2021

2021-08-24T13:13:26Z

← Older revision		Revision as of 15:13, 24 August 2021
Line 43:		Line 43:
	Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.		Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.

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

en>桂月August: Description of the new parameter

2021-08-23T08:40:35Z

Description of the new parameter

← Older revision		Revision as of 10:40, 23 August 2021
Line 4:		Line 4:
	==Syntax==		==Syntax==
	Add <code><nowiki><noinclude></nowiki>{{tl\|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{tl\|doc}}<nowiki></noinclude></nowiki></code> at the end of the template page.		Add <code><nowiki><noinclude></nowiki>{{tl\|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{tl\|doc}}<nowiki></noinclude></nowiki></code> at the end of the template page.
			* If <code><nowiki>notoc=1</nowiki></code>, the catalogue will not be displayed.
			* Use <code><nowiki>toc=</nowiki></code> will set the alignment of the catalogue.

	==Usage==		==Usage==

en>桂月August: Do not use Template:T any more

2021-08-23T08:11:12Z

Do not use Template:T any more

← Older revision		Revision as of 10:11, 23 August 2021
Line 3:		Line 3:

	==Syntax==		==Syntax==
	Add <code><nowiki><noinclude></nowiki>{{t\|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{t\|doc}}<nowiki></noinclude></nowiki></code> at the end of the template page.		Add <code><nowiki><noinclude></nowiki>{{tl\|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{tl\|doc}}<nowiki></noinclude></nowiki></code> at the end of the template page.

	==Usage==		==Usage==
Line 27:		Line 27:

	==Syntax==		==Syntax==
	Type <code>{{t\|templatename}}</code> somewhere.		Type <code>{{tl\|templatename}}</code> somewhere.

	==Samples==		==Samples==
Line 40:		Line 40:

	Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.		Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other 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>		<includeonly>[[Category:General wiki templates\|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation\|{{PAGENAME}}]]</noinclude>

en>桂月August: Doc for instructions of the templates.

2021-08-18T10:19:18Z

Doc for instructions of the templates.

← Older revision		Revision as of 12:19, 18 August 2021
Line 1:		Line 1:
	~~Test~~		==Description==
			This template is used to insert descriptions on template pages.

			==Syntax==
			Add <code><nowiki><noinclude></nowiki>{{t\|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{t\|doc}}<nowiki></noinclude></nowiki></code> at the end of the template page.

			==Usage==

			===On the Template page===
			This is the normal format when used:

			<pre>
			TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
			{{doc}}</noinclude>
			</pre>

			''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{doc}}</nowiki></code> is inserted (within the noinclude tags).''

			''A line break right before <code><nowiki>{{doc}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''

			===On the Template/doc page===
			Normally, you will want to write something like the following on the documentation page:

			<pre>
			==Description==
			This template is used to do something.

			==Syntax==
			Type <code>{{t\|templatename}}</code> somewhere.

			==Samples==
			<code><nowiki>{{templatename\|input}}</nowiki></code>

			results in...

			{{templatename\|input}}

			<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 other 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>

en>桂月August: Try to make a Doc for the template

2021-08-18T05:29:48Z

Try to make a Doc for the template

New page

Test