Diferenças entre edições de "Predefinição:Documentation/doc"
(Nova página: This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are [[Wikipedia:...) |
|||
| 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. | |
| − | + | 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 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== |
| − | + | Para usar esta predefinição, adicione o seguinte código após o código da página 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 === | === Best practice === | ||
| Linha 25: | Linha 22: | ||
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;". | If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;". | ||
| + | |||
| + | |||
| + | === In-line content === | ||
| + | <noinclude>{{{{{template-name|Documentation}}}|content=This is documentation.}}</noinclude> | ||
| + | |||
| + | === In-line content with [view][edit] links === | ||
| + | |||
| + | <noinclude>{{{{{template-name|Documentation}}} | ||
| + | |1 = Template:any page/doc | ||
| + | |content ={{Template:any page/doc|parameters}} | ||
| + | }}</noinclude> | ||
=== Customizing display === | === Customizing display === | ||
| Linha 32: | Linha 40: | ||
== Functions == | == 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. | 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. | ||
| − | |||
| − | |||
| − | |||
<includeonly> | <includeonly> | ||
[[Category:!Predefinições para predefinições]] | [[Category:!Predefinições para predefinições]] | ||
</includeonly> | </includeonly> | ||
Revisão das 08h45min de 15 de novembro de 2008
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.
O uso de {{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 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.
Índice
Uso
Para usar esta predefinição, adicione o seguinte código após o código da página da predefinição:
<noinclude>{{documentation}}<noinclude>
Não deve ser deixado qualquer espaço ou quebra de linha antes do <include> 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 /doc. No entanto, é possível usar o parâmetro para incluir outra página:
<noinclude>{{documentation|<nome da outra página>}}<noinclude>
Best practice
This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (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 <includeonly> </includeonly> 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 "<".
In-line content
<noinclude>{{Documentation|content=This is documentation.}}</noinclude>
In-line content with [view][edit] links
<noinclude>{{Documentation
|1 = Template:any page/doc
|content ={{Template:any page/doc|parameters}}
}}</noinclude>
Customizing display
Overrides exist to customize the output in special cases:
-
{{documentation| heading = ...}}− 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 preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
