Axuda:Modelos
Un modelo é un fragmento de código de Wikipedia que pode ser reutilizado por moitas páxinas distintas, sen necesidade de copiar todo o código novamente. Corresponden a un tipo de páxinas especiais, destinadas a utilizarse dentro doutras, e que utilizan o espazo de nomes modelo:.
Antes de crear un modelo, asegúrese de ler e entender esta guía, en particular a sección Suxestións.
O nome dun modelo é o título da páxina dentro do espazo de nomes «modelo:». Como todos os títulos, distingue entre maiúsculas e minúsculas (excepto a primeira letra): modelo de exemplo e modelo de Exemplo son modelos diferentes, pero Modelo de exemplo e modelo de exemplo son o mesmo modelo.
Como utilizar un modelo
[editar | editar a fonte]Supoñamos que queremos utilizar un modelo chamado Modelo:Nome_de_modelo nunha páxina calquera, chamada Páxina de exemplo. Isto podemos facelo de dúas maneiras diferentes:
Substitución
[editar | editar a fonte]Escríbese {{subst:Nome_de_modelo}}
en Páxina de exemplo, co cal o contido do modelo engádese permanentemente á Páxina de exemplo.
A substitución realízase unha soa vez, no momento de gravar a páxina. Non quedan rastros de que se usou un modelo, e o resultado é o mesmo que se se escribira manualmente o texto xerado polo modelo. Calquera cambio posterior feito no código do modelo non ten ningún efecto sobre a páxina. A substitución utilízase cando queremos que o contido incorporado polo modelo poida editarse posteriormente desde a páxina marcada, ou cando non é conveniente que futuros cambios no modelo modifiquen a páxina (ex.: os avisos por vandalismo nunha páxina de discusión de usuario).
Transclusión
[editar | editar a fonte]Escríbese {{Nome_de_modelo}}
en Páxina de exemplo. É a forma máis común de usar un modelo. Cada vez que se carga a páxina, tamén se procesa o modelo, e o resultado inclúese dentro da primeira.
A transclusión retarda un pouco a carga das páxinas, pero como se mantén a dependencia co modelo, calquera cambio ou mellora que se faga a este impactará automaticamente en todas as páxinas que a usen (ou transclúan). Ademais, como o código do modelo non se garda na páxina que a utiliza, o código desta última non se «ensucia», facéndose máis fácil de entender e de editar. Tamén permite atopar as páxinas utilizan certo modelo (usando a ligazón "Páxinas que ligan con esta" do menú Ferramentas).
Excepto algunhas situacións específicas, o normal é incluír os modelos por transclusión.
Pseudomodelos
[editar | editar a fonte]En realidade, calquera páxina pode usarse como modelo, por substitución ou transclusión. A sintaxe é a mesma, só que non se pode omitir o espazo de nomes ó usalas, como se omite o "Modelo:" nos modelos normais. O exemplo por antonomasia de pseudomodelos son as userboxes.
Mencionar un modelo
[editar | editar a fonte]Cando se desexa mencionar e ligar a un modelo (por exemplo, dentro das páxinas de conversa ou de axuda) utilízase o modelo {{ep}}
. Por exemplo {{ep|Actor}}
mostra {{Actor}}
.
Parámetros
[editar | editar a fonte]Os modelos aceptan parámetros ou argumentos, que permiten aumentar as súas funcionalidades, adecuándose ás necesidades de cada páxina que as utiliza. Cada aparición dun parámetro dentro do código do modelo substitúese polo valor que se lle deu a ese parámetro no momento de usar o modelo. Así, o texto xerado por un mesmo modelo pode variar en función dos valores que toman os seus parámetros.
Parámetros con nome
[editar | editar a fonte]É conveniente que os parámetros teñan nome. A diferenza dos nomes de páxina, "un nome", "Un nome" e "Un_nome" son todos nomes de parámetros distintos.
- Para referirse ao valor dun parámetro dentro do código do modelo, escríbese
{{{nome}}}
, onde nome é o nome do parámetro. - Para indicar o valor desexado para un parámetro no momento de usar o modelo dentro da páxina, escríbese
{{{Nome de modelo|parámetro=valor do parámetro|outroparámetro=outro valor|terceiro parámetro=texto do terceiro parámetro}}}
Supoñamos que o Modelo:Nome_de_modelo ten dous parámetros: data
e clave
. Para incluír o modelo (mediante transclusión) dentro dun artigo, deberase escribir:
{{Nome_de_modelo|data=27 de agosto de 2024|clave=paparulo}}
Dentro do modelo, usarase {{{data}}}
e {{{clave}}}
. Cada aparición de {{{data}}}
será substituída por 27 de agosto de 2024
, e cada aparición de {{{clave}}}
será substituída por paparulo
, no momento de usar o modelo.
Modelo:Exemplo de modelo | A data é {{{data}}} e o contrasinal é {{{clave}}}.
|
---|---|
Exemplo de artigo | Este texto está no artigo, e ...
|
Resultado | Este texto está no artigo, e ... A data é 27 de agosto de 2024 e o contrasinal é paparulo. |
Nótese como na segunda inclusión, ó non asignárselle valores ós parámetros data e clave, os textos {{{data}}}
e {{{clave}}}
non se substituíron e quedaron tal cal. Como evitalo verase na sección Valores por defecto.
Se se lle asigna máis dun valor ó mesmo parámetro, só a última asignación tomarase en conta. Por exemplo,
{{Exemplo de modelo|clave=zxcvz|clave=12345}}
é equivalente a :{{Exemplo
de modelo|clave=12345}}
.
Os espazos en branco (incluíndo tabulacións e saltos de liña) que aparecen ó principio e ó final do valor dun parámetro por nome, elimínanse; os que están no interior, mantéñense:
Modelo:Persoa | Nome: {{{nome}}}
|
---|---|
Exemplo de artigo | {{Persoa|nome=Xoán Pérez|domicilio=Basavilbaso 1234}} {{Persoa| nome = Xoán Pérez | domicilio = Basavilbaso 1234 }} {{Persoa | nome = Xoán Pérez | domicilio = Basavilbaso 1234 }} |
Resultado (os tres iguais) | Nome: Xoán Pérez Domicilio: Basavilbaso 1234 |
Parámetros posicionais
[editar | editar a fonte]Tamén é posible omitir o nome dun parámetro, e nese caso identifícase pola súa posición. Dentro do código dun modelo, {{{3}}}
fai referencia ó terceiro dos parámetros sen nome usados ó invocar ó modelo. É dicir, ó usar un modelo desta forma:
{{Nome do modelo|parámetro=texto1|outro valor|máis texto}}
{{{2}}} será substituído por máis texto
(o segundo dos parámetros sen nome).
Modelo:Exemplo de modelo | A data é {{{1}}} e o contrasinal é {{{2}}}.
|
---|---|
Exemplo de artigo | Este texto está no artigo, e ...
|
Resultado | Este texto está no artigo, e ... A data é 27 de agosto de 2024 e o contrasinal é paparulo. |
Outro exemplo (incorrecto):
Modelo:Mostra ecuación | A ecuación é: {{{1}}}
|
---|---|
Exemplo de artigo | Este texto está no artigo, e ...
|
Resultado | Este texto está no artigo, e ... A ecuación é {{{1}}} |
Note que este exemplo falla. O problema está en que o texto que estamos a pasar como primeiro parámetro («2x - y = 0») ten un signo igual. O signo igual utilízase na sintaxe dos parámetros nomeados, polo que o sistema cre que lle estamos pasando un parámetro de nome «2x - y» con valor «0». Hai dúas formas de solucionar isto:
- nomear explicitamente o parámetro:
1=2x - y = 0
. (Logo do primeiro signo igual, que se usa para separar o nome do seu valor, xa non importa se hai máis). - usar o modelo {{=}} en substitución do signo igual.
Modelo:Mostra ecuación | A ecuación é: {{{1}}}
|
---|---|
Exemplo de artigo | Este texto está no artigo, e ...
|
Resultado | Este texto está no artigo, e ... A ecuación é: 2x - y = 0 |
Este problema adoita suceder a miúdo cando se pasan URL como parámetros posicionais. Moitas veces, as URL (como http://gl.wikipedia.org/w/index.php?title=Axuda:Modelo) adoitan ter signos de igual, e o sistema toma como nome do parámetro todo o que estea diante do primeiro (coa URL de exemplo, interpretaría que hai un parámetro chamado «http://gl.wikipedia.org/w/index.php?title» con valor «Axuda:Modelo»). Por iso, sempre é conveniente nomear o parámetro explicitamente cando se lle queira pasar unha URL a un modelo.
A diferenza dos parámetros por nome, os espazos en branco (incluíndo tabulacións e saltos de liña) que aparecen ó principio e ó final do valor dun parámetro posicional si se preservan, tal como os que están no interior. Pódese usar o modelo {{trim}}
para eliminalos.
Parámetros combinados
[editar | editar a fonte]Os parámetros nomeados e posicionais pódense combinar sen problema. O sistema asignaralle un número secuencial a cada un dos parámetros sen nome, e logo aplicará as regras dos parámetros nomeados. Por exemplo,
{{Info|q|s|commons|2=wikt|wikisource=Axuda|outro}}
é equivalente a :{{Info|1=q|2=s|3=commons|2=wikt|wikisource=Axuda|4=outro}}
que, como o parámetro «2» aparece dúas veces, é o mesmo que
{{Info|1=q|3=commons|2=wikt|wikisource=Axuda|4=outro}}
.
Caracteres especiais
[editar | editar a fonte]Como xa se mencionou, o signo igual '=' debe substituírse por
cando se usa dentro do valor dun parámetro sen nome.
{{=}}
Tamén, como a barra vertical '|' úsase como separador, para incluíla dentro do valor dun parámetro debe substituírse por {{!}}
ou ben por |
.
Para incluír chaves '{{' ou '}}' como valor dun parámetro, pódense usar os modelos {{((}}
ou {{))}}
. Para outras substitucións necesarias, véxase a Categoría:Wikipedia:Modelos para evitar a avaliación por MediaWiki.
Valores por defecto
[editar | editar a fonte]A expresión {{{nome|por defecto}}}
é equivalente a {{{nome}}}
excepto cando non se lle deu valor ó parámetro, nese caso a primeira devolve o texto por defecto
mentres que a segunda devolve {{{nome}}}
.
Modelo:Mostrar data | A data é: {{{data|hoxe}}}
|
---|---|
Exemplo de artigo | Este texto está no artigo, e ...
|
Resultado | Este texto está no artigo, e ... A data é: 27 de agosto de 2024}} |
Como se ve, na segunda inclusión do modelo non se lle asignou valor ó parámetro data, polo que se incluíu o valor por defecto, hoxe.
Variables e parser functions (funcións de análise)
[editar | editar a fonte]As variables que prové MediaWiki parecen ser modelos pero non o son: {{PAGENAME}}, {{SITENAME}}, etc. As parser functions, ou funcións de análise, tamén usan unha sintaxe parecida: {{#ifexpr: 1 > 0 | si | non}}, pero tampouco son modelos.
Tanto as variables como as funcións de análise poden aparecer dentro do contido dun modelo, ou como argumentos.
Como controlar a inclusión
[editar | editar a fonte]En xeral, todo o contido do modelo móstrase ó visitar a páxina do modelo, e tamén, todo o seu contido inclúese dentro das páxinas que a usan. Como esas dúas situacións son diferentes, pódese controlar que partes do modelo se aplican a unha e outra.
- Contido excluído: «noinclude»
Corresponde ó código que non se desexa que sexa incluído dentro das páxinas que utilicen o modelo. Son as seccións que están entre as etiquetas <noinclude>
e </noinclude>
; pode non existir, pode haber unha soa sección, ou poden ser varias. Utilízase sobre todo para categorizar o modelo e documentar o seu uso. É o contido que só se ve ó visitar a páxina do modelo.
- Contido incluído: «includeonly»
Corresponde ó código que só se incluirá nas páxinas que utilicen o modelo (e non ó visualizar a páxina do propio modelo). Son as seccións que están dentro das etiquetas <includeonly>
e </includeonly>
; pode non existir, pode haber unha soa sección, ou poden ser varias. Utilízase sobre todo para agregar categorías ás páxinas marcadas co modelo (non para categorizar o modelo en si).
Todo o código do modelo que estea fóra desas etiquetas, inclúese sempre.
Páxina | Modelo:Exemplo de modelo | Exemplo de artigo |
---|---|---|
Código | Este texto forma parte do modelo. |
Este texto está no artigo, e ...
|
Resultado | Este texto forma parte do modelo. Este texto só se ve ó visualizar o modelo. Normalmente contén a documentación da mesma. |
Este texto está no artigo, e ... Este texto forma parte do modelo. |
Suxestións
[editar | editar a fonte]Non abuses dos modelos
[editar | editar a fonte]Ten en conta que existen moitísimos modelos para os máis diversos temas, e que é moi posible que alguén xa crease un modelo para o que desexas. Por iso, evita a creación de modelos redundantes ou innecesarios.
- Non son razóns para crear un modelo
- Que xa exista un análogo nunha wiki doutro idioma: moitas wikis non posúen un control sobre a creación de modelos, e para unha mesma tarefa pode haber moitísimas, o que dificulta o mantemento. Non copiemos os malos exemplos.
- Que xa exista un modelo específico para outro tema: dado o caso, en lugar de crear outro modelo que fai practicamente o mesmo, é mellor pensar en ampliar o modelo xa existente, incorporándolle parámetros.
Respecta as convencións de títulos
[editar | editar a fonte]A pesar que a política de convencións de títulos non está orientada ós modelos, si é moi desexable que os títulos que elixas sexan en galego e intuitivos. O mesmo pasa cos nomes dos parámetros: prefire aqueles explicativos en lugar ás abreviacións, pero tamén evita que sexan demasiado longos, para facilitar o uso.
Lembra que tamén se poden crear redireccións a modelos. Usar a redirección é o mesmo que usar o modelo ó cal redirixe.
Categoriza e documenta
[editar | editar a fonte]Nunca esquezas categorizar e documentar os modelos, mediante a etiqueta «noinclude» explicada anteriormente.
Tipos de modelos
[editar | editar a fonte]Modelos de mantemento
[editar | editar a fonte]Os modelos de mantemento son os utilizados, como o seu nome indica, para apoiar o mantemento dos artigos de Wikipedia. Normalmente logo de ser colocados nos artigos avísase ó usuario responsable da edición que ocasionou o problema ou deficiencia co uso dalgún modelo de aviso na súa páxina de discusión.
Fichas
[editar | editar a fonte]Unha ficha (en inglés chamada infobox) é un modelo utilizado en artigos, e excepcionalmente en páxinas de usuario -véxase a ficha correspondente- que serve para resumir e sistematizar por medio dunha táboa a información medular presente en cada páxina que a contén. Categorízanse na Categoría:Caixas de información, e baséanse na ficha xenérica {{Ficha}}
. Un exemplo delas é o modelo {{Vía}}
.
Modelos de navegación
[editar | editar a fonte]Un modelo de navegación é un modelo deseñado para agrupar artigos dun modo distinto á orde alfabética proporcionado polas categorías, e de forma tal que proporciona información adicional sobre a relación entre os devanditos artigos.
Os modelos de navegación específicos baséanse na metaplantilla {{Navbox}}
e sitúanse en Categoría:Caixas de navegación. Os modelos de navegación de propósito xeral sitúanse na Categoría:Modelos xerais de navegación.
Userboxes
[editar | editar a fonte]- Artigo principal: Wikipedia:Caixas de usuario.
Unha userbox, ou caixa de usuario, é un pseudomodelo utilizado exclusivamente en páxinas de usuario e nalgúns wikiproxectos, cuxo espazo de nomes é Usuario:, e que serve para mostrar características do usuario que a utiliza. Categorízanse na Categoría:Wikipedia:Modelos de usuario, e un exemplo deles é a pseudomodelo {{Modelo:Usuario Ubuntu}}.
Todos os modelos
[editar | editar a fonte]
|