Template:Documentation/doc - Revision history

Madness: /* Usage */

2012-04-16T01:58:05Z

‎Usage

Madness at 01:53, 16 April 2012

2012-04-16T01:53:17Z

Madness: /* See also */

2012-04-16T01:44:54Z

‎See also

Madness: Undoable without parser functions.

2012-04-16T01:44:20Z

Undoable without parser functions.

Madness: Created page with '{{documentation subpage}} This is the {{tl|documentation}} template. This template displays a green doc box like you are seeing now, and automatically loads the content from a /…'

2012-04-16T01:29:12Z

Created page with '{{documentation subpage}} This is the {{tl|documentation}} template. This template displays a green doc box like you are seeing now, and automatically loads the content from a /…'

New page

{{documentation subpage}}
This is the {{tl|documentation}} template.

This template displays a green doc box like you are seeing now, and automatically loads the content from a /doc subpage.

=== Usage ===

This template is used without any parameters, placed at the bottom of the template or page being documented, within <code><noinclude></code>:

<pre>
<noinclude>

{{documentation}}

</noinclude>
</pre>

Then this template automatically loads the content from the /doc subpage of the template it is used on.

=== Best practice ===

The code should be added at the bottom of the template code, with no space before {{tag|noinclude|o}} (which would cause extra space on pages where the template is used).

Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside {{tag|includeonly}} tags.

If the documentation page contains {{tag|includeonly|o}} or {{tag|noinclude|o}} tags as part of the visible documentation text, replace the "<code><</code>" with "<code>&lt;</code>".

=== See also ===

* {{tl|documentation subpage}} – Used at the top of /doc subpages to explain what they are and to link back to the page they document.

<includeonly>
[[Category:Template documentation]]
</includeonly>

@@ Line 19: / Line 19: @@
 === Best practice ===
-The code should be added at the bottom of the template code, with no space before {{tag|noinclude|o}} (which would cause extra space on pages where the template is used).
+The code should be added at the bottom of the template code, with no space before <code style="white-space:nowrap;"><nowiki><noinclude></nowiki></code> (which would cause extra space on pages where the template is used).
-Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside {{tag|includeonly}} tags.
+Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside <code style="white-space:nowrap;"><nowiki><includeonly>...</includeonly></nowiki></code> tags.
-If the documentation page contains {{tag|includeonly|o}} or {{tag|noinclude|o}} tags as part of the visible documentation text, replace the "<code>&lt;</code>" with "<code>&amp;lt;</code>".
+If the documentation page contains <code style="white-space:nowrap;"><nowiki><includeonly></nowiki></code> or <code style="white-space:nowrap;"><nowiki><noinclude></nowiki></code> tags as part of the visible documentation text, replace the "<code>&lt;</code>" with "<code>&amp;lt;</code>".
-=== See also ===
+=== Documentation pages ===
-* {{tl|documentation subpage}} – Used at the top of /doc subpages to explain what they are and to link back to the page they document.
+Documentation pages should end with the category links for both the documentation page and the template itself, in the following way:
 <includeonly>[[Category:Template documentation]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

@@ Line 11: / Line 11: @@
 {{documentation}}
-<!-- Add categories and interwikis to the /doc subpage, not here! -->
+<!-- Add categories to the /doc subpage, not here! -->
 </noinclude>
 </pre>

@@ Line 1: / Line 1: @@
 This is the {{tl|documentation}} template.
@@ Line 33: / Line 32: @@
 [[Category:Template documentation]]
 </includeonly>