Módulo:Mbabel/doc

Módulo projetado para simplificar a criação de predefinições de narrativas estruturadas usadas pelo {{Mbabel}}. Quando chamado, ele retorna o texto com a informação desejada do Wikidata substituída; Caso a informação não exista, o texto não é exibido.

Uso

O módulo apresenta três tipos de chamadas: title, phrase e reference. Dentro do ambiente de criação dos templates para o Mbabel, todas as chamadas devem ser configuradas de modo a só serem substituídas quando o usuário salvar sua página de testes. Isso é feito usando uma combinação de {{subst}} e da tag <noinclude />, por exemplo: {{subst:<noinclude />#invoke:Mbabel|title|qid=<qid>}}

Função title

A função title retorna o título de um item Wikidata.

Parâmetros

• qid: Código identificador do item no Wikidata.

Uso

• Sem substituição:
  • {{#invoke:Mbabel|title|qid=<qid>}}
• Com substituição:
  • {{subst:#invoke:Mbabel|title|qid=<qid>}}
• Com substituição (para uso na construção de predefinições):
  • {{subst:<noinclude />#invoke:Mbabel|title|qid=<qid>}}

Exemplos

• Sem substituição:
  • {{#invoke:Mbabel|title|qid=Q208363}} → Eru Ilúvatar
• Com substituição:
  • {{subst:#invoke:Mbabel|title|qid=Q208363}} → Eru Ilúvatar
• Com substituição (para uso na construção de predefinições):
  • {{subst:<noinclude/>#invoke:Mbabel|title|qid=Q208363}} → {{subst:#invoke:Mbabel|title|qid=Q208363}}

Função phrase

A função phrase retorna uma frase substituída com uma informação do Wikidata.

Parâmetros

Obrigatórios

• pid: Código identificador de uma propriedade Wikidata (Ex: P1441).
• qid: Código identificador do item no Wikidata (Ex: Q208363).
• text: Frase com partes fixas e partes variáveis que dependem do valor retornado do Wikidata (Ex: Presente em @.).
• var: Expressão ou variável ou caractere que identifica na |text= as partes variáveis (Ex: @).

Nota: O primeiro parâmetro pid é um parâmetro não nomeado, isto é, deve ser passado como |<pid>|. Os demais são passados como |qid=<qid>, |text=<text> e |var=<var>.

Opcionais

Esta função aceita todos os parâmetros opcionais que a função getPreferredValue aceita.

Uso

• Sem substituição:
  • {{#invoke:Mbabel|phrase|<pid>|qid=<qid>|text=<text>|var=<var>}}
  • {{#invoke:Mbabel|phrase|<pid>|qid=<qid>|text=<text>|var=<var>|parameter1=<parameter1>|...|parameterx=<parameterx>}}
• Com substituição:
  • {{subst:#invoke:Mbabel|phrase|<pid>|qid=<qid>|text=<text>|var=<var>}}
  • {{subst:#invoke:Mbabel|phrase|<pid>|qid=<qid>|text=<text>|var=<var>|parameter1=<parameter1>|...|parameterx=<parameterx>}}
• Com substituição (para uso na construção de predefinições):
  • {{subst:<noinclude />#invoke:Mbabel|phrase|<pid>|qid=<qid>|text=<text>|var=<var>}}
  • {{subst:<noinclude />#invoke:Mbabel|phrase|<pid>|qid=<qid>|text=<text>|var=<var>|parameter1=<parameter1>|...|parameterx=<parameterx>}}

Exemplos

• Sem substituição:
  • {{#invoke:Mbabel|phrase|P1441|qid=Q208363|text=Presente em ''@''|var=@}} → Presente em O Silmarillion, Contos Inacabados de Númenor e da Terra Média
  • {{#invoke:Mbabel|phrase|P1441|qid=Q208363|text=Presente em ''@''|var=@|artigosemlink=sim}} → Presente em O Silmarillion, Contos Inacabados de Númenor e da Terra Média
• Com substituição:
  • {{subst:#invoke:Mbabel|phrase|P1441|qid=Q208363|text=Presente em ''@''|var=@}} → Presente em O Silmarillion
  • {{subst:#invoke:Mbabel|phrase|P1441|qid=Q208363|text=Presente em ''@''|var=@|artigosemlink=sim}} → Presente em O Silmarillion
• Com substituição (para uso na construção de predefinições):
  • {{subst:<noinclude />#invoke:Mbabel|phrase|P1441|qid=Q208363|text=Presente em ''@''|var=@}} → {{subst:#invoke:Mbabel|phrase|P1441|qid=Q208363|text=Presente em @|var=@}}
  • {{subst:<noinclude />#invoke:Mbabel|phrase|P1441|qid=Q208363|text=Presente em ''@''|var=@|artigosemlink=sim}} → {{subst:#invoke:Mbabel|phrase|P1441|qid=Q208363|text=Presente em @|var=@|artigosemlink=sim}}

Função reference

A função reference retorna uma referência substituída com uma informação do Wikidata.

Parâmetros

Obrigatórios

• pid: Código identificador de uma propriedade Wikidata (Ex: P268).
• qid: Código identificador do item no Wikidata (Ex: Q892).
• text: Código da referência desejada com partes fixas e partes variáveis que dependem do valor retornado do Wikidata (Ex: {{citar web|url=https://catalogue.bnf.fr/ark:/12148/cb@|título=J.R.R.Tolkien - Biblioteca Nacional da França|publicado=[[Biblioteca Nacional da França]]|acessodata=28 de junho de 2024}}.).
• var: Expressão ou variável ou caractere que identifica na |text= as partes variáveis (Ex: @).
• name: Nome da referência. Ajuda a criar a referência no formato <ref name = "<name>">...</ref>

Nota: O primeiro parâmetro pid é um parâmetro não nomeado, isto é, deve ser passado como |<pid>|. Os demais são passados como |qid=<qid>, |text=<text>, |var=<var> e |name=<name>.

Opcionais

Esta função aceita todos os parâmetros opcionais que a função getPreferredValue aceita.

Uso

• Sem substituição:
  • {{#invoke:Mbabel|reference|<pid>|qid=<qid>|text=<text>|var=<var>}}
  • {{#invoke:Mbabel|reference|<pid>|qid=<qid>|text=<text>|var=<var>|parameter1=<parameter1>|...|parameterx=<parameterx>}}
• Com substituição:
  • {{subst:#invoke:Mbabel|reference|<pid>|qid=<qid>|text=<text>|var=<var>}}
  • {{subst:#invoke:Mbabel|reference|<pid>|qid=<qid>|text=<text>|var=<var>|parameter1=<parameter1>|...|parameterx=<parameterx>}}
• Com substituição (para uso na construção de predefinições):
  • {{subst:<noinclude />#invoke:Mbabel|reference|<pid>|qid=<qid>|text=<text>|var=<var>}}
  • {{subst:<noinclude />#invoke:Mbabel|reference|<pid>|qid=<qid>|text=<text>|var=<var>|parameter1=<parameter1>|...|parameterx=<parameterx>}}

Exemplos

• Sem substituição:
  • {{#invoke:Mbabel|phrase|P268|qid=Q892|text={{citar web|url=https://catalogue.bnf.fr/ark:/12148/cb@|título=J.R.R.Tolkien - Biblioteca Nacional da França|publicado=[[Biblioteca Nacional da França]]}}|var=@|name=BNF}} → <ref name="BNF">«J.R.R.Tolkien - Biblioteca Nacional da França». Biblioteca Nacional da França </ref>
• Com substituição:
  • {{subst:#invoke:Mbabel|phrase|P268|qid=Q892|text={{citar web|url=https://catalogue.bnf.fr/ark:/12148/cb@|título=J.R.R.Tolkien - Biblioteca Nacional da França|publicado=[[Biblioteca Nacional da França]]}}|var=@|name=BNF}} →
• Com substituição (para uso na construção de predefinições):
  • {{subst:<noinclude />#invoke:Mbabel|phrase|P268|qid=Q892|text={{citar web|url=https://catalogue.bnf.fr/ark:/12148/cb@|título=J.R.R.Tolkien - Biblioteca Nacional da França|publicado=[[Biblioteca Nacional da França]]}}|var=@|name=BNF}} → {{subst:#invoke:Mbabel|phrase|P268|qid=Q892|text=«J.R.R.Tolkien - Biblioteca Nacional da França». Biblioteca Nacional da França |var=@|name=BNF}}