Template:Documentation/doc - Revision history

CirTap: 1 revision(s)

2008-05-09T17:47:43Z

1 revision(s)

← Older revision	Revision as of 17:47, 9 May 2008
(No difference)

CirTap: /* Rationale */

2008-05-03T17:00:52Z

Rationale

← Older revision		Revision as of 17:00, 3 May 2008
Line 4:		Line 4:

	==Usage==		==Usage==
	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.
	<pre>		<pre>
	<noinclude>{{documentation}}</noinclude>		<noinclude>{{documentation}}</noinclude>
	or		or
	<noinclude>{{documentation\|~~other template doc~~}}</noinclude>		<noinclude>{{documentation\|:namespace:any article}}</noinclude>
	or		or
	<noinclude>{{documentation\|~~Namespace:some other~~ page}}</noinclude>		<noinclude>{{documentation\|template page}}</noinclude>
	</pre>		</pre>
	;~~Important:~~Add categories and interwiki links to the documentation page inside <includeonly> tags.
			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. If no argument/page name is provided the <tt>/doc</tt> subpage of the page is used -- just like this /doc page is used for it's parent.

			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;".		If the documentation page contains <includeonly> or <noinclude> tags as part of the documentation, replace the "<" with "&lt;".

	==Functions==		==Functions==
	If the documentation page doesn't exist, the "edit" link includes a [~~[Joomla~~:~~Creating pages with preloaded text\|~~preload]] parameter so that clicking it will pre-fill the edit form with the [[../preload/\|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 [http://www.mediawiki.org/wiki/Manual:Creating_pages_with_preloaded_text preload] parameter so that clicking it will pre-fill the edit form with the '''[[Template:Documentation/preload\|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:Wikipedia:Template limits\|technical limitation of templates]]. See [{{fullurl:wikipedia:Project:Village pump (technical)\|diff=prev&oldid=69888944}} Wikipedia Village pump] for a developer's explanation.
			<noinclude>[[Category:Template documentation\|!]]</noinclude>
	<!-- for the template -->		<!-- for the calling template -->
	<includeonly>		<includeonly>
	[[Category:Template documentation\| ]]		[[Category:Template documentation\|!]]
	[[Category:Formatting templates\|Template documentation]]		[[Category:Formatting templates\|Template documentation]]
	</includeonly>		</includeonly>

CirTap: /* Usage */

2008-03-30T14:46:38Z

Usage

← Older revision		Revision as of 14:46, 30 March 2008
Line 4:		Line 4:

	==Usage==		==Usage==
			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.
	<pre>		<pre>
	<noinclude>{{documentation}}</noinclude>		<noinclude>{{documentation}}</noinclude>
	or		or
	<noinclude>{{documentation\|~~Template:any~~ template}}</noinclude>		<noinclude>{{documentation\|other template doc}}</noinclude>
	or		or
	<noinclude>{{documentation\|~~any~~ page}}</noinclude>		<noinclude>{{documentation\|Namespace:some other page}}</noinclude>
	</pre>		</pre>
			;Important:Add categories and interwiki links to the documentation page inside <includeonly> tags.
	~~This code should be added at the bottom of the template code, with no extra space before "<code>&lt~~;~~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;".		If the documentation page contains <includeonly> or <noinclude> tags as part of the documentation, replace the "<" with "&lt;".

CirTap: /* Functions */

2008-01-21T13:35:37Z

Functions

← Older revision		Revision as of 13:35, 21 January 2008
Line 19:		Line 19:

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

	==Rationale==		==Rationale==

CirTap at 16:49, 17 January 2008

2008-01-17T16:49:36Z

← Older revision		Revision as of 16:49, 17 January 2008
Line 7:		Line 7:
	<noinclude>{{documentation}}</noinclude>		<noinclude>{{documentation}}</noinclude>
	or		or
	<noinclude>{{documentation\|template:any page}}</noinclude>		<noinclude>{{documentation\|Template:any template}}</noinclude>
			or
			<noinclude>{{documentation\|any page}}</noinclude>
	</pre>		</pre>

CirTap: 1 revision(s)

2008-01-17T15:35:30Z

1 revision(s)

← Older revision	Revision as of 15:35, 17 January 2008
(No difference)

CirTap: 1 revision(s)

2008-01-17T15:33:08Z

1 revision(s)

← Older revision		Revision as of 15:33, 17 January 2008
Line 4:		Line 4:

	==Usage==		==Usage==
	<pre><noinclude>{{documentation}}</noinclude>~~</pre>~~		<pre>
	If called without a parameter the <tt>/doc</tt> subpage of the template is transcuded into the template for display -- like this ''"{{PAGENAME}}"'' subpage is considered to be the documentation page of the ''"{{#titleparts:{{PAGENAME}}\|1}}"'' template.		<noinclude>{{documentation}}</noinclude>
	~~<pre>~~<noinclude>{{documentation\|template:any page}}</noinclude></pre>		or
	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. Make sure to add the namespace prefix of the documentation page if necessary.		<noinclude>{{documentation\|template:any page}}</noinclude>
			</pre>

	~~Add categories and interwiki links ''for~~ the template~~'' to the documentation page inside~~ <tt><~~includeonly~~></tt> ~~tags~~.		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.

	: If the documentation page contains <includeonly> or <noinclude> tags as part of the documentation, replace the "<" with "&lt;".		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==		==Functions==
	If the documentation page doesn't exist, the "edit" link includes a [~~http~~:~~//www.mediawiki.org/wiki/~~Manual:~~Creating_pages_with_preloaded_text~~ preload] parameter so that clicking it will pre-fill the edit form with the [[~~Template:Documentation~~/preload\|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 [[Mediawiki:Manual:Creating pages with preloaded text\|preload]] parameter so that clicking it will pre-fill the edit form with the [[../preload/\|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 ~~is not restricted to a particular namespace and~~ 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 [~~[Wikipedia~~: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]) -->.

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

CirTap: /* Rationale */

2007-11-03T12:20:59Z

Rationale

← Older revision		Revision as of 12:20, 3 November 2007
Line 4:		Line 4:

	==Usage==		==Usage==
	<pre>		<pre><noinclude>{{documentation}}</noinclude></pre>
	<noinclude>{{documentation}}</noinclude>		If called without a parameter the <tt>/doc</tt> subpage of the template is transcuded into the template for display -- like this ''"{{PAGENAME}}"'' subpage is considered to be the documentation page of the ''"{{#titleparts:{{PAGENAME}}\|1}}"'' template.
	or		<pre><noinclude>{{documentation\|template:any page}}</noinclude></pre>
	<noinclude>{{documentation\|template:any page}}</noinclude>		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. Make sure to add the namespace prefix of the documentation page if necessary.
	</~~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 ''for the template'' to the documentation page inside <tt><includeonly></tt> tags.

	~~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;".

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

	==Functions==		==Functions==
	If the documentation page doesn't exist, the "edit" link includes a [~~[Mediawiki~~:Manual:~~Creating pages with preloaded text\|~~preload]] parameter so that clicking it will pre-fill the edit form with the [[../preload/\|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 [http://www.mediawiki.org/wiki/Manual:Creating_pages_with_preloaded_text preload] parameter so that clicking it will pre-fill the edit form with the [[Template:Documentation/preload\|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 is not restricted to a particular namespace and 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 [[Wikipedia:Project:Village+pump+(technical)?diff=prev&oldid=69888944\|developer's explanation]]).

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

CirTap at 21:10, 19 October 2007

2007-10-19T21:10:31Z

New page

{{documentation subpage}}

This template automatically displays a documentation box like the one you read now, of which the content is taken 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 [[Mediawiki:Manual:Creating pages with preloaded text|preload]] parameter so that clicking it will pre-fill the edit form with the [[../preload/|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]] .


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