Mall:Documentation/doc: Skillnad mellan sidversioner

mIngen redigeringssammanfattning
mIngen redigeringssammanfattning
 
(8 mellanliggande sidversioner av samma användare visas inte)
Rad 4: Rad 4:


=== Normal /doc  ===
=== Normal /doc  ===
 
<pre>&lt;noinclude&gt;{{Documentation}}&lt;/noinclude&gt;</pre>
<noinclude>{{{{{template-name|Documentation}}}}}</noinclude>


=== Any /doc page  ===
=== Any /doc page  ===


&lt;noinclude&gt;{{{{{template-name|Documentation}}}|Template:any page/doc}}&lt;/noinclude&gt;
<pre> &lt;noinclude&gt;{{Documentation|Template:any page/doc}}&lt;/noinclude&gt;</pre>


=== In-line content  ===
=== In-line content  ===
 
<pre> &lt;noinclude&gt;{{Documentation|content=This is documentation.}}&lt;/noinclude&gt;</pre>
&lt;noinclude&gt;{{{{{template-name|Documentation}}}|content=This is documentation.}}&lt;/noinclude&gt;


=== In-line content with [view][edit] links  ===
=== In-line content with [view][edit] links  ===
 
<pre> &lt;noinclude&gt;{{Documentation
&lt;noinclude&gt;{{{{{template-name|Documentation}}}
  |1 = Template:any page/doc
  |1 = Template:any page/doc
  |content ={{Template:any page/doc|parameters}}
  |content ={{Template:any page/doc|parameters}}
  }}&lt;/noinclude&gt;
  }}&lt;/noinclude&gt;</pre>


=== Best practice  ===
=== Best practice  ===
Rad 34: Rad 31:
Overrides exist to customize the output in special cases:  
Overrides exist to customize the output in special cases:  


*<code>{{documentation| '''heading''' = ...}}</code> − 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.
*<pre>{{documentation| heading = ...}}</pre> − 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  ==
== Functions  ==
Rad 50: Rad 47:


<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Template documentation| ]]
[[Category:Mallar dokumentation| ]]
</includeonly>
</includeonly>

Nuvarande version från 12 juni 2013 kl. 02.12

<img class="FCK__MWIncludeonly" src="https://familysearch.org/learn/wiki/sv/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" _fckfakelement="true" _fckrealelement="8" _fck_mw_includeonly="true">

[[Kategori:Mall dokumentation<img class="FCK__MWNoinclude" src="https://familysearch.org/learn/wiki/sv/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" _fckfakelement="true" _fckrealelement="7" _fck_mw_noinclude="true">]]<img class="FCK__MWIncludeonly" src="https://familysearch.org/learn/wiki/sv/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" _fckfakelement="true" _fckrealelement="6" _fck_mw_includeonly="true"><img class="FCK__MWNoinclude" src="https://familysearch.org/learn/wiki/sv/extensions/FCKeditor/fckeditor/editor/images/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

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

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.

See also

  • {{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.