Şablon belgelemesi Belgeleme

İşbu {{mikutu}} ([m]adde [i]leti [kutu]su) üst şablonu, {{öksüz}} gibi maddelere yönelik ileti kutuları oluşturmak için kullanılmaktadır. Kutuları isteğe bağlı olarak biçimlendirmek ve farklı görünümler kazandırmak için gerekli işlevler şablona tanımlı olarak bulunmaktadır.

Sık kullanılan parametreler

Aşağıda bu şablonun en sık kullanılan parametreleri verilmiş olup her birinin işlevi ilgili alt başlıklarda açıklanmıştır.

{{mikutu 
| ad       = 
| yk       = <includeonly>{{yk:ykdenetim}}</includeonly>
| küçük    = {{{küçük|}}}
| tür      = 
| resim    = 
| bölüm    = {{{1|}}}
| sorun    = 
| çözüm    = 
| tartışma = {{{tartışma|}}}
| tarih    = {{{tarih|}}} 
| kat      = 
| hepsi    = 
}}

Bu parametre sayfanın ad alanını belirtmeden yalnızca şablon adını vermek için kullanılmaktadır. {{öksüz}} örneğinde şablon ad şeklinde kullanılmalıdır.

Eğer şablon taşındıysa parametreye girilen ad da taşınan ada göre güncellenmelidir. Bu parametre iki amaç için kullanılmaktadır:

  1. Eğer hatalı yerleştirilmişse, üst şablonun değiştirilen şablonun adını bildirmesini sağlar ve bu bilgi yazarların sorunu çözmesine yardımcı olur.
  2. Belirtilmediyse bile eklenme tarihini göstermek ya da şablon kategorisini otomatik olarak eklemek gibi şablonun sayfa adından daha yararlı bilgilerin görüntülenmesini sağlar.

yk

Açılımı [y]erine [k]oyma olan bu parametre şablon içeriğinin kullanılan sayfaya doğru şekilde kopyalanarak aktarılıp aktarılmadığının tespitini yapar ve eğer hatalı işlem yapılmışsa uyarı iletisi görüntülenmesini sağlar. Hatalı işlem yapıldığında ilgili sayfa otomatik olarak hatalı yerine koyma işlemi yapılan şablon içeren sayfalar kategorisine eklenir. Parametreyi yukarıda örnek verildiği şekilde kullanmak yeterlidir.

küçük

Bu parametre ileti kutusunun çok daha küçük boyutta ve sayfanın sol tarafına hizalanmış şekilde görüntülenmesini sağlamaktadır. Bunun için parametreye küçük değeri girilmelidir. Parametre yalnızca İngilizce kelimelere duyarlıdır, Türkçe değer girilmemelidir.

Aksi takdirde normal boyutta görüntülenecektir:

Diğer kullanımlar:

  • Eğer ileti kutusunun hiçbir zaman küçük boyutta görüntülenmemesi gerekiyorsa küçük şeklinde komut verilebilir ya da bu parametre hiç kullanılmayabilir.
  • Eğer ileti kutusunun her zaman küçük boyutta görüntülenmesi gerekiyorsa küçük şeklinde komut verilebilir.
  • Eğer ileti kutusunun varsayılan olarak küçük boyutta görüntülenmesi gerekiyorsa küçük şeklinde komut verilebilir. Bu durumda şablon hiçbir parametre belirtilmediği takdirde küçük boyutta görüntülense de isteğe bağlı olarak küçük komutu verildiğinde normal boyutlarda görüntülenmesi sağlanabilir.

Maddelerin yalnızca bir alt başlığına yönelik oluşturulan şablonlarda küçük parametresinin nasıl kullanılması gerektiğine yönelik bilgi için Şablon:Alt başlık bağlantısı kısmını okuyun.

tür

Bu parametre kutunun solundaki çubuğun rengini ve varsayılan resmi değiştirmek için kullanılmaktadır. Kutuya içeriğin ilgili konuya göre kategorize edilmesi amacıyla yedi farklı görünüm tanımlanmıştır:

Eğer bu parametreye hiçbir bilgi girilmezse varsayılan olarak tür değeri sağlanacaktır.

resim

Bu parametre kullanılarak belirli bir resim kutunun solunda görüntülenmesi için ayarlanabilir:

  • Örneğin {{taraflı}} şablonuna resim şeklinde resim tanımlı olup şu şekilde görüntülenmektedir:

Şablon:Taraflı

  • Bir başka örnek olarak {{viki bağlantısız}} şablonuna resim şeklinde resim tanımlı olup şu şekilde görüntülenmektedir:

Şablon:Viki bağlantısız

resim parametresi kullanılırken şunlar da göz önünde bulundurulmalıdır:

  • Eğer bir resim girilmezse belirtilen türün varsayılan resmi kullanılır.
  • Eğer resim şeklinde kullanılırsa türün varsayılan resmi de dâhil olmak üzere hiçbir resim görüntülenmez ve metin kutunun tamamını kaplar.
  • Yalnızca kamu malı resimler şablonlarda kullanılmalıdır. Eklenen resme linkalt parametreleri ile değer girerek imleç ile üzerinde beklendiğinde açıklama görüntülenmesi, tıklandığındaysa belirli bir maddeye gitmesi sağlanabilir ve böylece erişilebilirlik artırılabilir.

altbaşlık

Çoğu madde iletisi şablonu Bu madde... girizgâhını kullansa da alt başlıklar için oluşturulan ileti şablonlarının Bu alt başlık... şeklinde başlaması arzu edilir. Bunun istendiği durumlarda bu parametreye girilen değer "madde" kelimesinin yerine kullanılacaktır. altbaşlık, altbaşlık, |altbaşlık="Popüler kültürde" eser gibi farklı madde türlerine yönelik kullanılabilir.

Şablon:Vm

Parametrenin en bilindik ve işlevsel kullanımı altbaşlık şeklindedir. Böylece yazarlara "madde" kelimesini değiştirmek için ilk adsız parametre olarak bir altbaşlık belirtme seçeneği sunulacaktır. Örneğin {{reklam-madde|ALT BAŞLIK ADI}} şu şekilde görünür: Şablon:Reklam-madde Bir diğer yöntem de altbaşlık şeklinde farklı bir değer tanımlamaktır. Böylece şablona özel olarak bölüm şeklinde kullanılabilecek farklı bir parametre oluşturulabilir.

Şablon:Vm gerektiğinde kullanılması şiddetle önerilir. Kullanıma hazır şu örnek: Şablon:Blok girinti aşağıdakilere olanak sağlar:

  • {{evethayır}} şablonunun tespit edeceği altbaşlık, bölüm vb. herhangi bir olumlu değer "madde" yerine "altbaşlık" metnini görüntüleyecek. İsteğe bağlı olsa da bölüm ve altbaşlık parametrelerinin her ikisini de tanımlamak yazarların hangi parametrenin işe yaradığını düşünmesini gerektirmeyeceğinden kolaylık sağlaması açısından kullanılması önerilir. Yukarıdaki örnek kod olduğu gibi kullanılarak başka hiçbir işlem yapılmadan bu sağlanabilir.
  • Girilecek olan herhangi bir değer "madde" kelimesi yerine geçecektir: ', '1, altbaşlık, bölüm gibi.

küçük parametresi ile oluşturulan küçük boyutlu ileti şablonunun diğer benzer şablonlarla karışmaması için maddenin en üstünde değil de ilgili alt başlıkta görüntülenecek şekilde ayarlanması gerekli olup aşağıdaki şekilde bu sağlanabilir: Şablon:Blok girinti Bu kullanım şeklinde küçük ya da sol parametresinin yanı sıra altbaşlık parametresine de bilgi girildiği takdirde şablonun küçük sürüme geçmesi için ayarlama yapılmıştır.

sorun ve çözüm

sorun parametresi maddedeki sorunu tanımlamak için kullanılır. Sorun kısaca, en basit şekilde açıklanmalı (yaklaşık 10-20 kelime) ve ilgili bir politikaya ya da yönergeye bağlantı verilmelidir. çözüm parametresi, maddeyi geliştirmek için ne yapılması gerektiğini açıklayan metni içerir. Buraya girilecek olan bilgi sorun parametresine yazılan metinden daha uzun olabilir ancak yine de en fazla iki cümle olması önerilmektedir.

Şablon toplu hâldeyken ({{çoklu sorun}} içerisine yerleştirildiğinde) ya da küçük hâlde (küçük şeklinde kullanıldığında) yalnızca sorun parametresine girilen metin görüntülenir. Örneğin {{kaynakları düzenle}} şablonuna ilgili parametreler şu şekilde tanımlanmıştır:

  • |sorun=Bu madde '''önerilmeyen biçimde kaynaklandırılmış'''.
  • |çözüm=Gösterilen kaynaklar [[Vikipedi:Kaynak gösterme şablonları|kaynak gösterme şablonları]] ile [[Yardım:Dipnotlar|dipnot]] belirtme biçemine uygun olarak düzenlenmelidir.

ve tek başına kullanıldığında her iki metin de görüntülenir: Şablon:Kaynakları düzenle

Ancak {{çoklu sorun}} içerisinde ya da küçük ile kullanıldığında yalnızca sorun görüntülenir: Şablon:Çoklu sorun Şablon:Kaynakları düzenle

tartışma

Bazı madde ileti şablonları, tartışma sayfasına bağlantı içerir ve doğrudan ilgili alt başlığa erişmek için de alt başlık adı vermeye olanarak sağlar. tartışma şeklinde bu kolaylık sağlanabilir.

Bu tanımlama yapıldığında parametre daha sonra aşağıdaki gibi farklı usullerle kullanılabilir:

  • tartışma – Eğer tartışma sayfası şablonun eklendiği maddenin tartışma sayfasıyla yalnızca tartışma şeklinde kullanılabilir.
  • tartışma – Eğer tartışma sayfası şablonun eklendiği maddenin değil de farklı bir maddenin tartışma sayfasıysa tartışma şeklinde sayfanın ve alt başlığın tamamı kullanılmalıdır. Alt başlıkların bağlantı mantığına dair ayrıntılı bilgi için bölüm bağlantısı kılavuzu okunabilir.

Notlar:

  • Bu parametre bir şablon tarafından kullanıldığında tartışma sayfası bağlantısı şablonda görünecektir.
  • Tartışma sayfasına bağlantı gittiğinden emin olmak için tartışma kullanımı önerilir.
  • Bağlantı verilen tartışma sayfası henüz oluşturulmamışsa görüntülenmez.

tarih

Bu parametre kullanılarak şablonun maddeye ne zaman eklendiğine dair bilgi verilebilir. Girilen bilgi asıl metinden daha küçük boyutta görüntülenecektir.

bilgi

Bu parametre ek bilgi girmek içindir. Buraya ne eklenirse eklensin tarihten sonra gelecek ve şablon {{çoklu sorun}} içine alınmışsa görüntülenmeyecektir.

kaldırmailetisi

Eğer kaldırmailetisi şeklinde komut verilirse ve {{çoklu sorun}} içine alınmamışsa tarih ile bilgi parametrelerine girilen bilgileri takiben şablonda aşağıdaki metin görüntülenecektir:

kat

Şablona bu parametre vasıtasıyla izleme ya da temizlik kategorileri tanımlanabilir. kat şeklinde kullanıldığında:

  • Eğer tarih belirtilmişse şablonun eklendiği madde Kategori:TARİHİNDEN beri KATEGORİ kategorilerinde dizinlenir.
  • Eğer tarih belirtilmemişse yalnızca Kategori:KATEGORİ şeklinde belirtilen kategoride dizinlenir.

Örneğin {{dipnotsuz}} şablonuna kat kategorisi tanımlanmış olup {{dipnotsuz|tarih=Haziran 2010}} şeklindeki kullanımda ilgili madde Haziran 2010 tarihinden beri kaynakları olmayan maddeler kategorisine otomatik olarak eklenir.

Parametre kullanılırken [[bu şekilde]] bağlantı verilmemeli ve "Kategori:" ön eki kullanılmamalıdır.

tümü

Bu parametre şablonun eklendiği tüm maddelerin istisnasız olarak ekleneceği üst kategorileri belirtmek için kullanılır.

Parametre kullanılırken [[bu şekilde]] bağlantı verilmemeli ve "Kategori:" ön eki kullanılmamalıdır.

Diğer parametreler

Aşağıdaki "Tüm parametreler" kutusunda bu şablona tanımlı parametrelerin tamamı listelenmiştir. Bununla birlikte içeriğin olduğu gibi kopyalanması önerilmemektedir zira hiçbir zaman bütün parametrelerin aynı anda kullanılması gerekmeyecektir.

Tüm parametreler
{{mikutu
| ad              = 
| yk              = <includeonly>{{yk:ykdenetim}}</includeonly>
| küçük           = {{{küçük|}}}
| tür             = 
| resim           = 
| sağresim        = 
| küçükresim      = 
| küçüksağresim   = 
| sınıf           = 
| biçim           = 
| metinbiçimi     = 
| altbaşlık       = {{{1|}}}
| sorun           = 
| tartışma        = {{{tartışma|}}}
| çözüm           = 
| tarih           = {{{tarih|}}}
| metin           = 
| küçükmetin      = 
| yalınbağ        = hayır
| kaldırmailetisi =
| kat             = 
| tümü            = 
| kat2            = 
| tümü2           = 
| kat3            = 
| tümü3           = 
}}

sağresim

Bu parametre kullanılarak kutunun sağ tarafında da resim gösterilmesi sağlanabilir. Kullanım şekli resim parametresi ile tamamen aynıdır.

küçükresim ve küçüksağresim

Bu parametreler kullanılarak küçük boyutlu kutuların her iki yanında görüntülenmesi için ayrı resimler tanımlanabilir. Yalnızca küçük komutu verildiğinde görüntülenirler.

sınıf

Kutuya uygulanacak olan özel CSS sınıfının adı. Birden fazla sınıf eklenecekse boşluk karakteri ile birbirlerinden ayrılmış olmaları gerekmektedir.

biçim ve metinbiçimi

İsteğe bağlı biçim değerleri. Tırnak işareti " " olmadan yalnızca noktalı virgül ; ile birbirlerinden ayrılarak belirtilmelidir.

  • biçim, kutunun tamamını biçimlendirmek için kullanılır.
  • metinbiçimi, yalnızca metin parametresine girilen yazı için kullanılır.

metin ve küçükmetin

Bilgi kutusuna sorun ve çözüm parametreleri ile ayrı ayrı bilgi girmek yerine yalnızca metin parametresini kullanmak da mümkündür. Eğer küçük boyutlu bir şablon hazırlanıyorsa aynı işlev için küçükmetin parametresi kullanılmalıdır.

yalınbağ

Vikipedi'de bir dış bağlantı verildiğinde varsayılan olarak örnek.com şeklinde görüntülenir. Buna karşın örnek.com gibi bağlantının yanındaki ok simgesini gizlemek mümkündür. Eğer ileti kutusu dış bağlantı içeriyorsa ve ok simgesinin görünmesi istenmiyorsa yalınbağ komutu ile bu sağlanabilir.

kat2, kat3, tümü2 ve tümü3

  • kat2 ve kat3 parametrelerinin kullanım amacı ve şekli kat parametresi ile tamamen aynıdır.
  • tümü2 ve tümü3 parametrelerinin kullanım amacı ve şekli tümü parametresi ile tamamen aynıdır.

Teknik detaylar

  • Bu üst şablon MediaWiki:Common.css adresinde tanımlı olan ambox ("ambox" kelimesinin açılımı "article message box" olup "mikutu"nun İngilizcesidir) CSS sınıflarını kullanmaktadır. Özel işlevlerin kullanılması gerektiği takdirde sınıflar doğrudan vikitabloda kullanılabilir.
  • metin parametresinde şablonun işleyişini bozan özel işaretlerin kullanılması gerektiği durumlarda aşağıdaki gibi HTML işaretlemesi kullanılmalıdır:
{{mikutu
| metin = <div>
Eşittir işareti = ve küme parantezleri { } görüldüğü üzere normal şekilde kullanılabiliyor.
Ancak dikey çubuk &#124; ve çift küme parantezi kapama işareti ancak HTML koduyla kullanılabiliyor <nowiki>}}</nowiki>.
Bir de ikisini art arda kullanalım tam olsun <nowiki>|}}</nowiki>.
</div>
}}
  • Bu şablon parametrelerini {{#invoke:ileti kutusu}} modülünden çağırmaktadır.
  • Yukarıdaki örnekteki metni çevreleyen <div> etiketleri çoğunlukla gerekli değildir. Ancak, metin satır atlama içeriyorsa bazı durumlarda, özellikle de dikey noktalı listeler kullanılırken olmadık yerlerde satır atlanabilir. Bu sorunu düzeltmek için div etiketlerini kullanmak elzemdir.
  • Şablon MediaWiki:Common.css'de tanımlı CSS sınıflarının çoğunu kullanır, bu nedenle tamamen biçimlendirilebilirdir.
  • Şablon tablo oluştururken bazı dezavantajları olduğundan viki biçemini değil HTML biçimlendirmesini kullanmaktadır. Viki biçemini kullanmak, örneğin, ayrıştırıcı işlevler için gerekli bazı özel karakterlerin kullanılmasını zorlaştırmaktadır.
  • Şablonun varsayılan resimleri SVG formatı yerine PNG formatındadır. Bunun temel nedeni, bazı eski tarayıcıların MediaWiki'nin SVG görüntüler için oluşturduğu saydam arka planları göstermede sorun yaşamasıdır.
  • Daha fazla teknik detay için şablonun oluşturulduğu İngilizce Vikipedi'deki tartışma sayfasına ve aşağıdaki "Ayrıca bakınız" kısmına göz atılabilir. Bu şablon {{tikutu}}, {{dikutu}}, {{kikutu}} ve {{sikutu}} ile tam olarak aynı şekilde çalıştığından o şablonların tartışma sayfalarında da daha fazla detay bulunabilir.

Ayrıca bakınız

Omurgasını {{#invoke:ileti kutusu}} modülünün oluşturduğu yedi ileti kutusu şablonu:

  • {{mikutu}}, maddeler için ileti kutuları.
  • {{kikutu}}, kategoriler için ileti kutuları.
  • {{imbox}}, dosyalar (resim, elektronik kitap, video vb.) için ileti kutuları.
  • {{çkutu}}, farklı ad alanlarındaki kullanıma göre özelleştirilebilen mesaj kutuları.
  • {{tikutu}}, tartışma sayfaları için ileti kutuları.
  • {{sikutu}}, diğer sayfalar için ileti kutuları.
  • {{bikutu}}, üst ve alt bilgi ileti kutuları.

Benzer ileti kutuları:

  • {{mtkutu}}, taslak maddeler için ileti kutuları.
  • {{aikutu}}, anlam ayrımı ve dizinleme sayfaları için ileti kutuları.

Benzer ileti kutularıyla kullanılmak için tasarlanan alt şablonlar: