Diferenças entre edições de "Predefinição:Documentation"
Da Thinkfn
| Linha 17: | Linha 17: | ||
{{ | {{ | ||
#ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | #ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | ||
| − | | < | + | | <h2>Página do código</h2> |
| − | + | Esta é a página do código. O texto abaixo será sempre transcluído para a página do código, para que quem consulte o código da predefinição veja também a documentação. | |
| + | |||
| + | Nota: Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | ||
| + | ---- | ||
| + | <span class="editsection plainlinks" id="doc_editlinks">{{ | ||
#ifexist: {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc | #ifexist: {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc | ||
| [[{{fullurl:{{NAMESPACE}}:{{PAGENAME}}/doc|action=edit}} editar documentação]] | | [[{{fullurl:{{NAMESPACE}}:{{PAGENAME}}/doc|action=edit}} editar documentação]] | ||
| Linha 26: | Linha 30: | ||
#switch: {{SUBPAGENAME}} | #switch: {{SUBPAGENAME}} | ||
| doc = <h2>Página da documentação</h2> | | doc = <h2>Página da documentação</h2> | ||
| − | Esta é a página | + | Esta é a página da documentação. O texto abaixo será sempre transcluído para a página do código, para que quem consulte o código da predefinição veja também a documentação. |
| + | |||
| + | Nota: Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | ||
---- | ---- | ||
| − | | cat = <h2> | + | | cat = <h2>Página das categorias</h2> |
| − | Esta é a página das categorias | + | Esta é a página das categorias desta predefinição. Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. |
| + | ---- | ||
| + | | par = <h2>Página dos parâmetros</h2> | ||
| + | Esta é a página dos parâmetros desta predefinição. Liste todos os parâmetros que a predefinição aceita. Esta lista deve ser apresentada na documentação e pode ser usada no código para mostrar aos utilizadores quais os parâmetros que podem ser usados. | ||
| + | |||
| + | Nota: Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | ||
---- | ---- | ||
| − | |||
| parameterlist = | | parameterlist = | ||
| dev = <h2>Página de desenvolvimento</h2> | | dev = <h2>Página de desenvolvimento</h2> | ||
| Linha 39: | Linha 49: | ||
Quando a sua alteração estiver completa, peça a um administrador para migrar o novo código para a página do código. | Quando a sua alteração estiver completa, peça a um administrador para migrar o novo código para a página do código. | ||
| − | ---- | + | |
| + | Nota: Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | ||
| + | ---- | ||
| tst = <h2>Página de testes</h2> | | tst = <h2>Página de testes</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. 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. Servem também, claro, como exemplos do uso da predefinição. | ||
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). Ao alterar a predefinição, adicione aqui casos de teste que demonstrem o comportamento anterior e posterior à sua alteração. Verifique também, nos testes já existentes, que a sua funcionalidade já existente não foi danificada. | 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). Ao alterar a predefinição, adicione aqui casos de teste que demonstrem o comportamento anterior e posterior à sua alteração. Verifique também, nos testes já existentes, que a sua funcionalidade já existente não foi danificada. | ||
| + | |||
| + | Nota: Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | ||
---- | ---- | ||
| #default = }} }} <!-- transcluir categorias --> {{ | | #default = }} }} <!-- transcluir categorias --> {{ | ||
Revisão das 20h36min 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
