"Modül:Kısayol/belge" sayfasını değiştirmektesiniz

{{modül değerlendirmesi|hazır}}
{{TemplateStyles|Modül:Kısayol/biçim.css}}
{{Lua kenar kutusu}}
Bu modül {{şb|kısayol}} şablonunu yürütür.

== Kullanımı ==
=== Vikimetin ile ===
Modülün özellikleri {{şb|kısayol}} şablonu vasıtasıyla kullanılabilir olup şablonun belgelemesinde nasıl yapılacağı açıklanmıştır. Aynı işlevler <code><nowiki>{{#invoke:Kısayol|main|</nowiki>''değişkenler''<nowiki>}}</nowiki></code> çağrısı ile de kullanılabilir.

=== Lua ile ===
Modülü Lua ile kullanmak için öncelikle yükleme işlemi yapılmalıdır:
<syntaxhighlight lang="lua">
local mShortcut = require('Modül:Kısayol')
</syntaxhighlight>

Daha sonra aşağıdaki sözdizimiyle kısayol kutuları oluşturulabilir:
<syntaxhighlight lang="lua">
mShortcut._main(shortcuts, options, frame, cfg)
</syntaxhighlight>

* <var>shortcuts</var> kısayol sayfaları listesi. (zorunlu)
* <var>options</var> ayar tablosu olup şu anahtarlar ile özelleştirilebilir:
** <code>msg</code> kısayol listesinden sonra görüntülenecek bir ileti.
** <code>category</code> "hayır" değeri ile kullanılan ve sayfanın hata kategorisine eklenmesini engellemeyi sağlayan parametre.
* <var>frame</var> çerçeve nesnesi. İsteğe bağlıdır ve yalnızca dahili olarak kullanılması amaçlanmıştır.
* <var>cfg</var> yapılandırma değerleri tablosu. İsteğe bağlıdır ve yalnızca test amaçlıdır.

== Teknik detaylar ==
Modülün ayar dosyası [[Modül:Kısayol/yapılandırma]] sayfasında saklanmaktadır. Modülü farklı dillere çevirmek ya da kategori adları gibi detayları değiştirmek için kullanılabilir.
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
[[Kategori:İzleme kategorisi ekleyen modüller]]
}}</includeonly>