Template:Documentation/doc - Revision history

Prophecy at 17:41, 3 June 2008

2008-06-03T17:41:16Z

← Older revision		Revision as of 17:41, 3 June 2008
Line 44:		Line 44:

	<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->		<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
	[[Category:Template documentation\| ]]		[[Category:Template documentation\| {{PAGENAME}}]]
	[[Category:Boobpedia formatting templates\|Documentation]]		[[Category:Boobpedia formatting templates\|Documentation]]

	</includeonly>		</includeonly>

Prophecy at 17:37, 3 June 2008

2008-06-03T17:37:19Z

← Older revision		Revision as of 17:37, 3 June 2008
Line 45:		Line 45:
	<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->		<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
	[[Category:Template documentation\| ]]		[[Category:Template documentation\| ]]
	[[Category:Boobpedia formatting templates\|~~Template documentation~~]]		[[Category:Boobpedia formatting templates\|Documentation]]

	</includeonly>		</includeonly>

Prophecy at 10:17, 3 June 2008

2008-06-03T10:17:29Z

← Older revision		Revision as of 10:17, 3 June 2008
Line 37:		Line 37:
	== 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<!--[[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 ==		== Rationale ==

	Use of this template allows templates to be [[Wikipedia:Protection policy\|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.		Use of this template allows templates to be protected<!--[[Wikipedia:Protection policy\|protected]]--> where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

	<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->		<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->

Prophecy at 10:16, 3 June 2008

2008-06-03T10:16:25Z

← Older revision		Revision as of 10:16, 3 June 2008
Line 2:		Line 2:
	<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->		<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
	__NOTOC__		__NOTOC__
	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<!--[[Wikipedia:Transclusion\|transcluded]]--> in other pages, i.e. templates, whether in the template namespace or not.

	== Usage ==		== Usage ==

Prophecy at 07:24, 31 May 2008

2008-05-31T07:24:04Z

← Older revision		Revision as of 07:24, 31 May 2008
Line 45:		Line 45:
	<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->		<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
	[[Category:Template documentation\| ]]		[[Category:Template documentation\| ]]
	[[Category:~~Wikipedia~~ formatting templates\|Template documentation]]		[[Category:Boobpedia formatting templates\|Template documentation]]
	~~[[Category:Templates using ParserFunctions\|{{PAGENAME}}~~]]

	</includeonly>		</includeonly>

Prophecy at 21:18, 30 May 2008

2008-05-30T21:18:27Z

← Older revision		Revision as of 21:18, 30 May 2008
Line 42:		Line 42:

	Use of this template allows templates to be [[Wikipedia:Protection policy\|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.		Use of this template allows templates to be [[Wikipedia:Protection policy\|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

	~~== See also ==~~
	~~{{ Documentation/doc/see also }}~~

	<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->		<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->

Prophecy at 20:28, 30 May 2008

2008-05-30T20:28:19Z

← Older revision		Revision as of 20:28, 30 May 2008
Line 1:		Line 1:
	{{documentation subpage}}<includeonly>~~{{pp-semi-template\|small=yes}}{{intricate template}}~~</includeonly>		{{documentation subpage}}<includeonly></includeonly>
	<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->		<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
	__NOTOC__		__NOTOC__

Prophecy: New page: {{documentation subpage}}{{pp-semi-template|small=yes}}{{intricate template}} NOTOC ...

2008-05-29T11:23:31Z

New page: {{documentation subpage}}<includeonly>{{pp-semi-template|small=yes}}{{intricate template}}</includeonly>  __NOTOC__ ...

New page

{{documentation subpage}}<includeonly>{{pp-semi-template|small=yes}}{{intricate template}}</includeonly>

__NOTOC__
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 /doc ===
<noinclude>{{{{{template-name|Documentation}}}}}</noinclude>

=== Any /doc page ===
<noinclude>{{{{{template-name|Documentation}}}|Template:any page/doc}}</noinclude>

=== In-line content ===
<noinclude>{{{{{template-name|Documentation}}}|content=This is documentation.}}</noinclude>

=== In-line content with [view][edit] links ===

<noinclude>{{{{{template-name|Documentation}}}
|1 = Template:any page/doc
|content ={{Template:any page/doc|parameters}}
}}</noinclude>

=== Best practice ===

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.

Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <code><includeonly> </includeonly></code> tags. For more complex cases, see [[Wikipedia:Template documentation‎#Categories and interwiki links]].

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:
* <code>{{documentation| '''heading''' = ...}}</code> − 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 ==

Use of this template allows templates to be [[Wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

== See also ==
{{ Documentation/doc/see also }}

<includeonly>
[[Category:Template documentation| ]]
[[Category:Wikipedia formatting templates|Template documentation]]
[[Category:Templates using ParserFunctions|{{PAGENAME}}]]

</includeonly>