モジュール:Shortcut/doc

これはモジュール:Shortcutの解説サブページです。
使用方法、カテゴリ、およびその他モジュールページ自体に含まれない情報を収容しています。

このモジュールは保護されています。このモジュールは非常に多くのページで使用されています。荒らしまたは過失によって多くのページが影響を受け、また些細な編集でもサーバーに多大な負荷をかけるため、編集保護されています。

このLuaモジュールは多くのページで使われています。
余計な混乱やサーバーへの負荷を避けるために、どんな変更でも最初はモジュールのサンドボックス・サブページ、テストケース・サブページで試すべきです。そうすれば、試した変更を1度の編集でこのモジュールに加えることができます。しかし、最初にあなたの提案した変更を、この項目のノートで議論するようにお願いします。

Luaモジュールを使用しています:

このモジュールはテンプレートスタイルを使用しています:

Module:Shortcut/styles.css

このモジュールは特定のページへのショートカットリンクを表示するボックスを生成します。

使用法

ウィキテキストから

ウィキテキストからは、通常はテンプレート{{shortcut}}を介してこのモジュールを呼び出す必要があります。詳細はテンプレートページを参照してください。ただし、以下のような構文を使用して呼び出すこともできます: {{#invoke:shortcut|main|arguments}}.

Luaから

Lua からこのモジュールを使用するには、まずロードしてください。

local mShortcut = require('Module:Shortcut')

すろと、以下の構文でショートカットボックスを生成できます:

mShortcut._main(shortcuts, options, frame, cfg)

shortcuts - ショートカットページ名の配列（必須）
options - オプションのテーブル。キー:
- msg - ショートカットリストの下に配置するメッセージ。
- category - falseに設定されている場合（またはModule:Yesnoでfalseと見なされる値、例えば"no"）カテゴリを追加しません。
frame - フレームオブジェクト。内部でのみ使用。
cfg - コンフィグ値のテーブル。テストにのみ使用。

技術的詳細

このモジュールにはModule:Shortcut/configというコンフィグファイルがあります。このファイルを使用して、モジュールを他の言語に翻訳したり、カテゴリ名などの詳細を変更したりすることができます。