Help:Şablon belgelemesi

Meta sitesinden
Gezinti kısmına atla Arama kısmına atla
Bu sayfa Help:Template documentation sayfasının çevrilmiş sürüm ve çeviri %100 tamamlandı.

Bu yardım sayfası şablonların belgelenmesi hakkındadır. Genel şablon yardımı Help:Şablon sayfasında bulunabilir.

Bir şablonun ne yapması gerektiğini belgelemenin farklı yolları vardır:

  1. Bazı durumlarda, özel hükümler olmadan şablon sayfasının kendisinde açıkça görülebilir.
  2. <noinclude>...</noinclude> etiketleri ile açıklanabilir.
    Bu yöntem, şablonu bir şablona kategori eklemek gibi şeylere izin verir.
  3. Ayrıntılı belgeleme şablon tartışma sayfasına konabilir.
    Bu yöntem tipik olarak şablon sayfasındaki noinclude stratejisiyle, tartışma sayfasına bir kaynak ve belki de bir özetle karıştırılır.

Şablon sayfasında

Şablon sayfasının include kısmı, yansıtıma yapıldığında veya değiştirildiğinde çalışma şeklini tanımlarken, yalnızca içermeyen kısımlar sayfanın kendisini üretir.

Tipik bir şablon sayfası şunları içerebilir:

<includeonly><!--şablon adı-->
tanım içeriği, muhtemelen şablonu içeren bir sayfa kategorisi için bir etiket</includeonly><noinclude>
<nowiki><translate nowrap><!--T:14--> definition content, possibly formatted, annotated, summarized</translate></nowiki>

şablon kategorileri için açıklama, örnekler ve etiketler ({{PAGENAME}} sıralama anahtarını kullanarak)
</noinclude>

Yorum etiketleri içindeki şablon adı, değiştirme durumunda faydalı olabilir.

Örneğin, Template:T için:

<includeonly>start-{{{1|pqr}}}-end</includeonly><noinclude>
<nowiki>start-{{{1|pqr}}}-end</nowiki>
[[Category:Demo template]]
</noinclude>

Bu şu şekilde işler:

start-{{{1|pqr}}}-end

etiketler olmadan içerikle ilgili bilgilerin bir kısmı görüntülenmeyecektir:

start-pqr-end

Alternatif olarak, tanım içeriğinin bilgi kaybı olmadan oluşturulan kısmı (özellikle düz metin) her iki etiket türüne de yerleştirilmez, böylece kopyalanması gerekmez:

start-<includeonly>{{{1|pqr}}}</includeonly><noinclude>
<nowiki>{{{1|pqr}}}</nowiki>
[[Category:Demo template]]
</noinclude>-end

yine şu şekilde oluşturuldu:

start-{{{1|pqr}}}-end

Parametresiz değişim uygulamak, bunu vikimetin olarak üretir. Daha sonra etrafına nowiki etiketleri koyarak görüntülenebilir.

Tablo

Bir şablon bir tablo oluşturuyorsa, şablon sayfası bunu yapmak için vikimetin yerine tablo yapısını gösteriyorsa kullanışlıdır. Bu amaçla, tablo sözdizimi her iki etiket türüne de yerleştirilmez ve gerektiğinde tablo öğelerinin her birinin bir noinclude ve bir includeonly parçası vardır.

Oluşturma

Yukarıda gösterildiği gibi, tanım içeriğinin doğrudan oluşturulmasında, varsayılan değere sahip bir parametre olması durumunda bilgi "kaybolur": yalnızca bu değer işlenir. Bilgilerin kaybolduğu diğer durumlar şunlardır:

  • Parametreli bir ifadeye uygulanan #expr, "İfade hatası: tanınmayan noktalama karakteri "{"" verir.
  • bir değişken, değeri olarak oluşturulur.

Parametre varsayılan mekanizması, bir parametrenin tipik olarak ne yaptığını belgelemek için de kullanılabilir:

  • Tanımlanmamış bir {{{1}}}, şablonun bir ilk parametre almayı beklediğini açıkça belirten {{{1}}} olarak oluşturulur.
  • Tanımlanmamış bir {{{1|}}} hiçbir şey göstermez, bu muhtemelen istenen etkidir, ancak kendi kendini belgeleyen bir şablon için yararlı değildir.
  • Belki beklenen bir parametrenin işlevini belirtmek mümkündür, ör. resimlerle bir şeyler yapan şablonlar için {{{1|image}}}.

Tipik olarak noinclude bölümündeki örnekler şablonu içerir veya değiştirebilir. Şablonun çalışmasındaki değişikliklerin (yani noinclude-bölümü dışındaki değişiklikler) bu örneklerde önizleme de ve değiştirme durumunda "Değişiklikleri göster" seçeneğinde henüz etkili olmadığını unutmayın.

Kategori

Bazı şablonlar, belirli bir kategoriye sayfa eklemek için tasarlanmıştır. Bazen şablon sayfasının kendisi de bu kategoride gösteriliyorsa bu yeterince iyidir. Genellikle durum böyle değildir. Bir kategoriye sayfa ekleyen şablonlar daha sonra şunları kullanın:

...kodun sonu<includeonly>[[Category:hedef]]
</includeonly><noinclude>
belgeler ve/veya tartışma sayfasına bağlantı
[[Category:şablon kategorisi|{{PAGENAME}}]]
</noinclude>

Burada hedef, şablonu kullanan sayfalar için bir kategori anlamına gelir ve template cat, benzer şablonlar için bir kategoridir. Bu yöntem, bir şablondaki diller arası bağlantılar için de kullanılabilir.

Bazı şablonlarda görülen küçük bir iyileştirme, [[Category:hedef]] olarak [[Category:hedef]] ile değiştirir. Normalde, boş parametre {{{category}}} tanımsızdır (kullanılmaz) ve ardından şablon, sayfaları daha önce olduğu gibi hedef kategorisine ekler. category= ayarlama (boş değer), şablon listelerinde bu özelliği devre dışı bırakmaya izin verir. Aksi takdirde, örnekler içeren şablon listeleri, örnekle açıklanan çeşitli hedef şablon kategorilerine eklenir.

Örnekler

Genişletme demo şablonları canlı örnekler için kullanılabilir.

Bir şablon bir değişken içeriyorsa, çeşitli değerlerin etkisini göstermek için değişkenin değerinin bir parametre değeri tarafından geçersiz kılınabileceği şekilde yazılmışsa, örn.:

  • {{{namespace|{{NAMESPACE}}}}}
  • {{{pagename|{{PAGENAME}}}}}
  • {{{currentdow|{{CURRENTDOW}}}}}

Bu, özellikle değişkenin değerine bağlı olarak dallanma durumunda geçerlidir.

Ayrıca bakınız


Links to other help pages

Help contents
Meta · Wikinews · Wikipedia · Wikiquote · Wiktionary · Commons: · Wikidata · MediaWiki · Wikibooks · Wikisource · MediaWiki: Manual · Google
Versions of this help page (for other languages see further)
What links here on Meta or from Meta · Wikipedia · MediaWiki
Reading
Go · Search · Stop words · Namespace · Page name · Section · Backlinks · Redirect · Category · Image page · Special pages · Printable version
Tracking changes
Recent changes (enhanced) | Related changes · Watching pages · Diff · Page history · Edit summary · User contributions · Minor edit · Patrolled edit
Logging in and preferences
Logging in · Preferences · User style
Editing
Starting a new page · Advanced editing · Editing FAQ · Edit toolbar · Export · Import · Shortcuts · Edit conflict · Page size
Referencing
Links · URL · Piped links · Interwiki linking · Footnotes
Style and formatting
Wikitext examples · CSS · Reference card · HTML in wikitext · Formula · List · Table · Sorting · Colors · Images and file uploads
Fixing mistakes
Show preview · Testing · Reverting edits
Advanced functioning
Expansion · Template · Advanced templates · Parser function · Parameter default · Variable · System message · Substitution · Array · Calculation · Embed page
Others
Special characters · Renaming (moving) a page · Preparing a page for translation · Talk page · Signatures · Sandbox · Legal issues for editors