"Modül:İleti kutusu/belge" sayfasını değiştirmektesiniz

{{yüksek riskli|140724|tümsayfalar=evet}}
{{sistemde kullanılıyor}}

Bu modül {{şb|bikutu}}, {{şb|çikutu}}, {{şb|dikutu}}, {{şb|kikutu}}, {{şb|mikutu}}, {{şb|sikutu}} ve {{şb|tikutu}} şablonlarının yürütülmesinde kullanılmaktadır. Direkt olarak sayfalarda kullanılmak için tasarlanmayan bu üst modülün işlevlerinden yararlanmak için sıralanan ileti şablonları kullanılmalıdır.

== Kullanımı ==
Bu modülü başka bir Lua modülünde kullanmak için öncelikle söz konusu modüle çağrılması gerekir:

<syntaxhighlight lang="lua">
local messageBox = require('Modül:İleti kutusu')
</syntaxhighlight>

İleti kutusu oluşturmak için <code>main</code> işlevi kullanılmalıdır. Böylece kutu türü (dizgi olarak) ve ileti kutusunda kullanılacak olarak parametreler çağrılmış olur.

<syntaxhighlight lang="lua">
local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- Daha fazla parametre...
})
</syntaxhighlight>

Kullanılabilir yedi kutu türü bulunmaktadır:
{| class="wikitable"
! Kutu kodu !! Şablon !! Kapsam
|-
| <code>fmbox</code> || {{şb|bikutu}} || Başlık ve altlık ileti kutuları için
|-
| <code>mbox</code> || {{şb|çikutu}} || Birden fazla ad alanında kullanılacak ileti kutuları için
|-
| <code>imbox</code> || {{şb|dikutu}} || Dosya ad alanında kullanılacak ileti kutuları için
|-
| <code>cmbox</code> || {{şb|kikutu}} || Kategori ad alanında kullanılacak ileti kutuları için
|-
| <code>ambox</code> || {{şb|mikutu}} || Madde ad alanında kullanılacak ileti kutuları için
|-
| <code>tmbox</code> || {{şb|tikutu}} || Tartışma ad alanında kullanılacak ileti kutuları için
|-
| <code>ombox</code> || {{şb|sikutu}} || Diğer ad alanlarında kullanılacak ileti kutuları için
|}
Kutulara tanımlı parametreler için şablon belgelemesine bakılabilir.

=== ''#invoke'' ile kullanım ===
Ana (<code>main</code>) işlevin yanı sıra her kutu türü için ayrı işlevler de tanımlı bulunmaktadır. Bu işlevlere <code><nowiki>{{#invoke:İleti kutusu|mbox|...}}</nowiki></code>, <code><nowiki>{{#invoke:İleti kutusu|ambox|...}}</nowiki></code> şeklinde kutu kodlarını tanımlayarak erişim sağlanabilir. Bu işlevler diğer modüllerden çağrıldıklarında çalışacaktır ancak yalnızca ''#invoke'' çağrısı ile iletilen değişkenleri işlemek için kullanılan kodlara erişebileceklerinden <code>main</code> işlevini çağırmak verimli bir kullanım biçimi olacaktır.

== Teknik detaylar ==
Bu modül yukarıda listelenen her kutu türü için aynı temel kodu kullansa da [[Modül:İleti kutusu/yapılandırma|yapılandırma]] verilerindeki farklılıklar kutuları birbirlerinden ayırmaktadır. Yapılandırma komutları ve ne anlama geldikleri aşağıda açıklanmıştır:

* <code>types</code> - ileti kutusunun tür parametresi tarafından kullanılan verileri içeren tablodur. Tablo anahtarları, tür parametresine iletilebilecek değerlerden müteşekkil olup bu tablo değerleri türler tarafından kullanılan sınıfları ve resimleri saklamaktadırlar.
* <code>default</code> - tür parametresine hiçbir değer girilmezse veya geçersiz bir değer belirtilmişse kullanılacak olan varsayılan tür ayarı.
* <code>showInvalidTypeError</code> - tür parametresine girilen değer geçersizse hata gösterilip gösterilmeyeceğine dair ayar.
* <code>allowBlankParams</code> - boş değerler modüle iletilen parametrelerden çıkarılır. Ancak allowBlankParams tablosunda yer alan parametrelere girilen boşluk karakteri korunur.
* <code>allowSmall</code> - ileti kutusunun "küçük=evet" komutu ile daha küçük boyutta bir sürümünün oluşturulmasına dair ayar.
* <code>smallParam</code> - küçük parametresine girilecek özelleştirilebilir değer. Örneğin "left" şeklinde ayarlanmışsa "küçük=left" komutu ile küçük boyutta bir mesaj kutusu oluşturulabilir.
* <code>smallClass</code> - küçük ileti kutusu için kullanılacak sınıf.
* <code>substCheck</code> - yk ([y]erine [k]oyma) denetiminin yapılıp yapılmayacağına dair ayar.
* <code>classes</code> - ileti kutusunda kullanılacak sınıf dizisi.
* <code>imageEmptyCell</code> - resim belirtilmemişse boş {{etiket|td}} hücresinin kullanılıp kullanılmayacağına dair ayar. Ekranın tamamına yayılmayan ileti kutularının boyut aralıklarını korumak için kullanılır.
* <code>imageEmptyCellStyle</code> - boş resim hücrelerinin biçimlendirilip biçimlendirilmeyeceğine dair ayar.
* <code>imageCheckBlank</code> - "resim=blank" komutu hiçbir resmin görüntülenmemesini sağlar.
* <code>imageSmallSize</code> - küçük ileti kutularında kullanılan resimler otomatik olarak 30x30 piksel olarak ayarlanır. Bu ayar ile özel boyut belirlenebilir.
* <code>imageCellDiv</code> - resmin {{etiket|div}} içine alınıp izin verilen en büyük boyuta zorlanmasına dair ayar.
* <code>useCollapsibleTextFields</code> - "sorun", "çözüm", "tartışma" vb. daraltılabilen metin alanlarının kullanılıp kullanılmayacağına dair ayar. Şu anda yalnızca {{şb|mikutu}}'da kullanılmaktadır.
* <code>imageRightNone</code> - ileti kutusunun sağ tarafındaki resmin gizlenmesine dair ayar. "sağresim=none" komutu sağ tarafta hiçbir resmin görüntülenmesine izin vermez.
* <code>sectionDefault</code> - "altbaşlık" parametresi için varsayılan ad. <code>useCollapsibleTextFields</code> komuuna bağlı olarak çalışır.
* <code>allowMainspaceCategories</code> - ana ad alanında kategorilere izin verilmesine dair ayar.
* <code>templateCategory</code> - şablonun kullanıldığı sayfalara yerleştirilecek ana kategorinin adı.
* <code>templateCategoryRequireName</code> - şablona tanımlı kategoriyi görüntülemek için <code>ad</code> parametresinin gerekli olup olmadığına dair ayar.
* <code>templateErrorCategory</code> - şablon tarafından kullanılacak olan hata kategorisinin adı.
* <code>templateErrorParamsToCheck</code> - kullanılıp kullanılmadığı denetlenecek olan parametre adları. Herhangi biri eksikse hata olarak algılanır ve <code>templateErrorCategory</code> uygulanır.