Help:Predefinições

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:Templates and the translation is 77% complete.

Other languages:
العربية • ‎بلوچی مکرانی • ‎български • ‎català • ‎Deutsch • ‎Zazaki • ‎English • ‎British English • ‎español • ‎suomi • ‎français • ‎עברית • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Lëtzebuergesch • ‎Nederlands • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎slovenčina • ‎தமிழ் • ‎Türkçe • ‎Tiếng Việt • ‎中文 • ‎中文(台灣)‎
PD Note: When you edit this page, you agree to release your contribution under the CC0. See Public Domain Help Pages for more info.
PD

Se pretende incluir o mesmo texto em várias páginas, use a funcionalidade de predefinições do MediaWiki. Unlike extensions and media files, there is no central repository for templates. Templates can be newly written or to save duplicating work already done, exported from another wiki e.g. Wikipedia, and then imported into the target wiki.

Criação[edit | edit source]

Predefinições são páginas wiki normais, cujo conteúdo está concebido para ser transcluído (isto é, integrado) noutras páginas. Por convenção, as predefinições devem ser colocadas no espaço nominal «Template:»; de resto, pode criá-las como cria qualquer outra página.

O uso mais simples de uma predefinição é o seguinte. Se criar a página «Template:Boas-vindas», com este conteúdo:

Olá! Bem-vindo(a) à wiki.

terá criado a sua primeira predefinição. Se depois colocar o código:

{{Boas-vindas}}

em qualquer outra página, aparecerá nessa página o texto «Olá! Bem-vindo(a) à wiki.» em vez de {{Boas-vindas}}. Diz-se que o conteúdo da predefinição foi «transcluído» para dentro da outra página, isto é, que foi integrado nela.

Pode colocar este código em todas as páginas onde deseje dar as boas-vindas a alguém. Imagine que o usa em 100 páginas. Se depois alterar o conteúdo da predefinição para:

Olá! Bem-vindo(a) a esta wiki maravilhosa.

e voltar a qualquer das 100 páginas onde usou a predefinição, verá o novo texto em vez do antigo. Desta forma, alterou o conteúdo das 100 páginas sem as editar, porque elas transcluem o conteúdo da sua predefinição.

Este é o mecanismo básico. Existem várias opções que enriquecem este mecanismo e tornam as predefinições extremamente úteis.

Uso[edit | edit source]

Se criar uma predefinição com o nome «Template:Nome», pode transcluir o conteúdo da predefinição para dentro de outras páginas colocando, na posição onde deseja incorporar o conteúdo da predefinição, uma destas formas:

  • {{Nome}}, integra o conteúdo da predefinição na página de destino sempre, quando a página de destino é apresentada ao utilizador. Se entretanto a predefinição for alterada, o conteúdo na página de destino também será alterado automaticamente.
  • {{subst:Nome}}, é substituído pelo conteúdo da predefinição uma única vez, quando a página de destino é gravada. O conteúdo da predefinição torna-se parte integrante do conteúdo da página de destino e pode depois ser editado nesta, separadamente do original na página da predefinição. Alterações posteriores à predefinição, não serão reflectidas na página de destino.
  • {{safesubst:Nome}} permite uma forma de substituição que não quebra a transclusão; consulte w:en:Help:Substitution#safesubst: para mais detalhes (introduzido na rev:61710).
  • {{msgnw:Nome}}, integra o conteúdo da predefinição na página de destino sempre que a página de destino é apresentada ao utilizador, mas de forma não interpretada pelo analisador sintáctico, isto é, tal como se estivesse rodeada pelo elemento <nowiki>.

In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:

  • {{Template:Nome}} também transclui a página [[Template:Nome]]
  • {{Foo:Pagename}} includes [[Foo:Pagename]]
  • {{:Nome}} transclui a página [[Nome]]
    • {{subst:Nome}} é substituído pelo conteúdo da página [[Template:Nome]]

Se o espaço nominal especificado não existir, o MediaWiki assume que o título completo é uma predefinição:

  • {{Xpto:Nome}} transclui a página [[Template:Xpto:Nome]]

Parâmetros[edit | edit source]

Para enriquecer o mecanismo de transclusão, o MediaWiki permite que sejam passados parâmetros a uma predefinição, quando está é transcluída. Os parâmetros permitem que a predefinição produza resultados diferentes ou se comporte de formas diferentes.

Suppose you wish to insert a little thank you note in the talk page of other users, such as:

Imagem de exemplo
Um obrigadinho...
pelo teu esforço.
Abraço, Eu


O agradecimento conterá uma razão (neste caso, «pelo teu esforço») e a assinatura de quem agradece (neste caso, «Eu»). O objectivo é que o agradecimento possa ser feito por qualquer utilizador a outro, para agradecer qualquer coisa.

Para que o aspecto desta caixa de agradecimento seja igual em todos os agradecimentos, pode usar uma predefinição, chamada Template:Thankyou/pt, por exemplo. Embora o aspecto se mantenha de cada vez que alguém agradece a alguém, o conteúdo específico (a razão e a assinatura) será diferente. Por isso, deve-se passá-los como parâmetros. Ignorando os restantes elementos de formatação, tais como a linha que forma a caixa e a imagem, o conteúdo central da predefinição será este:

'''Um obrigadinho...'''
{{{1}}}.
Abraço, {{{2}}}

Repare no uso de {{{1}}} e {{{2}}}. Esta é a forma como, dentro das predefinições, se identifica os parâmetros que serão passados quando a predefinição for usada. Note que, dentro da predefinição, cada parâmetro é rodeado por três chavetas: {{{ }}}.

Quando uma predefinição é usada, passam-se os parâmetros separando-os com barras verticais (|). O MediaWiki permite que sejam passados parâmetros às predefinições de três formas.

Parâmetros anónimos[edit | edit source]

Para passar parâmetros de forma anónima, liste os valores dos parâmetros sequencialmente, desta forma:

{{Thankyou/pt|pelo teu esforço|Eu}}

Neste caso, a predefinição {{Thankyou/pt}} recebe os parâmetros {{{1}}}=pelo teu esforço e {{{2}}}=Eu e produz:

Imagem de exemplo
Um obrigadinho...
pelo teu esforço.
Abraço, Eu


Portanto, a ordem de passagem de parâmetros anónimos é crucial para o comportamento da predefinição. Inverter a ordem dos parâmetros:

{{Thankyou/pt|Eu|pelo teu esforço}}

would produce this result:

Imagem de exemplo
Um obrigadinho...
Eu.
Abraço, pelo teu esforço


causa que a predefinição {{Thankyou/pt}} receba os parâmetros {{{1}}}=Eu e {{{2}}}=pelo teu esforço e inverte o resultado:

Parâmetros numerados[edit | edit source]

Para passar parâmetros por número, identifique o número de cada parâmetro ao passá-lo:

{{Thankyou/pt|2=Eu|1=pela tua amizade}}

Desta vez, a predefinição {{Thankyou/pt}} recebe os parâmetros {{{1}}}=pela tua amizade e {{{2}}}=Eu, embora estes tenham sido fornecidos por ordem inversa. Este código resulta no seguinte:

Parâmetros com nome[edit | edit source]

A terceira forma de identificar os parâmetros é por um nome, em vez de usar números. Neste caso, o conteúdo da predefinição seria alterado para:

'''Um obrigadinho...'''
{{{razão}}}.
Abraço, {{{assinatura}}}

Assim, dentro da predefinição usa-se {{{razão}}} e {{{assinatura}}}. Para passar estes parâmetros por nome, identifica-se o nome de cada parâmetro ao passá-lo:

{{Thankyou/pt|razão=por seres quem és|assinatura=Eu}}

Neste caso, a predefinição {{Thankyou/pt}} recebe os parâmetros {{{razão}}}=por seres quem és e {{{assinatura}}}=Eu. Este código resulta no seguinte:

Imagem de exemplo
Um obrigadinho...
por seres quem és.
Abraço, Eu

A vantagem de usar parâmetros com nome na predefinição, para além de também ser flexível quanto à ordem de passagem dos parâmetros, é que torna o código da predefinição muito mais fácil de compreender se forem usados muitos parâmetros.

Valores por omissão[edit | edit source]

Se transcluir uma predefinição que espera receber parâmetros, mas não os passar, desta forma:

{{Thankyou/pt}}

no exemplo acima dos parâmetros numerados, obterá o seguinte:

Imagem de exemplo
Um obrigadinho...
{{{1}}}.
Abraço, {{{2}}}


Como não foram passados parâmetros, a predefinição apresenta os parâmetros em si mesmos, em vez de apresentar os respectivos valores. Nestes casos, pode ser útil definir valores por omissão para os parâmetros, isto é, valores que serão usados se o parâmetro não for passado. Por exemplo, se alterar o conteúdo da predefinição para:

'''Um obrigadinho...'''
{{{razão|por tudo}}}.
Abraço, {{{assinatura|Eu}}}

então {{{razão|por tudo}}} define que se não for passado o parâmetro {{{razão}}} será usado o valor por tudo. De forma semelhante, {{{assinatura|Eu}}} define que por omissão do parâmetro {{{assinatura}}} será usado o valor Eu. Agora, a mesma transclusão da predefinição sem passar quaisquer parâmetros resulta no seguinte:

Imagem de exemplo
Um obrigadinho...
por tudo.
Abraço, Eu


Controlar a inclusão das predefinições[edit | edit source]

Por omissão, quando uma página é transcluída, é transcluído todo o seu conteúdo, e quando é visionada directamente, é apresentado todo o seu conteúdo. No entanto, frequentemente existem razões para querer que uma parte específica do conteúdo seja visível só na página de origem e não na de destino. Ou, inversamente, para que uma parte do conteúdo da página não apareça ao visionar a página de origem e só apareça na de destino, quando ela é transcluída.

É possível impedir que parte do conteúdo de uma página seja incluído noutra, usando o elemento <noinclude>. Ao visionar a página directamente, o conteúdo entre <noinclude> e </noinclude> será visível mas, se a página for transcluída, ele não será transcluído para a página de destino. Portanto, esta parte do conteúdo só aparecerá na página de origem e nunca na de destino. As aplicações mais frequentes são:

  • Categorização da própria predefinição, sem categorizar as páginas de destino.
  • Inserção de links interlínguas para predefinições semelhantes noutras línguas.
  • Documentação do uso da predefinição.

A operação inversa é feita com o elemento <includeonly>. O texto que estiver entre <includeonly> e </includeonly> não é visível na página de origem e só aparece quando a página é transcluída. Portanto, esta parte do conteúdo não aparece na página de origem e só aparece na página de destino. As aplicações mais frequentes são:

  • Categorização das páginas de destino, sem categorizar a própria predefinição.
  • O código da predefinição em si, porque frequentemente esta não apresenta o resultado desejado se for visionada na página de origem (porque não lhe estão a ser passados os parâmetros que espera).

Everything outside <noinclude> and <includeonly> tags is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page.

Organização das predefinições[edit | edit source]

Para que as predefinições sejam úteis, os utilizadores precisam de encontrá-las e saber como usá-las.

Para encontrar todas as predefinições, um utilizador deve:

  1. Clicar Páginas especiais e depois Todas as páginas
  2. No campo Domínio:, escolha Template e clique Ver.

Nas predefinições, deve ser fornecida informação acerca do seu uso e incluído um exemplo como o seguinte:

<noinclude>
== Uso ==
Agradecer a alguém:
{{Thankyou/pt|razão=a sua razão|assinatura=a sua assinatura}}
</noinclude>

Assim, um utilizador pode simplesmente copiar o exemplo e inseri-lo numa página.

Copiar predefinições de uma wiki para outra[edit | edit source]

As predefinições usam frequentemente código CSS e outras predefinições. Por isso, os utilizadores têm frequentemente dificuldade em copiar uma predefinição de uma wiki para outra, porque estes elementos necessários estão noutras páginas. Os seguintes passos podem ajudar:

MediaWiki code[edit | edit source]

Se tem permissões de importar páginas na wiki de destino:

  1. Vá à página Exportar páginas da wiki de origem. Introduza o nome da predefinição na caixa de texto, marque a caixa de selecção «Incluir predefinições» e clique o botão «Exportar». Isto exportará a predefinição para um ficheiro .xml.
    • Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
    • Check the box "Include templates".
    • Uncheck the box "Include only the current revision, not the full history".
    • Click "Export".
  2. Vá à página Importar páginas da wiki de destino e importe o ficheiro .xml.

Se não tem permissões de importar páginas na wiki de destino:

  1. Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
  2. On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
  3. Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

This will copy the entire code necessary, and will suffice for some templates. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well.

After sucessfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

Extensions[edit | edit source]

Se a predefinição usa a extensão ParserFunctions, tem de instalar esta extensão na wiki de destino.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having {{#invoke: }} in template code is a good sign for it. In case it's used, you need to install the Scribunto extension and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS and JavaScript code[edit | edit source]

Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.

  1. Look for the use of CSS classes (text like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
  2. If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

Ver também[edit | edit source]