モジュール:Userbox/doc

このページは、モジュール:Userboxの説明文を記述するページです。

このモジュールはユーザーボックステンプレート({{Userbox}}、{{Userbox-2}}、{{Userbox-r}})を実装します。

テンプレート 説明 例示
{{Userbox}} ID記号の入る枠を左側に配置するか、使用しない場合。
id{{{info}}}

テンプレート:Clear

{{{info}}}
{{Userbox-2}} ID記号の入る枠を両側に配置する場合。
id1{{{info}}}id2
{{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引数は各ユーザーボックス関数に渡す引数のテーブルであり、渡せる引数については各テンプレートの解説文を参照してください。

追跡カテゴリ