Wikipedia: namespace do modelo
Diretrizes da Wikipedia | |||
---|---|---|---|
Comportamental | |||
|
|||
Contente | |||
Editando | |||
|
|||
Estilo | |||
Eliminação | |||
Conteúdo do projeto | |||
De outros | |||
O namespace Template na Wikipedia é usado para armazenar templates , que contêm marcação Wiki destinada à inclusão em múltiplas páginas, geralmente por meio de transclusão . Embora o namespace Template seja usado para armazenar a maioria dos templates, é possível transcluir e substituir de outros namespaces, [1] e assim algumas páginas de template são colocadas em outros namespaces, como o namespace User .
Os modelos ajudam a manter uma formatação consistente e auxiliam na navegação entre os artigos. Eles geralmente incluem elementos opcionais e / ou variáveis controlados por parâmetros para permitir o uso especializado. Os modelos também são usados para auxiliar em uma grande variedade de tarefas de manutenção da Wikipedia . Cada modelo tem uma Template talk:
página correspondente onde os editores podem discutir o design e a implementação do modelo associado (consulte a Ajuda: Usando páginas de discussão para saber como participar de discussões na página de discussão).
Um modelo é transcluído em outra página incluindo uma tag de modelo no conteúdo dessa página. Uma tag de modelo contém o nome da página de modelo entre chaves duplas, por exemplo {{Disambiguation}}
. Se o nome da página do modelo não começar com um namespace e dois pontos, presume-se que está no namespace do modelo.
Links internos para páginas de modelo podem ser feitos usando o Template:
prefixo, por exemplo [[Template:Disambiguation]]
. Esses links levam a uma página que contém diretamente um modelo básico e, frequentemente, documentação .
Diretrizes
- Normalmente, os modelos não devem ser usados para armazenar o texto do artigo , pois isso torna mais difícil editar o conteúdo. Eles também não devem ser usados para "reduzir" ou "ocultar" o conteúdo do leitor.
- Os modelos usados em artigos são projetados para fornecer informações para auxiliar os leitores, como auxílios à navegação, formatação ou avisos de que o conteúdo está abaixo do padrão. Os modelos que fornecem informações apenas de serviço aos editores não devem aparecer nas páginas do artigo - use a página de discussão do artigo ou outros namespaces que não sejam do artigo.
- A função do modelo deve estar clara no nome do modelo , mas redirecionamentos podem ser criados para ajudar no uso diário de modelos muito populares.
- Os modelos de alto risco devem ser semiprotegidos, protegidos por modelos ou totalmente protegidos, conforme apropriado (consulte Wikipedia: Política de proteção ). Isso também se aplica a qualquer redirecionamento de modelo de alto uso.
- Os modelos devem ser claramente documentados quanto ao seu uso e escopo.
- Os modelos não devem ser usados para criar listas de links para outros artigos quando uma categoria , página de lista ou lista de seção "Consulte também" pode executar a mesma função.
- Os modelos para mensagens curtas e temporárias que serão removidas rapidamente (como em User_talk: pages) ou que contêm texto que provavelmente nunca será alterado devem ser chamados com substituição (subst :). Os modelos típicos que se destinam ao uso de longo prazo e provavelmente requerem alterações devem ser transcluídos para facilitar as atualizações futuras.
- Os modelos que violam as diretrizes desta página, têm função mal definida, são redundantes, tornam-se órfãos ou usados em apenas uma página ou violam outras políticas da Wikipedia podem ser indicados para exclusão em Wikipedia: Modelos para discussão .
Práticas sugeridas
Modelos de referência
Às vezes, você desejará referir - se a um modelo, em vez de invocá-lo de fato. Uma maneira fácil de fazer isso é chamar Template: Tl (abreviação de "link de modelo"). Por exemplo, para fazer referência ao modelo de Limpeza, digite os {{tl|Cleanup}}
resultados em {{ Limpeza }}. Você também pode adicionar parâmetros usando Template: Tlp ; por exemplo, é {{tlp|Convert|1|m}}
exibido como {{ Convert | 1 | m}} .
Verifique a documentação do modelo em Modelo: Tl para outras opções, como {{ tlb }} (negrito), (código), (parâmetros em itálico) e muitos mais.
{{tlx}}
{{tlxi|param1|param2}}
Nomes de modelos
Os nomes dos modelos podem ser compostos por uma ou mais palavras, como {{Train topics}}
. O primeiro caractere (somente) não faz distinção entre maiúsculas e minúsculas, então {{cleanup}}
e {{Cleanup}}
são o mesmo modelo, mas {{cfd}}
e {{cfD}}
não são. Os nomes dos modelos são mais fáceis de lembrar se eles seguirem a ortografia, o espaçamento e a capitalização padrão do inglês (consulte também as convenções de nomenclatura para artigos). Evite modelos cujos nomes difiram apenas em maiúsculas e minúsculas, espaçamento ou pontuação.
Sandbox para experimentos
Se desejar experimentar modelos (e não excluir seus experimentos antes de concluí-los), você pode fazer isso na caixa de proteção do modelo . Você também pode usar os modelos X1 , X2 , X3 , X4 , X5 , X6 , X7 , X8 , X9 , X10 , X11 e X12 para fins experimentais. Para incluir um modelo de teste, use o formulário {{X1}}
para o modelo X1, {{X2}}
para o modelo X2, etc.
Os modelos existentes geralmente têm sua própria caixa de areia e páginas de casos de teste (especialmente aqueles que usam {{ Documentation }}). As alterações devem ser testadas exaustivamente antes de serem aplicadas ao modelo principal, a fim de evitar danos não intencionais a muitas páginas.
Legibilidade
Para modelos que usam um grande número de parâmetros, pode ser útil colocar cada parâmetro em uma linha separada e alinhar os sinais de igual. Isso ajuda os futuros editores a ler o wikicode com mais facilidade.
{{Nome do modelo de exemplo | first_parameter = Texto de first_value | second_parameter = Texto do second_value | third_parameter = Texto do third_parameter | etc = etc }}
Quebras de linha
Alguns modelos podem causar acidentalmente quebras de linha extras nos artigos renderizados. Isso é especialmente verdadeiro para modelos de infobox e outras caixas de modelo que geralmente flutuam no lado direito de um artigo, uma vez que as linhas adicionais não serão vistas na página do modelo. Para obter mais informações, consulte Wikipedia: Tratamento de quebra de linha .
Como orientação geral, evite duas quebras de linha juntas em seu modelo. Eles podem se "somar" a outras quebras de linha no artigo e ser exibidos como espaços em branco indesejados.
Substituição
Invocando um modelo usando o formulário
{{subst:name of template (|parameters |...)}}
(isto é, inserir subst:
imediatamente após o par de chaves de abertura) fará uma cópia do texto do modelo e o colocará na página, onde poderá ser visualizado no código-fonte. O modelo não é mais transcluído e futuras alterações no modelo não alterarão o texto. Como orientação , este método deve ser usado para quaisquer mensagens curtas e temporárias que são removidas rapidamente, como em User_talk: pages. A nova mensagem padrão do usuário é um bom exemplo.
{{Welcome}}
Use subst: também se precisar editar a mensagem após incluí-la na página. Se você não precisar editá-lo e preferir que a mensagem seja atualizada automaticamente junto com as alterações feitas no modelo, não use subst :.
Documentação
Como os modelos representam uma dificuldade maior para o editor novato, a documentação deve ser fornecida descrevendo seu uso (parâmetros opcionais) e escopo (onde deve ser usado). Existem duas maneiras diferentes de fazer isso:
Uma alternativa é usar <noinclude> para adicionar uma descrição secundária diretamente no modelo, por exemplo:
'' 'Este é um {{{1}}} artigo.' '' <noinclude> Coloque este modelo em qualquer artigo que requeira descrição. Isto leva um parâmetro, um adjetivo usado para descrever o artigo. Por exemplo, {{article-describe | bad}} produz o texto, '' 'Este é um artigo ruim.' '' </noinclude>
Outra alternativa é criar uma subpágina formal / doc para a documentação (preferível para modelos com vários parâmetros, etc.) e adicionar após o modelo real. A primeira tag "noinclude" deve ser colocada na mesma linha que as chaves finais do modelo real da seguinte maneira:
<noinclude>{{Documentation}}</noinclude>
{{(nome do modelo) (parâmetros canalizados) }} <noinclude> ...
Se a tag "noinclude" começar na linha abaixo das chaves de fechamento do modelo, um espaço em branco indesejado será introduzido na parte inferior do modelo quando ele for usado em artigos e em outras páginas.
Módulos
Módulos Lua às vezes são usados em vez de modelos para armazenar material reutilizável. As razões para isso incluem o uso de recursos específicos do módulo, como loops ou valores armazenados, e o código complexo geralmente é mais fácil de ler e manter em um módulo. Se um módulo é facilmente implementável em um modelo, geralmente deve ser, uma vez que há mais usuários com experiência em edição de modelos.
Se um módulo se destina a ser usado em artigos ou páginas de discussão, um wrapper de modelo geralmente deve ser criado para simplificar o uso sem exigir diretamente a #invoke
função de analisador. A documentação é então localizada principalmente na página / doc do modelo, com a documentação do módulo apontando para o modelo e / ou explicando outros detalhes técnicos que são desnecessários na documentação do modelo principal.
Às vezes, há motivos para não usar um wrapper de modelo, como causar possíveis problemas com os limites do modelo ; um wrapper de modelo que passa muitos parâmetros para um módulo é muito menos eficiente em comparação com uma chamada direta. Além disso, geralmente não é desejável usar wrappers de modelo em outros modelos.
História
Historicamente, um prefixo "msg:" tinha que ser adicionado antes do nome do modelo quando ele era usado em uma página. Por exemplo, {{msg: stub}} foi digitado em vez de {{stub}}. Isso não é mais necessário.
Nos primeiros 35 meses da Wikipedia, não havia nenhum modelo ou mecanismo de transclusão. A página Wikipedia: texto padrão foi criada em setembro de 2002 para coletar textos usados com frequência em vários processos da Wikipedia. O namespace MediaWiki foi introduzido com MediaWiki 1.2.6 em 6 de dezembro de 2003 e foi usado não apenas para a interface do usuário, mas também para criar mensagens de texto padronizadas a serem inseridas em artigos usando a sintaxe {{msg: ...}}. Esta função foi substituída pelo namespace do modelo durante a atualização do software para MediaWiki 1.3 em 30 de maio de 2004. Como uma função do " script de inicialização do namespace do modelo", todas as mensagens não pertencentes ao sistema foram movidas para o novo namespace. O script de inicialização também substituiu MediaWiki: referências em artigos por Modelo: para ignorar os redirecionamentos criados pelas mudanças.
Por um curto período, Wikipedia: Artigos para exclusão (então conhecidos como votos para exclusão ou VfD ) usou MediaWiki: mensagens nomeadas no formato "MediaWiki: VfD- artigo ". Eles foram movidos para o espaço Template: em junho de 2004 e foram nomeados "Template: VfD- artlename ". Este uso está obsoleto agora em favor de subpáginas.
Por volta de 2005, a crescente complexidade das funções de template e o desejo de consolidar templates semelhantes levaram à criação de hacks condicionais extremamente complexos, como templates aninhados e truques CSS . Esses métodos indesejáveis levaram ao desenvolvimento de m: Extension: ParserFunctions , adicionado em 2006 com o MediaWiki 1.7. Em 2009, muitos problemas com a legibilidade e complexidade dos modelos ainda permaneciam ( em modelos e linguagens de programação ). Em 2013, para lidar com os tempos de carregamento da página, principalmente devido à lenta renderização de template, Lua foi habilitada, criando um Módulo: namespace para os programadores usarem ( Novos templates Lua trazem páginas mais rápidas e flexíveis para seu wiki ).
Procurando por modelos
Use este formulário para pesquisar no Template: ou Template_talk: namespaces. Consulte a Ajuda: Procurando mais informações.
Páginas que contêm informações sobre os modelos comumente usados:
- Wikipedia: índice de modelo para um índice de modelos baseados em texto.
- Wikipedia: modelos de navegação para uma lista parcial de vários elementos de navegação da classe de assunto.
- Wikipedia: Lista de infoboxes para infoboxes, que são pequenos painéis que resumem os principais recursos do assunto da página.
- Wikipedia: categorização para modelos usados para categorias
- Wikipedia: modelos de citação para modelos usados para formatar referências e citações de artigos
Se você não conseguir encontrar um modelo existente para sua situação, mas não se sentir confortável em criar um você mesmo, pode pedir ajuda em Wikipedia: Modelos solicitados .
Veja também
- Ajuda: Modelo para obter informações sobre o desenvolvimento de modelos e detalhes de sintaxe
- Ajuda: Palavras mágicas para todos os modificadores de modelo
- Ajuda: Tabelas condicionais
- Wikipedia: padronização de modelos
Notas
- ^ Os namespaces dos quais a transclusão não é permitida são especificados em um wiki pela variável $ wgNonincludableNamespaces