Module:Message box/doc/ja
このページは、Module:Message box/doc の説明文 下位ページです。 使用法の情報、カテゴリ、言語間リンク、その他のコンテンツなど、元の Module ページの一部ではない情報を含みます。 |
このモジュールはシステム メッセージ内で使用されています。 変更すると、MediaWiki のユーザー インターフェイスがただちに変更される可能性があります。 大規模な混乱を回避するため、変更は最初にこの module の /サンドボックス または /テストケース の各下位ページ、またはあなた自身の 利用者空間 でテストする必要があります。テスト済みの変更であれば、このモジュールに一度の編集で追加できます。 いかなる変更も、実装する前にトークページで議論することをご検討ください。 |
このモジュールは一般使用可能です。 成熟した形に達しており、バグがなく、適切な場所であればどこでも使用できると考えられています。 新しい利用者が学習するための選択肢として、ヘルプページや他のリソースで言及する準備ができています。 サーバーへの負荷軽減やバグの修正を行う際は、試行錯誤しながら編集を繰り返すのではなく、サンドボックスでのテストを行ってください。 |
このモジュールはページ保護の対象です。 非常に多くのページで使用されている閲覧回数が多いモジュールです。 荒らしや編集ミスが多くのページに影響し、些細な編集でもサーバーに多大な負荷をかける可能性があることから、編集から保護されています。 |
このテンプレートはLuaを使用しています: |
This module uses TemplateStyles: |
このメタモジュールは告知ボックス用テンプレート{{mbox}}、{{ambox}}、{{cmbox}}、{{fmbox}}、{{imbox}}、{{ombox}} および {{tmbox}}を実行します。 Lua モジュール経由の利用を想定しており、ウィキページで直接使用できません。 ウィキページでこの機能を使いたい場合は、これではなく個別の告知用テンプレートを活用してください。
使用法
To use this module from another Lua module, first you need to load it.
local messageBox = require('Module:Message box')
To create a message box, use the main
function.
It takes two parameters:
- the first is the box type (as a string).
- the second is a table containing the message box parameters.
local box = messageBox.main( boxType, {
param1 = param1,
param2 = param2,
-- More parameters...
})
There are seven available box types:
Box type | テンプレート | 目的 |
---|---|---|
mbox
|
{{mbox}} | For message boxes to be used in multiple namespaces |
ambox
|
{{ambox}} | For article message boxes |
cmbox
|
{{cmbox}} | For category message boxes |
fmbox
|
{{fmbox}} | For interface message boxes |
imbox
|
{{imbox}} | For file namespace message boxes |
tmbox
|
{{tmbox}} | For talk page message boxes |
ombox
|
{{ombox}} | For message boxes in other namespaces |
See the template page of each box type for the available parameters.
Usage from #invoke
As well as the main
function, this module has separate functions for each box type.
They are accessed using the code {{#invoke:Message box|mbox|...}}
, {{#invoke:Message box|ambox|...}}
, etc.
These will work when called from other modules, but they access code used to process arguments passed from {{#invoke:...}}
, and so calling them will be less efficient than calling main
.
技術的な詳細
上記に示したそれぞれのテンプレートに対して、このモジュールは同一の基本コードを用います。それらの差異はModule:Message box/configurationのデータを用いて設定します。