モジュール:Catmain/doc

このモジュールは、「このカテゴリの主記事は「○○」です。」という定型のハットノートを生成する{{catmain}}テンプレートを実装します。

ウィキテキストから使用する

このモジュールは通常、{{catmain}}テンプレートを通して使用されます。しかし、{{#invoke:Cat main|catMain|parameters}}という構文で#invokeから使用することも可能です。利用可能な引数については、{{catmain}}テンプレートの説明ページをご覧ください。

他のLuaモジュールから使用する

モジュールをロードするには、

local mCatMain = require('Module:Catmain')

と入力します。

続いて、以下のように _catMain 関数を使用することができます。

mCatMain._catMain(options, ...)

options は、関数の出力を設定するために使用可能なオプションのテーブルです。利用可能なオプションは "article" と "selfref" の2つが用意されています。

• article - これが "no", "n", "false", または 0 に設定されている場合、モジュールは「主記事」の代わりに「主ページ」を出力します。{article = false}というコードを使用してください。
• selfref - これは、出力がウィキペディアに対する自己言及である場合に使用されます。このオプションを設定するには、{selfref = true}を使用してください。自己言及に関して、より詳しくは{{selfref}}テンプレートをご覧ください。

残りの引数は、「このカテゴリの主記事は「○○」です。」というテキストの「○○」の部分に入る、リンクとなるページ名です。ページ名が指定されない場合、現在のページ名（から名前空間名を除いたもの）が第1のリンクに使用されます。

使用例1

mCatMain._catMain(nil, 'Foo')

上記のコードは下記のテキストを生成し、

<div class="hatnote relarticle mainarticle">この[[Help:カテゴリ|カテゴリ]]の主記事は「'''[[Foo]]'''」です。</div>

次のように表示されます:

このカテゴリの主記事は「Foo」です。

使用例2

mCatMain._catMain(nil, 'Foo', 'Bar', 'Baz')

上記のコードは下記のテキストを生成し、

<div class="hatnote relarticle mainarticle">この[[Help:カテゴリ|カテゴリ]]の主記事は「'''[[Foo]]'''、'''[[Bar]]''' および '''[[Baz]]'''」です。</div>

次のように表示されます:

このカテゴリの主記事は「Foo、Bar および Baz」です。

使用例3

mCatMain._catMain({article = false}, 'Foo')

上記のコードは下記のテキストを生成し、

<div class="hatnote relarticle mainarticle">この[[Help:カテゴリ|カテゴリ]]の主ページは「'''[[Foo]]'''」です。</div>

次のように表示されます:

このカテゴリの主ページは「Foo」です。

技術的詳細

このモジュールは、ハットノートのテキストを形式化するためにModule:Hatnoteを使用します。