Mall:Documentation/doc
<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">
|
|
Detta är en dokumentations undersida för Mall:Documentation (se den sidan för mall själv). Den innehåller användningsinformation, kategorier och annat innehåll som inte är en del av ursprunglig mall sida. |
[[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>
fmbox-systemfckLR
" style=" background-color: #ecfcf4; ">
| {{{textstyle|}}}"> Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |
<img class="FCK__MWIncludeonly" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" _fckfakelement="true" _fckrealelement="15" _fck_mw_includeonly="true"></noinclude>
Any /doc page
<noinclude>
fmbox-systemfckLR
" style=" background-color: #ecfcf4; ">
| {{{textstyle|}}}"> Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Subpages of this template. |
<img class="FCK__MWIncludeonly" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" _fckfakelement="true" _fckrealelement="15" _fck_mw_includeonly="true"></noinclude>
In-line content
<noinclude>
This is documentation.
fmbox-systemfckLR
" style=" background-color: #ecfcf4; ">
| {{{textstyle|}}}"> Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Subpages of this template. |
<img class="FCK__MWIncludeonly" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" _fckfakelement="true" _fckrealelement="15" _fck_mw_includeonly="true"></noinclude>
In-line content with [view][edit] links
<noinclude>
fmbox-systemfckLR
" style=" background-color: #ecfcf4; ">
| {{{textstyle|}}}"> Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Subpages of this template. |
<img class="FCK__MWIncludeonly" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" _fckfakelement="true" _fckrealelement="15" _fck_mw_includeonly="true"></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 "<".
Customizing display
Overrides exist to customize the output in special cases:
- fmbox-systemfckLR[create]
Template documentation
" style="
background-color: #ecfcf4;
">
{{{textstyle|}}}"> Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.
<img class="FCK__MWIncludeonly" src="https://www.familysearch.org/learn/wiki/en/extensions/FCKeditor/fckeditor/editor/images/spacer.gif" _fckfakelement="true" _fckrealelement="15" _fck_mw_includeonly="true"> − 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.