Vikipediya

Şablon:Belgeleme

Belgeleme Belgeleme
{{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>
Başka dilden çevrilmekte Bu sayfa, İngilizce Template:Documentation maddesinden çevrilmektedir.
Siz de yardım etmek istiyorsanız ya da çeviri yarıda kalmışsa, çalışmaya katılan kişilerle veya çeviri grubu ile iletişime geçip, sayfanın durumunu onlara sorabilirsiniz.
Sayfanın geçmişine baktığınızda, sayfa üzerinde çalışma yapanları görebilirsiniz.
Başka dilden çevrilmekte Bu sayfa, başka dilde bir Vikipedi'den çevrilmektedir.
Siz de yardım etmek istiyorsanız veya çeviri yarıda kalmışsa, çalışmaya katılan kişilerle veya çeviri grubu ile iletişime geçip, sayfanın durumunu onlara sorabilirsiniz.
Sayfanın geçmişine baktığınızda, sayfa üzerinde çalışma yapanları görebilirsiniz.

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>

Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the content parameter is used for the content shown in the doc box. The above code means that the content is transcluded as "{{Template:Any page/belge|parameters}}". In this example a parameter is also fed to the /doc page being loaded.

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

When in Template space this template shows this heading:

Template documentation

In most other namespaces, such as "Wikipedia:", it shows this heading:

Documentation

But when on File (image) pages it shows this heading:

Summary

The heading parameter can be used to set the heading to something else. Like this:

{{Belgeleme| heading = Infobox documentation }}

If the heading parameter is empty but defined, no heading is shown and no [edit] [purge] links are shown. Like this:

{{Belgeleme| heading = }}

The heading-style parameter can be fed optional CSS values. Without quotation marks " " but with the ending semicolons ;. For example:

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ı

Terminology: Subject space is the opposite of talk space. For instance "Template:" is the subject space of "Template talk:".

This template is usually placed in subject space, within <noinclude> tags. But in some cases this template needs to be on the talkpage:

Documentation icon Şablon documentation[ekle]

</noinclude>.

  • In MediaWiki space, since <noinclude> often doesn't work in system messages and since MediaWiki space needs to be kept clean for performance reasons.

When placed on talkpages this template usually is placed near the top of the page and without <noinclude> tags.

The /doc, /sandbox and /testcases pages should normally be in subject space, except in the namespaces that don't have the MediaWiki subpage feature enabled: Main, File, MediaWiki and Category. (But currently we only show the /sandbox and /testcases links from User, User talk, Template and Template talk space.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talkpage for those namespaces.

This template automatically points its create links for the /doc, /sandbox and /testcases to the right namespace.

Teknik ayrıntılar

This template calls {{Belgeleme/start box2}}

Documentation icon Şablon documentation[ekle]

</noinclude> and {{Belgeleme/end box2}}

Documentation icon Şablon documentation[ekle]

</noinclude> which in turn call {{Belgeleme/start box}}

Documentation icon Şablon documentation[ekle]

</noinclude> and {{Belgeleme/end box}}

Documentation icon Şablon documentation[ekle]

</noinclude>. /start box (and /end box) hold most of the code, while this template and /start box2 (and /end box2) do parameter preprocessing.

The preload page for the /doc [create] link is Template:Belgeleme/preload, but in File space it is Template:Belgeleme/preload-filespace. The preload pages for the /sandbox and /testcases (create) links are Template:Belgeleme/preload-sandbox and Template:Belgeleme/preload-testcases.

For more technical details see the talk page.

Ayrıca bakınız

Documentation icon Şablon documentation[ekle]

</noinclude> – Placed on templates and other pages to document them.

Documentation icon Şablon documentation[ekle]

</noinclude> – Used at the top of /doc subpages to explain what they are and to link back to the page they document.

Kaynakça

  1. ↑ [http://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_(technical)&diff=prev&oldid=69888944
Alındı "https://gag.wikipedia.org/w/index.php?title=Şablon:Belgeleme&oldid=36759"dän