Module:Yesno/doc/ja

This page is a translated version of the page Module:Yesno/doc and the translation is 97% complete.

このページは、Module:Yesno/doc の説明文下位ページです。
使用法の情報、カテゴリ、言語間リンク、その他のコンテンツなど、元の Module ページの一部ではない情報を含みます。

この Lua モジュールは、多数のページで使用されています。

大規模な崩壊や不要なサーバー負荷を回避するため、このモジュールのいかなる変更も、前もって下位ページ /サンドボックス、/テストケース、のいずれかでテストすべきです。テスト済みの変更であれば、このページに一度の編集で追加できます。

いかなる変更も、実装する前にトークページで議論することをご検討ください。

このモジュールはシステムメッセージ内で使用されています。
変更すると、MediaWiki のユーザーインターフェイスがただちに変更される可能性があります。大規模な混乱を回避するため、変更は最初にこの module の /サンドボックスまたは /テストケースの各下位ページ、またはあなた自身の利用者空間でテストする必要があります。テスト済みの変更であれば、このモジュールに一度の編集で追加できます。いかなる変更も、実装する前にトークページで議論することをご検討ください。

このモジュールは一般使用可能です。成熟した形に達しており、バグがなく、適切な場所であればどこでも使用できると考えられています。新しい利用者が学習するための選択肢として、ヘルプページや他のリソースで言及する準備ができています。サーバーへの負荷軽減やバグの修正を行う際は、試行錯誤しながら編集を繰り返すのではなく、サンドボックスでのテストを行ってください。

このモジュールはページ保護の対象です。非常に多くのページで使用されている閲覧回数が多いモジュールです。荒らしや編集ミスが多くのページに影響し、些細な編集でもサーバーに多大な負荷をかける可能性があることから、編集から保護されています。

このモジュールは、真偽値または真偽値スタイルの文字列入力を処理するための一貫したインターフェイスを提供します。 Lua では true と false の真偽値を使用できますが、ウィキコードテンプレートでは "1"、"0"、"yes"、"no" などの文字列でしか真偽値を表現できません。このモジュールは、このような種類の文字列を処理して、Lua が処理できる真偽値の入力に変えます。また、nil の値を nil として返すことで、nil と false の区別ができるようにします。このモジュールは、真偽値、数値、テーブル、関数など、他の Lua 構造も入力として受け付けます。真偽値または nil と認識できない入力が渡された場合、返す既定値を指定できます。

モジュールの品質

Diff sandbox code

構文

yesno(value, default)

value はテスト対象の値です。真偽値または真偽値スタイルの入力 (下記参照) は常に true か false に評価され、nil は常に nil に評価されます。その他の値は default に評価されます。

使用法

First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages. 通常のウィキページでは、代わりに {{yesno}} を使用できます。

local yesno = require('Module:Yesno')

一部の入力値は常に true を返し、一部は常に false を返します。 nil 値は常に nil を返します。

-- これらは常に true を返します:
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)

-- これらは常に false を返します:
yesno('no')
yesno('n')
yesno('false')
yesno('f')
yesno('0')
yesno(0)
yesno(false)

-- nil 値は常に nil を返します:
yesno(nil)

文字列値は照合される前に小文字に変換されます:

-- これらは常に true を返します:
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')

-- これらは常に false を返します:
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')

yesno が上記以外の入力を受け取った場合、既定値を指定できます。既定値を指定しない場合、モジュールはこれらの入力に対して nil を返します。

-- これらは nil を返します:
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)

-- これらは true を返します:
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return 'This is a function.' end, true)

-- これらは "bar" を返します:
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return 'This is a function.' end, 'bar')

空文字列も同様に動作することに注意してください:

yesno('')        -- nil を返します。
yesno('', true)  -- true を返します。
yesno('', 'bar') -- "bar" を返します。

空文字列は通常ウィキテキストでは false に評価されますが、Lua では true に評価されます。このモジュールはウィキテキストの挙動よりも Lua の挙動を優先します。空文字列を false として扱うことがモジュールにとって重要な場合は、処理の早い段階で空の引数を除去する必要があります。