Şablon yazmak, diğer viki sayfalarını yazmak gibidir ve en basit şablonlar, diğer sayfalarda gösterilen tipik bir viki sayfasından başka bir şey değildir. Ancak çoğu şablon parametreleri, sihirli kelimeler ve standart ParserFunctions tarafından sağlananlar gibi ayrıştırıcı işlevlerini (tüm Gamepedia'da varsayılan olarak yüklü) kullanır vikiler) daha da kullanışlı hale getirmek için.
Basit bir şablon yazma[ | ]
İçeriğiyle "Şablon:Hoş Geldiniz" adlı bir sayfa oluşturursanız:
Merhaba! Vikiye hoş geldiniz.
ilk şablonunuzu oluşturacaksınız! Daha sonra kodu girerseniz:
{{Hoş geldiniz}}
başka bir sayfada, bu sayfa görüntülendiğinde "Merhaba! Vikiye hoş geldiniz" metni. {{Hoş Geldiniz}} yerine görünür. Şablon içeriği diğer sayfaya "aktarılır", yani sayfaya entegre edilir.
Daha sonra, birisini hoş geldiniz etmek istediğiniz herhangi bir sayfaya herhangi bir noktaya {{Hoş Geldiniz}} ekleyebilirsiniz. 100 sayfada kullanıldığını varsayalım. Daha sonra şablon içeriğini şu şekilde değiştirirseniz:
Merhaba! Bu harika vikiye hoş geldiniz.
ve şablonun kullanıldığı 100 sayfadan herhangi birini tekrar ziyaret ederseniz orijinal metni değil, yeni metni görürsünüz. Bu şekilde, şablon bu sayfalara dönüştürüldüğü için 100 sayfanın içeriğini değiştirmeden değiştirdiniz.
Temel mekanizma budur. Bu mekanizmayı zenginleştiren ve şablonları çok kullanışlı hale getiren transklüzyonun birkaç ek özelliği vardır.
Parametreler[ | ]
Kopyalama mekanizmasını zenginleştirmek için MediaWiki, parametrelerin kalıp geçirildiğinde bir şablona geçirilmesine izin verir. Parametreler, şablonun farklı içerikler üretmesine veya farklı davranışlara sahip olmasına izin verir.
Diyelim ki diğer kullanıcıların tartışma sayfası içine biraz teşekkür notu eklemek istediğinizi varsayalım:
{{Teşekkür|tüm çaban|Ben}}
Teşekkür notu bir neden (bu durumda, "tüm çaba") ve bir imza ("Ben") olacaktır. Hedefiniz, herhangi bir kullanıcının herhangi bir nedenle başka bir kullanıcıya teşekkür edebilmesidir.
Notun kullanıldığı her yerde benzer görünmesi için, örneğin [[Şablon:Teşekkür]] adlı bir şablon tanımlayabilirsiniz. Not, bir kullanıcı başka bir kullanıcıya teşekkür ettiğinde benzer görünmekle birlikte, içeriği (yani nedeni ve imzası) farklı olacaktır. Bu nedenle, bunları parametre olarak iletmelisiniz. Kutuyu biçimlendirmek ve görüntüyü yerleştirmek için kalan öğeleri yoksayarsak, şablonun temel içeriği şu olur:
'''Biraz teşekkür ederim...'''
{{{1}}} için.
sarılır, {{{2}}}
{{{1}}} ve {{{2}}}'ye dikkat edin. Şablonlar içinde, şablon kullanıldığında geçirilecek parametreleri tanımlamanın yolu budur. Şablonda, her parametre üç ayraçla çevrilidir: {{{}}}. Bu, normal şablon adı kullanımından farklıdır.
Bir sayfada şablonu kullanırken, "dikey" karakterle (|) ayrılmış parametre değerlerini doldurursunuz. MediaWiki, parametrelerin şablona üç şekilde iletilmesine izin verir: anonim, numaralı veya adlandırılmış.
Anonim parametreler[ | ]
Anonim parametreleri iletmek için, bu parametrelerin değerlerini sırayla listeleyin:
{{Teşekkür|tüm çaban|Ben}}
Bu durumda, {{Teşekkür}} şablonu, {{{1}}}=tüm çaban ve {{{2}}}==Ben üreten:
Biraz teşekkür ederim... tüm çaban için. sarılır, Ben
Anonim parametrelerin aktarılma sırası davranışı için çok önemlidir. Parametrelerin sırasını tersine çevirmek, şöyle:
{{Teşekkür|Ben|tüm caban}}
bu sonucu üretir:
Biraz teşekkür ederim... Benim için. sarılır, tüm caban
Not: parametreleri düzenine göre tanımlamak ({{{1}}}, vb.) anonim parametrelerle çalışır. Sayfanız, aşağıda gösterildiği gibi herhangi bir parametreyi sayı veya ada göre tanımlarsa, bu yöntem artık bunları alan şablon tarafından kullanılamaz.
Numaralandırılmış parametreler[ | ]
Parametreleri sayıya göre geçirmek için, her parametreyi geçerken tanımlayın:
{{Teşekkür|2=Ben|1=arkadaşlığınız}}
Bu kez, {{Teşekkür}} şablonu {{{1}}}=arkadaşlığınız parametrelerini alıyor ve {{{2}}}=Ben, ancak ters sırada sağlandıklarından ve ürettiklerinden:
Biraz teşekkür ederim... senin arkadaşlığın için. sarılır, Ben
Adlandırılmış parametreler[ | ]
Parametreleri iletmenin üçüncü yolu sayılar yerine ada göre yapılır. Bu durumda, şablon içerikleri şu şekilde değiştirilir:
'''Biraz teşekkür ederim...'''
{{{sebep}}} için.
sarılır, {{{imza}}}
Şablonda, her bir parametreyi tanımlamak için {{[sebep}}} ve {{{imza}}} kullanırız, bir sayı yerine. Bu parametreleri ada göre geçirmek için, geçerken her parametreyi tanımlayın:
{{Teşekkür|imza=Ben|sebep=kim olduğunuz}}
Bu durumda, {{Teşekkür}} şablonu, {{{sebep}}}=kim olduğunuz parametrelerini alır ve {{{imza}}}=Ben üretir:
Biraz teşekkür ederim... kim olduğunğuz için. sarılır, Ben
Şablonunuzda adlandırılmış parametreleri kullanmanın avantajı, sipariş parametrelerinde geçirilebilen esnekliğin yanı sıra, çok sayıda parametre olup olmadığını anlamak için şablon kodunu daha kolay hale getirmesidir.
Varsayılan değerler[ | ]
Parametreleri bekleyen ancak bunları sağlamayan bir şablonu aşarsanız, bu şekilde:
{{Teşekkür}}
yukarıdaki numaralı parametreler örneğinde aşağıdakileri elde edersiniz:
Biraz teşekkür ederim... {{{1}}} için. sarılır, {{{2}}}
Hiçbir parametre iletilmediğinden, şablon parametreleri kendi değerleri yerine kendileri sunar. Bu durumlarda, parametreler için varsayılan değerlerin, yani herhangi bir değer geçirilmezse kullanılacak değerlerin tanımlanması yararlı olabilir. Örneğin, şablon içeriği şu şekilde değiştirilirse:
'''Biraz teşekkür ederim...'''
{{{sebep|her şey}}} için.
sarılır, {{{imza|Ben}}}
daha sonra {{{sebep|her şey}}}, {{{sebep}}} parametresi sağlanmadıysa her şey kullanılacaktır. Benzer şekilde, {{{imza|Ben}}}, Ben. Şimdi, herhangi bir parametre geçirmeden şablonu tekrar transkript etmek, aşağıdakilerle sonuçlanır:
Biraz teşekkür ederim... her şey için. sarılır, Ben
Kontrol şablonu dahil etme[ | ]
Varsayılan olarak, bir şablonun içeriği hem doğrudan görüntülendiğinde hem de başka bir sayfaya dahil edildiğinde bütünüyle görüntülenir. Ancak, <code<noinclude>, <includeonly> ve <onlyinclude> etiketlerini kullanarak bir şablonun hangi bölümlerinin görüneceğini ve içerileceğini kontrol edebilirsiniz.
İçeriği yalnızca şablon sayfasında gösterme[ | ]
<noinclude> ve </noinclude> arasındaki her şey yalnızca şablonun sayfası doğrudan görüntülendiğinde görülecektir, ancak başka bir sayfaya eklendiğinde değil. Bu, şablonu içeren herhangi bir sayfaya yaymak istemediğiniz bir şablona metin veya kod eklemek istediğinizde yararlıdır:
- Kategori şablonun kendisini kategorilere ayırırken bağlantılar
- Diller arası bağlantılar Diğer dillerde benzer şablonlara
- Belge şablonun nasıl kullanılacağı hakkında
Alternatif olarak, dışında <onlyinclude> ve </onlyinclude> yalnızca şablonun sayfası doğrudan görüntülenir. <onlyinclude> ve <noinclude> aynı amaca sahiptir, ancak tam tersi şekilde işlev görür.
İçeriği yalnızca ekleme veya değiştirme ile gösterme[ | ]
<onlyinclude> farklı bir amacı olan <includeonly> ile karıştırılmamalıdır. <includeonly> ve </includeonly> arasındaki her şey yalnızca sayfa eklenirken işlenecek ve görüntülenecektir , ancak şablon sayfası doğrudan görüntülendiğinde değil ve aşağıdaki gibi durumlarda yararlıdır:
- Kategori şablonu içeren sayfalar. Not: bir şablon tarafından bu şekilde uygulanan kategoriler değiştirilirken, bu şablonu içeren sayfaların kategorisi bir süre sonraya kadar güncellenmeyebilir: bu iş kuyruğu tarafından işlenir. Belirli bir sayfanın yeniden sınıflandırılmasını zorlamak için, o sayfayı düzenleme için açın ve değişiklik yapmadan kaydedin (boş düzenleme olarak bilinir).
- Şablon sayfasını görüntülerken şablon kodunun yürütülmediğinden emin olmak. Genellikle bunun nedeni parametreleri beklemesidir ve parametresiz yürütülmesi istenmeyen bir sonuca neden olur.
Her zaman içerik gösterme[ | ]
<onlyinclude> etiketleri kullanılmadığı sürece, <noinclude> ve <includeonly> etiketleri normal şekilde işlenir ve görüntülenir; yani hem şablon sayfası doğrudan görüntülendiğinde hem de şablon başka bir sayfaya dahil edildiğinde.
Aksi takdirde, <onlyinclude> etiketlerindeki herhangi bir şey, hem şablon sayfasında hem de dahil edildiğinde, <includeonly> etiketler içinde kullanılır.
Eklemeyi ad alanına göre denetleme[ | ]
Birçok şablon sayfaları otomatik olarak kategorilere ayırır ve bu çok yararlıdır. Yararlı olmayan şey, bu kategorilerde şablonun kendisine sahip olmaktır. Bundan kaçınmak için aşağıdaki kodu kullanın:
{{#ifeq: {{NAMESPACE}} | Şablon | | <includeonly>[[Kategori:<kullandığınız kategori veya kategori listesi>]]</includeonly>}}
Şablonları düzenleme[ | ]
Şablonların etkili olabilmesi için kullanıcıların bunları bulmaları ve nasıl kullanacaklarını öğrenmeleri gerekir.
Bunları bulmak için kullanıcılar şunları yapabilir:
- Özel Sayfalar > Tüm Sayfalar tıklayın
- Ad alanı listesinde, Şablon seçin ve Git tuşuna basın.
Şablonlar her zaman kategorize edilmelidir. Genel olarak, editörlerin şablonlara göz atabileceği bir üst düzey "Kategori:Şablonlar" kategorisi olmalıdır.
Belge yazma[ | ]
Tüm şablonların nasıl kullanılacağını açıklayan belgeler olmalıdır. Doküman eklemek için şablon sayfasına {{Belge}} veya {{Belgeleme}}{ (bağlı olarak wikide).
Belgeler daha sonra şablonun "/belge" alt sayfasına yazılmalıdır, örneğin "Şablon:Teşekkür/belge". Vikinin şablon adlarına bağlı olarak, dokümantasyon tüm sayfayı başlangıç ve bitiş şablonlarına sararak yazılacaktır ({{Belge/Başlangıç}} ve {{Belge/Bitiş}}).
Genel olarak, belgeler şablonun kısa bir açıklamasını, şablon için kullanılan parametrelerin listesini, kullanım örneklerini ve "ayrıca bakınız" bölümünde ilgili diğer şablonların bir listesini içermelidir.
Bazı vikilerin belgelere ilişkin farklı kuralları vardır, bu nedenle ilgili vikiye özgü yönergeleri mutlaka okuyun.
Bir vikiden diğerine kopyalama[ | ]
Şablonlar genellikle CSS veya başka şablonlar gerektirir; Aşağıdaki adımlar çoğu şablon için geçerli olmalıdır.
MediaWiki kodu[ | ]
Yeni vikide içe aktarma haklarınız varsa:
- Orijinal vikide Özel:DışaAktar'a gidin ve aşağıdaki gibi tüm gerekli şablonların tam geçmişine sahip bir .xml dosyası indirin:
- Şablonun adını büyük metin kutusuna girin, örn. "Şablon:Hoşgeldin". Büyük/küçük harflere ve özel karakterlere özellikle dikkat edin - şablon adı tam olarak doğru değilse, dışa aktarma yine de gerçekleşebilir, ancak .xml dosyası beklenen verilere sahip olmaz.
- "Şablonları dahil et" kutusunu işaretleyin.
- "Yalnızca geçerli düzeltmeyi ekle" kutusunun işaretini kaldırın.
- Dışa Aktar'a tıklayın.
- Yeni vikide Özel:İçeAktar seçeneğine gidin ve .xml dosyasını yükleyin.
Yeni vikide içe aktarma haklarınız yoksa:
- Orijinalvwikide Özel:DışaAktar bölümüne gidin ve aşağıdaki gibi yalnızca gerekli tüm şablonların en son sürümüne sahip bir .xml dosyası indirin:
- Büyük metin kutusuna şablonun adını girin.
- "Şablonları dahil et" kutusunu işaretleyin.
- '"Sadece güncel düzeltmeyi ekle" kutusunu işaretleyin.
- Dışa Aktar'a tıklayın.
- Dosyayı bir metin düzenleyicisinde açın ve belirli XML varlıkları öğelerini karşılık gelen karakterlerle değiştirin: < → <, > → >, " → " ve & → &. XML sözdizimi kuralları nedeniyle, bu varlıklar XML dosyasında görünür, ancak MediaWiki örneğinin düzenleme kutusunda görünmemelidir.
- Listelenen her bir şablonun
<text>etiketinin içindeki metni vikinizdeki benzer şekilde adlandırılmış bir şablona manüel olarak kopyalayın. Her şablonun düzenleme özetinde, ilişkilendirme için orijinal sayfaya bağlantı verin.
Bu gerekli tüm kodu kopyalar ve bazı şablonlar için yeterli olur.
Uzantılar[ | ]
Şablonlarda sıklıkla kullanılan bir uzantı ParserFunctions'dır. ParserFunctions sayfasını ziyaret edin ve burada listelenen işlevlerden herhangi birinin kopyaladığınız şablonlarda kullanılıp kullanılmadığını kontrol edin. ParserFunctions uzantısı varsayılan olarak Gamepedia vikilere yüklenir.
CSS ve JavaScript kodu[ | ]
MediaWiki kodunun yanı sıra, birçok şablon CSS'den yararlanır ve bazıları tam olarak çalışması için JavaScript'e güvenir. Kopyalanan şablonlar beklendiği gibi davranmıyorsa, nedeni bu olabilir. Gerekli CSS ve JavaScript'i vikinize kopyalamak için normalde yönetici ayrıcalıklarına sahip olmanız gerekir, çünkü "MediaWiki:" ad alanındaki sistem mesajlarını düzenleyeceksiniz.
- Şablon metninde CSS sınıflarının (
class="örnekçubuğu"gibi metin) kullanımını arayın. Bu sınıflar orijinal vikideki "MediaWiki:Common.css" veya "MediaWiki:Monobook.css" klasörlerinde görünüyorsa, yeni vikideki "MediaWiki:Common.css" klasörüne kopyalayın ve şablonun şimdi iyi olup olmadığını kontrol edin. - Kopyalanan şablon hala beklendiği gibi çalışmıyorsa, orijinal vikide "MediaWiki:Common.js" veya "MediaWiki:Monobook.js" de kod olup olmadığını kontrol edin. Öyleyse, yeni vikide "MediaWiki:Common.js" dosyasına kopyalamayı deneyebilirsiniz. Normalde, yalnızca güvenilir kaynaklardan kod kopyalamak ve önce ilgili parçaları tanımlamak ve seçmek için koda göz atmak iyi bir fikirdir. Her parçanın işlevselliğini tanımlamak için ipucu olabilecek yorumları bulabilirsiniz.