Template:Documentation/doc - Revision history

Skace at 22:36, 7 July 2008

2008-07-07T22:36:08Z

← Older revision		Revision as of 22:36, 7 July 2008
Line 22:		Line 22:

	==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 technical limitation of templates (see a [{{fullurl:Project:Village pump (technical)\|diff=prev&oldid=69888944}} developer's explanation]).

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

Skace at 22:35, 7 July 2008

2008-07-07T22:35:08Z

← Older revision		Revision as of 22:35, 7 July 2008
Line 19:		Line 19:

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

	==Rationale==		==Rationale==

Skace at 22:34, 7 July 2008

2008-07-07T22:34:18Z

← Older revision		Revision as of 22:34, 7 July 2008
Line 1:		Line 1:
	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 transcluded in other pages, i.e. templates, whether in the template namespace or not.

	==Usage==		==Usage==
Line 23:		Line 23:
	==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 a [{{fullurl:Project:Village pump (technical)\|diff=prev&oldid=69888944}} developer's explanation]).

	~~==See also==~~
	* {{links-small\|template\|documentation subpage}}
	* {{links-small\|w\|template\|documentation}}

	<!-- for the template -->		<!-- for the template -->
	<includeonly>		<includeonly>
	[[Category:Template documentation\| ]]		[[Category:Template documentation\| ]]
	~~[[Category:Formatting templates\|Template documentation]]~~
	~~</includeonly>~~

	~~<!-- for the template -->~~
	~~<includeonly>~~
	[[Category:Formatting templates\|Template documentation]]		[[Category:Formatting templates\|Template documentation]]
	</includeonly>		</includeonly>

Skace: New page: 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:Tran...

2008-07-07T22:19:55Z

New page: 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:Tran...

New page

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==
===Normal===
<pre>
<noinclude>{{documentation}}<noinclude>
or <noinclude>{{documentation|template:any page/doc}}<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;".

===Customizing display===
Overrides exist to customize the output in special cases:
* <nowiki>{{</nowiki>documentation|'''heading'''=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

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

==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==
* {{links-small|template|documentation subpage}}
* {{links-small|w|template|documentation}}


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


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