Şablon:Disambig/belge

Vikipediya saydından
Gezinti kısmına atla Arama kısmına atla
Belgeleme Belgeleme

Bu gördüğünüz, Şablon:Disambig için bir belgeleme sayfasıdır. Doğrudan tek başına görüntülendiği zaman, bağlantıların kullandığı bazı değişkenler bozuk gözükebilir. Bu durum genellikle normaldir, bu değişkenler yerine doğrudan koda yazılmış (hard coded) sayfa adları veya URL'ler yazmayın.

{{Belgeleme}}
Documentation icon Şablon documentation[ekle]

</noinclude> ş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.[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 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, <noinclude> etiketleri arasına alınarak yerleştirilir:

<!--şablon kodunun son satırı--><noinclude>
{{Belgeleme}}
<!-- Kategori ve interwikileri buraya değil /belge altsayfasına ekleyin lütfen! -->
</noinclude>

Sayfaya katıştırılan Böylece, tarayıcıda açılan şablon sayfasının yapısı:

...
<includeonly>
   [[Şablon:Şablon belgeleme başlangıç|Şablon belgeleme başlangıç]]
      şablon-adı/belge sayfası
   [[Şablon:Şablon belgeleme bitiş|Şablon belgeleme bitiş]]
</includeonly>


Bu şablon ayrıca herhangi bir başka sahifeden şu şekilde içerik yükleyebilir:

<!--Şablon kodunuzun son satırı--><noinclude>

{{Belgeleme|Şablon:Başka sayfa/belge}}
</noinclude>

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:

<!--Şablon kodunuzun son satırı--><noinclude>

{{Belgeleme
| içerik = Belgeleme yazısı.
}}
</noinclude>

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:

<!--Şablon kodunuzun son satırı--><noinclude>

{{Belgeleme
| 1 = Şablon:Herhangi bir sahife/belge
| içerik = {{Şablon:Herhangi bir sahife/belge|parametreler}}
}}
</noinclude>

Şablonun belgelemesini düzenlemek ve yenilemek için (değiştir) ve (yenile) kullanılır.

Kullanım talimatları

Kod, şablon kodunun sonuna, "<noinclude>"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 <includeonly></includeonly> 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> ya da <noinclude> etiketleri içeriyorsa, "<" yerine "&lt;" kullanın.

Başlık

Bu şablon başlığı böyle görünür:

Belgeleme Belgeleme

Diğer alan isimleri için böyle görünür:

Documentation

Resimle (Dosya) olduğunda böyle görünür:

Summary

Heading parametleri böyle görünür:

{{Belgeleme| heading = Infobox documentation }}

Heading parametreleri [değiştir] [yenile] linklerinde yoktur. Gözükme:

{{Belgeleme| heading = }}

Heading parametreleri CSS ile uyumludur. Örnek:

heading-style = color: red; font-size: 150%;

Bağlantı kutusu

Below the big doc box is a small link box that shows some meta-data about the documentation. The link box shows different things depending on what parameters are fed to this template, and in which namespace it is used. In some cases the link box is not shown at all.

To hide the link box, add the parameter link box=off.

You can also insert customised text in the link box, by defining the |link box parameter. For example:

|link box=This documentation is automatically generated by [[Şablon:Country showdata]]

Otomatik işlevler

If the documentation page doesn't exist, the [create] link includes a preload page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases (create) links.

When this template is on a protected template page it now automatically adds {{pp-template}}

Documentation icon Şablon documentation[ekle]

</noinclude> which shows the grey or red padlock in the top right corner. So no need to manually add {{pp-template}} to templates that use {{Belgeleme}}

Documentation icon Şablon documentation[ekle]

</noinclude>.

When this template is on a /sandbox subpage it automatically adds the {{template sandbox notice}}

Documentation icon Şablon documentation[ekle]

</noinclude>.

Konu alanı / Tartışma alanı

Terminoloji:Konu alanı,tartışma alanıtersidir. Örneğin "Şablon:", "Şablon tartışma:" konusu alandır.

Bu şablon genellikle
  1. [http://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_(technical)&diff=prev&oldid=69888944