「テンプレート:Documentation」の版間の差分

提供: ひつじ小屋別館2代目
移動先: 案内検索
(1 revision imported from w:en:Template:Documentation)
(1版 をインポートしました)
 
(相違点なし)

2016年7月24日 (日) 00:26時点における最新版

Documentation icon Template documentation[view] [edit] [history] [purge]

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[編集]

<noinclude>{{documentation}}<noinclude>

or

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

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.

Add categories and interwiki links to the documentation page inside includeonly tags.

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[編集]

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).

See also[編集]

Language: English  • 日本語
en:Template:Documentation

eo:Ŝablono:Dok es:Plantilla:Uso de plantilla fr:Modèle:Documentation hsb:Předłoha:Doc hu:Sablon:Sablondokumentáció ko:틀:틀 설명문서 nl:Sjabloon:Sjabdoc ru:Шаблон:Doc pl:Szablon:Dokumentacja sl:Predloga:Dokumentacija uk:Шаблон:Документація zh:Template:Documentation