Template‐ノート:Documentation

ナビゲーションに移動 検索に移動

(編集)リンク[編集]

ふと思ったのですが、サンドボックスなどへの(編集)というリンクはそのページが存在する場合だけでよいのではないでしょうか。ついでに、サンドボックスやテストケースという言葉がいきなり出てくるので、どこかにWikipedia:テンプレートのサンドボックスとテストケースへのリンクをおいたほうがよくはないでしょうか。たとえば、

このテンプレートには、サンドボックスもテストケースもありません。?

というような感じで。 --fryed-peach 2008年2月23日 (土) 08:58 (UTC)

サンドボックスに変更案をおいておきます(いじりすぎ?)。もうしばらく意見を待ちます。 --fryed-peach 2008年3月1日 (土) 11:21 (UTC)
おつかれさまです。サンドボックスに提示された変更で良いと思います。--Mizusumashi 2008年3月1日 (土) 11:30 (UTC)
反映しました。 --fryed-peach 2008年3月8日 (土) 04:44 (UTC)

英語版のテンプレート[編集]

今年に入って英語版のテンプレートの内容が大幅に更新され、呼び出してるドキュメントとサンドボックスとテンプレートのリンクが最下部に移動しました。それと同時に内部テンプレートとしてen:Template:Documentation/coreen:Template:Documentation/core2が作成されました。日本語版でも更新した方がいいでしょうか?--219.67.55.21 2010年3月5日 (金) 04:00 (UTC)

個人的には今のままのほうが好きです。呼び出しているドキュメントへのリンクはテンプレートは伝統的に最上部にありますし、サンドボックスやテストケースへのリンクを最下部に移動してしまうとサンドボックスの存在に気づかない編集者がテンプレート本体をいきなり編集して誤作動を起こしてしまうリスクが高くなると思います。--新幹線 2010年4月16日 (金) 08:57 (UTC)

sandbox との連携[編集]

英語版のテンプレートで、興味深い機能があったので、書き残します。一つ目は、/sandbox に documentation を置くと(位置はテンプレート出力の下側になるが) sandbox 用のメッセージボックスが表示されること。二つ目は、特別:ページの比較 を利用した本体と /sandbox との比較。これは先の /sandbox 用の拡張と合わせると、差分が見やすくなる。この修正を適用することで、本体と/sandbox間で複製する際、単純にコピペすることが推奨され、いくつかの手間を省くことができると期待します。--Frozen-mikan 2011年8月5日 (金) 15:09 (UTC)

いいですね。保護されいているテンプレートの編集依頼などが簡単になりそうでよいと思います。誰かやってくれないかな…。--fryed-peach [会話] 2011年8月6日 (土) 17:52 (UTC)
報告 [1] にて前述のような機能を追加しました。これでコピペ複製が出来ると思います。--Frozen-mikan 2011年10月28日 (金) 07:28 (UTC)

一部のスタイルを Common.css に転記することについて[編集]

このテンプレートは、多くのテンプレートで使われるようになりました。そろそろ、template-documentation クラスと同じ要素のスタイル群を Common.css に転記しても構わないと思いますが、いかがでしょうか。賛同が得られるようでしたら、Common.css に修正を提案する形にしたいと思っています。(なお、先ほど、padding を 5px から 1em に変更しました)--Frozen-mikan会話) 2012年3月31日 (土) 10:33 (UTC)

Template:documentation[編集]

I would like to add these updated codes please


<!--
  Automatically add {{template sandbox notice}} when on a /sandbox page.
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
| <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}}
}}<!--
  Automatically add {{pp-template}} to protected templates.
-->{{template other
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
  | {{pp-template|docusage=yes}}
  | {{#if: {{PROTECTIONLEVEL:edit}}
    | {{pp-template|docusage=yes}}
    | <!--Not protected, or only semi-move-protected-->
    }}
  }}
}}<!--
  Start of green doc box.
-->{{documentation/start box2
| preload = {{{preload|}}}   <!--Allow custom preloads-->
| heading = {{{heading|¬}}}   <!--Empty but defined means no header-->
| heading-style = {{{heading-style|}}}
| content = {{{content|}}}

<!--Some namespaces must have the /doc, /sandbox and /testcases 
    in talk space-->
| docspace = {{documentation/docspace}}

| 1 = {{{1|}}}   <!--Other docname, if fed-->

<!--The namespace is added in /start box2-->
| template page = {{documentation/template page}}

}}<!-- Start content --><!--
  Start load the /doc content:
  Note: The line breaks between this comment and the next line are necessary
  so  "=== Headings ===" at the start and end of docs are interpreted.
-->
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}}
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 
| 1111 = {{{content|}}}
| 0110 | 0111 = {{ {{{1}}} }}
| 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }}
| 0000 | 0100 | 0010 | 0101 = 
}}
<!--
  End load the /doc content:
  Note: The line breaks between this comment and the previous line are necessary
  so  "=== Headings ===" at the start and end of docs are interpreted.
-->{{documentation/end box2
| preload = {{{preload|}}}   <!--Allow custom preloads-->
| content = {{{content|}}}
| link box = {{{link box|}}}   <!--So "link box=off" works-->

<!--Some namespaces must have the /doc, /sandbox and /testcases 
    in talk space-->
| docspace = {{documentation/docspace}}

| 1 = {{{1|}}}   <!--Other docname, if fed-->

<!--The namespace is added in /end box2-->
| template page = {{documentation/template page}}

}}<!--
  End of green doc box
--><noinclude>

<!-- Add categories and interwikis to the /doc subpage, not here! -->
</noinclude>

178.239.50.146 2013年2月5日 (火) 21:56 (UTC)

Luaモジュール使用提案[編集]

Luaモジュール「モジュール:Documentation」の導入を提案します。Template:Documentation/testcasesでテストしていますが著しい不具合は確認できません。モジュールには本来テンプレート保護関連の記述({{pp-template}}が不要になります)もあるのですが、英語版と日本語版では保護の方針に違いがあり導入が現時点では困難と判断し該当部分をコメント化して動作しないようにしました。--K-iczn会話) 2015年12月10日 (木) 10:54 (UTC)

  • 賛成 モジュールの修正や翻訳など、まいどありがとうございます。テストを見る限りでは違和感は無いようです。細かい問題は出るかもしれませんが、大きな問題が出ない間は少しずつ修正をしていけば良いと思います。--Frozen-mikan会話) 2015年12月10日 (木) 16:18 (UTC)
  • ありがとうございます。一週間後ぐらいに異論が出なかったら導入したいと思います。--K-iczn会話) 2015年12月11日 (金) 01:32 (UTC)
    • チェック 導入しました。--K-iczn会話) 2015年12月18日 (金) 09:43 (UTC)

「定義の箇条書き」が正常に表示できない[編集]

Template:Company template tagline/doc#使用法の項で、定義の箇条書きが使われていますが、{{Documentation}}を通して使用すると、このように通常のスタイルが適用されなくなってしまうようです。 --WwLMvm会話) 2016年10月14日 (金) 21:55 (UTC)

報告 取り敢えず、修正してみました(差分)。--Frozen-mikan会話) 2016年10月15日 (土) 08:56 (UTC)
ありがとうございます これはもしかして、元の文書のほうに問題があったのでしょうか? --WwLMvm会話) 2016年10月15日 (土) 09:15 (UTC)
コメント「/doc」自体ではなく、それを呼び出しているテンプレートページを修正しました。テンプレートといっても <noinclude>...</noinclude> 内の事ですし、別のページにまで影響するものではないと思います。依頼場所については、一般的には問題を見つけたページのノートに書き込むのが良いと思いますが、迷うこともありますし最終的には「Wikipedia:バグの報告」でも良いと思います。--Frozen-mikan会話) 2016年10月15日 (土) 09:52 (UTC)
返信 (Frozen-mikan氏宛) わかりました。ご対応ありがとうございました。 --WwLMvm会話) 2016年10月15日 (土) 11:38 (UTC)

ttタグ[編集]

モジュールの方からttタグが出力されているのか知りませんが、廃止されたタグのソースにこのテンプレートが乗っていたので付記。 --Testment777会話) 2018年12月13日 (木) 10:35 (UTC)

保護アイコン表示機能の有効化[編集]

モジュール:Documentationにおいてコメントアウトした状態で存在する、保護アイコン表示機能を有効化することを提案します。

機能について説明しますと、{{Documentation}}を使用しているテンプレートの保護レベルを取得し、保護されていればそのテンプレートに対して{{pp-template}}に相当するインジケーターアイコンを表示し、Category:編集保護中のテンプレートなどのカテゴリを付与するというものです。保護されていなければアイコンは表示されず、カテゴリを付与することもしません。この機能の実現のためにモジュール:Protection bannerを使用します。

この機能を有効にするメリットとして、テンプレートが{{Documentation}}を使用している場合は保護した後に{{pp-template}}を貼る必要がなくなることが挙げられます。またdocページに{{pp-template}}を貼ることをやめれば、sandboxページに対してCategory:不適切な保護テンプレートのあるページが付与されることも起きなくなります。もし荒らし行為や編集合戦などを理由に一時的に保護する場合、テンプレートのページにおいて{{Documentation}}より後ろに{{pp-vandalism|small=yes}}のようなテンプレート呼び出しを挿入することで、インジケーターアイコンを上書きすることができます。

1週間待ってみて反対意見が出ないようでしたら編集作業を行います。--本日晴天会話) 2020年10月18日 (日) 03:05 (UTC)

  • チェック 保護アイコン表示機能を有効化しました。--本日晴天会話) 2020年10月25日 (日) 12:46 (UTC)