Vikipedi:Şablon deneme tahtası ve sınama

Vikipedi, özgür ansiklopedi
Gezinti kısmına atla Arama kısmına atla

Şablonlar Vikipedi için kullanılan MediaWiki yazılımının çok etkili bir özelliğidir ama şablonların yapımında, deneyimli kullanıcılar bile hata yapabilir. Dolayısıyla karmaşık şablonlar, yazılım hatalarını önlemek için deneme tahtalarında sınanmalıdır. Şablon geliştirme konusunda yeni olan kullanıcılar ya da yeni denemeler yapmak isteyenler geçici deneme tahtaları X1'i, X2'yi, ..., X20'yi ya da şablon deneme tahtasını kullanabilir.

Deneme ve sınama alt sayfaları adlandırma[kaynağı değiştir]

Koruma altında olan şablonların çoğunun deneme ve sınama yapmak için alt sayfaları hâlihazırda bulunmaktadır. Bu alt sayfaların varsayılan adları "deneme" ve "test" sayfalarıdır. Her şablonun sayfasında, belge alt sayfasına eklenmiş olarak şablonun deneme ve sınama alt sayfalarını yaratmak ya da düzenlemek için bağlantılar bulunur.

Örneğin, anlam ayrımı ileti kutusu için kullanılan {{Aikutu}} şablonunun alt sayfaları:

Şablon Bağlantı
Ana şablon Şablon:Aikutu
Şablon deneme alt sayfası Şablon:Aikutu/deneme
Şablon sınama alt sayfası Şablon:Aikutu/test

Hangi tür şablonlar için deneme tahtası kullanmalı[kaynağı değiştir]

Çok parametre kullanan ya da #switch operatörünün çok sayıda dalı bulunana ve çok farklı görünen çıktılar üretebilen ParserFunctions kullanan şablonlar için deneme ve sınama yapılması önemle önerilmektedir.

Yansıtıldığı her sayfada çoğunlukla benzer sonuçlar gösteren dolaşım şablonlarında ise deneme ve sınama yapmak ile elde edilecek yarar bunun için geçecek zamanı telafi etmeyecek kadar az olabilir, gene de emin değilseniz deneme ve sınama yapınız. Yüksek riskli şablon olarak belirtilmiş tüm şablonlarda ise değişiklik yapmadan önce her zaman sınama yapılmalıdır. Diğer sayfalarda ise şablonu kullanan sayfaları kontrol etmelisiniz. Şablonu kullanan sayfaları ekranınızın sol tarafındaki "Sayfaya bağlantılar" bağlantısını kullanarak görebilirsiniz.

/deneme ve /test alt sayfaları nasıl oluşturulur[kaynağı değiştir]

  1. Şablonunuzun adının Şablon:X olduğunu varsayalım. Şablon:X/deneme adında bir alt sayfa oluşturun. Eğer ana şablon {{belgeleme}} şablonu kullanıyorsa bunu şablonun ana sayfasındaki belgeleme kutusunun altında bulunan bağlantı sayesinde yapabilirsiniz. Ya da arama kutusuna yazabilir ya da doğrudan internet tarayıcınızın URL çubuğuna yazabilirsiniz. "/deneme" adının tamamen küçük harflerle yazıldığına dikkatinizi çekeriz.
    • Eğer şablonun belge bölümünün altındaki "yansıtma" bağlantısını kullanırsanız şablon kodu içindeki <noinclude> etiketleri ve arasında olanlar aktarılmayacaktır. Manuel olarak kopyalayıp yapıştırmak daha iyidir.
  2. Ana şablonun içeriğini, <noinclude> etiketleri ve varsa {{belgeleme}} şablonu da dahil olarak tamamen kopyalayın ve /deneme altsayfasının düzenleme penceresine yapıştırdıktan sonra sayfayı kaydedin. Değişiklik özetiniz [[Şablon:X]]'in deneme versiyonu oluşturuldu gibi giriliebilir.
  3. Şablon:X/test adında başka bir alt sayfa oluşturun. Bu sayfa eğer oluşturulduysa yalnızca şablon belgeleme sayfasında alt kısımda bağlantısı bulunmaktadır, dolayısıyla oluşturmak için arama kutusuna yazabilir ya da doğrudan internet tarayıcınızın URL çubuğuna yazabilirsiniz. "/test" adının tamamen küçük harflerle yazıldığına dikkatinizi çekeriz.
  4. Sayfanın başına {{test senaryosu uyarısı}} şablonunu ekleyin ve istediğiniz deneme şablonunu kullanarak değişiklikler yapın ve değişikliklerinizi kaydedin.
  5. Denemek istediğiniz şablon kodunu Şablon:X/deneme sayfasına ekleyin. Kodunuzu sınamak için sayfayı kaydedin ve sonra /test sayfasına gidin. Yaptığınız değişiklikleri görebilmek için genellikle önbelleği temizlemeniz gerekebilir; bunun için {{test senaryosu uyarısı}} şablonunda gerekli bağlantı bulunmaktadır. Önbelleği temizledikten sonra ana şablonun çıktısı ile deneme sayfasındaki değiştirilmiş şablonun çıktısını karşılaştırın ve eğer herşey yolunda görünüyorsa ana şablonu değiştirerek güncelleyebilirsiniz. Ancak şablon sınaması yaparken eksik kalmış test senaryolarına dikkat edin çünkü yalnızca bazı ad alanlarında ve bazı sayfalarda sınanabilecek kodlar olması mümkündür.

Varolan /deneme ve /test alt sayfaları nasıl güncellenir?[kaynağı değiştir]

/deneme ve /test alt sayfaları olan şablonlarda değişiklik yapmak yukarıda anlatılanlara benzer şekildedir.

  1. /deneme alt sayfasında şablonun son hâli olmayabilir dolayısıyla değişiklik yapmadan önce ana şablon ile senkronize etmek zorunda kalabilirsiniz. Ana şablonun içeriğinin tamamını /deneme alt sayfasına kopyalayın ve alt sayfadaki değişiklikleri yayımlayın. Değişiklik özetiniz "ana şablon ile senkronize edildi" gibi ya da basitçe "senkronizasyon" gibi olabilir.
  2. Deneme sayfasında istediğiniz değişikliği yapın ve eklemek istediğiniz kodu ekledikten sonra değişiklikleri yayımlayın.
  3. Eğer yeni özellikler eklediniz ya da parametrelerde değişiklik yaptıysanız sınama yapabilmek için /test alt sayfasına yeni sınama senaryoları eklemelisiniz. Ayrıca varolan sınama senaryolarının tam olmayabileceğini unutmayın. Yapmak istediğinize hizmet etmeyecekse sınama senaryolarını değiştirmek uygundur ama aynı zamanda sizden sonra sınama senaryolarını kullanabilecek diğer kullanıcıları da unutmayın.
  4. Sonuçları güncellemek için /test alt sayfasında önbelleği temizleyiniz.
  5. Sınama senaryolarının sonuçlarının doğru olduğunu kontrol ediniz. Eğer herşey yolnda görünüyorsa deneme sayfasındaki kodu kopyalayarak ana şablon sayfasına taşıyınız ve değişiklikleri yayımlayınız.

Sınama senaryoları ekleme[kaynağı değiştir]

/test alt sayfasında şablonunuzun her farklı davranışı için bir sınama senaryosu olmalıdır. Örneğin eğer şablon çıktınız bir mesaj ise ve eğer |italik=evet parametresi bu mesajı eğik yazıya çeviriyorsa hem normal mesaj hem de eğizk yazılı mesaj için bir sınama senaryosu eklemelisiniz. Eğer şablonda |tarih= parametresi gibi kullanıcının tarih girdiği başka bir parametre varsa o zaman bunun için de üçüncü bir sınama senaryosu girmelisiniz. Kullanıcıların şablonu kullanabileceği her durum için bir sınama yapmaya çalışmalısınız ancak her bir parametre kombinasyonu için sınama senaryosu yapmak genellikle kullanışsız olacağından en ilgili olan durumları seçmelisiniz.

Kullanabileceğiniz birkaç farklı sınama senaryosu biçimi bulunur. Bunlardan hangisini seçeceğiniz üzerinde çalıştığınız şablonun yapısına bağlıdır. Örneğin tek bir satıra sığan kısa şablonlar için senaryo durumlarını bir vikitablonun içine koymak yararlı olabilir. Bilgi kutuları gibi uzun ve ince şablonlar için ise genellikle bunları {{test senaryosu tablosu}} şablonu kullanarak yanyana göstermek daha iyidir.

Manuel biçimlendirme[kaynağı değiştir]

Manuel biçimlendirme büyük bir esneklik sağlar ama tüm şablon parametrelerinin doğru olarak girildiğine dikkat edilmelidir. Bir sınama senaryosundaki hata genellikle şablonun kendisindeki hatayı bulmaktan daha zor olabilir.

Temel biçimlendirme[kaynağı değiştir]

Bu biçimlendirme mesaj şablonları ve kaynak şablonlarında olduğu gibi uzun metinler için iyi çalışır. {{Test senaryosu}} ve benzeri şablonları kullanarak bunun gibi sınamaları otomatik olarak biçimlendirebilirsiniz.

== Tanımlayıcı başlık ==
 
* <code><nowiki>{{şablon|parametre1=değer1|parametre2=değer2}}</nowiki></code>
 
'''Ana'''
 
{{şablon|parametre1=değer1|parametre2=değer2}}
 
'''Deneme'''
 
{{şablon/deneme|parametre1=değer1|parametre2=değer2}}

şablon, parametre1, değer1 vd. her biri aynı olmalıdır.

"float" CSS özelliği kullanan şablonlarda sonuçların birbiri üstüne gelmesi önlemek için {{temiz}} şablonu kullanmalısınız:

== Tanımlayıcı başlık ==
 
* <code><nowiki>{{şablon|parametre1=değer1|parametre2=değer2}}</nowiki></code>
 
'''Ana'''
 
{{şablon|parametre1=değer1|parametre2=değer2}}
 
{{temiz}}
 
'''Deneme'''
 
{{şablon/deneme|parametre1=değer1|parametre2=değer2}}
 
{{temiz}}

Vikitablo[kaynağı değiştir]

Kısa çıktısı olan şablonları sınamak için vikitablo kullanmak yararlı olabilir.

Tabloya şu şekilde başlayın:

{| class="wikitable"
|-
! Kod
! Ana
! Deneme

<!-- Her yeni sınama senaryosu böyle eklenmelidir: -->

|-
| <code><nowiki>{{şablon|parametre1=değer1|parametre2=değer2}}</nowiki></code>
| {{şablon|parametre1=değer1|parametre2=değer2}}
| {{şablon/deneme|parametre1=değer1|parametre2=değer2}}

<!-- Tabloyu böyle bitirin: -->

|}

Otomatik biçimlendirme[kaynağı değiştir]

Şablon sınama senaryolarını biçimlendirmenize yardımcı olacak çeşitli şablonlar vardır. Bu şablonların yardımıyla parametreler ve değerler yalnızca bir kere girilir ama hem ana şablon hem de deneme şablonlar aynı anda sınanabilir. Bu şablonların kullanılması sınama senaryosunda parametre hatasını önlediği gibi /test alt sayfalarının bakımını yapmak da kolaylaşır. Bu şablonların arasında şunlar sayılabilir:

Tüm bu şablonların kapanabilir sınama senaryoları oluşturabildiğine dikkatinizi çekeriz; Şablon:Kapanabilir test senaryosu ise bu özelliğin varsayılan olarak açık olmasıdır. Daha detaylı açıklamalar için her bir şablonun kendi sayfasına bakınız.

/test alt sayfasında yapılamayan sınamalar[kaynağı değiştir]

Bazı şablon özellikleri /test alt sayfalarında sınanamaz. Örneğin bir şablon yalnızca ana ad alanı altında kullanıldığında bazı metinleri çıktı olarak verebilir ya da bir alt sayfada kullanıldığında farklı çıktılara sahip olabilir. Bu tarz sınamalar için şablon sayfalarının düzenleme sayfalarının altında bulunan "Bu şablonu kullanan sayfa önizlemesi" özelliğini kullanabilirsiniz.

Eğer /test alt sayfasında sınanamayacak herhangi bir sınama şekli aklınıza gelirse başka sınanması gereken nelerin kaldığı ile ilgili bir notu sınama sayfasının başına not olarak ekleyebilirsiniz şablonun gelecekteki düzenleyicilerinin de bunun farkında olmalarını sağlayabilirsiniz.