Şablonlar, MediaWiki'nin çok güçlü bir özelliğidir, ancak yeni kullanıcılar için kafa karıştırıcı olabilir ve deneyimli kullanıcılar bile daha karmaşık olanları anlamakta zorluk çekebilir. Bu nedenle, kullanılabilirliği artırmak için şablonların belgelendirme olması gerekir.
Bu belgeler, bir şablonun ne yaptığını ve nasıl kullanılacağını açıklamalıdır. Basit olmalı, böylece şablonların nasıl kullanılacağına dair tam bilgisi olmayan biri onu doğru şekilde kullanabilir.
Neleri içermelidir?[]
Bazı şablonların belgeleri şunları içermelidir:
- Şablonun amacı; ne yapar/neden yapar.
- Şablonun parametreleri.
- Şablonların nasıl kullanılacağına dair örnekler
- TemplateData
- İlgili şablonlar
- Kategoriler ve vikiarası bağlantılar; ayrı bir /belge alt sayfasına sahip şablonlar bunları farklı şekilde ele alır.
Belgelendirme nasıl eklenir[]
Şablon ekleme[]
Şablonlara belge eklemek oldukça kolaydır. Bunu yapmak için vikimetin öğrenmeniz gerekiyor.
- Bir şablona gidin, ör. Şablon:Taslak.
- Sayfayı düzenleyin
- Sayfanın altına şu kodu ekleyin:
- Sayfayı kaydedin.
Belgelendirme zaten mevcutsa, altta Belgelendirme kelimesinden sonra metni görmelisiniz. Ekran biraz şuna benzer olmalıdır:
Şablon belgelendirmesi
|
|---|
| Not: Şablon örneğinin bölümleri, sağlanan değerler olmadan görünmez olabilir |
| Bu belgeyi görün veya düzenleyin. (Şablon belgelendirmesi hakkında) |
| Düzenleyiciler bu şablonunda deneme tahtası ve test durumu sayfalarında denemeler yapabilir. |
Not: Vikinizde yaptığınız değişikliklere bağlı olarak ekran değişebilir.
Belgelendirme oluşturma[]
Belge şablonunun daha gelişmiş bir sürümüne sahipseniz, /belge alt sayfası olmadan {{Belgelendirme}} şablonunu eklediğinizde bu açılır pencereyi görebilirsiniz:
Şablondaki [oluştur] bağlantısını tıklayabilirsiniz ve bu, Şablon:Belgelendirme/preload içeriğini önceden yükleyecektir. Düzenleyici metnini dilediğiniz gibi değiştirebilirsiniz.
Aksi takdirde, bu şunu gösterecektir: Şablon:<şablon>/belge.
Bağlantıya tıklayın ve önerilen içerikleri aşağıya yazın:
Belgelere ne eklenmeli[]
Şablon belgeleri yazmak için birçok biçim vardır. Bunun için standartlaştırılmış bir kılavuz olup olmadığını görmek için vikinizin kurallarını okuduğunuzdan emin olun.
Eğer yoksa, aşağıdaki biçimleri kopyalamaktan çekinmeyin. Bunları ayrıca özelleştirebilir/vikinize uyarlayabilirsiniz.
Temel biçim[]
== Açıklama ==
Bu şablon bir şeyler yapmak için kullanılır...
== Sözdizimi ==
{{ş|Şablon}}
== Örnek çıkış ==
<code>{{Şablon}}</code> verir:
{{Şablon}}
Bu, bir şablon için en temel biçimdir. Ne istediğinize bağlı olarak genişletilebilir.
Bunu yazmanın alternatif bir yolu, açıklama listelerini kullanmaktır:
; Açıklama
: Bu şablon bir şeyler yapmak için kullanılır...
; Sözdizimi
: {{ş|Şablon}}
; Örnek çıkış
: <code>{{Şablon}}</code> verir:
: {{Şablon}}
Parametreli şablonlar[]
Parametreleri içeren şablonlar için, ne istediğinize bağlıdır:
Şablon maddelerde kullanılıyorsa, parametre listesinin altına TemplateData eklemek yardımcı olabilir.
Bu kodu == Sözdzimi == altına ekleyin:
=== Parametreler ===
; <code>param=</code>
: Bu parametre abc yapar.
=== TemplateData ===
<templatedata>{}</templatedata>
Kategoriler ve vikiarası bağlantılar[]
Bir /belge alt sayfası kullanıyorsanız, aşağıdaki adımları şablonun kendisine değil, alt sayfanın içine uygulayın:
Şablon için[]
Kategoriler için şunu ekleyin:
<Kategori> öğesini Taslaklar gibi kategorinin adıyla değiştirin.
Vikiarası bağlantılar için şunu ekleyin:
/belge alt sayfası için[]
Kategoriler için şunu ekleyin:
<Kategori> öğesini Taslaklar gibi kategorinin adıyla değiştirin.
Vikiarası bağlantılar için şunu ekleyin:
Ayrıca bakınız[]
- Vikipedi:Şablon belgelemesi
- Yardım:Şablonlar
- Yardım:Vikimetin
- Şablonlar Viki'de Şablon:Belgelendirme (kopya)
- Dev Viki'de Template:Documentation, yukarıdaki sayfanın bir Lua versiyonu.
Daha fazla yardım ve geri bildirim[]
- Yardım:İçindekiler sayfasında diğer yardım sayfalarına göz atın ve arayın
- Daha fazla yardım ve destek kaynakları için Fandom Topluluk Merkezi'ne bakın
- Bu maddedeki hataları veya belirsiz adımları nasıl bildireceğiniz konusunda Fandom'a iletişim sayfasına bakın