Template:Documentation subpageEdit This Page

From FamilySearch Wiki

(Difference between revisions)
m (Reverted edits by Noelseivad (talk) to last revision by Cottrells)
 
Line 7: Line 7:
 
<tr><td><small>This page may not be intended to be viewed directly. <br/
 
<tr><td><small>This page may not be intended to be viewed directly. <br/
 
>Links using [[Help:Variable|variable]]s may appear broken; do not replace these with [[hardcoded]] page names or URLs.</small></td></tr>
 
>Links using [[Help:Variable|variable]]s may appear broken; do not replace these with [[hardcoded]] page names or URLs.</small></td></tr>
</table>{{#if:{{{inhib|x}}}{{{inhibit|}}}|<!-- skip --->|<img _fck_mw_includeonly="true" _fckrealelement="9" _fckfakelement="true" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" class="FCK__MWIncludeonly">
+
</table>{{#if:{{{inhib|x}}}{{{inhibit|}}}|<!-- skip --->|<includeonly>[[Category:Template documentation|{{PAGENAME}}]]</includeonly>
 
}}<!-- Please retain the above original template...  
 
}}<!-- Please retain the above original template...  
  
Line 15: Line 15:
  
 
--->
 
--->
|<img _fck_mw_includeonly="true" _fckrealelement="8" _fckfakelement="true" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" class="FCK__MWIncludeonly">{{
+
|<includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}
 +
  | <!-- doc page -->
 +
</includeonly>{{
 
     #ifeq: {{{doc-notice|show}}} | show
 
     #ifeq: {{{doc-notice|show}}} | show
 
     | {{mbox
 
     | {{mbox
Line 30: Line 32:
 
       | {{SUBJECTSPACE}}
 
       | {{SUBJECTSPACE}}
 
       | Article
 
       | Article
     }} documentation<img _fck_mw_noinclude="true" _fckrealelement="7" _fckfakelement="true" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" class="FCK__MWNoinclude">]]
+
     }} documentation<noinclude>| </noinclude>]]
   }}<img _fck_mw_includeonly="true" _fckrealelement="6" _fckfakelement="true" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" class="FCK__MWIncludeonly"><img _fck_mw_noinclude="true" _fckrealelement="5" _fckfakelement="true" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" class="FCK__MWNoinclude">
+
   }}<includeonly>
 +
| <!-- if not on a /doc subpage, do nothing -->
 +
}}</includeonly><noinclude>
 +
 
 +
{{documentation}}
 +
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 +
</noinclude>
 
}}
 
}}

Latest revision as of 08:48, 23 January 2013

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

Usage

{{documentation subpage}}

OR

{{documentation subpage|[[main page to link to]]}}

Customization of text

To manually change the text of the template, the "text1=your text here" and/or "text2=your other text here" parameters can be specified. "text1=" changes the automatic text on the first line to your own word(s). "text2=" changes the automatic text on the second line to your own word(s). If "text1=" parameter is specified without the "text2=" parameter, both the first and second line of text will be custom based on the text given in the "text1=" parameter.

Example usage:

{{documentation subpage|text1=custom first and second line text}}
{{documentation subpage|text2=custom second line text only}}
{{documentation subpage|text1=custom first line text|text2=custom second line text}}

How it is displayed

This template should be placed at the top of "/doc" pages. It changes output depending on where it is viewed:

  • On a "/doc" page, it displays a box explaining template documentation and links to the template page.
  • On other pages (ie, pages transcluding the "/doc" page), the template will not show. The template page itself (which contains {{Documentation}}) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to the output message, the template categorizes pages to Category:Template documentation or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').

See also

  • This page was last modified on 23 January 2013, at 08:48.
  • This page has been accessed 664 times.