Difference between revisions of "Template:Documentation"
From JRiverWiki
(whoops, that should be the main module, not the sandbox...) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
| − | {{# | + | <div style="clear: both; border: 1px solid black; margin: 1em;"> |
| − | <! | + | <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> |
| − | </ | + | <div style="padding: 1em; padding-bottom: 0; margin: 0;">{{ |
| + | #if: {{{content|}}} | ||
| + | | <nowiki/> | ||
| + | {{{content}}} | ||
| + | | {{ | ||
| + | #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }} | ||
| + | | {{tocright}}{{{{ | ||
| + | #ifeq: {{NAMESPACE}} | {{ns:Template}} | ||
| + | || :{{NAMESPACE:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}} }}}}: | ||
| + | }}{{ #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> | ||
| + | <div style="clear: both; background: #ddd; color: #111; padding: 0.5em; margin: 0; font-size: 85%; text-align: right;">{{ | ||
| + | #if: {{{content|}}} | ||
| + | | [{{fullurl:{{FULLPAGENAMEE}}|action=edit}} Edit this page] | ||
| + | | Visit {{ | ||
| + | #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }} | ||
| + | | [[{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]] | ||
| + | | [{{fullurl:{{ #if: {{{1|}}} | {{ urlencode: {{{1}}} }} | {{FULLPAGENAMEE}}/doc }}|action=edit&preload=Template:Documentation/preload}} {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}] | ||
| + | }} | ||
| + | }} 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> | ||
| + | </div> | ||
Revision as of 00:12, 11 April 2014
 | This 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?)
Done making changes? Refresh this text! (Why?)
