Template:Documentation

From PCSAR

(Difference between revisions)
Jump to: navigation, search
(New page: <noinclude>{{documentation}}</noinclude><includeonly> This is the documentation for the template '''{{FULLPAGENAME}}''' {{quote-page|{{FULLPAGENAME}}/Doc}} Edit this page and examine the ...)
Current revision (18:38, 9 September 2016) (edit) (undo)
 
(2 intermediate revisions not shown.)
Line 1: Line 1:
<noinclude>{{documentation}}</noinclude><includeonly>
<noinclude>{{documentation}}</noinclude><includeonly>
-
This is the documentation for the template '''{{FULLPAGENAME}}'''
+
This is the documentation for the template '''{{FULLPAGENAME}}'''<!--
-
{{quote-page|{{FULLPAGENAME}}/Doc}}
+
-
Edit this page and examine the portion
+
Use 1= in case page name includes an equal sign.
-
between <code>&lt;includeonly&gt;</code> and <code>&lt;/includeonly&gt;</code>
+
 
-
to see how this template works.
+
-->
 +
{{quote-page|1={{FULLPAGENAME}}/Doc}}
 +
 
 +
To see how this template is implemented,
 +
edit this page and examine the portion
 +
between <code>&lt;includeonly&gt;</code> and <code>&lt;/includeonly&gt;</code>.
</includeonly>
</includeonly>

Current revision

This is the documentation for the template Template:Documentation

Template:Documentation/Doc:

{{documentation}} is a template used in the documentation section of other templates.

To reduce system load, Template:Documentation should be employed as part of all high-use templates.

It can be used on any template to simplify the template's appearance in the edit buffer.

It's typically used in the form:

<noinclude>{{documentation}}</noinclude><includeonly>

...

</includeonly>

The template automatically includes the documentation which is on the subpage "/Doc" of the template. Thus the template proper and the documentation are on separate pages, but the documentation is shown on the main template's page. The separation means that the documentation can be edited without modifying the template itself and without having every page that (in)directly calls the template re-evaluated.


To see how this template is implemented, edit this page and examine the portion between <includeonly> and </includeonly>.

Personal tools