Módulo:Yesno/doc: diferenças entre revisões

 

== Sintaxe ==

 

<code>valor</code> é o valor a ser testado. Entradas booleanas ou de tipo booleano (ver abaixo) são sempre avaliadas como <code>true</code> ou <code>false</code>, e valores <code>nil</code> sempre são avaliados como <code>nil</code>. Outros valores são avaliados como <code>padrão</code>.

Primeiro, carrega-se o módulo. Note que só pode ser carregado a partir de outros módulos feitos em Lua, não de páginas wiki em outros domínios, como predefinições, domínio principal e/ou páginas de usuário; Para essas, a predefinição {{tl|yesno}} pode servir como substitutivo. Para carregar o módulo, utiliza-se a seguinte linha de comando:

 

 

Alguns valores de entrada sempre retornam <code>true</code>, e alguns sempre retornam <code>false</code>. Valores <code>nil</code> sempre retornam <code>nil</code>.

 

-- Estes sempre retornam true:

yesno('sim')

-- Valores nil sempre retornam nil:

yesno(nil)

 

Valores string são convertidos para letras minúsculas antes de serem testados:

 

-- Estes sempre retornam true:

yesno('Sim')

yesno('nÃO')

yesno('fALsO')

 

É possível especificar um valor padrão para o caso de yesno receber como entrada algo que não esteja listado acima. Se não for fornecido um valor padrão, o módulo retornará <code>nil</code> para tais entradas.

 

-- Estes retornam nil:

yesno('teste')

yesno(5, 'padrão')

yesno(function() return 'Esta é uma função.' end, 'padrão')

 

Note que a string vazia também funciona deste modo:

yesno('') -- Retorna nil.

yesno('', true) -- Retorna true.

yesno('', 'padrão') -- Retorna "padrão".

 

Embora a string vazia geralmente seja avaliada como false em código wiki, ela é avaliada como true em Lua. Este módulo prefere o comportamento em Lua em vez do comportamento em código wiki. Se para o seu módulo for importante tratar strings vazias como false, você precisará remover os argumentos vazios em um estágio anterior do processamento.