Módulo:Wikidata/Testes/doc

Módulo a ser usado para recuperar e formatar dados do Wikidata.

Tanto quanto possível, este módulo deve ser linguisticamente neutro. Para textos especificamente portuguêses, veja Módulo:Wikidata/i18n.

Funções exportáveis

Funções que operam em um snak

Nome	Argumentos	Descrição
formatSnak	snak, params	Obtenha o valor de um snak e coloque-o em forma
getDataValue	snak, params	Recupera o valor de um snak com um valor do tipo "value" e o formata
isSpecial	snak	retorna true </ code> se um snak é um valor especial (novalue ou somevalue)
getId	snak	retorna o identificador Qdd do elemento usado como um valor de lanchonete

Funções que operam no nível de uma afirmação

Nome	Argumentos	Descrição
formatStatement	params	Transforma uma declaração individual em uma string wikitexto, usando os mesmos parâmetros que stringTable
getDate	statement, qualifs	recupera as informações de data armazenadas em uma declaração Wikidata (qualificadores ou valor principal) e as armazena como uma tabela
getFormattedDate	statement, params	recupera a data associada a uma declaração Wikidata como getDate, mas a retorna como uma string formatada de acordo com os parâmetros params
hasQualifier	claim, acceptedqualifs, acceptedvals, excludequalifiervalues	retorna true 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	claim	retorna o identificador Qdd do elemento usado como o valor do "mainsnak" de uma declaração
getFormattedQualifiers	statement, qualifs, params	a partir de uma afirmação, retorna uma string contendo os qualificadores solicitados. A tabela params permite personalizar a exibição, veja #Settings.
getReferences	statement	recupera e exibe a parte de referências de uma instrução Wikidata.
addtrackingcat	property, cat	categoriza em [[Categoria:!Artigos que utilizam $property]]

Funções operando em um nível de entidade

Nome	Argumentos	Descrição
sortClaims	claims	Coloque uma série de valores em ordem. A ordem pode ser 'cronológica'ou'invertida' (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 sorttype de wd.formatGetClaims e, portanto, também wd.formatStatements
filterClaims	claims, params	Obtém uma tabela de instruções e exclui aquelas que não correspondem aos critérios fornecidos na tabela params </ code>. Para a lista desses argumentos, veja a ajuda abaixo
getClaims	params	entity = e |property = , e pode conter muitos outros parâmetros opcionais, consulte #Configuração.
getIds	params	Seleciona instruções da mesma forma que os conjuntos getClaims em vez de retornar instruções completas, apenas retorna o identificador de seu mainsnak (só funciona para dados do tipo elemento).
stringTable		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	params	Retorna os mesmos valores que stringTable, mas concatenados como uma única string. O método de concatenação é definido pelo parâmetro conjtype que usa Módulo:Linguística. Se linkback e addcat estiverem habilitados, um trackback e uma categoria de manutenção também podem ser adicionados.
formatAndCat	params	Mesma função que formatStatements, mas adicione um trackback ao Wikidata e uma categoria de manutenção
getTheDate	params	exibe uma data que está no valor principal ou como um qualificador da propriedade prop do elemento item
mainDate	entity	Recupera e formata a "data principal" que pode ser associada ao elemento, com base em suas propriedades P580 (« data inicial »), P582 (« data final ») e P585 (« data de ocorrência »)
keyDate	event, item, params	Recupera e formata uma data do elemento item. event 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 P793 (« evento notável ») e retornará a data indicada como um qualificador. <Código>evento 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, wd.keyDate ('Q1417098', 'P1690'} irá procurar o valor em P793 (« evento notável ») Q1417098 (« tomada de posse ») e se não encontrar nada, irá procurar em P1690 (« ICD-10-PCS »).
getLabel	entity, lang, labelformat	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 labelformat é usado para definir uma exibição alternativa. Seu valor deve ser uma função tomando como argumento a entidade e retornando uma string.
siteLink	entity, lang, project	retorna um link para a página do projeto solicitada ('wikipédia', 'wikivoyage', 'commons') etc. vinculado à entidade Wikidata especificada, no idioma solicitado. Por padrão, o idioma é português e o projeto Wikipédia.
formatEntity	entity, params	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	entity, lang	exibe a descrição do Wikidata para uma determinada entidade, em um determinado idioma (o padrão é o português)
getNumericId	snak	retorna o identificador numérico do elemento usado como o valor de um lanche
getEntity	str	retorna a tabela de dados correspondente a um identificador (inverso de getEntityId)
getEntityId	str	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

Nome	Argumentos	Descrição
isSubclass	class, item, maxdepth
isinstance	class, item, maxdepth
inTransitiveVals	searchedval, sourceval, query, maxdepth, maxnodes

Diversos

Nome	Argumentos	Descrição
Dump	entity	exibir o conteúdo de uma entidade Wikidata
sourceStr
frameFun	(frame)	chama uma das funções anteriores do quadro. O nome da função é dado no argumento 1
addRefAnchor
addLinkback		adicionar um trackback (normalmente usado por formatStatements {arglinkback = true}, 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	searchset, val	retorna true se a string val estiver na tabela searchset
addNewValues	old, new	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 filterclaims e, portanto, indiretamente pelas funções de chamada, como getClaims e formatStatements.

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 property e entity 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. 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 property = PXX. 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 |excludespecial = true Em Lua, ativado por um booleano (excludespecial = true)
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 showqualifiers
qualifiervalue	Lua e wikicode	O qualificador usado pelo argumento 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, 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 P248 (« afirmado em ») ou outra propriedade definida pelo parâmetro sourceproperty. Para aceitar qualquer fonte, desde que use a propriedade solicitada, defina o valor any. Para desabilitar esse parâmetro, defina o valor -.
sourceproperty	Lua e wikicode	Propriedade a ser usada para o parâmetro withsource
rank	Lua e wikicocde	Ranks aceites : preferred normal deprecated valid (= preferred + normal) best (preferred, ou, se nenhum atende aos outros critérios da consulta, normal) Valor por padrão : best
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 true, o site usado será a Wikipédia em português.
withdate	Lua e wikicode	Somente valores de retorno com um qualificador de data : P585 (« data de ocorrência »), P580 (« data inicial »), P582 (« data final »)
atdate	Lua e wikicode	Exclui valores cujos qualificadores P580 (« data inicial ») ou P582 (« data final ») 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 withdate). Para solicitar o valor na data de hoje, use: |atdate = today.
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 true </ code>, a declaração será mantida
sorttype	Lua e wikicode	Como classificar declarações. Valores possíveis:* chronological inverted (cronológica invertida funções Lua (ver a função sortClaims)

Activação / desativação de Wikidata

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 linkback e addcat)
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 {{ WD}} (útil para dados atualizados, mas cuja utilidade em cada artigo é difícil) decidir automaticamente).

Formatação de dados

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 conj do Módulo:Linguística. Valores possíveis: and adicionando "ou" entre o penúltimo e último valor or adicionando "ou" entre o penúltimo e último valor comma vírgulas em todos os lugares new line um retorno de linha Qualquer outro valor dado ao parâmetro será inserido entre cada valor (|conjtype = e então também 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 «  »
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 true, 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 (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.
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	ucfirst = - para desabilitar isso
statementformat	declaração	Lua	deve ser uma função function (statement) retornar XX 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. weblink </ code> transforma dados de string em um link da web raw </ code> retorna um formato mais bruto, às vezes útil para codificação latitude para Módulo:Coordenadas longitude 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 displayformat. Quando este parâmetro é deixado vazio, os qualificadores usam o parâmetro displayformat 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. true </ code> mostrará todas as fontes usando a propriedade P248 (« afirmado em »).
linktopic	snak (temporada)	Lua e wikicode	Tipo de link para adicionar às datas (consulte Módulo: Data). Para não colocar nenhum link : linktopic = -
precision	snak (temporal)	Lua e wikicode	Precisão com quais datas devem ser exibidas. Valores possíveis: day month year Valor por padrão : day
textformat	snak (temporal)	Lua e wikicode	Exibir formato de intervalos de tempo, conforme definido por Módulo:Data complexa minimum 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 |showqualifiers = P460 , em Lua como showqualifiers = "P460" ou showqualifiers = {"P460 "," P461 "}
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: Wikipédia em inglês ou, se não, Wikidata. O valor "-" desabilita o parâmetro.
defaultlinkquery	snak (entidade)	Lua	defaultlinkquery = {property = 'P279'} o link criado será aquele fornecido pelo elemento usado na propriedade P279 (« subclasse de »).
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: 'long': exibe o nome completo da unidade (por exemplo, "12,7 metros") 'short' exibe a abreviação usada convencionalmente ("12,7 m") '-' : nenhuma unidade exibida padrão: 'curto'
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 Com a propriedade P214 (« identificador VIAF ») e o valor do parâmetro http://viaf.org/viaf/$1, 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 displayformat = "weblink" ou com o parâmetro urlpattern 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: "-". 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". 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

Code	Resultado	Observações
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity = Q79 | property = P36}}		Capital do Egito, formato padrão
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity = Q79 | property = P36|link=-}}		Capital do Egito, sem link
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity = Q79 | property = P36|link=wikidata}}		Capital do Egito, com link para Wikidata
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity = Q937 | property = P569}}		O aniversário de Albert Einstein, usando o formato padrão da Wikipédia em português
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity = Q937 | property = P569|linktopic = futebol }}		Data de nascimento do Einstein, com links especializados em futebol
{{#invoke:Wikidata/Testes|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.

Code	Resultado	Observações
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q12418 | property = P186}}		Material da Mona Lisa, exibição padrão (portanto, somente aqueles com a classificação "preferida", se houver)
{{#invoke:Wikidata/Testes|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)
{{#invoke:Wikidata/Testes|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.

Code	Resultado	Observações
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518}}		somente retém valores com um qualificador P518 (« aplicável a »)
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q12418 | property = P186|showqualifiers = P518|qualifiervalue=Q1737943}}		qualiervalue define o valor que o qualificador possui. Aqui, Q1737943 (« moldura ») especifica que o material da estrutura é obrigatório. Note que nenhum valor de classificação "preferido" é encontrado, um valor de classificação "normal" é retornado.
{{#invoke:Wikidata/Testes|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
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q12418 | property = P186|showdate = true|rank=valid}}		se os qualificadores que indicam a data forem fornecidos, eles serão exibidos

Mostrando fontes

{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q12418 | property = P276|sourceproperty = P854}}
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493}}
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q11879536 | property = P460|withsource=Q1645493|showsource=true}}		Mostrar apenas os valores fornecidos pela fonte
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q153 | property = P231|showsource=true}}

Outras opções

Code	Resultado	Observações
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity = Q937 | property = P106|conjtype = new line|showdate= true}}		conjtype permite definir o separador entre os valores (veja Módulo:Linguística). Aqui "nova linha" indica que você deve retornar à linha após cada valor.
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=chronological|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.
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q205309 | property = P793|showdate=true|sorttype=inverted|conjtype = new line}}		sorttype = invertida para inverter a ordem cronológica
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity =Q12418 | property = P186|displayformat=raw}}		exibe os identificadores dos valores (essencialmente úteis para programação)
{{#invoke:Wikidata/Testes|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)
{{#invoke:Wikidata/Testes|frameFun|formatStatements|entity=Q535922 | property=P172 |expl= |value={{WD}} }}		com expl =, para que o valor da noite retornado requeira valor = {{WD}}