Difference between revisions of "Template:Documentation"

From JRiverWiki
Jump to: navigation, search
m (1 revision: Importing archive template to tidy up community portal page.)
m (1 revision)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<!--
+
<div style="clear: both; border: 1px solid black; margin: 1em;">
−
   Automatically add {{template sandbox notice}} when on a /sandbox page.
+
   <div style="background: #ddd; color: #111; padding: 1em; margin: 0;">'''Template documentation''' <span style="font-size: 85%;">(for the above template, sometimes hidden or invisible)</span><span class="editsection plainlinks" id="doc_editlinks">[[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} Edit]] [[{{fullurl:{{FULLPAGENAME}}|action=purge}} <span title="Refresh this page">Refresh</span>]]</span></div>
−
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
+
  <div style="padding: 1em; padding-bottom: 0; margin: 0;">{{
−
| <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}}
+
    #if: {{{content|}}}
−
}}<!--
+
    | <nowiki/>
−
  Automatically add {{pp-template}} to protected templates.
+
{{{content}}}
−
-->{{template other
+
    | {{
−
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
+
      #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}
−
  | {{pp-template|docusage=yes}}
+
      | {{tocright}}{{{{
−
  | {{#if: {{PROTECTIONLEVEL:edit}}
+
        #ifeq: {{NAMESPACE}} | {{ns:Template}}
−
    | {{pp-template|docusage=yes}}
+
        || :{{NAMESPACE:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}} }}}}:
−
    | <!--Not protected, or only semi-move-protected-->
+
      }}{{ #if: {{{1|}}} | {{PAGENAME:{{{1}}}}} | {{PAGENAME}}/doc}} }}
 +
      | :<strong class="error">This template doesn't have any documentation yet!</strong> Help out by [{{fullurl:{{ #if: {{{1|}}} | {{ urlencode: {{{1}}} }} | {{FULLPAGENAMEE}}/doc }}|action=edit&preload=Template:Documentation/preload}} writing some]. {{
 +
        #ifeq: {{NAMESPACE}} | {{ns:10}}
 +
        | There may also be documentation on [[w:c:templates:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|Wikia Templates]] which can be copied.
 +
      }}[[Category:Templates without documentation|{{PAGENAME}}]]
 
     }}
 
     }}
 
   }}
 
   }}
−
}}<!--
+
  </div>
−
  Start of green doc box.
+
   <div style="clear: both; background: #ddd; color: #111; padding: 0.5em; margin: 0; font-size: 85%; text-align: right;">{{
−
-->{{documentation/start box2
+
    #if: {{{content|}}}
−
| preload = {{{preload|}}}   <!--Allow custom preloads-->
+
     | [{{fullurl:{{FULLPAGENAMEE}}|action=edit}} Edit this page]
−
| heading = {{{heading|¬}}}  <!--Empty but defined means no header-->
+
    | Visit {{
−
| heading-style = {{{heading-style|}}}
+
      #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}
−
| content = {{{content|}}}
+
      | [[{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]]
−
 
+
      | [{{fullurl:{{ #if: {{{1|}}} | {{ urlencode: {{{1}}} }} | {{FULLPAGENAMEE}}/doc }}|action=edit&preload=Template:Documentation/preload}} {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]
−
<!--Some namespaces must have the /doc, /sandbox and /testcases
+
     }}
−
     in talk space-->
+
  }} to change this text! ([[Template:Documentation|How does this work]]?)<br />Done making changes? [{{fullurl:{{FULLPAGENAME}}|action=purge}} Refresh] this text! ([[Help:Purge|Why?]])</div>
−
| docspace = {{documentation/docspace}}
+
</div>
−
 
 
−
| 1 = {{{1|}}}   <!--Other docname, if fed-->
 
−
 
 
−
<!--The namespace is added in /start box2-->
 
−
| template page = {{documentation/template page}}
 
−
 
 
−
}}<!-- Start content --><!--
 
−
  Start load the /doc content:
 
−
  Note: The line breaks between this comment and the next line are necessary
 
−
  so  "=== Headings ===" at the start and end of docs are interpreted.
 
−
-->
 
−
{{#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:
 
−
  Note: The line breaks between this comment and the previous line are necessary
 
−
  so  "=== Headings ===" at the start and end of docs are interpreted.
 
−
-->{{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
 
−
     in talk space-->
 
−
| docspace = {{documentation/docspace}}
 
−
 
 
−
| 1 = {{{1|}}}  <!--Other docname, if fed-->
 
−
 
 
−
<!--The namespace is added in /end box2-->
 
−
| template page = {{documentation/template page}}
 
−
 
 
−
}}<!--
 
−
  End of green doc box
 
−
--><noinclude>
 
−
 
 
−
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
−
</noinclude>
 

Latest revision as of 00:45, 17 April 2014

Template documentation (for the above template, sometimes hidden or invisible)[Edit] [Refresh]
Wiki.pngThis template was copied from Template:Documentation on Wikia Templates.
That wiki should periodically be checked for a new version of this template.
Description
This template is used to insert documentation on template pages.
Syntax
Type <noinclude>{{documentation}}</noinclude> at the end of the template page.

General usage

On the Template page

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>

On the Template/doc page

See also Template:Documentation/preload
{{SPW|name={{subst:BASEPAGENAME}}}}
;Description
:This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}

<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.

Note that the above example also uses {{T}}.

Visit Template:Documentation/doc to change this text! (How does this work?)
Done making changes? Refresh this text! (Why?)
Retrieved from "http://wiki.jriver.com/index.php?title=Template:Documentation&oldid=10744"