Şablon:Belgeleme
Belgeleme şablonu, şablonların "kodları" ile "belge"lerini (kategori ve interwiki bilgileri, açıklamaları, örnekleri ve kullanım talimatları) ayırmak içindir. Böylece şablonlar koruma altındayken de belge sayfaları düzenlenebilmekte ve şablonların belgeleri değiştirilirken yanlışlıkla şablonun kodunda değişiklik yapılması önlenmektedir. Ayrıca sayfalar görüntülenirken, bunlara gömülü olduğu için çağrılan şablonların sadece kodlarının değil bazen hayli yüklü olabilen belgelerinin de gereksiz yere çağrılıp işlenmesi, performansı olumsuz etkilemektedir. Bunları önlemek için MediaWiki geliştiricileri tarafından da önerilmektedir.[1]
Bu şablonun kullanım alanı sadece şablonlarla sınırlı değildir, istenildiği takdirde başka sayfalarda da kullanılabilir.
Belgeleme konusunda ayrıntılı bilgi için Yardım:Şablon belgeleme sayfasına bakınız.
Kullanımı ve parametreler değiştir
Şablonun parametreleri şunlardır:
- boş parametre
- Önüne parametre adı getirmeden direk olarak bir şey yazılarak (mesela
{{belgeleme|herhangi bir metin}}) şablonun belgelemesinin yansıtılacağı sayfanın adı belirtilir. Kullanılmadığında varsayılan olarak "ŞABLONADI/doc" sayfası kullanılır.
- başlık
- Bu parametre belgeleme kutusunun başlığının değiştirilmesine imkan sağlar. Kullanımı zorunlu değildir. Kullanılmadığında varsayılan olarak başlık Şablon belgelemesi olur. Kullanılıp boş olarak belirtildiğinde belgeleme kutusunda başlık ve değiştir, tazele, oluştur bağlantıları görünmez.
- başlık-stili
- Eğer başlık için CSS stil kodları yazacaksanız, bu parametreye yazabilirsiniz. Kullanılmadığında varsayılan başlık stili uygulanır. Kullanılıp boş bırakıldığında ise hiçbir stil uygulanmaz.
- içerik
- Bu parametre kullanılırsa, sayfanın belgelemesini başka bir sayfadan yansıtmak yerine bu parametrede yazılı olan metin gösterilir. Bu şablonlardan çok başka sayfalarda kullanım için uygundur.
Kullanıma ilişkin öneriler değiştir
- Şablonu kullanırken
<noinclude>{{Belgeleme|parametreler}}</noinclude>şeklinde sayfanın sonuna ekleyin.<noinclude>etiketinden sonra boşluk bırakmayın. - Kategorileri ve interviki bağlantılrını şablonun belgeleme sayfasına,
<includeonly> </includeonly>etiketlerinin arasına yazın. - {{Belgeleme alt sayfası}}
Örnekler değiştir
- En yaygın şekliyle parametresiz olarak kullanılır:
<noinclude>{{Belgeleme}}</noinclude>
- Başka Belgeleme sayfası
<noinclude>{{Belgeleme|Şablon:başka bir şablon/doc}}</noinclude>
- İçerik adresi belirtme
<noinclude>{{Belgeleme|içerik=Şablon belgeleme sayfası.}}</noinclude>
Deneme ve Sınama sayfaları değiştir
Şablonlarda bazı yeni kodların denenmesi için şablonun deneme isimli bir alt sayfası ve bu denenen yeni kodların sınanması için de sınama isimli bir alt sayfası olabilir. Eğer bu sayfalar mevcutsa belgeleme şablonu bunu bildirecektir.