Belgeleme
Belgeleme şablonu, koruma altındaki şablonların kullanım talimatının düzenlenebilmesini ve şablonların kullanım talimatını değiştirirken yanlışlıkla şablonun kodunda değişiklik yapılmasının önlenmesini sağlamaktadır. Belgeleme şablonun kullanılmasının bir diğer sebebi de şablonlar başka sayfalarda görüntülenirken şablon sayfasındaki metinlerin işlenmesi ve dolayısıyla gereksiz iş yükü oluşturmasıdır. Bunu önlemek için MediaWiki geliştiricileri bu sistemin uygulanmasını önermişlerdir. Bu şablonun kullanım alanı sadece şablonlarla sınırlı değildir. İstenildiği takdirde başka sayfalarda da kullanılabilir.
Kullanımı
Bu şablonda bir çok farklı parametre mevcuttur. Aşağıda kullanım örneklerinde bu şablonların teker teker açıklamaları mevcuttur.
- 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ım ile ilgili birkaç bilgi
- Ş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.
Örnek kullanımlar
Normal kullanım
<noinclude>{{Belgeleme}}</noinclude>
Başka Belgeleme sayfası
<noinclude>{{Belgeleme|başlık=Şablon:başka bir şablon/doc}}</noinclude>
İçerik belirtme
<noinclude>{{Belgeleme|içerik=Şablon belgeleme sayfası.}}</noinclude>
Deneme ve Sınama sayfaları
Ş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.