Template:Module rating
このテンプレートは、Luaモジュールのレーティング(状態)を表示するために用いられます。 モジュールの/docサブページの一番上に配置されるものです。 そのページのレーティングについてユーザーに知らせるメッセージを表示し、またモジュールを追跡カテゴリに分類させる機能を持ちます。
使用法
基礎的な使用法:
{{module rating|rating}}
カテゴリに分類させない使用法:
{{module rating|rating|nocat=true}}
{{Module rating}}がモジュール名前空間の外で使用されている場合、このようなエラーメッセージが表示されます。エラー: {{Module rating }}はModule名前空間で使用しなければなりません。
レーティング
レーティングは最初のパラメーターに指定します。 pre-alpha、alpha、beta、release および protectedという5種類のレーティングがあります。 また、各レーティングには短縮した書き方(別名)が存在します。
レーティング | 別名 | 結果 | ||
---|---|---|---|---|
pre-alpha
|
prealpha pa
|
| ||
alpha
|
a
|
| ||
beta
|
b
|
| ||
release
|
r general g
|
| ||
protected
|
protect p
|
| ||
その他、もしくは指定されていない場合 |
|
TemplateData
これは、ビジュアルエディターまたは他のツールで使用される、このテンプレート向けのテンプレートデータ説明文です。
Module rating
This template is used to rate Lua modules by quality. It is placed at the top of the module's /doc subpage. It produces a message informing users about the rating system, and it also places the module into a tracking category.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Rating | 1 | One of pre-alpha, alpha, beta or release for quality, or protected, or an approved (see full docs) abbreviation for one of these.
| String | required |
Do not categorize | nocat | Set to true to disable categorization by rating. Normally leave blank.
| Boolean | optional |
Fake namespace | demospace | Set to module to force template to display outside that namespace. Demonstration purposes only.
| String | optional |
カテゴリ
このテンプレートは、指定されたレーティングに従って、以下のカテゴリのいずれかにモジュールを分類します。
- Category:Modules in pre-alpha development
- Category:Modules in alpha
- Category:Modules in beta
- Category:Modules for general use
- Category:Modules subject to page protection
なお、/docで終わるページではカテゴリに分類されません。
カテゴリに分類させたくない場合は、|nocat=true
というコードを用いてください。
関連項目
- {{Module-rating categories }}
- Lua
- {{Lua }}