3 167
edições
Mudanças
Ir para navegação
Ir para pesquisar
Criação da documentação do Módulo Infobox/Wikidata
<section begin=header />
{{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|Testes}}|0|<includeonly>{{Module rating|p}}{{alto risco| 70000}}</includeonly>}}<!-- if pagename does not contain sandbox -->
<section end=header />
{{VT|Módulo:Wikidata}}
Módulo a ser usado para mostrar e formatar dados do Wikidata. No caso de querer desligar dados do Wikidata informe o parâmetro {{parâmetro|wikidata|<var>-</var>}}
Tanto quanto possível, este módulo deve ser linguísticamente neutro. Para textos portugueses, veja [[Módulo:Wikidata/i18n/Testes]] e [[Módulo:Wikidata/i18n]].
== Funções exportáveis ==
=== Funções que operam em um snak ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| formatSnak || <code>snak, params</code> || Obtenha o valor de um snak e coloque-o em forma
|-
| getDataValue || <code>snak, params</code> || Recupera o valor de um snak com um valor do tipo "value" e o formata
|-
| isSpecial || <code>snak</code> || retorna <code> true </code> se um snak é um valor especial (''novalue'' ou ''somevalue'')
|-
| getId || <code>snak</code> || retorna o identificador Qdd do elemento usado como um valor de snack
|}
=== Funções que operam no nível de uma afirmação ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| formatStatement || <code>params</code> || Transforma uma declaração individual em uma string wikitexto, usando os mesmos parâmetros que stringTable
|-
| getDate || <code>statement, qualifs</code> || recupera as informações de data armazenadas em uma declaração Wikidata (qualificadores ou valor principal) e as armazena como uma tabela
|-
| getFormattedDate || <code>statement, params</code> || recupera a data associada a uma declaração Wikidata como getDate, mas a retorna como uma string formatada de acordo com os parâmetros <code>params</code>
|-
| hasQualifier || <code>claim, acceptedqualifs, acceptedvals, excludequalifiervalues</code> || retorna <code> true </code> se a instrução tiver qualificadores usando as propriedades acceptedqualifs com os valores acceptedvals e sem os valqualifiervalues. Se acceptedqualifs não for preenchido, todas as propriedades serão aceitas. Se acceptedvals não for preenchido, todos os valores serão aceitos.
|-
| getMainId || <code>claim</code> || retorna o identificador Qdd do elemento usado como o valor do "mainsnak" de uma declaração
|-
| getFormattedQualifiers || <code>statement, qualifs, params</code> || a partir de uma afirmação, retorna uma string contendo os qualificadores solicitados. A tabela params permite personalizar a exibição, veja #Settings.
|-
| getReferences || <code>statement</code> || recupera e exibe a parte de referências de uma instrução Wikidata.
|-
| addtrackingcat|| <code>property, cat</code> || categoriza em <nowiki>[[Categoria:!Artigos que utilizam $property]]</nowiki>
|-
|}
=== Funções operando em um nível de entidade ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| sortClaims|| <code>claims</code> || Coloque uma série de valores em ordem. A ordem pode ser <code>'cronológica'</code>ou<code>'invertida'</code> (ordem cronológica inversa). Nesse caso, as datas usadas são aquelas dadas como o valor handsnak ou nos qualificadores. O pedido também pode ser uma função (consulte a ajuda Lua para a classificação da tabela). Essa função é chamada pelo argumento <code>sorttype</code> de <code>wd.formatGetClaims</code> e, portanto, também <code>wd.formatStatements</code>
|-
| filterClaims || <code>claims, params</code> || Obtém uma tabela de instruções e exclui aquelas que não correspondem aos critérios fornecidos na tabela <code> params </ code>. Para a lista desses argumentos, veja a ajuda abaixo
|-
| getClaims || <code>params</code> || Retorna uma tabela de asserções (ou nil) de acordo com as instruções dadas na tabela <code>params</code>, que contém uma chave <code>|entity = </code> e <code>|property = </code>, e pode conter muitos outros parâmetros opcionais, consulte #Configuração.
|-
| getIds || <code>params</code> || Seleciona instruções da mesma forma que os conjuntos <code>getClaims</code> em vez de retornar instruções completas, apenas retorna o identificador de seu ''mainsnak'' (só funciona para dados do tipo ''elemento'').
|-
| stringTable || <code></code> || Retorna as mesmas asserções que getClaims, exceto possivelmente aquelas suprimidas pelo parâmetro removedupes. Cada um é processado como uma string Wikitexto diretamente utilizável. Os parâmetros de formatação também estão contidos na tabela params.
|-
| formatStatements || <code>params</code> || Retorna os mesmos valores que stringTable, mas concatenados como uma única string. O método de concatenação é definido pelo parâmetro <code>conjtype</code> que usa [[Módulo:Linguística]]. Se <code>linkback</code> e <code>addcat</code> estiverem habilitados, um trackback e uma categoria de manutenção também podem ser adicionados.
|-
| formatAndCat || <code>params</code> || Mesma função que <code>formatStatements</code>, mas adicione um trackback ao Wikidata e uma categoria de manutenção
|-
| getTheDate|| <code>params</code> || exibe uma data que está no valor principal ou como um qualificador da propriedade prop do elemento item
|-
| mainDate || <code>entity</code> || Recupera e formata a "data principal" que pode ser associada ao elemento, com base em suas propriedades {{WD P|580}}, {{WD P|582}} e {{WD P|585}}
|-
| keyDate || <code>event, item, params</code> || Recupera e formata uma data do elemento <code>item</code>. <code>event</code> deve ser um identificador de propriedade, caso em que a função recuperará os valores nessa propriedade, que é um identificador de elemento. Nesse caso, ele procurará esse elemento nos valores de {{WD P|793}} e retornará a data indicada como um qualificador. <Código>evento</code> também pode ser uma lista de identificadores no formato de tabela, Nesse caso, o valor retornado será o do primeiro identificador para o qual algo é encontrado. Por exemplo, <code>wd.keyDate ('Q1417098', 'P1690'}</code> irá procurar o valor em {{WD P|793}} {{WD Q|Q1417098}} e se não encontrar nada, irá procurar em {{WD P|1690}}.
|-
| getLabel ||<code>entity, lang, labelformat</code> || Retorna por padrão o rótulo Wikidata da entidade em, português ou no idioma especificado no segundo parâmetro. O parâmetro opcional <code>labelformat</code> é usado para definir uma exibição alternativa. Seu valor deve ser uma função tomando como argumento a entidade e retornando uma string.
|-
| siteLink || <code>entity, lang, project</code> || retorna um link para a página do projeto solicitada ('wIRChelp', 'wikivoyage', 'commons') etc. vinculado à entidade Wikidata especificada, no idioma solicitado. Por padrão, o idioma é português e o projeto wIRChelp.
|-
| formatEntity||<code>entity, params</code> || Obtém o identificador (ou a tabela de dados) fornecido no parâmetro da entidade e o transforma, retornando-o na forma de um texto contendo um rótulo e, possivelmente, um link interno.
|-
| getDescription || <code>entity, lang</code> || exibe a descrição do Wikidata para uma determinada entidade, em um determinado idioma, ou "lang" (o padrão é o português)
|-
| getNumericId || <code>snak</code> || retorna o identificador numérico do elemento usado como o valor de um snack
|-
| getEntity || <code>str</code> || retorna a tabela de dados correspondente a um identificador (inverso de getEntityId)
|-
| getEntityId || <code>str</code> || retorna o identificador de uma entidade Wikidata passada na forma de uma tabela de dados (inversa de getEntity)
|-
|}
=== Funções recuperando dados em diversas entidades ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| isSubclass || <code>class, item, maxdepth</code>||
|-
| isinstance || <code>class, item, maxdepth</code>||
|-
| inTransitiveVals || <code>searchedval, sourceval, query, maxdepth, maxnodes</code>||
|}
=== Diversos ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| Dump || <code>entity</code> || exibir o conteúdo de uma entidade Wikidata
|-
| sourceStr || <code></code> ||
|-
| frameFun || (frame) || chama uma das funções anteriores do quadro. O nome da função é dado no argumento 1
|-
| addRefAnchor || <code></code> ||
|-
| addLinkback || <code></code> || adicionar um trackback (normalmente usado por <code>formatStatements {arglinkback = true}</code>, mas pode ser útil como uma função independente quando os dados necessários estão sujeitos a muitas manipulações antes de sua renderização final
|-
| isHere || <code>searchset, val</code> || retorna <code>true</code> se a string <code>val</code> estiver na tabela <code>searchset</code>
|-
| addNewValues || <code>old, new</code> || adiciona novos valores a uma tabela somente se eles ainda não estiverem lá
|}
== Configurações ==
Lista de chaves que podem ser usadas na tabela "params" mencionada abaixo..
=== Escolha de declarações ===
Parâmetros usados pela função <code>filterclaims</code> e, portanto, indiretamente pelas funções de chamada, como <code>getClaims</code> e <code>formatStatements</code>.
{| class="wikitable sortable"
|-
! Nome !! Mode de utilização !! Descrição
|-
| claims || Lua || Lista de instruções a serem usadas. Quando esse parâmetro está ativado, os parâmetros <code>property</code> e <code>entity</code> não são usados para recuperação de dados.
|-
| entity || Lua e wikicode || O identificador da entidade Wikidata para usar. Por padrão, o link para a página. <br /> Em Lua, você pode passar uma entidade já ocupada em vez de seu identificador.
|-
| property ||Lua e wikicode || O nome da propriedade a ser usada, no formato <code>property = PXX</code>. Em Lua, pode-se usar várias propriedades na forma de tabelas
|-
| excludespecial || Lua e wikicode || Remove declarações cujo valor principal (mainsnak) não é do tipo "value", ou seja, as declarações "valor desconhecido" ou "sem valor".
No wikicode: ativado por <code>|excludespecial = true</code><br /> Em Lua, ativado por um booleano (<code>excludespecial = true</code>)
|-
| targetvalue || Lua e wikicode || Mantém apenas a(s) instrução(ões) onde o valor do snak principal corresponde ao valor (ou valores) indicado
|-
| excludevalues || Lua e wikicode || Exclui instruções em que o valor do snak principal corresponde ao valor indicado (ou valores)
|-
| qualifier || Lua e wikicode || Apenas declarações contendo este qualificador são retornadas. Para ativar a exibição do qualificador, consulte <code>showqualifiers</code>
|-
| qualifiervalue || Lua e wikicode || O qualificador usado pelo argumento <code> qualifier </code> deve ter esse valor (ou um desses valores, se for uma tabela de propriedade ou uma tabela separada por vírgula)
|-
| excludequalifier || Lua e wikicode || Declarações contendo este qualificador são excluídasLes déclarations contenant ce qualificatif sont exclues
|-
| excludequalifiervalue || Lua e wikicode || Se este parâmetro for preenchido, <code> excludequalifier </code> será ativado apenas quando o valor do qualificador estiver naqueles indicados.
|-
| withsource || Lua e wikicode || Retorna apenas os valores que contêm uma origem, usando a origem especificada na propriedade {{WD P|248}} ou outra propriedade definida pelo parâmetro <code>sourceproperty</code>. Para aceitar qualquer fonte, desde que use a propriedade solicitada, defina o valor <code>any</code>. Para desabilitar esse parâmetro, defina o valor <code>-</code>.
|-
| sourceproperty || Lua e wikicode || Propriedade a ser usada para o parâmetro <code>withsource</code>
|-
|rank || Lua e wikicocde || Ranks aceites :
* <code>preferred</code>
* <code>normal</code>
* <code>deprecated</code>
* <code>valid</code> (= preferred + normal)
* <code>best</code> (preferred, ou, se nenhum atende aos outros critérios da consulta, normal)
Valor por padrão : <code>best</code>
|-
| numval || Lua e wikicode || Número máximo de valores a serem retornados (os primeiros n valores da lista estabelecidos pelos outros parâmetros)
|-
| withlink || Lua e wikicode || Retorna apenas os valores que contêm um link para o site especificado. Se o valor do parâmetro for simplesmente <code>true</code>, o site usado será a wIRChelp em português.
|-
| withdate || Lua e wikicode || Somente valores de retorno com um qualificador de data : {{WD P|585}}, {{WD P|580}}, {{WD P|582}}
|-
| atdate || Lua e wikicode || Exclui valores cujos qualificadores {{WD P|580}} ou {{WD P|582}} indicam que ele era inválido para o período especificado. atdate talvez uma data no formato wikibase ou no formato ISO. Valores não ordenados não são excluídos (eles podem ser excluídos usando a função <code>withdate</code>). Para solicitar o valor na data de hoje, use: <code>|atdate = today</code>.
|-
| minprecision || Lua e Wikicode || Grau mínimo de precisão aceite para dados do tipo de data. Deve ser um valor numérico correspondente ao modelo Wikidata (por exemplo, ano = 9)
|-
| condition || Lua || Para definir uma função livre Se a função retornar <code> true </code>, a declaração será mantida
|-
| sorttype|| Lua e wikicode || Como classificar declarações. Valores possíveis:* <code>chronological</code>
* <code>inverted</code> (cronológica invertida
* funções Lua (ver a função <code>sortClaims</code>)
|}
=== Activação / desativação de Wikidata ===
{| class="wikitable sortable"
|-
! Nome !! Mode de utilização !! Descrição
|-
| value || Lua e wikicode || Quando o parâmetro value não está vazio, o módulo não pesquisa dados do Wikidata, mas usa aqueles fornecidos localmente por esse parâmetro. A função formatAndCat em vez disso aplica <code>linkback</code> e <code>addcat</code>)
|-
| expl || Lua e wikicode || Quando o parâmetro expl estiver presente, a função formatStatements não fará nada se o parâmetro value não tiver o valor de resultado {{m | WD}} (útil para dados atualizados, mas cuja utilidade em cada artigo é difícil) decidir automaticamente).
|-
|}
=== Formatação de dados ===
{| class="wikitable sortable"
|-
! Nome !! Nível de aplicação !! Modo de utilização !! Descrição
|-
| conjtype || lista das declarações|| Lua e wikicode || Como coordenar declarações, usando a função <code>conj</code> do [[Módulo:Linguística]]. Valores possíveis:
* <code>and</code> adicionando "ou" entre o penúltimo e último valor
* <code>or</code> adicionando "ou" entre o penúltimo e último valor
* <code>comma</code> vírgulas em todos os lugares
* <code>new line</code> um retorno de linha
Qualquer outro valor dado ao parâmetro será inserido entre cada valor (<code>|conjtype = e então também</code> irá adicionar "e então também" entre cada valor)
|-
| linkback || lista das declarações || Lua e wikicode || Adicione um trackback ao Wikidata como um lápis « [[File:Blue pencil.svg|10px]] »
|-
| addcat || lista das declarações || Lua e wikicode || Coloque a página em uma categoria de rastreamento (veja [[:Categoria:!Artigos que utilizam Wikidata por propriedade]]). O nome da categoria é o valor do parâmetro. Se este valor for simplesmente <code>true</code>, a categoria é uma função do parâmetro da propriedade.
Atenção, este parâmetro pode ser uma fonte de erros. Por exemplo, se a propriedade for usada em um URL ou link.
|-
| removedupes || escolha das declarações <br /> (no final, numa função diferente) || Lua e wikicode || Quando, após toda a formatação, duas declarações são renderizadas da mesma maneira, apenas uma é preservada.
|-
|rowspan=2| lang || formatar os dados || Lua e Wikicode || Idioma em que o texto deve ser retornado.
|-
| snak (entidade) || Lua e wikicode || Código da Wikimedia da linguagem usada para exibir os rótulos (por padrão : português)
|-
| ucfirst || lista das declarações || Lua e Wikicode || Por padrão, a função formatStatements adiciona uma letra maiúscula no início do texto. <code>|ucfirst = -</code> para desabilitar isso
|-
| statementformat || declaração || Lua || deve ser uma função <code><nowiki> function (statement) retornar XX </nowiki></code> retornando uma string. Será aplicado a cada afirmação (simplifica alguma infobox Lua)
|-
| showdate|| declaração || Lua e wikicode || Para exibir a data entre parênteses em pequena para cada instrução usando os mesmos qualificadores como (withdate). Quando nenhuma data é encontrada, o valor é exibido sem qualquer data.
|-
| displayformat || snak || Lua e wikicode|| Para alterar o formato padrão entre cada valor. <br />
* <code> weblink </code> transforma dados de string em um link da web
* <code> raw </code> retorna um formato mais bruto, às vezes útil para codificação
* <code>latitude </code> para [[Módulo:Coordenadas]]
* <code>longitude</code> para [[Module:Coordenadas]]
Em lua, o valor do parâmetro também pode ser uma função.
|-
| qualifdisplayformat || snak || Lua e wikicode|| Exibir formato dos qualificadores. O mesmo que <code>displayformat</code>. Quando este parâmetro é deixado vazio, os qualificadores usam o parâmetro <code>displayformat</code> como o valor principal.
|-
| showsource || declaração || Lua e wikicode || Identificador de uma fonte que alguém gostaria de ver exibido em referência se estiver presente. <code> true </code> mostrará todas as fontes usando a propriedade {{WD P|248}}.
|-
| linktopic || snak (temporada) || Lua e wikicode || Tipo de link para adicionar às datas (consulte [[Módulo: Data]]). Para não colocar nenhum link : <code>linktopic = - </code>
|-
|-
| precision|| snak (temporal) || Lua e wikicode || Precisão com quais datas devem ser exibidas. Valores possíveis:
* <code>day</code>
* <code>month</code>
*<code>year</code>
Valor por padrão : <code>day</code>
|-
| textformat || snak (temporal) || Lua e wikicode || Exibir formato de intervalos de tempo, conforme definido por [[Módulo:Data complexa]]
* <code>minimum</code> exibirá "1995" em vez de "de 1995".
|-
| speciallabels || snak (entidade) || Lua|| Tabelas de valores especiais para usar em vez do rótulo Wikidata para o valor de alguns elementos, por exemplo [[Módulo:Wikidata/Dicionário profissões]].
|-
| labelformat || snak (entidade) || Lua || Função de formatação de etiquetas
|-
| showlang || declaração || Lua e wikicode || Quando o valor principal é do tipo "texto monolíngua", o seu código de idioma é exibido (usado pelo [[Módulo:Website oficial]])
|-
| showqualifiers || declaração || Lua e wikicode || Qualificador para retornar entre parênteses por trás do valor da propriedade principal solicitada. Em wikicode no formato <code><nowiki>|</nowiki>showqualifiers = P460 </code>, em Lua como <code>showqualifiers = "P460"</code> ou <code>showqualifiers = {"P460 "," P461 "}</code>
|-
| showonlyqualifier || declaração || Lua e wikicode || Qualificador do mesmo, mas para retornar sozinho sem o valor da propriedade principal solicitada
|-
| link || snak (entité) || Lua e wikicode || Site ao qual os dados do tipo de item devem ser vinculados. Por padrão: Wikidata em português. Se igual a "-", nenhum link será criado.
|-
| defaultlink || snak (entidade) || Lua e wikicode || Quando o site solicitado pelo parâmetro link não retorna um link, exibe um link entre parênteses para o site solicitado. Padrão: wIRChelp em inglês ou, se não, Wikidata. O valor "-" desabilita o parâmetro.
|-
| defaultlinkquery || snak (entidade) || Lua || Quando o site solicitado pelo parâmetro link não retorna um link, esse parâmetro define uma consulta que <code> recup.getClaims </code> usa para criar um link. Por exemplo, com <code>|defaultlinkquery = {property = 'P279'}</code> o link criado será aquele fornecido pelo elemento usado na propriedade {{WD P|279}}.
|-
| targetunit || snak (quantidade) || Lua e Wikicode || Unidade na qual os dados do tipo de quantidade devem ser convertidos. Os valores possíveis são visíveis no [[Módulo:Conversão/Dados]], por exemplo, km ou km2.
|-
| showunit || snak (quantidade) || Lua e Wikicode ||
Como exibir a unidade solicitada. Valores possíveis:
* <code>'long'</code>: exibe o nome completo da unidade (por exemplo, "12,7 metros")
* <code>'short'</code> exibe a abreviação usada convencionalmente ("12,7 m")
* <code>'-' </code>: nenhuma unidade exibida
padrão: <code>'curto'</code>
|-
| rounding || snak (quantidade) número de dígitos || Lua e Wikicode || Número de dígitos significativos a serem exibidos em dados de quantidade, após possível conversão (padrão: depende da precisão indicada no Wikidata)
|-
| urlpattern || snak (string) || Lua e wikicode || O valor do parâmetro é uma string representando uma URL, a expressão "$1" será substituída pelo valor Wikidata <br /> Com a propriedade {{WD P|214}} e o valor do parâmetro <nowiki>http://viaf.org/viaf/$1</nowiki>, o valor do ID VIAF armazenado no Wikidata será usado para criar um link externo.
|-
| text || snak (string) || Lua e wikicode || Texto para exibir quando o valor cria um link externo, ou seja, para dados de string com <code>displayformat = "weblink"</code> ou com o parâmetro <code>urlpattern</code> preenchido . Padrão: o valor inicial da declaração. Usado no [[Módulo:Website oficial]] [[Módulo:Bases Archi]].
|-
| novaluelabel || snak (novalue) || Lua e wikicode || Rótulo para retornar quando o valor é do tipo "novalue". Padrão: "-". <br />
Em Lua, o valor pode ser uma função.
|-
| somevaluelabel || snak (somevalue) || Lua e wikicode || Rótulo para retornar quando o valor é do tipo "somevalue". Padrão: "desconhecido". <br />
Em Lua, o valor pode ser uma função.
|-
| returnnumberofvalues || lista das declarações || Lua || retorna no segundo valor o número de valores recuperados por getClaims (se a função for chamada do Wikicode, o número será concatenado ao resto da string retornada
|}
== Exemplos ==
=== Definição de links ===
{| class="wikitable"
|-
! Code !! Resultado !! Observações
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36}} || Capital do Egito, formato padrão
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=-}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=-}} || Capital do Egito, sem link
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=wikidata}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=wikidata}} || Capital do Egito, com link para Wikidata
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569}} || O aniversário de Albert Einstein, usando o formato padrão da wIRChelp em português
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = futebol }}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569 |linktopic = futebol }} || Data de nascimento do Einstein, com links especializados em futebol
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = -}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = -}} || Data de nascimento do Einstein, sem links
|}
=== Gama ===
Existem três tipos de classificação no Wikidata: "normal", "preferido" e "obsoleto". A classificação descontinuada é reservada para dados que sabemos serem falsos, mas que mantemos para a memória, por exemplo, para documentar uma crença antiga que foi invalidada por estudos mais recentes.
Por padrão, apenas a classificação "preferida" é recuperada, mas o parâmetro "rank" permite que você altere isso.
{| class="wikitable"
|-
! Code !! Resultado !! Observações
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186}} || Material da Mona Lisa, exibição padrão (portanto, somente aqueles com a classificação "preferida", se houver)
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid}} || rank = "valid" aceita valores de classificação "normal" e "preferencial" (por exemplo, o material de um quadro que foi adicionado posteriormente à Mona Lisa)
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=normal}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=normal}} || rank = "normal" recupera apenas dados com uma classificação "normal" e ignora aqueles com classificação "preferida"
|}
=== Qualificadores ===
Qualificadores são dados adicionais incorporados em uma instrução Wikidata que podem ser especificados.
{| class="wikitable"
|-
! Code !! Resultado !! Observações
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|qualifier = P518}} || somente retém valores com um qualificador {{WD P|518}}
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|qualifiervalue=Q1737943}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|qualifier = P518|qualifiervalue=Q1737943}} || qualiervalue define o valor que o qualificador possui. Aqui, {{WD Q|1737943}} especifica que o material da estrutura é obrigatório. Note que nenhum valor de classificação "preferido" é encontrado, um valor de classificação "normal" é retornado.
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|rank=valid}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|rank=valid}} || showqualifiers exibe o valor dos qualificadores solicitados entre parênteses, após o valor principal
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showdate = true|rank=valid}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid|showdate = true}} || se os qualificadores que indicam a data forem fornecidos, eles serão exibidos
|}
=== Mostrando fontes ===
<!-- {| class="wikitable"
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P276|sourceproperty = P854}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P276|sourceproperty = P854|nocat=yes}} ||
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493}} ||
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493|showsource=true}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493|showsource=true}} || Mostrar apenas os valores fornecidos pela fonte
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q153 | property = P231|showsource=true}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q153 | property = P231|showsource=true}} ||
|}
<references />
-->=== Outras opções ===
<!-- {| class="wikitable"
|-
! Code !! Resultado !! Observações
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P106|conjtype = new line|showdate= true}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q1299 | property = P527|conjtype = new line|showdate=true}} || conjtype permite definir o separador entre os valores (veja [[Módulo:Linguística]]). Aqui "<nowiki>nova linha</nowiki>" indica que você deve retornar à linha após cada valor.
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=chronological|conjtype =new line}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|sorttype=chronological|showdate=true|conjtype = new line}} || sorttype = chronological tenta classificar os valores em ordem cronológica (com base nos qualificadores). Aqui: os principais eventos ([[:d:P:P793]]) na história do antigo estádio do Arsenal.
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=inverted|conjtype = new line}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|sorttype=inverted|showdate=true|conjtype = new line}} || sorttype = invertida para inverter a ordem cronológica
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|displayformat=raw}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|displayformat=raw}} || exibe os identificadores dos valores (essencialmente úteis para programação)
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|numval=1}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|numval=1}} || retorna os primeiros valores numéricos correspondentes ao resto da consulta (útil especialmente para recuperar uma imagem)
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity=Q535922 | property=P172 |expl= |value={{WD}} }}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity=Q535922 | property=P172 |expl= |value={{WD}} }} || com expl =, para que o valor da noite retornado requeira valor = <nowiki>{{WD}}</nowiki>
|-
|}
-->
* <kbd>getImageLegend</kbd>: devolve uma legenda da imagem (imagem é a propriedade P18; a legenda da imagem é a propriedade P2096).
*: Faz a chamada como <code><nowiki>{{#invoke:Wikidata |getImageLegend | <PARAMETER> | lang=<ISO-639code> |id=<QID>}}</nowiki></code>
*: Devolve PARÂMETRO, a menos que seja igual a "FETCH_WIKIDATA", de Item QID (chamada cara). Se o QID for omitido ou vazio, o artigo corrente é usado (não é uma chamada cara). Se lang for omitido, ele usa a língua local, de outra modo ele usa o código de língua ISO-639.
*: A etiqueta é devolvida da primeira imagem com rank 'preferido'; ou da primeira imagem com rank 'normal' se nenhuma imagem tem rank preferido.
Outra documentação:
* [[wIRChelp:Lua]]
<includeonly>{{#ifeq:{{SUBPAGENAME}}|Testes||
[[Categoria:!Módulos Wikidata]]
}}</includeonly>
{{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|Testes}}|0|<includeonly>{{Module rating|p}}{{alto risco| 70000}}</includeonly>}}<!-- if pagename does not contain sandbox -->
<section end=header />
{{VT|Módulo:Wikidata}}
Módulo a ser usado para mostrar e formatar dados do Wikidata. No caso de querer desligar dados do Wikidata informe o parâmetro {{parâmetro|wikidata|<var>-</var>}}
Tanto quanto possível, este módulo deve ser linguísticamente neutro. Para textos portugueses, veja [[Módulo:Wikidata/i18n/Testes]] e [[Módulo:Wikidata/i18n]].
== Funções exportáveis ==
=== Funções que operam em um snak ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| formatSnak || <code>snak, params</code> || Obtenha o valor de um snak e coloque-o em forma
|-
| getDataValue || <code>snak, params</code> || Recupera o valor de um snak com um valor do tipo "value" e o formata
|-
| isSpecial || <code>snak</code> || retorna <code> true </code> se um snak é um valor especial (''novalue'' ou ''somevalue'')
|-
| getId || <code>snak</code> || retorna o identificador Qdd do elemento usado como um valor de snack
|}
=== Funções que operam no nível de uma afirmação ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| formatStatement || <code>params</code> || Transforma uma declaração individual em uma string wikitexto, usando os mesmos parâmetros que stringTable
|-
| getDate || <code>statement, qualifs</code> || recupera as informações de data armazenadas em uma declaração Wikidata (qualificadores ou valor principal) e as armazena como uma tabela
|-
| getFormattedDate || <code>statement, params</code> || recupera a data associada a uma declaração Wikidata como getDate, mas a retorna como uma string formatada de acordo com os parâmetros <code>params</code>
|-
| hasQualifier || <code>claim, acceptedqualifs, acceptedvals, excludequalifiervalues</code> || retorna <code> true </code> se a instrução tiver qualificadores usando as propriedades acceptedqualifs com os valores acceptedvals e sem os valqualifiervalues. Se acceptedqualifs não for preenchido, todas as propriedades serão aceitas. Se acceptedvals não for preenchido, todos os valores serão aceitos.
|-
| getMainId || <code>claim</code> || retorna o identificador Qdd do elemento usado como o valor do "mainsnak" de uma declaração
|-
| getFormattedQualifiers || <code>statement, qualifs, params</code> || a partir de uma afirmação, retorna uma string contendo os qualificadores solicitados. A tabela params permite personalizar a exibição, veja #Settings.
|-
| getReferences || <code>statement</code> || recupera e exibe a parte de referências de uma instrução Wikidata.
|-
| addtrackingcat|| <code>property, cat</code> || categoriza em <nowiki>[[Categoria:!Artigos que utilizam $property]]</nowiki>
|-
|}
=== Funções operando em um nível de entidade ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| sortClaims|| <code>claims</code> || Coloque uma série de valores em ordem. A ordem pode ser <code>'cronológica'</code>ou<code>'invertida'</code> (ordem cronológica inversa). Nesse caso, as datas usadas são aquelas dadas como o valor handsnak ou nos qualificadores. O pedido também pode ser uma função (consulte a ajuda Lua para a classificação da tabela). Essa função é chamada pelo argumento <code>sorttype</code> de <code>wd.formatGetClaims</code> e, portanto, também <code>wd.formatStatements</code>
|-
| filterClaims || <code>claims, params</code> || Obtém uma tabela de instruções e exclui aquelas que não correspondem aos critérios fornecidos na tabela <code> params </ code>. Para a lista desses argumentos, veja a ajuda abaixo
|-
| getClaims || <code>params</code> || Retorna uma tabela de asserções (ou nil) de acordo com as instruções dadas na tabela <code>params</code>, que contém uma chave <code>|entity = </code> e <code>|property = </code>, e pode conter muitos outros parâmetros opcionais, consulte #Configuração.
|-
| getIds || <code>params</code> || Seleciona instruções da mesma forma que os conjuntos <code>getClaims</code> em vez de retornar instruções completas, apenas retorna o identificador de seu ''mainsnak'' (só funciona para dados do tipo ''elemento'').
|-
| stringTable || <code></code> || Retorna as mesmas asserções que getClaims, exceto possivelmente aquelas suprimidas pelo parâmetro removedupes. Cada um é processado como uma string Wikitexto diretamente utilizável. Os parâmetros de formatação também estão contidos na tabela params.
|-
| formatStatements || <code>params</code> || Retorna os mesmos valores que stringTable, mas concatenados como uma única string. O método de concatenação é definido pelo parâmetro <code>conjtype</code> que usa [[Módulo:Linguística]]. Se <code>linkback</code> e <code>addcat</code> estiverem habilitados, um trackback e uma categoria de manutenção também podem ser adicionados.
|-
| formatAndCat || <code>params</code> || Mesma função que <code>formatStatements</code>, mas adicione um trackback ao Wikidata e uma categoria de manutenção
|-
| getTheDate|| <code>params</code> || exibe uma data que está no valor principal ou como um qualificador da propriedade prop do elemento item
|-
| mainDate || <code>entity</code> || Recupera e formata a "data principal" que pode ser associada ao elemento, com base em suas propriedades {{WD P|580}}, {{WD P|582}} e {{WD P|585}}
|-
| keyDate || <code>event, item, params</code> || Recupera e formata uma data do elemento <code>item</code>. <code>event</code> deve ser um identificador de propriedade, caso em que a função recuperará os valores nessa propriedade, que é um identificador de elemento. Nesse caso, ele procurará esse elemento nos valores de {{WD P|793}} e retornará a data indicada como um qualificador. <Código>evento</code> também pode ser uma lista de identificadores no formato de tabela, Nesse caso, o valor retornado será o do primeiro identificador para o qual algo é encontrado. Por exemplo, <code>wd.keyDate ('Q1417098', 'P1690'}</code> irá procurar o valor em {{WD P|793}} {{WD Q|Q1417098}} e se não encontrar nada, irá procurar em {{WD P|1690}}.
|-
| getLabel ||<code>entity, lang, labelformat</code> || Retorna por padrão o rótulo Wikidata da entidade em, português ou no idioma especificado no segundo parâmetro. O parâmetro opcional <code>labelformat</code> é usado para definir uma exibição alternativa. Seu valor deve ser uma função tomando como argumento a entidade e retornando uma string.
|-
| siteLink || <code>entity, lang, project</code> || retorna um link para a página do projeto solicitada ('wIRChelp', 'wikivoyage', 'commons') etc. vinculado à entidade Wikidata especificada, no idioma solicitado. Por padrão, o idioma é português e o projeto wIRChelp.
|-
| formatEntity||<code>entity, params</code> || Obtém o identificador (ou a tabela de dados) fornecido no parâmetro da entidade e o transforma, retornando-o na forma de um texto contendo um rótulo e, possivelmente, um link interno.
|-
| getDescription || <code>entity, lang</code> || exibe a descrição do Wikidata para uma determinada entidade, em um determinado idioma, ou "lang" (o padrão é o português)
|-
| getNumericId || <code>snak</code> || retorna o identificador numérico do elemento usado como o valor de um snack
|-
| getEntity || <code>str</code> || retorna a tabela de dados correspondente a um identificador (inverso de getEntityId)
|-
| getEntityId || <code>str</code> || retorna o identificador de uma entidade Wikidata passada na forma de uma tabela de dados (inversa de getEntity)
|-
|}
=== Funções recuperando dados em diversas entidades ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| isSubclass || <code>class, item, maxdepth</code>||
|-
| isinstance || <code>class, item, maxdepth</code>||
|-
| inTransitiveVals || <code>searchedval, sourceval, query, maxdepth, maxnodes</code>||
|}
=== Diversos ===
{| class="wikitable sortable"
|-
! Nome !! Argumentos !! Descrição
|-
| Dump || <code>entity</code> || exibir o conteúdo de uma entidade Wikidata
|-
| sourceStr || <code></code> ||
|-
| frameFun || (frame) || chama uma das funções anteriores do quadro. O nome da função é dado no argumento 1
|-
| addRefAnchor || <code></code> ||
|-
| addLinkback || <code></code> || adicionar um trackback (normalmente usado por <code>formatStatements {arglinkback = true}</code>, mas pode ser útil como uma função independente quando os dados necessários estão sujeitos a muitas manipulações antes de sua renderização final
|-
| isHere || <code>searchset, val</code> || retorna <code>true</code> se a string <code>val</code> estiver na tabela <code>searchset</code>
|-
| addNewValues || <code>old, new</code> || adiciona novos valores a uma tabela somente se eles ainda não estiverem lá
|}
== Configurações ==
Lista de chaves que podem ser usadas na tabela "params" mencionada abaixo..
=== Escolha de declarações ===
Parâmetros usados pela função <code>filterclaims</code> e, portanto, indiretamente pelas funções de chamada, como <code>getClaims</code> e <code>formatStatements</code>.
{| class="wikitable sortable"
|-
! Nome !! Mode de utilização !! Descrição
|-
| claims || Lua || Lista de instruções a serem usadas. Quando esse parâmetro está ativado, os parâmetros <code>property</code> e <code>entity</code> não são usados para recuperação de dados.
|-
| entity || Lua e wikicode || O identificador da entidade Wikidata para usar. Por padrão, o link para a página. <br /> Em Lua, você pode passar uma entidade já ocupada em vez de seu identificador.
|-
| property ||Lua e wikicode || O nome da propriedade a ser usada, no formato <code>property = PXX</code>. Em Lua, pode-se usar várias propriedades na forma de tabelas
|-
| excludespecial || Lua e wikicode || Remove declarações cujo valor principal (mainsnak) não é do tipo "value", ou seja, as declarações "valor desconhecido" ou "sem valor".
No wikicode: ativado por <code>|excludespecial = true</code><br /> Em Lua, ativado por um booleano (<code>excludespecial = true</code>)
|-
| targetvalue || Lua e wikicode || Mantém apenas a(s) instrução(ões) onde o valor do snak principal corresponde ao valor (ou valores) indicado
|-
| excludevalues || Lua e wikicode || Exclui instruções em que o valor do snak principal corresponde ao valor indicado (ou valores)
|-
| qualifier || Lua e wikicode || Apenas declarações contendo este qualificador são retornadas. Para ativar a exibição do qualificador, consulte <code>showqualifiers</code>
|-
| qualifiervalue || Lua e wikicode || O qualificador usado pelo argumento <code> qualifier </code> deve ter esse valor (ou um desses valores, se for uma tabela de propriedade ou uma tabela separada por vírgula)
|-
| excludequalifier || Lua e wikicode || Declarações contendo este qualificador são excluídasLes déclarations contenant ce qualificatif sont exclues
|-
| excludequalifiervalue || Lua e wikicode || Se este parâmetro for preenchido, <code> excludequalifier </code> será ativado apenas quando o valor do qualificador estiver naqueles indicados.
|-
| withsource || Lua e wikicode || Retorna apenas os valores que contêm uma origem, usando a origem especificada na propriedade {{WD P|248}} ou outra propriedade definida pelo parâmetro <code>sourceproperty</code>. Para aceitar qualquer fonte, desde que use a propriedade solicitada, defina o valor <code>any</code>. Para desabilitar esse parâmetro, defina o valor <code>-</code>.
|-
| sourceproperty || Lua e wikicode || Propriedade a ser usada para o parâmetro <code>withsource</code>
|-
|rank || Lua e wikicocde || Ranks aceites :
* <code>preferred</code>
* <code>normal</code>
* <code>deprecated</code>
* <code>valid</code> (= preferred + normal)
* <code>best</code> (preferred, ou, se nenhum atende aos outros critérios da consulta, normal)
Valor por padrão : <code>best</code>
|-
| numval || Lua e wikicode || Número máximo de valores a serem retornados (os primeiros n valores da lista estabelecidos pelos outros parâmetros)
|-
| withlink || Lua e wikicode || Retorna apenas os valores que contêm um link para o site especificado. Se o valor do parâmetro for simplesmente <code>true</code>, o site usado será a wIRChelp em português.
|-
| withdate || Lua e wikicode || Somente valores de retorno com um qualificador de data : {{WD P|585}}, {{WD P|580}}, {{WD P|582}}
|-
| atdate || Lua e wikicode || Exclui valores cujos qualificadores {{WD P|580}} ou {{WD P|582}} indicam que ele era inválido para o período especificado. atdate talvez uma data no formato wikibase ou no formato ISO. Valores não ordenados não são excluídos (eles podem ser excluídos usando a função <code>withdate</code>). Para solicitar o valor na data de hoje, use: <code>|atdate = today</code>.
|-
| minprecision || Lua e Wikicode || Grau mínimo de precisão aceite para dados do tipo de data. Deve ser um valor numérico correspondente ao modelo Wikidata (por exemplo, ano = 9)
|-
| condition || Lua || Para definir uma função livre Se a função retornar <code> true </code>, a declaração será mantida
|-
| sorttype|| Lua e wikicode || Como classificar declarações. Valores possíveis:* <code>chronological</code>
* <code>inverted</code> (cronológica invertida
* funções Lua (ver a função <code>sortClaims</code>)
|}
=== Activação / desativação de Wikidata ===
{| class="wikitable sortable"
|-
! Nome !! Mode de utilização !! Descrição
|-
| value || Lua e wikicode || Quando o parâmetro value não está vazio, o módulo não pesquisa dados do Wikidata, mas usa aqueles fornecidos localmente por esse parâmetro. A função formatAndCat em vez disso aplica <code>linkback</code> e <code>addcat</code>)
|-
| expl || Lua e wikicode || Quando o parâmetro expl estiver presente, a função formatStatements não fará nada se o parâmetro value não tiver o valor de resultado {{m | WD}} (útil para dados atualizados, mas cuja utilidade em cada artigo é difícil) decidir automaticamente).
|-
|}
=== Formatação de dados ===
{| class="wikitable sortable"
|-
! Nome !! Nível de aplicação !! Modo de utilização !! Descrição
|-
| conjtype || lista das declarações|| Lua e wikicode || Como coordenar declarações, usando a função <code>conj</code> do [[Módulo:Linguística]]. Valores possíveis:
* <code>and</code> adicionando "ou" entre o penúltimo e último valor
* <code>or</code> adicionando "ou" entre o penúltimo e último valor
* <code>comma</code> vírgulas em todos os lugares
* <code>new line</code> um retorno de linha
Qualquer outro valor dado ao parâmetro será inserido entre cada valor (<code>|conjtype = e então também</code> irá adicionar "e então também" entre cada valor)
|-
| linkback || lista das declarações || Lua e wikicode || Adicione um trackback ao Wikidata como um lápis « [[File:Blue pencil.svg|10px]] »
|-
| addcat || lista das declarações || Lua e wikicode || Coloque a página em uma categoria de rastreamento (veja [[:Categoria:!Artigos que utilizam Wikidata por propriedade]]). O nome da categoria é o valor do parâmetro. Se este valor for simplesmente <code>true</code>, a categoria é uma função do parâmetro da propriedade.
Atenção, este parâmetro pode ser uma fonte de erros. Por exemplo, se a propriedade for usada em um URL ou link.
|-
| removedupes || escolha das declarações <br /> (no final, numa função diferente) || Lua e wikicode || Quando, após toda a formatação, duas declarações são renderizadas da mesma maneira, apenas uma é preservada.
|-
|rowspan=2| lang || formatar os dados || Lua e Wikicode || Idioma em que o texto deve ser retornado.
|-
| snak (entidade) || Lua e wikicode || Código da Wikimedia da linguagem usada para exibir os rótulos (por padrão : português)
|-
| ucfirst || lista das declarações || Lua e Wikicode || Por padrão, a função formatStatements adiciona uma letra maiúscula no início do texto. <code>|ucfirst = -</code> para desabilitar isso
|-
| statementformat || declaração || Lua || deve ser uma função <code><nowiki> function (statement) retornar XX </nowiki></code> retornando uma string. Será aplicado a cada afirmação (simplifica alguma infobox Lua)
|-
| showdate|| declaração || Lua e wikicode || Para exibir a data entre parênteses em pequena para cada instrução usando os mesmos qualificadores como (withdate). Quando nenhuma data é encontrada, o valor é exibido sem qualquer data.
|-
| displayformat || snak || Lua e wikicode|| Para alterar o formato padrão entre cada valor. <br />
* <code> weblink </code> transforma dados de string em um link da web
* <code> raw </code> retorna um formato mais bruto, às vezes útil para codificação
* <code>latitude </code> para [[Módulo:Coordenadas]]
* <code>longitude</code> para [[Module:Coordenadas]]
Em lua, o valor do parâmetro também pode ser uma função.
|-
| qualifdisplayformat || snak || Lua e wikicode|| Exibir formato dos qualificadores. O mesmo que <code>displayformat</code>. Quando este parâmetro é deixado vazio, os qualificadores usam o parâmetro <code>displayformat</code> como o valor principal.
|-
| showsource || declaração || Lua e wikicode || Identificador de uma fonte que alguém gostaria de ver exibido em referência se estiver presente. <code> true </code> mostrará todas as fontes usando a propriedade {{WD P|248}}.
|-
| linktopic || snak (temporada) || Lua e wikicode || Tipo de link para adicionar às datas (consulte [[Módulo: Data]]). Para não colocar nenhum link : <code>linktopic = - </code>
|-
|-
| precision|| snak (temporal) || Lua e wikicode || Precisão com quais datas devem ser exibidas. Valores possíveis:
* <code>day</code>
* <code>month</code>
*<code>year</code>
Valor por padrão : <code>day</code>
|-
| textformat || snak (temporal) || Lua e wikicode || Exibir formato de intervalos de tempo, conforme definido por [[Módulo:Data complexa]]
* <code>minimum</code> exibirá "1995" em vez de "de 1995".
|-
| speciallabels || snak (entidade) || Lua|| Tabelas de valores especiais para usar em vez do rótulo Wikidata para o valor de alguns elementos, por exemplo [[Módulo:Wikidata/Dicionário profissões]].
|-
| labelformat || snak (entidade) || Lua || Função de formatação de etiquetas
|-
| showlang || declaração || Lua e wikicode || Quando o valor principal é do tipo "texto monolíngua", o seu código de idioma é exibido (usado pelo [[Módulo:Website oficial]])
|-
| showqualifiers || declaração || Lua e wikicode || Qualificador para retornar entre parênteses por trás do valor da propriedade principal solicitada. Em wikicode no formato <code><nowiki>|</nowiki>showqualifiers = P460 </code>, em Lua como <code>showqualifiers = "P460"</code> ou <code>showqualifiers = {"P460 "," P461 "}</code>
|-
| showonlyqualifier || declaração || Lua e wikicode || Qualificador do mesmo, mas para retornar sozinho sem o valor da propriedade principal solicitada
|-
| link || snak (entité) || Lua e wikicode || Site ao qual os dados do tipo de item devem ser vinculados. Por padrão: Wikidata em português. Se igual a "-", nenhum link será criado.
|-
| defaultlink || snak (entidade) || Lua e wikicode || Quando o site solicitado pelo parâmetro link não retorna um link, exibe um link entre parênteses para o site solicitado. Padrão: wIRChelp em inglês ou, se não, Wikidata. O valor "-" desabilita o parâmetro.
|-
| defaultlinkquery || snak (entidade) || Lua || Quando o site solicitado pelo parâmetro link não retorna um link, esse parâmetro define uma consulta que <code> recup.getClaims </code> usa para criar um link. Por exemplo, com <code>|defaultlinkquery = {property = 'P279'}</code> o link criado será aquele fornecido pelo elemento usado na propriedade {{WD P|279}}.
|-
| targetunit || snak (quantidade) || Lua e Wikicode || Unidade na qual os dados do tipo de quantidade devem ser convertidos. Os valores possíveis são visíveis no [[Módulo:Conversão/Dados]], por exemplo, km ou km2.
|-
| showunit || snak (quantidade) || Lua e Wikicode ||
Como exibir a unidade solicitada. Valores possíveis:
* <code>'long'</code>: exibe o nome completo da unidade (por exemplo, "12,7 metros")
* <code>'short'</code> exibe a abreviação usada convencionalmente ("12,7 m")
* <code>'-' </code>: nenhuma unidade exibida
padrão: <code>'curto'</code>
|-
| rounding || snak (quantidade) número de dígitos || Lua e Wikicode || Número de dígitos significativos a serem exibidos em dados de quantidade, após possível conversão (padrão: depende da precisão indicada no Wikidata)
|-
| urlpattern || snak (string) || Lua e wikicode || O valor do parâmetro é uma string representando uma URL, a expressão "$1" será substituída pelo valor Wikidata <br /> Com a propriedade {{WD P|214}} e o valor do parâmetro <nowiki>http://viaf.org/viaf/$1</nowiki>, o valor do ID VIAF armazenado no Wikidata será usado para criar um link externo.
|-
| text || snak (string) || Lua e wikicode || Texto para exibir quando o valor cria um link externo, ou seja, para dados de string com <code>displayformat = "weblink"</code> ou com o parâmetro <code>urlpattern</code> preenchido . Padrão: o valor inicial da declaração. Usado no [[Módulo:Website oficial]] [[Módulo:Bases Archi]].
|-
| novaluelabel || snak (novalue) || Lua e wikicode || Rótulo para retornar quando o valor é do tipo "novalue". Padrão: "-". <br />
Em Lua, o valor pode ser uma função.
|-
| somevaluelabel || snak (somevalue) || Lua e wikicode || Rótulo para retornar quando o valor é do tipo "somevalue". Padrão: "desconhecido". <br />
Em Lua, o valor pode ser uma função.
|-
| returnnumberofvalues || lista das declarações || Lua || retorna no segundo valor o número de valores recuperados por getClaims (se a função for chamada do Wikicode, o número será concatenado ao resto da string retornada
|}
== Exemplos ==
=== Definição de links ===
{| class="wikitable"
|-
! Code !! Resultado !! Observações
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36}} || Capital do Egito, formato padrão
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=-}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=-}} || Capital do Egito, sem link
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=wikidata}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q79 | property = P36|link=wikidata}} || Capital do Egito, com link para Wikidata
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569}} || O aniversário de Albert Einstein, usando o formato padrão da wIRChelp em português
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = futebol }}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569 |linktopic = futebol }} || Data de nascimento do Einstein, com links especializados em futebol
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = -}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = -}} || Data de nascimento do Einstein, sem links
|}
=== Gama ===
Existem três tipos de classificação no Wikidata: "normal", "preferido" e "obsoleto". A classificação descontinuada é reservada para dados que sabemos serem falsos, mas que mantemos para a memória, por exemplo, para documentar uma crença antiga que foi invalidada por estudos mais recentes.
Por padrão, apenas a classificação "preferida" é recuperada, mas o parâmetro "rank" permite que você altere isso.
{| class="wikitable"
|-
! Code !! Resultado !! Observações
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186}} || Material da Mona Lisa, exibição padrão (portanto, somente aqueles com a classificação "preferida", se houver)
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid}} || rank = "valid" aceita valores de classificação "normal" e "preferencial" (por exemplo, o material de um quadro que foi adicionado posteriormente à Mona Lisa)
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=normal}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=normal}} || rank = "normal" recupera apenas dados com uma classificação "normal" e ignora aqueles com classificação "preferida"
|}
=== Qualificadores ===
Qualificadores são dados adicionais incorporados em uma instrução Wikidata que podem ser especificados.
{| class="wikitable"
|-
! Code !! Resultado !! Observações
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|qualifier = P518}} || somente retém valores com um qualificador {{WD P|518}}
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|qualifiervalue=Q1737943}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|qualifier = P518|qualifiervalue=Q1737943}} || qualiervalue define o valor que o qualificador possui. Aqui, {{WD Q|1737943}} especifica que o material da estrutura é obrigatório. Note que nenhum valor de classificação "preferido" é encontrado, um valor de classificação "normal" é retornado.
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|rank=valid}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|rank=valid}} || showqualifiers exibe o valor dos qualificadores solicitados entre parênteses, após o valor principal
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|showdate = true|rank=valid}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|rank=valid|showdate = true}} || se os qualificadores que indicam a data forem fornecidos, eles serão exibidos
|}
=== Mostrando fontes ===
<!-- {| class="wikitable"
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P276|sourceproperty = P854}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P276|sourceproperty = P854|nocat=yes}} ||
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493}} ||
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493|showsource=true}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493|showsource=true}} || Mostrar apenas os valores fornecidos pela fonte
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q153 | property = P231|showsource=true}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q153 | property = P231|showsource=true}} ||
|}
<references />
-->=== Outras opções ===
<!-- {| class="wikitable"
|-
! Code !! Resultado !! Observações
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q937 | property = P106|conjtype = new line|showdate= true}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity = Q1299 | property = P527|conjtype = new line|showdate=true}} || conjtype permite definir o separador entre os valores (veja [[Módulo:Linguística]]). Aqui "<nowiki>nova linha</nowiki>" indica que você deve retornar à linha após cada valor.
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=chronological|conjtype =new line}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|sorttype=chronological|showdate=true|conjtype = new line}} || sorttype = chronological tenta classificar os valores em ordem cronológica (com base nos qualificadores). Aqui: os principais eventos ([[:d:P:P793]]) na história do antigo estádio do Arsenal.
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=inverted|conjtype = new line}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q205309 | property = P793|sorttype=inverted|showdate=true|conjtype = new line}} || sorttype = invertida para inverter a ordem cronológica
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|displayformat=raw}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|displayformat=raw}} || exibe os identificadores dos valores (essencialmente úteis para programação)
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|numval=1}}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity =Q12418 | property = P186|numval=1}} || retorna os primeiros valores numéricos correspondentes ao resto da consulta (útil especialmente para recuperar uma imagem)
|-
| <nowiki>{{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity=Q535922 | property=P172 |expl= |value={{WD}} }}</nowiki> || {{#invoke:Infobox/Wikidata|frameFun|formatStatements|entity=Q535922 | property=P172 |expl= |value={{WD}} }} || com expl =, para que o valor da noite retornado requeira valor = <nowiki>{{WD}}</nowiki>
|-
|}
-->
* <kbd>getImageLegend</kbd>: devolve uma legenda da imagem (imagem é a propriedade P18; a legenda da imagem é a propriedade P2096).
*: Faz a chamada como <code><nowiki>{{#invoke:Wikidata |getImageLegend | <PARAMETER> | lang=<ISO-639code> |id=<QID>}}</nowiki></code>
*: Devolve PARÂMETRO, a menos que seja igual a "FETCH_WIKIDATA", de Item QID (chamada cara). Se o QID for omitido ou vazio, o artigo corrente é usado (não é uma chamada cara). Se lang for omitido, ele usa a língua local, de outra modo ele usa o código de língua ISO-639.
*: A etiqueta é devolvida da primeira imagem com rank 'preferido'; ou da primeira imagem com rank 'normal' se nenhuma imagem tem rank preferido.
Outra documentação:
* [[wIRChelp:Lua]]
<includeonly>{{#ifeq:{{SUBPAGENAME}}|Testes||
[[Categoria:!Módulos Wikidata]]
}}</includeonly>
