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

Da Thinkfn
< Predefinição:Documentation

Deprecated: The each() function is deprecated. This message will be suppressed on further calls in /home1/thinkfnw/public_html/wiki/includes/diff/DairikiDiff.php on line 390
Linha 1: Linha 1:
 
<noinclude>{{documentation}}</noinclude>
 
<noinclude>{{documentation}}</noinclude>
−
Esta predefinição transcreve e inclui ''(transclui)'' uma página de documentação para dentro da página de código de outra predefiniçã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]].
+
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}}:'''. A predefinição:
 +
*cria a caixa que vê acima, com ligações 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 em que for incluída.
  
−
O uso de {{tl|documentation}} dentro de uma predefinição, tal como aqui foi feito, permite que o código da predefinição seja protegido enquanto que a respectiva documentação, que está noutra página, 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.
  
 
==Uso==
 
==Uso==
−
Para usar {{tl|documentation}} adicione o seguinte código após o código da predefinição:
+
Para usar {{tl|documentation}} coloque o seguinte código no topo da página:
  
−
  <nowiki><noinclude>{{</nowiki>{{{template-name|documentation}}}<nowiki>}}<noinclude></nowiki>
+
  <nowiki><noinclude>{{documentation}}<noinclude></nowiki>
  
−
Não deve ser deixado qualquer espaço ou quebra de linha antes do <code><nowiki><noinclude></nowiki></code> inicial, porque isso pode causar espaçamentos extra onde a predefinição for usada.
+
==Parâmetros==
 +
Não aceita parâmetros.
  
−
Por omissão, a página que é incluída tem o mesmo nome e o sufixo <code>/doc</code>. No entanto, é possível usar o parâmetro para incluir outra página:
+
==Ver também==
−
+
*[[Ajuda:Predefinições]]<!-- deixe no fim -->
−
<nowiki><noinclude>{{</nowiki>{{{template-name|documentation}}}<nowiki>|<nome da outra página>}}<noinclude></nowiki>
+
  
−
=== Best practice ===
+
<!-- coloque a categoria na página de categorias, não aqui -->
−
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 ===
+
−
 
+
−
&lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}
+
−
|1 = Template:any page/doc
+
−
|content =&#123;&#123;Template:any page/doc|parameters}}
+
−
}}&lt;/noinclude>
+
−
 
+
−
=== Customizing display ===
+
−
Overrides exist to customize the output in special cases:
+
−
* <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 ==
+
−
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.
+

Revisão das 11h50min de 13 de dezembro de 2009

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:. A predefinição:

  • cria a caixa que vê acima, com ligações 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 em que for 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 da página: 

<noinclude>{{documentation}}<noinclude>

Parâmetros

Não aceita parâmetros.

Ver também


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