Template:Documentation/doc - Revision history

Logmanoriginal: Cleanup documentation

2024-08-02T16:42:35Z

Cleanup documentation

← Older revision		Revision as of 16:42, 2 August 2024
Line 1:		Line 1:
	{{documentation subpage}}		<noinclude>{{documentation subpage}}</noinclude>
			This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are [[wikipedia:Transclusion\|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.
	This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are [[~~LabVIEW Wiki~~:Transclusion\|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

	==Usage==		==Usage==
Line 23:		Line 22:
	<!-- for the template -->		<!-- for the template -->
	<includeonly>		<includeonly>
	[[Category:Template ~~documentation\| ]]~~		[[Category:Template namespace templates]]
	~~[[Category:Formatting~~ templates~~\|Template documentation~~]]
	</includeonly>		</includeonly>

Michael_Aivaliotis at 08:09, 6 October 2007

2007-10-06T08:09:51Z

← Older revision		Revision as of 08:09, 6 October 2007
Line 1:		Line 1:
	{{documentation subpage}}		{{documentation subpage}}

	This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are [[~~Wikipedia~~:Transclusion\|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.		This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are [[LabVIEW Wiki:Transclusion\|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

	==Usage==		==Usage==
Line 16:		Line 16:

	==Functions==		==Functions==
	If the documentation page doesn't exist, the "edit" link includes a ~~[[mw:Manual:Creating pages with preloaded text\|~~preload]] parameter so that clicking it will pre-fill the edit form with the basic documentation page format. The header depends on the namespace; for example, it will display "Template documentation" in the template namespace.		If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format. The header depends on the namespace; for example, it will display "Template documentation" in the template namespace.

	==Rationale==		==Rationale==
	This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a [[Wikipedia:Template limits\|technical limitation of templates]] ~~(see a [{{fullurl:Project:Village pump (technical)&diff=prev&oldid=69888944}} developer's explanation])~~.		This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a [[Wikipedia:Template limits\|technical limitation of templates]].

	~~==See also==~~
	* {{tiw\|template doc}} (similar template with more documentation; see [[User:Pathoschild/Sandbox\|template comparison]])
	* {{tiw\|documentation subpage}} (replaces older {{[[template:Template doc page viewed directly\|Template doc page viewed directly]]}} and {{[[template:Template doc page transcluded\|Template doc page transcluded]]}})
	*{{tim\|Documentation}}

	<!-- for the template -->		<!-- for the template -->

Michael_Aivaliotis at 08:07, 6 October 2007

2007-10-06T08:07:31Z

← Older revision		Revision as of 08:07, 6 October 2007
Line 1:		Line 1:
	{{documentation subpage}}		{{documentation subpage}}
	~~{{mergefrom\|Template doc\|date=October 2007}}~~

	This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are [[Wikipedia:Transclusion\|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.		This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are [[Wikipedia:Transclusion\|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

Michael_Aivaliotis: New page: {{documentation subpage}} {{mergefrom|Template doc|date=October 2007}} This template automatically displays a documentation box like you are seeing now, of which the content is transclude...

2007-10-06T08:06:51Z

New page: {{documentation subpage}} {{mergefrom|Template doc|date=October 2007}} This template automatically displays a documentation box like you are seeing now, of which the content is transclude...

New page

{{documentation subpage}}
{{mergefrom|Template doc|date=October 2007}}

This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are [[Wikipedia:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

==Usage==
<pre>
<noinclude>{{documentation}}<noinclude>
or <noinclude>{{documentation|template:any page}}<noinclude>
</pre>

This code should be added at the bottom of the template code, with no extra space before "<code><noinclude></code>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.

Add categories and interwiki links to the documentation page inside includeonly tags.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

==Functions==
If the documentation page doesn't exist, the "edit" link includes a [[mw:Manual:Creating pages with preloaded text|preload]] parameter so that clicking it will pre-fill the edit form with the basic documentation page format. The header depends on the namespace; for example, it will display "Template documentation" in the template namespace.

==Rationale==
This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a [[Wikipedia:Template limits|technical limitation of templates]] (see a [{{fullurl:Project:Village pump (technical)&diff=prev&oldid=69888944}} developer's explanation]).

==See also==
* {{tiw|template doc}} (similar template with more documentation; see [[User:Pathoschild/Sandbox|template comparison]])
* {{tiw|documentation subpage}} (replaces older {{[[template:Template doc page viewed directly|Template doc page viewed directly]]}} and {{[[template:Template doc page transcluded|Template doc page transcluded]]}})
*{{tim|Documentation}}


<includeonly>
[[Category:Template documentation| ]]
[[Category:Formatting templates|Template documentation]]
</includeonly>