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

提供: ひつじ小屋別館2代目
移動先: 案内検索
(ページの作成:「{{#ifeq: {{SUBPAGENAME}} | sandbox | <div style="clear: both;"></div>{{template sandbox notice}} | <div class="template-documentation" style="clear:both; margin:1em 0 1em...」)
 
(1版 をインポートしました)
 
(9人の利用者による、間の21版が非表示)
1行目: 1行目:
{{#ifeq: {{SUBPAGENAME}} | sandbox
+
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}<noinclude>
| <div style="clear: both;"></div>{{template sandbox notice}}
+
<!-- Categories go on the /doc subpage, and interwikis go on Wikidata. -->
| <div class="template-documentation" style="clear:both; margin:1em 0 1em 0; border:1px solid #aaa; background-color:#ecfcf4; padding:1em;"><!--styleパラメータは、本来はスタイルシートに記述するべき? …スタイルシートをどこから見つけたのか忘れてしまった。-->
+
</noinclude>
{{
 
  #if: {{{heading|解説}}}
 
  |<!-- headingがキャンセルされていない場合。
 
        headingが指定されていなければ、デフォルトの「解説」になる。
 
        {{Documentation|heading=}}のように設定することでキャンセルできる。
 
  --><div style="padding-bottom:{{{heading-padding|3px}}}; border-bottom:1px solid #aaa; margin-bottom:{{{heading-margin|1ex}}}"><span id="doc_editlinks" class="editsection plainlinks">{{
 
    #ifexist:{{{ 1 | {{Documentation/docname}} }}}
 
    |<!-- /doc がある
 
      -->[[{{
 
      fullurl:{{{ 1 | {{Documentation/docname}} }}}
 
      | action=edit
 
      }} 編集]] [{{purge|キャッシュ破棄}}]
 
    |<!-- /doc がない
 
      -->{{
 
      #if:{{{content|}}}
 
      |<!-- contentあり: 動作なし -->
 
      |<!-- contentなし
 
        -->[[{{
 
        fullurl:{{{ 1 | {{Documentation/docname}} }}}
 
        | action=edit&preload={{urlencode:{{{preload|Template:Documentation/preload}}}}}
 
        }} 作成]]
 
      }}<!-- #if:{{{content|}}} 閉じる -->
 
    }}<!-- #ifexist:{{{ 1 | {{Documentation/docname}} }}} 閉じる
 
  --></span><span style="{{{heading-style|font-size:150%}}}">{{#switch: {{SUBJECTSPACE}}
 
    | {{ns:Template}} = [[ファイル:Template-info.svg|50px|alt=]] テンプレートの解説
 
    | {{ns:File}} = 要約
 
    | #default = 解説
 
  }}</span></div><!-- ここまでheadingがキャンセルされていない場合 -->
 
  |<!-- headingがキャンセルされた場合: 動作なし -->
 
}}<!-- #if:{{{heading|解説}}} を閉じる
 
--><!--  呼び出し先とサンドボックス・テストケースの誘導に使われるdivセクション。本来はスタイルシートに記述するべき?-->
 
<div id="template_doc_page_transcluded" style="clear:both; border:none; background-color:#ecfcf4; margin:0 0 0 2em; font-style:italic; font-size:85%" ><!--
 
  呼び出し元処理の開始
 
-->{{
 
  #ifeq:{{{transcluded|show}}} | show
 
  |<!-- 呼び出し先を表示 -->{{
 
    #ifexist:{{{ 1 | {{Documentation/docname}} }}}
 
    |<!-- /doc がある場合
 
      -->この[[Help:テンプレートの説明文|解説]]は、[[{{{ 1 | {{Documentation/docname}} }}}]]<small class="plainlinks" style="font-style:normal">([{{
 
      fullurl:{{{ 1 | {{Documentation/docname}} }}}
 
      | action=edit
 
      }} 編集] &#124; [{{
 
      fullurl:{{{ 1 | {{Documentation/docname}} }}}
 
      | action=history
 
      }} 履歴])</small>から[[Help:テンプレート#テンプレートとは|呼び出されて]]います。<br />
 
    |<!-- /doc がない場合:動作なし -->
 
  }}
 
  |<!-- 呼び出し先を表示しない:動作なし -->
 
}}<!-- #ifeq:{{{transcluded|show}}} | show を閉じる。
 
--><!--
 
  サンドボックス・テストケース処理の開始
 
-->{{
 
  #switch:{{SUBPAGENAME}}
 
  |sandbox=<!-- sandbox -->
 
  |testcases=<!-- testcases -->
 
  |#default={{
 
    #switch:{{SUBJECTSPACE}}/{{{sandbox-testcases|show}}}
 
    | {{ns:template}}/show
 
    | {{ns:user}}/show = <!-- show /sandbox /testcases -->{{
 
      #ifexist:{{ #rel2abs: /sandbox }}
 
      | {{
 
        #ifexist:{{ #rel2abs: /testcases }}
 
        | <!-- /sandbox も /testcases も存在する
 
            -->このテンプレートには、[[/sandbox|サンドボックス]]<small class="plainlinks" style="font-style:normal">([{{
 
          fullurl:{{ #rel2abs: /sandbox }}
 
          | action=edit
 
          }} 編集] {{!}} [{{fullurl:Special:ComparePages | page1={{urlencode:{{FULLPAGENAME}}}}&page2={{urlencode:{{FULLPAGENAME}}/sandbox}}}} 差分])</small>と[[/testcases|テストケース]]<small class="plainlinks" style="font-style:normal">([{{
 
          fullurl:{{ #rel2abs: /testcases }}
 
          | action=edit
 
          }} 編集])</small>があります。
 
        | <!-- /sandbox は存在するが、 /testcases が存在しない
 
            -->このテンプレートには、[[/sandbox|サンドボックス]]<small class="plainlinks" style="font-style:normal">([{{
 
          fullurl:{{ #rel2abs: /sandbox }}
 
          | action=edit
 
          }} 編集] {{!}} [{{fullurl:Special:ComparePages | page1={{urlencode:{{FULLPAGENAME}}}}&page2={{urlencode:{{FULLPAGENAME}}/sandbox}}}} 差分])</small>がありますが、[[/testcases|テストケース]]はありません。
 
        }}<!-- #ifexist: {{ #rel2abs: /testcases }} を閉じる -->
 
      | {{
 
        #ifexist:{{ #rel2abs: /testcases }}
 
        | <!-- /sandbox は存在しないが /testcases が存在する
 
            -->このテンプレートには、[[/testcases|テストケース]]<small class="plainlinks" style="font-style:normal">([{{
 
          fullurl: {{ #rel2abs: /testcases }}
 
          | action=edit
 
          }} 編集])</small>がありますが、[[/sandbox|サンドボックス]]はありません。
 
        | <!-- /sandbox も /testcases も存在しない
 
            -->このテンプレートには、[[/sandbox|サンドボックス]]も[[/testcases|テストケース]]もありません。
 
        }}<!-- #ifexist:{{ #rel2abs: /testcases }} を閉じる -->
 
      }}<!-- #ifexist:{{ #rel2abs: /sandbox }} を閉じる -->([[Wikipedia:テンプレートのサンドボックスとテストケース|解説]])<br />
 
    }}<!-- #switch:{{SUBJECTSPACE}}/{{{sandbox-testcases|show}}} を閉じる-->
 
 
 
}}<!-- #switch:{{SUBPAGENAME}} を閉じる --><!--
 
  呼び出し先とサンドボックス・テストケースの誘導に使われるdivセクションを閉じる。
 
--></div><!--
 
-->{{#if:{{{content|}}} |
 
{{{content}}}
 
}}
 
{{
 
  {{ #ifexist:{{{ 1 | {{Documentation/docname}} }}}
 
  | {{{ 1 | {{Documentation/docname}} }}}
 
  | ns:0
 
  }}
 
}}<div style="clear:both" /></div>
 
}}<!-- #ifeq: {{SUBPAGENAME}} | sandbox を閉じる -->
 

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