Predefinição:Documentação
Esta predefinição mostra uma caixa de "Documentação da predefinição" tal como a que está a ver neste momento, cujo conteúdo é importado de outra página.
Utilização
<noinclude>{{Documentação}}</noinclude>
- Adicione
<noinclude>{{Documentação}}</noinclude>
logo abaixo do código da predefinição que você quer documentar e salve a modificação. - Na caixa de documentação que surge na página da predefinição, clique em criar. Será criada uma página de documentação a partir de um modelo, com nome equivalente a Predefinição:nome da predefinição/doc. Introduza o texto da documentação nesta página.
- As categorias e interwikis das predefinições devem ser adicionadas na página da documentação respectiva e não na página da predefinição. As categorias e interwikis devem ser colocadas dentro das tags
<includeonly> </includeonly>
.
Outras opções de uso
Qualquer página /doc
<noinclude>{{Documentação|Predefinição:Qualquer página/doc}}</noinclude>
Contéudo na mesma linha
<noinclude>{{Documentação|conteúdo=Esta é uma documentação}}</noinclude>
Contéudo na mesma linha com links [ver] e [editar]
<noinclude>{{Documentação |1= Predefinição:Qualquer página/doc |conteúdo= {{Predefinição:Qualquer página/doc|parâmetros}} }}</noinclude>
Boas práticas
- Uma destas opções de código deve ser adicionada logo após o texto da predefinição, sem nenhum espaço antes da tag "
<noinclude>
" (o que causaria um espaço extra nas páginas onde a predefinição é usada). Parâmetros adicionais podem ser usados como mostrado acima para transcluir uma página de documentação arbitrária.
- Links de categorias e interwikis da própria predefinição devem ser adicionados na página de documentação, dentro das tags
<includeonly> </includeonly>
. Para casos mais complexos, veja Wikipedia:Documentação da predefinição#Categorias e interwikis.
- Se a página de documentação inclui tags "
<includeonly>
" ou "<noinclude>
" como parte da documentação, substitua o "<" por "<" ou coloque-as entre <nowiki></nowiki>.
Personalizando
Em casos especiais é possível personalizar a apresentação:
{{documentação|heading= ...}}
− altera o texto do título da documentação. Se for definida como vazia, o título inteiro, incluindo o link [editar], também desaparecerão.
Funções
A utilização da {{Documentação}}
nas predefinições possibilita que elas sejam protegidas quando necessário, não impedindo que qualquer um edite a documentação, categorias e interwikis, uma vez que ficam em um página à parte.
Caso a página de documentação não exista, clicando-se no link [criar] é gerado um modelo pré-carregado com o formato básico para uma página de documentação, facilitando o processo.
Ver também
- {{Falta doc}}
- Informações sobre documentação de predefinições
- Família de predefinições de documentação
- Predefinição:Documentação/doc (afluentes, editar)
- Predefinição:Documentação/Ver também (afluentes, editar)
- Predefinição:Documentação/nomedoc (afluentes, editar)
- Predefinição:Documentação/preload (afluentes, editar)
- Documentação ancestral do Meta Wiki
als:Vorlage:Dokumentation
ar:قالب:توثيق
ba:Ҡалып:Doc
bar:Vorlage:Dokumentation
bg:Шаблон:Документация
bs:Šablon:Dokumentacija
ca:Plantilla:Ús de la plantilla
ckb:داڕێژە:Documentation
cs:Šablona:Dokumentace
cy:Nodyn:Doc
da:Skabelon:Dokumentation
de:Vorlage:Dokumentation
diq:Template:Documentation
dsb:Pśedłoga:Dokumentacija
el:Πρότυπο:Τεκμηρίωση προτύπου
en:Template:Documentation
eo:Ŝablono:Dok
es:Plantilla:Documentación
et:Mall:Dokumentatsioon
eu:Txantiloi:Txantiloi dokumentazioa
fa:الگو:توضیحات
fr:Modèle:Documentation
gl:Modelo:Uso de marcador
he:תבנית:תיעוד
hsb:Předłoha:Dokumentacija
hu:Sablon:Sablondokumentáció
hy:Կաղապար:Փաստաթղթեր
ia:Patrono:Documentation
id:Templat:Dokumentasi
it:Template:Man
ja:Template:Documentation
ko:틀:틀 설명문서
ku:Şablon:Belgekirin
la:Formula:Documentation
ltg:Taiss:Dokumentaceja
ml:ഫലകം:വിവരണം
nds-nl:Mal:Dokumentatie
nl:Sjabloon:Sjabdoc
no:Mal:Dokumentasjon
nso:Template:Documentation
pl:Szablon:Dokumentacja
ro:Format:Documentație
ru:Шаблон:Doc
simple:Template:Documentation
sk:Šablóna:Dokumentácia
sl:Predloga:Dokumentacija
sq:Stampa:Dokumentacion
sr:Шаблон:Документација
stq:Foarloage:Dokumentation
sv:Mall:Dokumentation
sw:Kigezo:Documentation
te:మూస:Documentation
tl:Suleras:Documentation
tpi:Template:Template doc
tr:Şablon:Belgeleme
tt:Калып:Doc
uk:Шаблон:Документація
ur:سانچہ:Documentation
war:Template:Documentation
yo:Àdàkọ:Aṣàlàyé
zh:Template:Documentation