モジュール:Userbox/doc
このページは、モジュール:Userboxの説明文を記述するページです。
このLuaモジュールは11,000以上のページで使われています。 余計な混乱やサーバーへの負荷を避けるために、どんな変更でも最初はモジュールのサンドボックス・サブページ、テストケース・サブページで試すべきです。そうすれば、試した変更を1度の編集でこのモジュールに加えることができます。しかし、最初にあなたの提案した変更を、この項目のノートで議論するようにお願いします。 |
Luaモジュールを使用しています: |
このモジュールはユーザーボックステンプレート({{Userbox}}、{{Userbox-2}}、{{Userbox-r}})を実装します。
テンプレート | 説明 | 例示 | |||
---|---|---|---|---|---|
{{Userbox}} | ID記号の入る枠を左側に配置するか、使用しない場合。 |
| |||
{{Userbox-2}} | ID記号の入る枠を両側に配置する場合。 |
| |||
{{Userbox-r}} | ID記号の入る枠を右側に配置する場合。 | テンプレート:Userbox-r |
各テンプレートの使い方はそれぞれの解説文ページを参照してください。Luaから本モジュールを呼び出して、ユーザーボックスを直接生成する場合は読み進めてください。
Luaからユーザーボックスを生成する場合
Luaからユーザーボックスを生成する場合、まずモジュールを読み込みます。
local userbox = require('Module:Userbox')
続いて、下記のように呼び出します。
userbox.main(functionName, args)
functionName
引数は"_userbox
"が{{Userbox}}と、"_userbox-2
"が{{Userbox-2}}と、"_userbox-r
"が{{Userbox-r}}と同等の出力になります。args
引数は各ユーザーボックス関数に渡す引数のテーブルであり、渡せる引数については各テンプレートの解説文を参照してください。
追跡カテゴリ
- テンプレート:Clc - 配色のコントラスト比が4.5未満か、配色の引数に誤りがある場合
- テンプレート:Clc - 標準名前空間で使用した場合