Difference between revisions of "Template:Doc"

From Grand Theft Wiki
Jump to: navigation, search
(Added a comment about updating Template:Doc-1-argument)
m (changed comment)
Line 1: Line 1:
 
<div style="border:1px solid #8A8; padding:5px; background-color:#F3FFF3; clear:both; margin:10px;">
 
<div style="border:1px solid #8A8; padding:5px; background-color:#F3FFF3; clear:both; margin:10px;">
 
:''This documentation is imported from [[{{FULLPAGENAME}}/doc]]''
 
:''This documentation is imported from [[{{FULLPAGENAME}}/doc]]''
{{/doc}}</div><noinclude><!-- When editing this template, please update Template:Doc-1-argument accordingly as well. --></noinclude>
+
{{/doc}}</div><noinclude><!-- When editing this template, please update Template:Doc-1-parameter accordingly as well. --></noinclude>

Revision as of 17:28, 7 June 2010

This documentation is imported from Template:Doc/doc

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.