Diferenças entre edições de "Predefinição:Documentation"
Da Thinkfn
Linha 25: | Linha 25: | ||
| {{ <!-- esta não é a página do código - mostrar cabeçalho padrão por tipo de página --> | | {{ <!-- esta não é a página do código - mostrar cabeçalho padrão por tipo de página --> | ||
#switch: {{SUBPAGENAME}} | #switch: {{SUBPAGENAME}} | ||
− | | doc = <h2> | + | | doc = <h2>Página da documentação</h2> |
Esta é a página de documentação desta predefinição. O texto abaixo será sempre transcluído para a página do código, para que quem consulte a predefinição também veja a documentação ao mesmo tempo. | Esta é a página de documentação desta predefinição. O texto abaixo será sempre transcluído para a página do código, para que quem consulte a predefinição também veja a documentação ao mesmo tempo. | ||
---- | ---- | ||
− | |||
| cat = <h2>Categorias</h2> | | cat = <h2>Categorias</h2> | ||
− | Esta é a página das categorias que serão automaticamente atribuídas a todas as páginas desta predefinição. Ao colocar uma categoria nesta página, a mesma categoria será automaticamente atribuída a todas as restantes páginas da predefinição. Isto evita que tenha de categorizar as páginas uma a uma e garante que a categorização é a mesma para todas. Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. | + | Esta é a página das categorias que serão automaticamente atribuídas a todas as páginas desta predefinição. Ao colocar uma categoria nesta página, a mesma categoria será automaticamente atribuída a todas as restantes páginas da predefinição. Isto evita que tenha de categorizar as páginas uma a uma e garante que a categorização é a mesma para todas. Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. |
+ | ---- | ||
| par = | | par = | ||
| parameterlist = | | parameterlist = | ||
Linha 36: | Linha 36: | ||
| tst = | | tst = | ||
<h2>Casos de teste</h2> | <h2>Casos de teste</h2> | ||
− | Os seguintes testes são usados no desenvolvimento e manutenção desta predefinição. Devem testar o comportamento da predefinição em casos típicos e em casos limite, onde ela deve ter sempre um comportamento elegante para o leitor. Para cada caso de teste, é apresentada a versão actual (criada pelo código da página de código) e a versão de desenvolvimento (criada pelo código da página de desenvolvimento). Servem também, claro, como exemplos do uso da predefinição. | + | Os seguintes testes são usados no desenvolvimento e manutenção desta predefinição. Devem testar o comportamento da predefinição em casos típicos e em casos limite, onde ela deve ter sempre um comportamento elegante para o leitor. Para cada caso de teste, é apresentada a versão actual (criada pelo código da página de código) e a versão de desenvolvimento (criada pelo código da página de desenvolvimento). Servem também, claro, como exemplos do uso da predefinição. |
+ | ---- | ||
| #default = | | #default = | ||
}} | }} |
Revisão das 18h47min de 12 de dezembro de 2009
|
Documentação
Esta predefinição é o elemento central de articulação do mecanismo das predefinições. Deve ser incluída em todas as páginas do espaço nominal Predefinição:. Ela:- cria a caixa de navegação da predefinição que vê acima, com links para navegar facilmente por todas as páginas padrão da predefinição,
- auxilia a criação inicial dessas páginas, apresentado um modelo padronizado do conteúdo de cada uma, que deve ser seguido,
- mostra a página da documentação quando se consulta o código da predefinição, para que se veja também a sua documentação (esse processo está a ocorrer neste momento: o texto que está a ler, não está na página Predefinição:Documentation, que é a página do código de
{{documentation}}
, mas sim na página Predefinição:Documentation/doc), e - categoriza automaticamente todas as páginas da predefinição nas quais tenha sido incluída.
Esta predefinição existe para permitir que o código das predefinições seja protegido enquanto todos os restantes componentes, que estão noutras páginas, possam continuar a ser editados pelos utilizadores.
Uso
Para usar {{documentation}}
coloque o seguinte código no topo de todas as páginas da predefinição:
<noinclude>{{documentation}}<noinclude>
Se criar as páginas seguindo os links na caixa de navegação da predefinição, as páginas serão automaticamente preenchidas com um modelo que deve seguir. Os modelos estão listados abaixo.
Parâmetros
Não aceita parâmetros.
Ver também
- Páginas extra desta predefinição (adicionais às páginas padrão)
- Predefinição:Documentation/docname
- Predefinição:Documentation/preload/cod - Modelo padronizado para pré-preenchimento da página de código
- Predefinição:Documentation/preload/doc - Modelo padronizado para pré-preenchimento da página de documentação
- Predefinição:Documentation/preload/cat - Modelo padronizado para pré-preenchimento da página de categoria
- Predefinição:Documentation/preload/par - Modelo padronizado para pré-preenchimento da página de parâmetros
- Predefinição:Documentation/preload/dev - Modelo padronizado para pré-preenchimento da página de desenvolvimento
- Predefinição:Documentation/preload/tst - Modelo padronizado para pré-preenchimento da página de testes
- Outras