Diferenças entre edições de "Predefinição:Documentation"
Da Thinkfn
| Linha 1: | Linha 1: | ||
| − | <noinclude>{{documentation}}</noinclude><includeonly>{{ | + | <noinclude>{{documentation}}</noinclude><includeonly>{{<!-- |
| − | <!-- caixa para predefinições --> | + | # |
| − | aviso | + | # caixa para predefinições |
| + | # | ||
| + | --> | ||
| + | aviso<!-- | ||
| + | # | ||
| + | # título da caixa | ||
| + | # | ||
| + | --> | ||
| título = {{ | | título = {{ | ||
#ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | #ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | ||
| Linha 14: | Linha 21: | ||
| #default = Página extra (não padronizada) | | #default = Página extra (não padronizada) | ||
}} | }} | ||
| − | }} | + | }}<!-- |
| − | | texto = Páginas da [[Ajuda:Predefinições|predefinição]]: {{documentation/docname|cod}} {{!}} {{documentation/docname|doc}} {{!}} {{documentation/docname|cat}} {{!}} {{documentation/docname|par}} {{!}} {{documentation/docname|dev}} {{!}} {{documentation/docname|tst}}<br /><br />{{ | + | # |
| + | # lista das diferentes páginas padronizadas que constituem a predefinição | ||
| + | # | ||
| + | --> | ||
| + | | texto = Páginas da [[Ajuda:Predefinições|predefinição]]: {{documentation/docname|cod}} {{!}} {{documentation/docname|doc}} {{!}} {{documentation/docname|cat}} {{!}} {{documentation/docname|par}} {{!}} {{documentation/docname|dev}} {{!}} {{documentation/docname|tst}}<br /><br />{{<!-- | ||
| + | # | ||
| + | # texto explicativo, dependendo do tipo de página | ||
| + | # | ||
| + | --> | ||
#ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | #ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | ||
| ''Esta é a página do código desta predefinição. O texto abaixo vem da página da documentação. A categoria vem da página de categorias (não categorize esta página). Todos os parâmetros que a predefinição aceita estão listados na página de parâmetros e o seu uso é explicado na documentação. Se quiser alterar o código, faça-o na página de desenvolvimento. Verifique as suas alterações na página de testes. Quando terminar a alteração, peça a um administrador que migre o código de desenvolvimento para cá.'' | | ''Esta é a página do código desta predefinição. O texto abaixo vem da página da documentação. A categoria vem da página de categorias (não categorize esta página). Todos os parâmetros que a predefinição aceita estão listados na página de parâmetros e o seu uso é explicado na documentação. Se quiser alterar o código, faça-o na página de desenvolvimento. Verifique as suas alterações na página de testes. Quando terminar a alteração, peça a um administrador que migre o código de desenvolvimento para cá.'' | ||
| Linha 23: | Linha 38: | ||
Nota: Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. Siga-o, por favor. Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | Nota: Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. Siga-o, por favor. Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | ||
| − | | {{#titleparts:{{PAGENAME}}|1}}/cat = ''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. | + | | {{#titleparts:{{PAGENAME}}|1}}/cat = ''Esta é a página das categorias desta predefinição. Só pode usar UMA categoria. NÃO CATEGORIZE A PÁGINA usando <code><nowiki>[[Categoria: ]]</nowiki></code>. Coloque unicamente o nome da página da categoria que pretende. Por exemplo, para categorizar a predefinição na categoria <code>!Ajuda</code> escreve aqui <code>!Ajuda</code> E NÃO <code><nowiki>[[Categoria:!Ajuda]]</nowiki></code>. |
| − | + | ||
| + | Nota: Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. Siga-o, por favor. Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | ||
| + | | {{#titleparts:{{PAGENAME}}|1}}/par = ''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: Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. Siga-o, por favor. Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | Nota: Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. Siga-o, por favor. Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | ||
| Linha 40: | Linha 57: | ||
Nota: Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. Siga-o, por favor. Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | Nota: Se está a criar esta página pela primeira vez, ela já foi pré-preenchida com o modelo que deve seguir. Siga-o, por favor. Não categorize esta página. Coloque a categoria da predefinição na página das categorias. | ||
| #default = ''Esta é uma página extra da predefinição (não é uma das padronizadas, que são listadas acima).'' | | #default = ''Esta é uma página extra da predefinição (não é uma das padronizadas, que são listadas acima).'' | ||
| − | }} }} }} {{ | + | }} }} }} {{<!-- |
| + | # | ||
| + | # após a caixa: link à direita para editar ou criar a documentação | ||
| + | # | ||
| + | --> | ||
#ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | #ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | ||
| <span class="editsection plainlinks" id="doc_editlinks">{{ | | <span class="editsection plainlinks" id="doc_editlinks">{{ | ||
#ifexist: {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc | #ifexist: {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc | ||
| [[{{fullurl:{{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc|action=edit}} editar documentação]] | | [[{{fullurl:{{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc|action=edit}} editar documentação]] | ||
| − | | [[{{fullurl:{{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc|action=edit&preload=Template:Documentation/preload/doc}} criar documentação]] | + | | [[{{fullurl:{{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc|action=edit&preload=Template:Documentation/preload/doc}} criar documentação]]<!-- |
| − | }}</span><span><h2>Documentação</h2></span>{{ | + | # |
| + | # cabeçalho da secção documentação | ||
| + | # | ||
| + | --> | ||
| + | }}</span><span><h2>Documentação</h2></span>{{<!-- | ||
| + | # | ||
| + | # conteúdo da secção documentação: se a subpágina /doc existe, transclui-la para cá | ||
| + | # | ||
| + | --> | ||
#ifexist: {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc | #ifexist: {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc | ||
| {{:{{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc}} | | {{:{{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/doc}} | ||
| }} | | }} | ||
| − | }}<!-- | + | }}<!-- |
| + | # | ||
| + | # categorizar esta página, dependendo do seu tipo | ||
| + | # | ||
| + | -->{{ | ||
#ifexist: {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/cat | #ifexist: {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/cat | ||
| {{ | | {{ | ||
#ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | #ifeq: {{FULLPAGENAME}} | {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}} | ||
| − | | {{ {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/cat }} | + | | [[Categoria: {{ {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/cat }} ]] |
| {{ | | {{ | ||
#switch: {{#titleparts:{{PAGENAME}}|2}} | #switch: {{#titleparts:{{PAGENAME}}|2}} | ||
| Linha 62: | Linha 95: | ||
| {{#titleparts:{{PAGENAME}}|1}}/dev = [[Categoria:!Páginas padronizadas das predefinições|{{PAGENAME}}]] | | {{#titleparts:{{PAGENAME}}|1}}/dev = [[Categoria:!Páginas padronizadas das predefinições|{{PAGENAME}}]] | ||
| {{#titleparts:{{PAGENAME}}|1}}/tst = [[Categoria:!Páginas padronizadas das predefinições|{{PAGENAME}}]] | | {{#titleparts:{{PAGENAME}}|1}}/tst = [[Categoria:!Páginas padronizadas das predefinições|{{PAGENAME}}]] | ||
| − | | #default = {{ {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/cat }} | + | | #default = [[Categoria: {{ {{NAMESPACE}}:{{#titleparts:{{PAGENAME}}|1}}/cat }} ]] |
}} | }} | ||
}} | }} | ||
| | | | ||
}} __NOEDITSECTION__ __NOTOC__</includeonly> | }} __NOEDITSECTION__ __NOTOC__</includeonly> | ||
Revisão das 14h40min de 2 de julho de 2010
|
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
