Template:DocumentationEdit This Page

From FamilySearch Wiki

(Difference between revisions)
(200 So. Main Street, Blanding, Utah 84511)
m (Reverted edits by Slang (talk) to last revision by Murphynw)
 
Line 1: Line 1:
<p><!--
+
<!--
 
   Automatically add {{template sandbox notice}} when on a /sandbox page.
 
   Automatically add {{template sandbox notice}} when on a /sandbox page.
--><span class="fck_mw_template"><span class="fck_mw_template"><span class="fck_mw_template">{{#ifeq: {{SUBPAGENAME}} | sandboxfckLR| &amp;amp;lt;div style=&amp;amp;quot;clear: both;&amp;amp;quot;&amp;amp;gt;&amp;amp;lt;/div&amp;amp;gt;{{template sandbox notice|{{{livepage|}}}}}fckLR}}</span></span></span><!--
+
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
 +
| <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}}
 +
}}<!--
 
   Automatically add {{pp-template}} to protected templates.
 
   Automatically add {{pp-template}} to protected templates.
--><span class="fck_mw_template"><span class="fck_mw_template"><span class="fck_mw_template">{{template otherfckLR| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysopfckLR  | {{pp-template|docusage=yes}}fckLR  | {{#if: {{PROTECTIONLEVEL:edit}}fckLR    | {{pp-template|docusage=yes}}fckLR    | <!--Not protected, or only semi-move-protected-->fckLR    }}fckLR  }}fckLR}}</span></span></span><!--
+
-->{{template other
 +
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
 +
  | {{pp-template|docusage=yes}}
 +
  | {{#if: {{PROTECTIONLEVEL:edit}}
 +
    | {{pp-template|docusage=yes}}
 +
    | <!--Not protected, or only semi-move-protected-->
 +
    }}
 +
  }}
 +
}}<!--
 
   Start of green doc box.
 
   Start of green doc box.
--><span class="fck_mw_template"><span class="fck_mw_template"><span class="fck_mw_template">{{documentation/start box2fckLR| preload = {{{preload|}}}  <!--Allow custom preloads-->fckLR| heading = {{{heading|¬}}}  <!--Empty but defined means no header-->fckLR| heading-style = {{{heading-style|}}}fckLR| content = {{{content|}}}fckLR
+
-->{{documentation/start box2
 +
| preload = {{{preload|}}}  <!--Allow custom preloads-->
 +
| heading = {{{heading|¬}}}  <!--Empty but defined means no header-->
 +
| heading-style = {{{heading-style|}}}
 +
| content = {{{content|}}}
 +
 
 
<!--Some namespaces must have the /doc, /sandbox and /testcases  
 
<!--Some namespaces must have the /doc, /sandbox and /testcases  
 
     in talk space-->
 
     in talk space-->
fckLRfckLRfckLR| docspace = {{documentation/docspace}}fckLRfckLR| 1 = {{{1|}}}  <!--Other docname, if fed-->fckLR
+
| docspace = {{documentation/docspace}}
 +
 
 +
| 1 = {{{1|}}}  <!--Other docname, if fed-->
 +
 
 
<!--The namespace is added in /start box2-->
 
<!--The namespace is added in /start box2-->
fckLRfckLRfckLR| template page = {{documentation/template page}}fckLRfckLR}}</span></span></span><!-- Start content --><!--
+
| template page = {{documentation/template page}}
 +
 
 +
}}<!-- Start content --><!--
 
   Start load the /doc content:
 
   Start load the /doc content:
 
   Note: The line breaks between this comment and the next line are necessary
 
   Note: The line breaks between this comment and the next line are necessary
 
   so  "=== Headings ===" at the start and end of docs are interpreted.
 
   so  "=== Headings ===" at the start and end of docs are interpreted.
 
-->
 
-->
<span class="fck_mw_template"><span class="fck_mw_template"><span class="fck_mw_template">{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}}fckLR| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 fckLR| 1111 = {{{content|}}}fckLR| 0110 | 0111 = {{ {{{1}}} }}fckLR| 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }}fckLR| 0000 | 0100 | 0010 | 0101 = fckLR}}</span></span></span>
+
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}}
 +
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110  
 +
| 1111 = {{{content|}}}
 +
| 0110 | 0111 = {{ {{{1}}} }}
 +
| 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }}
 +
| 0000 | 0100 | 0010 | 0101 =  
 +
}}
 
<!--
 
<!--
 
   End load the /doc content:
 
   End load the /doc content:
 
   Note: The line breaks between this comment and the previous line are necessary
 
   Note: The line breaks between this comment and the previous line are necessary
 
   so  "=== Headings ===" at the start and end of docs are interpreted.
 
   so  "=== Headings ===" at the start and end of docs are interpreted.
--><span class="fck_mw_template"><span class="fck_mw_template"><span class="fck_mw_template">{{documentation/end box2fckLR| preload = {{{preload|}}}  <!--Allow custom preloads-->fckLR| content = {{{content|}}}fckLR| link box = {{{link box|}}}  <!--So "link box=off" works-->fckLR
+
-->{{documentation/end box2
 +
| preload = {{{preload|}}}  <!--Allow custom preloads-->
 +
| content = {{{content|}}}
 +
| link box = {{{link box|}}}  <!--So "link box=off" works-->
 +
 
 
<!--Some namespaces must have the /doc, /sandbox and /testcases  
 
<!--Some namespaces must have the /doc, /sandbox and /testcases  
 
     in talk space-->
 
     in talk space-->
fckLRfckLRfckLR| docspace = {{documentation/docspace}}fckLRfckLR| 1 = {{{1|}}}  <!--Other docname, if fed-->fckLR
+
| docspace = {{documentation/docspace}}
 +
 
 +
| 1 = {{{1|}}}  <!--Other docname, if fed-->
 +
 
 
<!--The namespace is added in /end box2-->
 
<!--The namespace is added in /end box2-->
fckLRfckLRfckLR| template page = {{documentation/template page}}fckLRfckLR}}</span></span></span><!--
+
| template page = {{documentation/template page}}
 +
 
 +
}}<!--
 
   End of green doc box
 
   End of green doc box
--><span class="fck_mw_noinclude">fckLRfckLR&lt;!-- Add categories and interwikis to the /doc subpage, not here! --&gt;fckLR</span>
+
--><noinclude>
</p>
+
 
 +
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 +
</noinclude>

Latest revision as of 14:40, 5 August 2013

[view] [edit] [history] [purge] Documentation icon Template documentation

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.

Usage

Normal /doc

<noinclude>{{Documentation}}</noinclude>

Any /doc page

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

In-line content

<noinclude>{{Documentation|content=This is documentation.}}</noinclude>

In-line content with [view][edit] links

<noinclude>{{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 "<noinclude>" (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 <includeonly> </includeonly> tags. For more complex cases, see Wikipedia: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:

  • {{documentation| heading = ...}} − 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 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 protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

See also

  • {{documentation}} – Placed on templates and other pages to document them.
  • {{documentation subpage}} – Used at the top of /doc subpages to explain what they are and to link back to the page they document.


  • This page was last modified on 5 August 2013, at 14:40.
  • This page has been accessed 1,502 times.