För att be om redigering av rättigheter på Wiki, klicka här.

Mall:Documentation

Från FamilySearch Wiki
Hoppa till navigering Hoppa till sök
[view] [edit] [history] [purge] Documentation icon Template documentation

<img class="FCK__MWIncludeonly" src="spacer.gif" _fckfakelement="true" _fckrealelement="8" _fck_mw_includeonly="true">Mall:Mbox[[Kategori:Mall dokumentation<img class="FCK__MWNoinclude" src="spacer.gif" _fckfakelement="true" _fckrealelement="7" _fck_mw_noinclude="true">]]<img class="FCK__MWIncludeonly" src="spacer.gif" _fckfakelement="true" _fckrealelement="6" _fck_mw_includeonly="true"><img class="FCK__MWNoinclude" src="spacer.gif" _fckfakelement="true" _fckrealelement="5" _fck_mw_noinclude="true"> 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[redigera wikitext]

Normal /doc[redigera wikitext]

<noinclude>{{Documentation}}</noinclude>

Any /doc page[redigera wikitext]

 <noinclude>{{Documentation|Template:any page/doc}}</noinclude>

In-line content[redigera wikitext]

 <noinclude>{{Documentation|content=This is documentation.}}</noinclude>

In-line content with [view][edit] links[redigera wikitext]

 <noinclude>{{Documentation
 |1 = Template:any page/doc
 |content ={{Template:any page/doc|parameters}}
 }}</noinclude>

Best practice[redigera wikitext]

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 RTENOTITLE.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

Customizing display[redigera wikitext]

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[redigera wikitext]

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[redigera wikitext]

Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

See also[redigera wikitext]

  • {{documentation}} – Placed on templates and other pages to document them.
  • {{documentation subpage}} – Used at the top of /doc subpages to explain what they are and to link back to the page they document.
    fmbox-systemfckLR

" style=" background-color: #ecfcf4; ">