This is a documentation subpage for Module:Yesno/doc. It contains usage information, categories and other content that is not part of the original Module page.

Aviso:

Esta página é compartilhada entre múltiplas wikis. Todas as modificações a esta página serão automaticamente copiadas para todas as wikis listadas na barra lateral esquerda.

This Lua module is used on many pages. To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them.

This module is used in system messages. Changes to it can cause immediate changes to the MediaWiki user interface. To avoid large-scale disruption, any changes should first be tested in this module's /sandbox or /testcases subpage, or in your own user space.The tested changes can then be added in one single edit to this module. Please discuss any changes on the talk page before implementing them.

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

Este módulo fornece uma interface consistente para o processamento de booliano e da entrada de string ao estilo de boolinao. Enquanto Lua permite os valores boolianos true e false, os modelos do código wiki só podem expressar os valores boolianos através de strings, tais como "1", "0", "yes", "no", etc. Este módulo processa estes tipos de strings e transforma-as numa entrada booliana para Lua processar. Este também devolve valores nil como nil, para permitir distinções entre nil e false. Este módulo aceita outras estruturas de Lua como entrada, por exemplo, boolianos, números, tabelas, e funções. Se for passada uma entrada que não reconhece como booliano ou nil, é possível especificar um valor predefinido para devolver.

Qualidade do Módulo

• Diff sandbox code

Sintaxe

yesno(value, default)

value é o valor a ser testado. A entrada booliana ou entrada no estilo booliano (veja em baixo) aponta sempre para true ou false, e nil aponta sempre para nil. Outros valores apontam para default.

Utilização

Primeiro, carregue o módulo. Note que este só pode ser carregado de outros módulos de Lua, não das páginas wiki normais. Em vez disso, para as páginas wiki normais pode utilizar {{yesno}}.

local yesno = require('Module:Yesno')

Alguns valores de entrada devolvem sempre true, e alguns devolvem sempre false. Valores nil devolvem sempre nil.

-- Estes devolvem sempre true:
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)

-- Estes devolvem sempre false:
yesno('no')
yesno('n')
yesno('false')
yesno('f')
yesno('0')
yesno(0)
yesno(false)

-- Um valor nil devolve sempre nil:
yesno(nil)

Os valores da string são convertidos para letras minúsculas antes de serem correspondidas:

-- Estes devolvem sempre true:
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')

-- Estes devolvem sempre false:
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')

Pode especificar um valor predefinido se yesno recebe entrada diferente da listada em cima. Se não fornecer uma predefinição , o módulo devolverá nil para essas entradas.

-- Estes devolvem nil:
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)

-- Estes devolvem true:
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return 'This is a function.' end, true)

-- Estes devolvem "bar":
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return 'This is a function.' end, 'bar')

NOTE que UMA string em branco também funciona desta forma:

yesno('')        -- Devolve nil.
yesno('', true)  -- Devolve true.
yesno('', 'bar') -- Devolve "bar".

Embora a string em branco geralmente seja apontada para false no texto wiki, ela é apontada para true na Lua. Este módulo prefere o comportamento de Lua ao comportamento do texto wiki. Se tratar a string em branco como false é importante para o seu módulo, terá de remover os argumentos em branco numa fase anterior do processamento. Category:Module documentation pages/pt