Module:Yesno/doc/ja
このページは、Module:Yesno/doc の説明文 下位ページです。 使用法の情報、カテゴリ、言語間リンク、その他のコンテンツなど、元の Module ページの一部ではない情報を含みます。 |
警告: | このページは複数のウィキ間で共有されています。 このページへのすべての変更は、左側のサイドバーに列挙されているすべてのウィキに自動的にコピーされます。 |
この Lua モジュールは、多数のページで使用されています。 大規模な崩壊や不要なサーバー負荷を回避するため、このモジュールのいかなる変更も、前もって下位ページ /サンドボックス、/テストケース、のいずれかでテストすべきです。 テスト済みの変更であれば、このページに一度の編集で追加できます。 いかなる変更も、実装する前にトーク ページで議論することをご検討ください。 |
このモジュールはシステム メッセージ内で使用されています。 変更すると、MediaWiki のユーザー インターフェイスがただちに変更される可能性があります。 大規模な混乱を回避するため、変更は最初にこの module の /サンドボックス または /テストケース の各下位ページ、またはあなた自身の 利用者空間 でテストする必要があります。テスト済みの変更であれば、このモジュールに一度の編集で追加できます。 いかなる変更も、実装する前にトークページで議論することをご検討ください。 |
このモジュールは一般使用可能です。 成熟した形に達しており、バグがなく、適切な場所であればどこでも使用できると考えられています。 新しい利用者が学習するための選択肢として、ヘルプページや他のリソースで言及する準備ができています。 サーバーへの負荷軽減やバグの修正を行う際は、試行錯誤しながら編集を繰り返すのではなく、サンドボックスでのテストを行ってください。 |
このモジュールはページ保護の対象です。 非常に多くのページで使用されている閲覧回数が多いモジュールです。 荒らしや編集ミスが多くのページに影響し、些細な編集でもサーバーに多大な負荷をかける可能性があることから、編集から保護されています。 |
このモジュールは、真偽値または真偽値スタイルの文字列入力を処理するための一貫したインターフェイスを提供します。
Lua では true
と false
の真偽値を使用できますが、ウィキコード テンプレートでは "1"、"0"、"yes"、"no" などの文字列でしか真偽値を表現できません。
このモジュールは、このような種類の文字列を処理して、Lua が処理できる真偽値の入力に変えます。
また、nil
の値を nil
として返すことで、nil
と false
の区別ができるようにします。
このモジュールは、真偽値、数値、テーブル、関数など、他の Lua 構造も入力として受け付けます。
If it is passed input that it does not recognise as boolean or nil
, it is possible to specify a default value to return.
Module Quality
- Diff sandbox code
構文
yesno(value, default)
value
is the value to be tested.
Boolean input or boolean-style input (see below) always evaluates to either true
or false
, and nil
always evaluates to nil
.
Other values evaluate to default
.
使用法
First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages. For normal wiki pages you can use {{yesno}} instead.
local yesno = require('Module:Yesno')
Some input values always return true
, and some always return false
.
nil
values always return nil
.
-- These always return true:
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)
-- These always return false:
yesno('no')
yesno('n')
yesno('false')
yesno('f')
yesno('0')
yesno(0)
yesno(false)
-- A nil value always returns nil:
yesno(nil)
String values are converted to lower case before they are matched:
-- These always return true:
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')
-- These always return false:
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')
You can specify a default value if yesno
receives input other than that listed above.
If you don't supply a default, the module will return nil
for these inputs.
-- These return nil:
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)
-- These return true:
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return 'This is a function.' end, true)
-- These return "bar":
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return 'This is a function.' end, 'bar')
Note that the blank string also functions this way:
yesno('') -- Returns nil.
yesno('', true) -- Returns true.
yesno('', 'bar') -- Returns "bar".
Although the blank string usually evaluates to false
in wikitext, it evaluates to true
in Lua.
This module prefers the Lua behaviour over the wikitext behaviour.
If treating the blank string as false
is important for your module, you will need to remove blank arguments at an earlier stage of processing.