MarkusSkalprGrimsson at 03:47, 4 February 2023

2023-02-04T03:47:58Z

← Older revision		Revision as of 03:47, 4 February 2023
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 [[~~MiddleWiki~~: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 [[AEWiki:Transclusion\|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

	{{AccessibilityDispute}}		{{AccessibilityDispute}}
Line 28:		Line 28:
	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.		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 [[~~MiddleWiki~~:Template documentationâ€Ž#Categories and interwiki links]].		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 [[AEWiki:Template documentationâ€Ž#Categories and interwiki links]].

	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;".
Line 43:		Line 43:
	== Rationale ==		== Rationale ==

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

	== See also ==		== See also ==
Line 50:		Line 50:
	<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->		<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
	[[Category:Template documentation\| ]]		[[Category:Template documentation\| ]]
	[[Category:~~MiddleWiki~~ formatting and function templates\|Template documentation]]		[[Category:AEWiki formatting and function templates\|Template documentation]]
	</includeonly>		</includeonly>

MarkusSkalprGrimsson: Created page with "{{documentation subpage}} 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 transcluded in other pages, i.e. templates, whether in the template namespace or not. {{AccessibilityDispute}} == Usage == === Normal /doc === <noinclude>..."

2023-02-04T03:24:51Z

Created page with "{{documentation subpage}}  __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 transcluded in other pages, i.e. templates, whether in the template namespace or not. {{AccessibilityDispute}} == Usage == === Normal /doc === <noinclude>..."

New page

{{documentation subpage}}

__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 [[MiddleWiki:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

{{AccessibilityDispute}}

== 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 [[MiddleWiki: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 [[MiddleWiki: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:MiddleWiki formatting and function templates|Template documentation]]
</includeonly>

Template:Documentation/doc - Revision history

MarkusSkalprGrimsson at 03:47, 4 February 2023