モジュール:Userbox/docのソースを表示

{{使用箇所の多いテンプレート|11,000以上}}
{{Lua|モジュール:Category handler|モジュール:Arguments|モジュール:Color contrast}}
このモジュールはユーザーボックステンプレート（{{tl|Userbox}}、{{tl|Userbox-2}}、{{tl|Userbox-r}}）を実装します。

{| class="wikitable"
|-
! テンプレート
! 説明
! 例示
|-
| {{tl|Userbox}}
| ID記号の入る枠を左側に配置するか、使用しない場合。
| {{Userbox|id=id}}
{{Clear}}
{{Userbox}}
|-
| {{tl|Userbox-2}}
| ID記号の入る枠を両側に配置する場合。
| {{Userbox-2}}
|-
| {{tl|Userbox-r}}
| ID記号の入る枠を右側に配置する場合。
| {{Userbox-r}}
|}

各テンプレートの使い方はそれぞれの解説文ページを参照してください。Luaから本モジュールを呼び出して、ユーザーボックスを直接生成する場合は読み進めてください。

== Luaからユーザーボックスを生成する場合 ==
Luaからユーザーボックスを生成する場合、まずモジュールを読み込みます。

<syntaxhighlight lang="lua">
local userbox = require('Module:Userbox')
</syntaxhighlight>

続いて、下記のように呼び出します。

<syntaxhighlight lang="lua">
userbox.main(functionName, args)
</syntaxhighlight>

<code>functionName</code>引数は"<code>_userbox</code>"が{{tl|Userbox}}と、"<code>_userbox-2</code>"が{{tl|Userbox-2}}と、"<code>_userbox-r</code>"が{{tl|Userbox-r}}と同等の出力になります。<code>args</code>引数は各ユーザーボックス関数に渡す引数のテーブルであり、渡せる引数については各テンプレートの解説文を参照してください。

== 追跡カテゴリ ==
* {{clc|配色のコントラスト比が低すぎるユーザーボックス}} - 配色のコントラスト比が4.5未満か、配色の引数に誤りがある場合
* {{clc|誤った名前空間にテンプレートのあるページ}} - 標準名前空間で使用した場合
<includeonly>{{sandbox other||
<!-- カテゴリは以下に追加してください -->
[[カテゴリ:ウィキペディアのモジュール]]<!-- 適切なサブカテゴリに張り替えてください -->
}}</includeonly>