Módulo:Cartas/doc

Esta é uma subpágina de documentação para o Módulo:Cartas/dados.
Ela contém informações sobre o seu uso, categorias, bem como todo o conteúdo que não faz parte do módulo original.

Utilização

Função exportável :

carta(frame) – devolve a cor que corresponde à info caixa, a categoria e o tipo de carta gráfica desejada
- Parâmetros :
  - infobox= : indica o tipo de infobox (a cada tipo de infobox pode ter as suas cartas gráficas). Valor por padrão : "biografia"
  - tipo= : tipo de carta no marco da infobox escolhida. Valor por padrão : "padrão"
  - categoria= : categoria de cor no marco da infobox e do tipo de carta. Os valores possíveis são "principal" (ou "1" ou "primário"), "secundário" (ou "2"), eventualmente "terciário" (ou "3"). Valor por padrão : "primário"
  - sustenido=sim : a cor devolvida está precedida do sustenido (#). Valor por padrão : ausente (o # não é inserido)

Nota : a opção sustenido=sim põe o problema : o # é interpretado durante o regresso do módulo, gerando um começo de lista numerada. Não utilizar por enquanto.

Função utilizável directamente desde outro módulo :

carta_m(infobox, categorie, tpe, sustenido) - função idêntica à precedente, mas chamada directamente desde outro módulo (nota : sustenido pode valer « sim » ou true)

Sub-módulo de dados

Este módulo utiliza o sub-módulo Módulo:Cartas/dados que descreve as cartas gráficas para as diferentes infobox, tipos e categorias.

Formato

O formato deste sub-módulo é o seguinte :

uma entrada na tabela data para a cada infobox gerada
- esta entrada tem que ter como índice o nome da infobox (como passado ao parâmetro infobox=). Isto pode se fazer de dois modos :
  - data.nome = { … } para o infobox « nome », se e só se « nome » só contém das letras não acentuadas (e não tem espaços)
  - data["nome"] = { … } para a infobox « nome », nos demais casos (espaços, acentos, outros caracteres)
- esta entrada é uma tabela em que a cada elemento descrito um tipo de carta. Construção :
  - indexado pelo tipo como passado ao parâmetro tipo=
  - o conteúdo é uma tabela que contém ao menos duas cadeias de texto, a primeira que corresponde à categoria "primária", a segunda à categoria "secundária" (e eventualmente uma terçeira para a categoria "terciária")
  - deve ter obrigatóriamente uma entrada para o tipo "padrão" correspondente às cores por padrão
  - as entradas devem obrigatóriamente ser em minúsculas. Não faz falta escrever "rugby Seven" mas "rugby seven".
  - se um tipo retoma os mesmos valores que outro tipo faz falta substituir a tabela por uma cadeia de texto que contém o nome do tipo etiqueta (ver exemplos)

Exemplos

No exemplo aqui mostrado cria-se uma carta para a infobox "biografia" e uma carta para a infobox "testes" :

-- Nota : decidir bem qual o separador dos elementos (a virgula em final de linha).
--        O último elemento pode não ter.
-- uma entrada para a infobox "biografia" na tabela "data"
data["biografia"] = {
    -- cria-se uma entrada por "tipo"
    -- um entrada "padrão" obrigatório
    ["padrão"] = { "FFFFFF", "EEEEEE" },  -- uma entrada por categoria (primária, secundária)
    -- para compatibilidade aceita-se "default", idêntico
    ["default"] = "padrão",  -- um texto em lugar de uma tabela indica uma "redireccionamento"
    -- tipo animação e BD asiática"
    ["animação e banda desenhada asiática"] = { "80DDBF", "B0FFD0" },
    -- versão mais curta
    ["abda"] = "animação e banda desenhada asiática"
} -- final de "biografia"

-- uma entrada para a infobox "testes" na tabela "data"
data["testes"] = {
    -- um entrada "padrão" obrigatória
    ["padrão"] = { "AACCEE", "EECCAA", "AAEECC" },  -- uma entrada por categoria (primária, secundária, terciária)
    -- tipo "tipo1"
    ["tipo1"] = { "00CCEE", "00CCAA", "00.ºECC" },
    -- tipo "tipo2"
    ["tipo2"] = { "AACC00", "EECC00", "AAEE00" },
} -- final de "testes"

Exemplos de utilização

{{#invoke:Cartas|carta|infobox=testes|tipo=cat1|categoria=primária}} dados « AAAAAA »
{{#invoke:Cartas|carta|infobox=testes | tipo=cat1|categoria=secundária}} dados « EEEEFF »
{{#invoke:Cartas|carta|infobox=testes | tipo=cat2|categoria=primária}} dados « 777777 »
{{#invoke:Cartas|carta|infobox=testes | tipo=cat2|categoria=secundária}} dados « 777700 »

Outra documentação:

Wikipédia:Lua