Predefinição:Documentação1/doc

Esta página é um subpágina de documentação da Predefinição:Documentação1.

Esta predefinição exibe uma caixa de documentação como a que você está vendo agora. Ela incorpora o texto da subpágina [[<Nome da página>/doc]].

Fundamentação

A separação do código-fonte e da documentação torna o código mais legível.

• Em particular, uma pequena alteração na documentação não implica na necessidade de regerar milhares de páginas que a incorporam.
• No histórico de versões da página de programação, apenas as alterações que afetam as integrações efetivas serão exibidas.

Uso

Esta predefinição geralmente não requer parâmetros. Basta incluir o código programado entre <onlyinclude> assim como </onlyinclude> e escrever {{Documentação1}} no final da predefinição. Em seguida, a página de documentação [[<Nome da página>/doc]] pode ser criada. Após a geração da documentação, as ferramentas de criação pré-carregamento (preload) serão disponibilizadas.

Nas subpáginas, as seguintes linhas de código no início da página garantem a referência cruzada:

/doc

<noinclude>{{Documentação1/Página de documentação}}</noinclude>

No final da página, as categorias de <includeonly></includeonly> serão incluídas.

/Teste

<noinclude>{{Documentação1/Página de teste}}</noinclude>

/Fundo

<noinclude>{{Documentação1/Fundo}}</noinclude>

/Manutenção

<noinclude>{{Documentação1/Página de manutenção}}</noinclude>

/Estilo

<noinclude>{{Documentação1/Página de estilo}}</noinclude>

/Página de aviso (Editnotice)

<noinclude>{{Documentação1/Página de aviso de edição}}</noinclude>

/Meta

Este método está desatualizado e não é mais suportado (integrado em /doc).

Subpáginas específicas

/Teste

Uma subpágina de teste contém exemplos abrangentes para demonstração e teste da funcionalidade correta.

Apenas alguns exemplos curtos são mais adequados para serem incluídos diretamente na página de documentação.

/Manutenção

Se existir uma página de manutenção para a predefinição, também será exibida uma notificação

No entanto, uma página de manutenção dedicada só vale a pena para análises abrangentes. Caso contrário, é melhor integrá-la à subpágina de documentação, pois é muito raro que um visitante aleatório abra a página de manutenção e procure por tarefas pendentes.

/XML

Se a predefinição tiver uma descrição XML para o mestre de predefinição além da documentação, uma notificação correspondente será exibida.

/styles

/styles.css

Consulte TemplateStyles

/Editnotice

Um aviso especial que aparece durante a edição.

/Meta

Uma subpágina como essa era destinada principalmente para páginas totalmente protegidas que não poderiam ser categorizadas de outra forma e deveria permitir que bots interwiki as descrevessem sem serem bloqueados por semiproteção e perturbarem as listas de observação. Essa subpágina também incluía categorizações.

• Os links interwiki agora estão no Wikidata.
• Sobram apenas algumas linhas para categorização, que agora estão incluídas em <includeonly> no final de /doc.
• Manter uma subpágina separada não faz mais sentido e apenas complica as coisas.
• Consulte Wikipédia:Documentação da predefinição.

Parâmetro

No momento, um parâmetro para casos especiais está disponível:

TOC

Exibir índice antecipado.

Para documentações de predefinição, onde uma tabela alta aparece à direita (por exemplo, infoboxes), um salto para a documentação pode ser permitido no canto superior esquerdo.

1 – Índice antes da seção de documentação

Mais informações

• Ajuda:Documentação da predefinição

Predefinições de suporte internas, para uso individual em casos específicos:

• Predefinição:Documentação1/Ruler – Linha divisória uniforme
• Predefinição:Documentação1/Cabeçalho – Cabeçalho principal
• Predefinição:Documentação1/Rodapé – Rodapé com informações adicionais padronizadas