Template:Documentation/doc - Revision history

Ganaram inukshuk at 11:08, 31 October 2025

2025-10-31T11:08:41Z

← Older revision		Revision as of 11:08, 31 October 2025
Line 45:		Line 45:
	=== See also ===		=== See also ===
	* [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.		* [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.

			{{todo\|inline=1\|rework\|comment=Template:Lua is deprecated; placement of dochead is incorrect; add module introspection}}

ArrowHead294 at 23:09, 25 May 2025

2025-05-25T23:09:28Z

← Older revision		Revision as of 23:09, 25 May 2025
Line 1:		Line 1:
	{{Dochead}}{{wikipedia}}{{templatestyles}}		{{Dochead}}{{substitute\|no}}{{wikipedia}}{{templatestyles}}
	The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.		The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.
	__NOTOC__		__NOTOC__

ArrowHead294 at 14:20, 25 May 2025

2025-05-25T14:20:26Z

← Older revision		Revision as of 14:20, 25 May 2025
Line 1:		Line 1:
	{{Dochead}}{{wikipedia}}		{{Dochead}}{{wikipedia}}{{templatestyles}}
	The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.		The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.
	__NOTOC__		__NOTOC__

ArrowHead294 at 18:57, 22 May 2025

2025-05-22T18:57:25Z

← Older revision		Revision as of 18:57, 22 May 2025
Line 42:		Line 42:
	}}		}}
	</pre>		</pre>

	~~Wikipedia has {{w\|Module: Documentation}} which takes care of things automatically, but here, these are used as workarounds to avoid the need for modules.~~

	=== See also ===		=== See also ===
	* [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.		* [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.

FloraC: -redundant whitespace

2025-05-22T15:06:07Z

-redundant whitespace

← Older revision		Revision as of 15:06, 22 May 2025
Line 1:		Line 1:
	{{Dochead}}{{wikipedia}}		{{Dochead}}{{wikipedia}}
	The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.		The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.

	__NOTOC__		__NOTOC__
	=== Usage ===		=== Usage ===

FloraC: + how (i think) this template works

2025-05-22T15:05:40Z

+ how (i think) this template works

← Older revision		Revision as of 15:05, 22 May 2025
Line 1:		Line 1:
	{{Dochead}}{{wikipedia}}		{{Dochead}}{{wikipedia}}
	The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. ~~The actual information~~ is ~~located in the <code>/doc</code> subpage~~.		The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.

	~~Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.~~
	__NOTOC__		__NOTOC__
	=== Templates ===		=== Usage ===
			This template automatically extracts contents from the <code>/doc</code> subpage of any page. You can optionally add an unnamed argument, which will be displayed in place.

			==== Templates ====
	On templates, place <code><nowiki>{{documentation}}</nowiki></code> on the page itself, place the relevant categories afterwards, and enclose them in <code><nowiki><noinclude></nowiki></code> tags:		On templates, place <code><nowiki>{{documentation}}</nowiki></code> on the page itself, place the relevant categories afterwards, and enclose them in <code><nowiki><noinclude></nowiki></code> tags:

Line 16:		Line 18:
	</pre>		</pre>

	=== Modules ===		==== Modules ====
	On pages consisting of exclusively code (modules, CSS, JS, etc.), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx\|dochead}}, in as the first unnamed parameter:		On pages consisting of exclusively code (modules, CSS, JS, etc.), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx\|dochead}}, in as the first unnamed parameter:

FloraC: Cleanup

2025-05-22T14:47:19Z

Cleanup

← Older revision		Revision as of 14:47, 22 May 2025
Line 1:		Line 1:
	{{~~dochead~~}}{{wikipedia}}		{{Dochead}}{{wikipedia}}
	The <code>{{<nowiki />documentation}}</code> template is used to contain information and instructions for templates and modules. The actual information is located in the <code>/doc</code> subpage.		The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. The actual information is located in the <code>/doc</code> subpage.

	Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.		Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.
	__NOTOC__		__NOTOC__
	=== Templates ===		=== Templates ===
	On templates, place <code>{{<nowiki />documentation}}</code> on the page itself, place the relevant categories afterwards, and enclose them in <code><<nowiki />noinclude></code> tags:		On templates, place <code><nowiki>{{documentation}}</nowiki></code> on the page itself, place the relevant categories afterwards, and enclose them in <code><nowiki><noinclude></nowiki></code> tags:

	<pre>		<pre>
	<noinclude>		<noinclude>
	{{~~documentation~~}}		{{Documentation}}

	[[Category: ~~...~~]]		[[Category: …]]
	~~...~~		…
	</noinclude>		</noinclude>
	</pre>		</pre>

	=== Modules ===		=== Modules ===
	On pages consisting of exclusively code (modules, CSS, JS, etc), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx\|dochead}}, in as the first unnamed parameter:		On pages consisting of exclusively code (modules, CSS, JS, etc.), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx\|dochead}}, in as the first unnamed parameter:

	~~{{escape notice}}~~

	<pre>		<pre>
	{{~~documentation~~\|		{{Documentation\|
	{{~~dochead~~}}		{{Dochead}}
	~~...~~		…
	}}		}}
	</pre>		</pre>

	Additionally, when {{tlx\|lua}} is used on a module documentation page to indicate dependencies, the first ~~paragraph~~ paragraph of text after the Lua banner may need to be encased in its own paragraph (<code>~~<~~p~~>~~</code>) element since otherwise the MediaWiki parser may fail to render the paragraphs correctly:		{{Escape notice}}

			Additionally, when {{tlx\|lua}} is used on a module documentation page to indicate dependencies, the first paragraph of text after the Lua banner may need to be encased in its own paragraph (<code><nowiki><p></nowiki></code>) element since otherwise the MediaWiki parser may fail to render the paragraphs correctly:

	<pre>		<pre>
	{{~~documentation~~\|		{{Documentation\|
	{{~~dochead~~}}{{lua\|~~...~~\|~~...~~\|}}		{{Dochead}}{{lua\|…\|…\|}}
	<p>Paragraph 1</p>		<p>Paragraph 1</p>

Line 38:		Line 38:

	Paragraph 3		Paragraph 3
	~~...~~		…
	}}		}}
	</pre>		</pre>

	Wikipedia has {{w\|Module:Documentation}} which takes care of things automatically, but here, these are used as workarounds to avoid the need for modules.		Wikipedia has {{w\|Module: Documentation}} which takes care of things automatically, but here, these are used as workarounds to avoid the need for modules.

	=== See also ===		=== See also ===
	* [[Template:Dochead]] – used to categorise and add appropriate headers onto documentation pages.		* [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.

ArrowHead294: /* Modules */

2025-05-21T11:58:39Z

Modules

← Older revision		Revision as of 11:58, 21 May 2025
Line 28:		Line 28:
	</pre>		</pre>

	Additionally, when {{tlx\|lua}} is used on a module documentation page to indicate dependencies, the first paragraph paragraph of text after the Lua banner may need to be encased in its own paragraph (<code><p></code>) element:		Additionally, when {{tlx\|lua}} is used on a module documentation page to indicate dependencies, the first paragraph paragraph of text after the Lua banner may need to be encased in its own paragraph (<code><p></code>) element since otherwise the MediaWiki parser may fail to render the paragraphs correctly:

	<pre>		<pre>
Line 42:		Line 42:
	</pre>		</pre>

	Wikipedia has {{w\|Module:Documentation}} which takes care of things automatically, but here, ~~this is~~ used as ~~a workaround~~ to avoid the need for modules.		Wikipedia has {{w\|Module:Documentation}} which takes care of things automatically, but here, these are used as workarounds to avoid the need for modules.

	=== See also ===		=== See also ===
	* [[Template:Dochead]] – used to categorise and add appropriate headers onto documentation pages.		* [[Template:Dochead]] – used to categorise and add appropriate headers onto documentation pages.

ArrowHead294: /* Modules */

2025-05-19T12:08:53Z

Modules

← Older revision		Revision as of 12:08, 19 May 2025
Line 28:		Line 28:
	</pre>		</pre>

	Additionally, when {{tlx\|lua}} is used on a module documentation page to indicate dependencies, the first paragraph paragraph of text after the Lua banner may need to be encased in its own paragraph (<code><p>)</code> element:		Additionally, when {{tlx\|lua}} is used on a module documentation page to indicate dependencies, the first paragraph paragraph of text after the Lua banner may need to be encased in its own paragraph (<code><p></code>) element:

	<pre>		<pre>

ArrowHead294 at 12:08, 19 May 2025

2025-05-19T12:08:40Z

← Older revision		Revision as of 12:08, 19 May 2025
Line 19:		Line 19:
	On pages consisting of exclusively code (modules, CSS, JS, etc), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx\|dochead}}, in as the first unnamed parameter:		On pages consisting of exclusively code (modules, CSS, JS, etc), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx\|dochead}}, in as the first unnamed parameter:

	{{escape notice}} ~~Additionally, when {{tlx\|lua}} is used on a module documentation page to indicate dependencies, each paragraph of text may need to be encased in its own paragraph (<code><p>)</code> element:~~		{{escape notice}}

	<pre>		<pre>
Line 27:		Line 27:
	}}		}}
	</pre>		</pre>

			Additionally, when {{tlx\|lua}} is used on a module documentation page to indicate dependencies, the first paragraph paragraph of text after the Lua banner may need to be encased in its own paragraph (<code><p>)</code> element:

	<pre>		<pre>
Line 32:		Line 34:
	{{dochead}}{{lua\|...\|...\|}}		{{dochead}}{{lua\|...\|...\|}}
	<p>Paragraph 1</p>		<p>Paragraph 1</p>
	~~<p>~~Paragraph 2~~</p>~~
	~~<p>~~Paragraph 3~~</p>~~		Paragraph 2

			Paragraph 3
	...		...
	}}		}}