Module:Yesno/doc/ja

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Module:Yesno/doc and the translation is 15% complete.
Other languages:
warning 警告This page is shared between multiple wikis.
All changes to this page will be automatically copied to all wikis listed in the left side bar.

このモジュールは、真偽値または真偽値スタイルの文字列入力を処理するための一貫したインターフェイスを提供します。 Lua では truefalse の真偽値を使用できますが、ウィキコード テンプレートでは "1"、"0"、"yes"、"no" などの文字列でしか真偽値を表現できません。 このモジュールは、このような種類の文字列を処理して、Lua が処理できる真偽値の入力に変えます。 また、nil の値を nil として返すことで、nilfalse の区別ができるようにします。 このモジュールは、真偽値、数値、テーブル、関数など、他の 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

Syntax

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.

Usage

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.