Diferenças entre edições de "Predefinição:Documentation/doc"

Da Thinkfn
< Predefinição:Documentation
 
(15 edições intermédias não estão a ser mostradas.)
Linha 1: Linha 1:
−
Esta predefinição transcreve e inclui ''(transclui)'' uma página de documentação para dentro da página de código de uma predefinição. Esse processo está a ocorrer neste momento: o texto que está a ler, não está na página Predefinição:Documentation mas sim na página Predefinição:Documentation/doc.
+
<noinclude>{{documentation}}</noinclude>
 +
Esta predefinição é o elemento central de articulação do [[Ajuda:Predefinições|mecanismo das predefinições]]. Deve ser incluída em todas as páginas do espaço nominal '''{{ns:template}}:'''. 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 {{tl|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.
  
−
O uso de {{tl|documentation}} dentro de uma predefinição, tal como aqui é feito, permite que a predefinição seja protegida enquanto que a sua documentação pode continuar a ser editada pelos utilizadores.
+
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.
−
 
+
−
Esta predefinição deve ser usada no fim da página da predefinição, e resulta na inclusão do conteúdo de outra página que tenha o mesmo nome da predefinição seguido do prefixo /doc.
+
  
 
==Uso==
 
==Uso==
−
Para usar esta predefinição, adicione o seguinte código após o código da página da predefinição:
+
Para usar {{tl|documentation}} coloque o seguinte código no topo de todas as páginas da predefinição:
−
 
+
−
:<code><nowiki><noinclude>{{</nowiki>{{{template-name|documentation}}}<nowiki>}}<noinclude></nowiki></code>
+
−
 
+
−
Não deve ser deixado qualquer espaço ou quebra de linha antes do <code><nowiki><include></nowiki></code> inicial, porque isso pode causar espaçamentos extra onde a predefinição for usada.
+
−
 
+
−
Por omissão, a página que é incluida tem o mesmo nome e o sufixo <code>/doc</code>. No entanto, é possível usar o parâmetro para incluir outra página:
+
−
+
−
:<code><nowiki><noinclude>{{</nowiki>{{{template-name|documentation}}}<nowiki>|<nome da outra página>}}<noinclude></nowiki></code>
+
−
 
+
−
=== Best practice ===
+
−
This code should be added at the bottom of the template code, with no extra space before "<code>&lt;noinclude></code>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.
+
−
 
+
−
Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <code>&lt;includeonly> &lt;/includeonly></code> tags.  For more complex cases, see [[Wikipedia:Template documentation‎#Categories and interwiki links]].
+
−
 
+
−
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&amp;lt;".
+
−
 
+
−
 
+
−
=== In-line content ===
+
−
&lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|content=This is documentation.&#125;&#125;&lt;/noinclude&gt;
+
  
−
=== In-line content with [view][edit] links ===
+
<nowiki><noinclude>{{documentation}}<noinclude></nowiki>
  
−
&lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}
+
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.
−
|1 = Template:any page/doc
+
−
|content =&#123;&#123;Template:any page/doc|parameters}}
+
−
}}&lt;/noinclude>
+
  
−
=== Customizing display ===
+
==Parâmetros==
−
Overrides exist to customize the output in special cases:
+
Não aceita parâmetros.
−
* <code>{&#123;documentation| '''heading''' = ...}}</code> − change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.
+
  
−
== Functions ==
+
==Ver também==
−
If the documentation page doesn't exist, the "edit" link includes a [[mw:Manual:Creating pages with preloaded text|preload]] parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
+
;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<!-- deixe no fim -->
 +
*[[Ajuda:Predefinições]]
  
−
<includeonly>
+
<!-- coloque a categoria na página de categoria, não aqui -->
−
[[Category:!Predefinições para predefinições]]
+
−
</includeonly>
+

Edição atual desde as 17h42min de 2 de julho de 2010

Predefinição
código | documentação | categoria | parâmetros | desenvolvimento | testes


Esta é a página da documentação. O texto abaixo será sempre apresentado na página do código, para que quem consulte o código da predefinição veja também a documentação.

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 da categoria.

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)
Outras


Obtida de "https://www.thinkfnwiki.com/wiki/index.php?title=Predefinição:Documentation/doc&oldid=45331"