Template:Documentation/doc - Revision history

imported>Screamer Nerd: 1 revision

2015-08-05T08:27:12Z

1 revision

← Older revision		Revision as of 01:27, 5 August 2015
(No difference)

imported>Sumpy: 10 revisions

2015-08-04T00:03:34Z

10 revisions

← Older revision		Revision as of 17:03, 3 August 2015
Line 1:		Line 1:
	~~==Description==~~		'''To use this template, type {{t\|documentation}} on the template page.'''
	~~This~~ template ~~is used to insert descriptions~~ on template ~~pages~~.

	~~==Syntax==~~		<includeonly>[[Category:General wiki templates\|{{PAGENAME}}]]</includeonly>
	~~Add <code><nowiki><noinclude></nowiki>{{t\|documentation}}<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>~~
	~~{{documentation}}</noinclude>~~
	~~</pre>~~

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

	~~''A line break right before <code><nowiki>{{documentation}}</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~~>

imported>Default: Protected "Template:Documentation/doc" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite))

2015-06-13T19:30:59Z

Protected "Template:Documentation/doc" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite))

← Older revision		Revision as of 12:30, 13 June 2015
Line 1:		Line 1:
	;Description		==Description==
	:This template is used to insert descriptions on template pages.		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.		==Syntax==
			Add <code><nowiki><noinclude></nowiki>{{t\|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.

			==Usage==

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

	<pre>		<pre>
	~~Template code~~<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>		TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
	{{documentation}}~~Any categories for the template itself~~</noinclude>		{{documentation}}</noinclude>
	</pre>		</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 your template is not a completed div or table, you may need to close the tags 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.		''A line break right before <code><nowiki>{{documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''

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

	<pre>		<pre>
	;Description		==Description==
	:This template is used to do something.		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}}~~

	<~~noinclude~~>~~[[Category:Template documentation\|~~{{~~PAGENAME~~}}]]</~~noinclude~~>		==Syntax==
	</~~pre~~>		Type <code>{{t\|templatename}}</code> somewhere.

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

	~~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~~.		results in...

	~~Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.~~		{{templatename\|input}}

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

	~~does not seem to work consistently at getting~~ the ~~template itself to show up in a category~~. ~~It works for some templates, and not for others. This~~ may ~~be a bug. So it is better~~ to add ~~the template category to the template page itself~~. ~~Use ''<nowiki><noinclude></noinclude></nowiki>''~~		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>

imported>Default: /* On the Template page */ Inconsistency solution. Put category on template page itself. "Any categories for the template itself" placed between the noinclude tags.

2015-06-13T19:30:59Z

On the Template page: Inconsistency solution. Put category on template page itself. "Any categories for the template itself" placed between the noinclude tags.

← Older revision		Revision as of 12:30, 13 June 2015
Line 8:		Line 8:
	<pre>		<pre>
	Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>		Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
	{{documentation}}</noinclude>		{{documentation}}Any categories for the template itself</noinclude>
	</pre>		</pre>

imported>Default: /* On the Template/doc page */ Explained inconsistentcy of category placement. I can not start the discussion page here. So please contact me at http://cannabis.wikia.com/wiki/User:Timeshifter

2015-06-13T19:30:59Z

On the Template/doc page: Explained inconsistentcy of category placement. I can not start the discussion page here. So please contact me at http://cannabis.wikia.com/wiki/User:Timeshifter

← Older revision		Revision as of 12:30, 13 June 2015
Line 31:		Line 31:

	Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.		Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.

			Adding
			<pre>
			<nowiki><includeonly>Any categories for the template itself</includeonly></nowiki>
			</pre>

			does not seem to work consistently at getting the template itself to show up in a category. It works for some templates, and not for others. This may be a bug. So it is better to add the template category to the template page itself. Use ''<nowiki><noinclude></noinclude></nowiki>''


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

imported>Default: Removed: Any categories for the template itself - This does not work correctly. License tags are not showing up at Category:Image wiki templates

2015-06-13T19:30:59Z

Removed: <includeonly>Any categories for the template itself</includeonly> - This does not work correctly. License tags are not showing up at Category:Image wiki templates

← Older revision		Revision as of 12:30, 13 June 2015
Line 25:		Line 25:
	:{{templatename\|foo}}		:{{templatename\|foo}}

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

imported>Default: 8 revisions

2015-06-13T19:30:59Z

8 revisions

← Older revision		Revision as of 12:30, 13 June 2015
Line 1:		Line 1:
	~~'''To use this~~ template~~, type~~ <code><nowiki><noinclude></nowiki>{{t\|documentation}}<nowiki></noinclude></nowiki></code> on the template 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.

	<includeonly>[[Category:General wiki templates\|{{PAGENAME}}]]</includeonly>		==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><nowiki>{{templatename\|foo}}</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>

imported>Default at 19:30, 13 June 2015

2015-06-13T19:30:59Z

← Older revision		Revision as of 12:30, 13 June 2015
Line 1:		Line 1:
	'''To use this template, type {{t\|documentation}} on the template page.'''		'''To use this template, type <code><nowiki><noinclude></nowiki>{{t\|documentation}}<nowiki></noinclude></nowiki></code> on the template page.'''

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

imported>Default: New page: '''To use this template, type {{t|documentation}} on the template page.''' {{PAGENAME}}

2015-06-13T19:30:59Z

New page: '''To use this template, type {{t|documentation}} on the template page.''' <includeonly>{{PAGENAME}}</includeonly>

← Older revision		Revision as of 12:30, 13 June 2015
Line 1:		Line 1:
	~~==Description==~~		'''To use this template, type {{t\|documentation}} on the template page.'''
	~~This~~ template ~~is used to insert descriptions~~ on template ~~pages~~.

	~~==Syntax==~~		<includeonly>[[Category:General wiki templates\|{{PAGENAME}}]]</includeonly>
	~~Add <code><nowiki><noinclude></nowiki>{{t\|documentation}}<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>~~
	~~{{documentation}}</noinclude>~~
	~~</pre>~~

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

	~~''A line break right before <code><nowiki>{{documentation}}</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~~>

imported>Default: 1 revision

2013-11-11T18:48:02Z

1 revision

← Older revision		Revision as of 11:48, 11 November 2013
Line 1:		Line 1:
	;Description		==Description==
	:This template is used to insert descriptions on template pages.		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.		==Syntax==
			Add <code><nowiki><noinclude></nowiki>{{t\|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.

			==Usage==

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

	<pre>		<pre>
	~~Template code~~<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>		TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
	{{documentation}}</noinclude>		{{documentation}}</noinclude>
	</pre>		</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 your template is not a completed div or table, you may need to close the tags 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.		''A line break right before <code><nowiki>{{documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''

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

	<pre>		<pre>
	;Description		==Description==
	:This template is used to do something.		This template is used to do something.
	;Syntax
	:Type <code>{{t\|templatename}}</code> somewhere.		==Syntax==
	~~;Sample output~~		Type <code>{{t\|templatename}}</code> somewhere.
	:<code><nowiki>{{templatename\|~~foo~~}}</nowiki></code> ~~gives~~...
	:{{templatename\|~~foo~~}}		==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>		<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation\|{{PAGENAME}}]]</noinclude>
	</pre>		</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.		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.		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>