Şablon:Belgeleme/belge

[bullvar_katip]

şablonu, şablonların "kodları" ile "belge"lerini (kategori ve interviki 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 MediaViki geliştiricileri tarafından da önerilmektedir.En.Wikipedia/Köy çeşmesi 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 Vikipedi:Şablon belgelemesi sayfasına bakınız. Bu şablon şimdi görmekte olduğunuza benzer bir belge kutusu gösterir ve bunun içine otomatik olarak bir /belge altsayfasının içeriğini yükler. Uygun şekilde kullanıldığında, başka adreslerdeki içeriği de yükleyebilir. Bu şablon, başka sayfalara katıştırılmış, gömülmüş şablonları ve sayfaları belgelemek için düşünülmüştür. Çoğunlukla şablon isim alanında uygulanmakla beraber, diğer isim alanlarına??? ait sayfalar için de kullanılır. Bu şablon, şablonların gerekli durumlarda protected edilmesini ama aynı anda da bunlara bağlanmış belgeleme, kategoriler ve interwiki bağlantılarını isteyenlerin düzenleyebilmelerini sağlar. Kullanım Normalde bu şablon hiçbir parametre kullanılmaksızın, belgelenecek şablon ya da sayfanın sonuna, etiketleri arasına alınarak yerleştirilir: Sayfaya katıştırılan Böylece, tarayıcıda açılan şablon sayfasının yapısı: ---- DİKKAT: iki şablonun kodları çok farklı, hem Şablon:Belgeleme'yi geliştirmek hem de bu /belge belgesini düzenlemek lazım. Ayrıca Bkz:Vikikitap'taki belgeleme şablonu İstiastiklere göre İngilizce Vikipedi'deki Documentation şablonu, 59000 sayfaya katışmıştır. Şu anda Türkçe Vikipedi'de. 1193 sayfadan fazla kullanılıyor. Türkçe Vikipedi'de şu anda Belgeleme şablonunun ne kadar kullanıldığını öğrenmek için tıklayın. ---- Bu şablon ayrıca herhangi bir başka sahifeden şu şekilde içerik yükleyebilir: Belgelemeyi kendi /belge sayfasından başka bir sayfadan yüklemek istendiğinde kategoriler ve intervikileri eklemenin kolay olmadığına dikkatinizi çekeriz. İçerik ayrıca yazı olarak doğrudan şöyle eklenebilir: Eğer içerik parametresi kullanılırsa belge kutusu normalde [düzenle][sil] bağlantılarını sağ üst köşede göstermez. Eğer /belge sayfası varsa ona bir bağlantının hâlâ belgeleme kutusunun altındaki bağlantı kutusunda gösterildiğine dikkat ediniz. Fakat 1. parametre ve içerik parametresi ayrıca şu şekilde birleştirilebilir: Şablonun belgelemesini düzenlemek ve yenilemek için ve kullanılır. Kullanım talimatları Kod, şablon kodunun sonuna, ""dan sonra hiç boşluk bırakmadan yerleştirilmelidir (bu boşluk, şablonun kullanıldığı sayfalarda istenmeyen fazla aralık yaratabilir). Şablonun kendisine uygulanan kategori ve interwiki bağlantılar, /doc altsayfasının sonuna ve etiketleri içinde, eklenmelidir. Daha karmaşık durumlar için Wikipedia:Template documentation#Categories and interwiki links sayfasına bakınız. Eğer belgeleme sayfası, görünen metin içinde <includeonly>