テンプレートの書き方

From Template Wiki, a repository of MediaWiki templates.
This page is a translated version of the page Template writing and the translation is 100% complete.
Other languages:

多くの場合、テンプレートはかなり複雑で、さまざまな外部要因に依存する可能性があるため、このページでは、テンプレートを作成するためのいくつかの提案について概説します。

コード

  • テンプレートは自己完結型であり、他のテンプレートを呼び出さないようにする必要があります (どうしても必要な場合を除く)。
  • デザインにCSSの呼び出しを含むテンプレートは、そのように言及する必要があります。CSS クラスが標準として存在しない限り、通常は避けるのが最善です。
  • アイコンには、可能な限りベクター グラフィックを使用します。これらの良い情報源は、ウィキメディアコモンズのCategory:主題別のアイコン です。Mirahezeウィキはインスタントコモンズ対応です。それ以外の場合は、これらの画像をローカルにアップロードする必要があります。

使用法

  • テンプレートには、使用法と変更の説明が必要です。 他のテンプレートが必要な場合は、必要なテンプレートへのリンクとともに、この事実を明確に文書化する必要があります。
  • テンプレートは、使用説明書がなくても読みやすく理解しやすいものにする必要があります。

インプット

  • これまでで最も拡張性の高いテンプレートを作成しようとしないでください。すべてをユーザーが提供する変数にしないでください。 たとえば、ボックスの配置:配置を選択してハードコードするか、デフォルトの選択にします。

レイアウト

ドキュメンテーションサブページ (Template:templatename/doc) を使用することは標準的な方法になりましたが、実際にはドキュメンテーションが大きいか、多くの例がある場合にのみ優れています。ドキュメントの必要性が少なく、小さくてシンプルなテンプレートの場合は、テンプレートページ自体にドキュメントを含めます。ドキュメント用の /doc サブページは通常、別のテンプレートへの依存関係を自動的に追加する {{Documentation}} テンプレートを使用する必要があることを意味します。

完成していないテンプレートは、{{Template:Under construction}}経由で:Category:Underconstruction templatesに配置する必要があります。

外部リンク