Template:Documentation: Difference between revisions

Latest revision as of 11:28, 29 January 2012

Template documentation (for the above template, sometimes hidden or invisible)

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>

A simple and inletligent point, well made. Thanks!

Visit Template:Documentation/doc to edit this text! (How does this work?)
Done editing it? Refresh this page! (Why?)

@@ Line 1: / Line 1: @@
-<div class="template-documentation"><!--
+<div style="clear: both; border: 1px solid black; margin: 1em; margin-top: 3em;">
+  <div style="background: #ddd; color: #111; padding: 1em; margin: 0em;">'''Template documentation''' <span style="font-size: 85%;">(for the above template, sometimes hidden or invisible)</span></div>
-These are the literal class definitions in common.css:
+   <div style="padding: 1em; padding-bottom: 0em; margin: 0em;">{{
+    #if: {{{content|}}}
-/* For template documentation */
+    | {{{content}}}
-.template-documentation {
+     | {{
-    clear: both;
+      #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}
-    margin: 1em 0 0 0;
+      | {{tocright}}{{{{
-    border: 1px solid #aaa;
+        #ifeq: {{NAMESPACE}} | {{ns:Template}}
-    background-color: #ecfcf4;
+        || :{{NAMESPACE:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}} }}}}:
-    padding: 5px;
+      }}{{ #if: {{{1|}}} | {{PAGENAME:{{{1}}}}} | {{PAGENAME}}/doc}} }}
-}
+      | :<strong class="error">This template currently doesn't have any documentation!</strong> Help out by [{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} writing some]. {{
+        #ifeq: {{NAMESPACE}} | {{ns:10}}
+        | There may also be documentation on [[w:c:templates:{{FULLPAGENAME}}/doc|Wikia Templates]] which can be copied.
- -->{{#ifeq:{{{heading|μ}}}|<!--**DEFINED BUT EMPTY**-->
+      }}[[Category:Templates without documentation]]
-  |<!--**NOTHING**-->
+    }}
-   |<div style="padding-bottom:3px; border-bottom: 1px solid #aaa; margin-bottom:1ex">{{#ifeq:{{{content|μ}}}|μ
+  }}
-   |<span class="editsection plainlinks" id="doc_editlinks">{{#ifexist: {{{1|{{Documentation/docname}}}}}
+  </div>
-     |<!--**    /doc EXISTS**   -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]]
+  <div style="clear: both; background: #ddd; color: #111; padding: 0.5em; margin: 0em; font-size: 85%; text-align: right;">Visit {{
-    |<!--**/doc DOESN'T EXIST**-->[[{{fullurl:{{{1|{{Documentation/docname }}}}}|action=edit&preload=Template:Documentation/preload}} create]]
+    #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}
-   }}</span>
+    | [[{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]]
-  }} <span style="{{#if:{{{heading-style|}}}|{{{heading-style}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|font-weight: bold; font-size: 125%|font-size: 150%}}}}">{{#if:{{{heading|}}}|{{{heading}}}|{{#ifeq:{{NAMESPACE}}|{{ns:template}}|[[Image:Template-info.svg|50px]] Template documentation|Documentation}}}}</span></div>
+    | [{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]
- }}<!--
+  }} to edit this text! ([[Template:Documentation|How does this work]]?)<br />Done editing it? [{{fullurl:{{FULLPAGENAME}}|action=purge}} Refresh] this page! ([[Help:Purge|Why?]])</div>
+</div>
- --><div id="template_doc_page_transcluded" class="dablink plainlinks"><!--
-  -->{{#ifexist: {{{1|{{Documentation/docname}}}}}
-  |<!--**/doc EXISTS**-->This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style: normal">([{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] &#124; [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])</small><br />
- }}<!--
- -->{{#switch: {{SUBPAGENAME}}
-   |sandbox|testcases=<!--**DO NOT SHOW THESE LINKS ON THE SANDBOX/TESTCASES PAGES**-->
-   |#default=
-    {{#switch: {{SUBJECTSPACE}}
-     |{{ns:template}}
-     |{{ns:user}}=
-      {{#ifexist: {{FULLPAGENAME}}/sandbox
-       |This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /sandbox }}|action=edit}} edit])</small> <!--
-        -->{{#ifexist: {{FULLPAGENAME}}/testcases
-         |and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>}} for editors to experiment.
-       |{{#ifexist: {{FULLPAGENAME}}/testcases
-        |This template has [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small> for editors to experiment.}}
- }}}}}}
- </div>
-{{#if:{{{content|}}}|{{{content}}}|{{#ifexist:{{{1|{{Documentation/docname}}}}} | {{ {{{1|{{Documentation/docname}}}}} }} }}}}
-</div><noinclude>
-{{pp-template|small=yes}}
-<!-- Add categories and interwikis to the /doc subpage, not here! -->
-</noinclude>