Extension:Scribunto/Lua reference manual/tr

Bu kılavuz, MediaWiki'de uzantısıyla kullanıldığı için  belgelemektedir. Bazı parçalar MIT lisansı altında bulunan Lua 5.1 kaynak kılavuzundan türetilmiştir.



Başlarken
Scribunto'nun etkin olduğu bir MediaWiki vikide, "Modül:" ile başlayan bir başlık içeren bir sayfa oluşturun, örneğin Modül:Muzlar". Bu yeni sayfaya aşağıdaki metni kopyalayın:

Bunu kaydedin, sonra başka bir (modül olmayan) sayfaya şunu yazın:

Bunun dışında "Muzlar"'ı modülünüzün adı ile değiştirmelisiniz. Bu, o modülden dışa aktarılan "merhaba" işlevini çağıracaktır. , işlevin döndürdüğü metinle değiştirilir, bu durumda "Hello, world!"

Lua kodunu şablon bağlamından çağırmak genellikle iyi bir fikirdir. Bu, çağıran bir sayfa açısından sözdiziminin, şablon mantığının Lua veya vikimetinde uygulanmasından bağımsız olduğu anlamına gelir. Ayrıca, bir vikinin içerik ad alanına ek karmaşık sözdiziminin eklenmesini önler.

Modül yapısı
Modülün kendisi,  tarafından çağrılabilecek işlevleri içeren bir Lua tablosu döndürmelidir. Genel olarak, yukarıda gösterildiği gibi, bir tablo tutan bir yerel değişken bildirilir, işlevler bu tabloya eklenir ve tablo modül kodunun sonunda döndürülür.

İster yerel ister genel olsun, bu tabloya eklenmeyen işlevlere  ile erişilemez, ancak küreselleri $requir_function kullanılarak yüklenen diğer modüllerden erişilebilir. Modülün tüm işlevleri ve değişkenleri yerel olarak bildirmesi genellikle iyi bir stildir.

Parametrelere vikimetinden erişme
tarafından çağrılan işlevlere çerçeve nesnesi olan tek bir parametre aktarılacaktır. ile iletilen parametrelere erişmek için, kod genellikle  o çerçeve nesnesinin tablosunu kullanır. içeren şablona geçirilen parametrelere frame:getParent  kullanarak ve bu karenin   erişerek de erişmek mümkündür.

Bu çerçeve nesnesi, çağıran ayrıştırıcı işlevlerini, genişletme şablonları ve genişletme rastgele vikimetin dizeleri gibi bağlama özgü özelliklere erişmek için de kullanılır.

Metin döndürme
Modül işlevi genellikle tek bir dize döndürmelidir; döndürülen değerler tostring ile geçirilir ve ayırıcı olmadan birleştirilir. Bu dize,  sonucunda vikimetine eklenir.

Sayfa ayrıştırmasındaki bu noktada, şablonlar zaten genişletildi, ayrıştırıcı işlevleri ve uzantı etiketleri zaten işlendi ve ön kayıt dönüşümleri (örneğin, imza tilde genişletme ve boru hilesi) zaten oldu. Bu nedenle modül, çıkış metninde bu özellikleri kullanamaz. Örneğin, bir modül  döndürürse, sayfada "Hello, world!  " görünür.

Öte yandan, değiştirme daha erken bir işleme aşamasında ele alındığından,  ile yalnızca diğer denenen ikameler işlenecektir. Başarısız olan ikame vikimetinde kalacağından, sonraki düzenlemede işlenecektir. Bundan genellikle kaçınılmalıdır.

Modül belgesi
Scribunto, modülün otomatik olarak bir vikimetin belgelendirme sayfası ile ilişkilendirilmesiyle modüllerin belge edilmesine izin verir; varsayılan olarak, modülün "/belge" alt sayfası bu amaçla kullanılır ve modül sayfasındaki modül kaynak kodunun üzerinde yer alır. Örneğin, "Modül:Muz" belgesini "Modül:Muz/belge" olurdu.

Bu, aşağıdaki MediaWiki ad alanı iletileri kullanılarak yapılandırılabilir:


 * scribunto-doc-page-name: Belgelendirme için kullanılan sayfanın adını belirler. Modülün adı (Modül: öneki olmadan)  olarak geçirilir. Modül ad alanında ise, burada belirtilen sayfalar Lua kaynağı yerine wikitext olarak yorumlanır ve   ile kullanılamaz. Varsayılan, "Modül:$1/belge", yani modülün /belge alt sayfasıdır. Ayrıştırıcı işlevlerinin ve diğer küme ayracı genişletmesinin bu iletide kullanılamayabileceğini unutmayın.
 * scribunto-doc-page-does-not-exist: Belge sayfası mevcut olmadığında görüntülenen mesaj. Sayfanın adı  olarak geçirilir. Varsayılan değer boştur.
 * scribunto-doc-page-show: belge sayfası mevcut olduğunda görüntülenen mesaj. Sayfanın adı  olarak geçirilir. Varsayılan, dokümantasyon sayfasını aşmaktır.
 * scribunto-doc-page-header: Belge sayfası görüntülenirken başlık görüntülenir. Belgelenen modülün adı (Modül: öneki ile)  olarak geçirilir. Varsayılan, eğik olarak kısa bir açıklama görüntüler.

Modüllerin doğrudan kategorilere ayrılamadığını ve vikiarası bağlantılarının doğrudan eklenemeyeceğini unutmayın. Bunlar, belge sayfası modül sayfasına aktarıldığında modüle uygulanacakları  etiketlerinin içindeki belgelendirme sayfasına yerleştirilebilir.

Anahtarlar
Lua'daki bir ad (tanımlayıcı olarak da adlandırılır), herhangi bir harf, rakam ve alt çizgi olabilir, bir rakamla başlamaz. İsimler büyük / küçük harfe duyarlıdır; "foo", "Foo" ve "FOO" hepsi farklı adlardır.

Aşağıdaki anahtar kelimeler saklıdır ve ad olarak kullanılamaz:



Alt çizgi ile başlayan ve büyük harfler ile başlayan isimler dahili Lua global değişkenleri için ayrılmıştır.

Diğer anahtarlar:



Yorumlar
Yorum, bir dizenin dışında herhangi bir yerde  ile başlar. hemen bir açılış uzun parantez takip ederse, yorum ilgili kapanış uzun parantezine devam eder; aksi takdirde yorum geçerli satırın sonuna kadar devam eder.

Veri türleri
Lua, dinamik olarak yazılan bir dildir, yani değişkenlerin ve işlev bağımsız değişkenlerinin türü yoktur, yalnızca kendilerine atanan değerler vardır. Tüm değerler bir tür taşır.

Lua'nın sekiz temel veri türü vardır, ancak yalnızca altı tanesi Scribunto uzantısıyla ilgilidir. işlevi bir değerin türünü döndürür.

işlevi, bir değeri dizeye dönüştürür. işlevi, bir değeri mümkünse bir sayıya dönüştürür, aksi takdirde nil değerini döndürür. Bir değeri diğer veri türlerine dönüştürecek açık işlevler yoktur.

Bir dizenin beklendiği yerlerde kullanıldığında sayılar otomatik olarak dizelere dönüştürülür, ör. birleştirme operatörü ile birlikte kullanıldığında. tarafından tanınan dizeler, aritmetik işleçlerle kullanıldığında otomatik olarak sayılara dönüştürülür. Bir boolean değeri beklendiğinde, nil ve false dışındaki tüm değerlerin true olduğu kabul edilir.

nil
"nil", bir değerin yokluğunu temsil eden  veri tipidir.

Nil, tabloda anahtar olarak kullanılamaz ve atanmamış bir tablo anahtarı ile sıfır değeri atanan anahtar arasında fark yoktur.

Bir dizgeye dönüştürüldüğünde sonuç "nil" olur. Boole'ye dönüştürüldüğünde, nil false kabul edilir.

boole
Boole değerleri  ve.

Bir dizeye dönüştürüldüğünde sonuç "true" veya "false" olur.

Diğer birçok dilden farklı olarak, boole değerleri doğrudan sayılara dönüştürülmeyebilir. Diğer birçok dilden farklı olarak, boole dönüşümü için yalnızca false ve nil yanlış kabul edilir; 0 sayısı ve boş dizenin ikisi de doğru olarak kabul edilir.

dize
Lua dizeleri 8 bit baytlık bir dizi olarak kabul edilir; bunları belirli bir kodlamada yorumlamak uygulamaya bağlıdır.

Dize değişmezleri tek veya çift tırnak ( veya  ) ile sınırlandırılabilir; JavaScript gibi ve PHP'den farklı olarak, ikisi arasında fark yoktur. Aşağıdaki kaçış dizileri tanınır:


 * (çan, bayt 7)
 * (geri boşluk, bayt 8)
 * (yatay sekme, bayt 9)
 * (satırsonu, bayt 10)
 * (dikey sekme, bayt 11)
 * (form besleme, bayt 12)
 * (satır başı, bayt 13)
 * (çift tırnak, bayt 34)
 * (tek tırnak, bayt 39)
 * (ters eğik çizgi, bayt 92)

Değişmez bir satırsonu, bir ters eğik çizgi ile önüne eklenerek bir dizeye dahil edilebilir. Baytlar ayrıca '\ddd' bir kaçış dizisi kullanılarak belirtilebilir; burada ddd, 0-255 aralığındaki baytın ondalık değeridir. Çıkış dizilerini kullanarak Unicode karakterleri dahil etmek için, UTF-8 kodlaması için ayrı baytlar belirtilmelidir; genel olarak, doğrudan Unicode karakterleri girmek daha kolay olacaktır.

Değişmez dizeler ayrıca uzun parantezler kullanılarak tanımlanabilir. Bir açma uzun braketi, bir açılış kare braketinden sonra sıfır veya daha fazla eşit işaret ve ardından başka bir açılış kare braketinden oluşur;,   veya. Açma uzun braketi, karşılık gelen kapanma uzun braketi ile eşleşmelidir, örn. ,  veya. Özel bir durum olarak, eğer bir açılış uzun braketini hemen bir yeni satır takip ederse, yeni satır dizeye dahil edilmez, ancak kapanış uzun braketin korunmasından hemen önce yeni satır eklenir. Uzun parantezler ile sınırlanan dizeler kaçış dizilerini yorumlamaz.

Boole biçimine dönüştürüldüğünde tüm dizelerin true olarak kabul edildiğini unutmayın. Bu, boş dizenin genellikle yanlış olarak kabul edildiği diğer birçok dilden farklıdır.

sayı
Lua, yalnızca dahili olarak çift kesinlikli kayar nokta değeri olarak temsil edilen yalnızca bir sayısal türe sahiptir. Bu biçimde, -9007199254740992 ve 9007199254740992 arasındaki tamsayılar tam olarak temsil edilebilirken, kesirli kısmı olan daha büyük sayılar ve sayılar yuvarlama hatasından muzdarip olabilir.

Sayı sabitleri, ondalık ayırıcı olarak nokta kullanılarak ve grup ayırıcılar olmadan ör. . Sayılar boşluk olmadan E notasyonu kullanılarak da temsil edilebilir, örn. ,  veya. Tamsayılar ayrıca bir  öneki kullanılarak onaltılık gösterimde de belirtilebilir, ör. .

NaN ve pozitif ve negatif sonsuzluklar doğru şekilde saklanıp işlense de, Lua karşılık gelen değişmez değerleri sağlamaz. sabiti,  gibi bir bölme gibi pozitif sonsuzdur ve   gibi bir bölme olabilir hızla bir NaN oluşturmak için kullanılır.

Boole'ye dönüştürüldüğünde tüm sayıların doğru sayıldığını unutmayın. Bu, 0 sayısının genellikle yanlış olarak kabul edildiği diğer birçok dilden farklıdır. Bir dizgeye dönüştürüldüğünde, sonlu sayılar ondalık sayı, büyük olasılıkla E gösteriminde gösterilir; NaN  veya  ; ve infinities   veya.

tablo
Lua tabloları, PHP dizileri ve JavaScript nesneleri gibi ilişkilendirilebilir dizilerdir.

Tablolar kıvırcık parantez kullanılarak oluşturulur. Boş tablo. Oluşturmadaki alanları doldurmak için, ayraçlara virgül ve/veya noktalı virgülle ayrılmış alan belirteçleri listesi eklenebilir. Bunlar birkaç formdan herhangi birini alır:


 * , anahtar olarak deyim1 öğesinin (ilk) değerini ve değer olarak deyim2 öğesinin (ilk) değerini kullanır.
 * ,  eşdeğerdir
 * , kabaca  ile eşdeğerdir, burada i 1'den başlayan ve bu formun her alan spesifikasyonu ile artan bir tamsayıdır. Bu son alan belirleyicisiyse ve ifadede birden çok değer varsa, tüm değerler kullanılır; aksi takdirde sadece birincisi tutulur.

Bir tablodaki alanlara köşeli ayraç notasyonu kullanılarak erişilebilir, ör. . Ayrıca geçerli olan ad dize anahtarlarına nokta gösterimi kullanılarak da erişilebilir, ör. ,  eşittir. Tablodaki bir değer olan bir işlev çağrıldığında iki nokta üst üste işareti kullanılabilir; örneğin,,    veya   eşdeğerdir.

Bir dizi, 1'den N'ye kadar olan tüm pozitif tamsayılar için sıfır olmayan değerlere sahip olan ve N'den büyük olan tüm pozitif tamsayılar için hiçbir değer (nil) olmayan bir tablodur. Birçok Lua işlevi yalnızca dizilerde çalışır ve pozitif olmayanları yoksay.

PHP veya JavaScript gibi diğer birçok dilden farklı olarak, nil ve NaN dışındaki herhangi bir değer anahtar olarak kullanılabilir ve tür dönüştürme yapılmaz. Bunların hepsi geçerli ve farklıdır:

Benzer şekilde, nil dışındaki herhangi bir değer bir tabloda değer olarak saklanabilir. Nil'in depolanması, anahtarın tablodan silinmesine eşdeğerdir ve ayarlanmamış herhangi bir anahtara erişmek sıfır değeriyle sonuçlanır.

Tabloların hiçbir zaman Lua'da dolaylı olarak kopyalanmadığını unutmayın; bir tablo işleve bağımsız değişken olarak iletilirse ve işlev tablodaki anahtarları veya değerleri değiştirirse, bu değişiklikler arayanda görünür olur.

Bir dizeye dönüştürüldüğünde, normal sonuç "tablo" olur ancak  metamethod kullanılarak geçersiz kılınabilir. Boş tablo bile bir boolean olarak kabul edilir.

işlev
Lua'daki işlevler birinci sınıf değerlerdir: anonim olarak oluşturulabilir, bağımsız değişken olarak geçirilebilir, değişkenlere atanabilir vb.

İşlevler  anahtar sözcüğü kullanılarak oluşturulur ve parantez kullanılarak çağrılır. Sözdizimsel şeker adlandırılmış işlevler, yerel işlevler ve bir tabloya üye işlevleri gibi işlev gören işlevler için kullanılabilir. Ayrıntılar için aşağıdaki İşlev bildirimleri ve İşlev çağrılarına bakın.

Lua işlevleri kapanışlarıdır, yani bildirildikleri kapsama bir referans sağlarlar ve bu kapsamdaki değişkenlere erişebilir ve bunları değiştirebilirler.

Tablolarda olduğu gibi, bir işlev farklı bir değişkene atanırsa veya başka bir işleve bağımsız değişken olarak iletilirse, çağrılması gereken temel "işlev nesnesidir".

Bir dizgeye dönüştürüldüğünde sonuç "işlev" olur.

Desteklenmeyen türler
userdata türü, diğer dillerde yazılmış Lua uzantıları için opak değerleri tutmak için kullanılır; örneğin, bir C işaretçisi veya yapısı tutmak için bir kullanıcı verisi kullanılabilir. Özel derlenmiş koda izin verilmeyen barındırma ortamlarında Scribunto'nun kullanılmasına izin vermek için bu tür uzantılar kullanılmaz.

thread türü, Scribunto'nun sanal alanında bulunmayan eşyordamlar tutamaçlarını temsil eder.

Meta tablolar
Her tablonun metatable olarak bilinen ilişkili bir tablosu olabilir. Meta tablodaki alanlar, tablo için farklı veya geri dönüş davranışı belirtmek için bazı işleçler ve işlevler tarafından kullanılır. Bir tablo için metatable'a getmetatable işlevi kullanılarak erişilebilir ve setmetatable işlevi ile ayarlanabilir.

Meta işlevleri için erişilirken, metatable alanlarına rawget ile erişilir.

Tablonun kendisini etkileyen metatable alanları şunlardır:
 * __index
 * Bu, bir tablo erişimi  nil döndüreceği zaman kullanılır. Bu alanın değeri bir tablo ise, erişim o tabloda tekrarlanır, yani   (bu tablonun metatable __index'ini çağırabilir). Bu alanın değeri bir işlevse, işlev   olarak adlandırılır. rawget işlevi bu metametriyi atlar.


 * __newindex
 * Bu, bir tabloya  anahtarını atarken kullanılır; burada   sıfır döndürür. Bu alanın değeri bir tablo ise, atanması o tabloda tekrarlanır, yani.   (metatable __newindex tablosunu çağırabilir). Bu alanın değeri bir işlevse, işlev   olarak adlandırılır. rawset işlevi bu metametriyi atlar.


 * __call
 * Bu, bir tabloda işlev çağrısı sözdizimi kullanıldığında kullanılır, . Değer,   gibi bir işlev olarak adlandırılan bir işlev olmalıdır.


 * __mode
 * Bu, zayıf kaynakça içeren tablolar yapmak için kullanılır. Değer bir dize olmalıdır. Varsayılan olarak, anahtar olarak veya tablodaki bir değer olarak kullanılan hiçbir değer çöp toplanmaz. Ancak bu meta alan 'k' harfini içeriyorsa, zayıf olmayan kaynakça yoksa anahtarlar çöp toplanabilir ve 'v' değerleri içeriyorsa, her iki durumda da, karşılık gelen anahtar ve değer tablodan kaldırılır. Tablonun metatable olarak kullanıldıktan sonra bu alan değiştirilirse, davranışın tanımsız olduğunu unutmayın.

Diğer metatable alanları şunları içerir:


 * __add†
 * __sub†
 * __mul†
 * __div†
 * __mod†
 * __pow†
 * __unm
 * __concat†
 * __eq‡
 * __lt‡
 * __le‡
 * __pairs
 * __ipairs
 * __metatable*
 * __tostring

† İkili işleçler için, Lua önce sol bağımsız değişkenin metatable'ına (varsa), sonra da sağa bir metamethod ararken bakar. ‡ İlişkisel işleçler için meta yöntem yalnızca her iki bağımsız değişkenin meta tablolarında da aynı işlev belirtilirse kullanılır. Özdeş beden ve kapanma ile bile farklı anonim işlevler aynı kabul edilemez. * __metatable hem getmetatable hem de setmetatable öğelerini etkiler

Not: Lua'da tüm dizeler, __index,  tablosuna kaynakladığı tek bir metatable'ı da paylaşır. Bu metatable'a Scribunto'da veya kaynaklanan  tablosuna erişilemez; modüllerin kullanabileceği dize tablosu bir kopyadır.

Değişkenler
Değişkenler, değerleri depolayan yerlerdir. Lua'da üç tür değişken vardır: küresel değişkenler, yerel değişkenler ve tablo alanları.

name genel veya yerel bir değişkeni (veya yalnızca bir tür yerel değişken olan bir işlev bağımsız değişkenini) temsil eder. anahtar sözcüğü kullanılarak açıkça yerel olarak bildirilmedikçe değişkenlerin global olduğu varsayılır. Bir değer atanmamış herhangi bir değişkenin nil değeri olduğu kabul edilir.

Küresel değişkenler, ortam adı verilen standart bir Lua tablosunda saklanır; bu tablo genellikle  genel değişkeni olarak bulunur. Bu genel değişken tablosu için bir metatable ayarlamak mümkündür; __index ve __newindex metamethod'ları, diğer tüm tablolardaki alanlara erişim ve atamalarda olduğu gibi global değişkenlere erişim ve atamalarda çağrılır.

Bir işlevin ortamına getfenv işlevi kullanılarak erişilebilir ve setfenv işlevi kullanılarak değiştirilebilir; Scribunto'da, eğer mevcutsa bu işlevler ciddi şekilde kısıtlanmıştır.

Yerel değişkenler sözlüksel olarak kapsamlıdır; ayrıntılar için Yerel değişken bildirimlerine bakın.

İfadeler
İfade değerleri olan bir şeydir: değişmez değerler (sayılar, dizeler, true, false, nil), anonim işlev bildirimleri, tablo kurucuları, değişken başvuruları, işlev çağrıları, vararg ifadesi, ifadeler parantez içine alınmış, ifadelere uygulanan tekli işleçler ve ikili işleçlerle birleştirilmiş ifadeler.

Çoğu ifadenin bir değeri vardır; işlev çağrıları ve vararg ifadesi herhangi bir sayı içerebilir. Bir işlev çağrısını veya vararg ifadesini parantez içine almanın ilk değer dışındaki tüm öğelerin kaybolacağını unutmayın.

İfade listeleri, virgülle ayrılmış ifade listeleridir. Son ifade hariç tümü bir değere zorlanır (ek değerler düşer veya ifadede değer yoksa nil kullanılır); son ifadedeki tüm değerler ifade listesinin değerlerine dahil edilir.

Aritmetik operatörleri
Lua alışılmış aritmetik işleçleri destekler: toplama, çıkarma, çarpma, bölme, modulo, üs alma ve olumsuzlama.

Tüm işlenenler, tonumber değerinin sıfırdan farklı olduğu sayılar veya dizeler olduğunda, işlemlerin olağan anlamları vardır.

Her iki işlenen de uygun metamethod değerine sahip bir tabloysa, metamethod çağrılır.

İlişkisel operatörleri
Lua'daki ilişkisel operatörler,  ,  ,  ,   ve. İlişkisel bir operatörün sonucu her zaman bir boole olur.

Eşitlik önce işlenen türlerini karşılaştırır; eğer farklılarsa, sonuç yanlıştır. Sonra değerleri karşılaştırır: nil, boolean, number ve string beklenen şekilde karşılaştırılır. İşlevler, aynı işlev nesnesine başvuruyorsa eşittir; İki farklı anonim işlevi karşılaştırdığı için  false değerini döndürür. Tablolar varsayılan olarak aynı şekilde karşılaştırılır, ancak bu __eq metamethod kullanılarak değiştirilebilir.

Eşitsizlik eşitliğin kesin olarak olumsuzlanmasıdır.

Düzen operatörleri için, her ikisi de sayı veya her ikisi de dize ise, doğrudan karşılaştırılır. Ardından metametreler kontrol edilir:


 * ,  kullanılır
 * varsa,   kullanılır, veya   mevcut ise, öyleyse buna   eşdeğer kabul edilir
 * ,  eşdeğer kabul edilir
 * ,  eşdeğer kabul edilir

Gerekli meta yöntemler kullanılamıyorsa, bir hata oluşur.

Mantıksal operatörler
Mantıksal işleçler,   ve   şeklindedir. Hepsi, nil ve false olduğu ve başka bir şeyin true olduğu standart yorumu kullanır.

için, sol işlenen yanlış kabul edilirse döndürülür ve ikinci işlenen değerlendirilmez; aksi takdirde ikinci işlenen döndürülür.

için, sol işlenen doğru kabul edilirse, döndürülür ve ikinci işlenen değerlendirilmez; aksi takdirde ikinci işlenen döndürülür.

için, sonuç her zaman true veya false olur.

ve  kısa devre olduğunu unutmayın. Örneğin,, yalnızca   ise   ile çağırır. ilk değeri olarak false veya nil değerini döndürür.

Birleştirme operatörü
Birleştirme işleci,  olarak kullanılan iki noktadır. Her iki işlenen de sayı veya dizgiyse, dizgeye dönüştürülür ve birleştirilir. Aksi takdirde, bir __concat metamethod varsa, kullanılır. Aksi takdirde bir hata oluşur.

Lua dizelerinin değişmez olduğunu ve Lua herhangi bir tür "string builder" sağlamadığını unutmayın, bu yüzden tekrar tekrar  yapan bir döngü her yineleme için yeni bir dize oluşturun ve sonunda eski dizeleri çöp toplayın. Birçok dizenin birleştirilmesi gerekiyorsa, string.format kullanmak veya tüm dizeleri bir array içine eklemek ve sonunda table.concat kullanmak daha hızlı olabilir.

Uzunluk operatörü
Uzunluk operatörü,  olarak kullanılan. bir dize ise, uzunluğu bayt olarak döndürür. bir array tablosu ise, dizinin uzunluğunu döndürür.

bir dizi olmayan bir tablo ise,  herhangi bir N değerini, [N] sıfır ve a[N+1] olacak şekilde döndürebilir nil, daha yüksek dizinlerde nil olmayan değerler olsa bile. Örneğin,

Operatör önceliği
Lua'nın operatör önceliği veya işlem sırası, en yüksekten en düşüğe:


 * 1) not # - (olumsuzluk)
 * 2) + - (çıkarma)
 * 3) and
 * or
 * 1) and
 * or
 * 1) and
 * or

Öncelik düzeyinde, çoğu ikili işleç sol ilişkiseldir, yani,   olarak yorumlanır. Üstelleştirme ve birleştirme doğru çağrıştırıcıdır, yani,   olarak yorumlanır.

İşlev çağrıları
Lua işlev çağrıları diğer birçok dilde olanlara benzer: bir ad ve ardından parantez içindeki bağımsız değişkenler listesi:

işlev( expression-list )

Lua'daki ifade listelerinde olduğu gibi, listedeki son ifade birden çok bağımsız değişken değeri sağlayabilir.

İşlev, ifade listesinde işlev tanımında bağımsız değişkenlerden daha az değerle çağrılırsa, ek bağımsız değişkenlerin sıfır değeri olur. İfade listesi bağımsız değişkenlerden daha fazla değer içeriyorsa, fazla değerler atılır. Bir fonksiyonun değişken sayıda argüman alması da mümkündür; ayrıntılar için İşlev bildirimlerine bakın.

Lua ayrıca bir işlev dönüş değerinin doğrudan çağrılmasına izin verir, yani. Çağrılacak işlevi belirlemek için değişken erişimden daha karmaşık bir ifade gerekiyorsa, değişken erişim yerine parantez içine alınmış bir ifade kullanılabilir.

Lua, iki genel vaka için sözdizimsel şekere sahiptir. Birincisi, bir tablonun nesne olarak kullanıldığı ve fonksiyonun nesne üzerinde bir yöntem olarak çağrılmasıdır. Sözdizimi

tablo:ad( expression-list )

tam olarak eşdeğerdir

tablo.ad( tablo, expression-list )

İkinci yaygın durum, Lua'nın işleve tek konumsal argüman olarak ad-değer eşlemelerini içeren bir tablo ileterek adlandırılmış bağımsız değişkenler uygulama yöntemidir. Bu durumda, argüman listesindeki parantezler atlanabilir. Bu, işlevin tek bir değişmez dizeden geçirilmesi durumunda da çalışır. Örneğin, çağrılar

func{ arg1 = exp, arg2 = exp } func"string"

eşittir

func( { arg1 = exp, arg2 = exp } ) func( "string" )

Bunlar birleştirilebilir; aşağıdaki çağrılar eşdeğerdir:

table:name{ arg1 = exp, arg2 = exp } table.name( table, { arg1 = exp, arg2 = exp } )

İşlev bildirimleri
İşlev bildirimi sözdizimi şöyle görünür:

function ( var-list ) block end

var-list içindeki tüm değişkenler işleve yereldir ve değerler function call içindeki ifade listesinden atanır. Ek yerel değişkenler blok içinde bildirilebilir.

İşlev çağrıldığında, var-list ile karşılık gelen yerel değişkenler oluşturulduktan ve değerler atandıktan sonra block içindeki ifadeler yürütülür. return statement ulaşılırsa, bloktan çıkılır ve işlev çağrısı ifadesinin değerleri return deyimi tarafından verilen değerlerdir. Yürütme, bir return ifadesiyle karşılaşmadan işlevin bloğunun sonuna ulaşırsa, işlev çağrısı ifadesinin sonucu sıfır değerine sahiptir.

Lua işlevleri sözcüksel kapanıştır. Ortak bir deyim "private static" değişkenleri işlevin bildirildiği kapsamda yerel olarak bildirmektir. Örneğin,

Bir işlev, var-list öğesinde son öğe olarak  belirtilerek değişken sayıda bağımsız değişkeni kabul ettiği bildirilebilir:

function ( var-list, ... ) block end

Blok içinde, varargs ifadesi  kullanılabilir, sonuç işlev çağrısındaki tüm ekstra değerler olur. Örneğin,

select işlevi varargs ifadesi ile çalışmak üzere tasarlanmıştır; özellikle,  yerine   kullanılmalıdır. varargs ifadesindeki değer sayısını saymak için, çünkü  bir array olmayabilir.

Lua, işlev bildirimini ve bir değişkene atamayı birleştirmek için sözdizimsel şeker sağlar; ayrıntılar için İşlev bildirim bildirimlerine bakın.

Bunun işe yaramayacağını unutmayın:

 local factorial = function ( n ) if n <= 2 then return n   else return n * factorial( n - 1 ) end end

İşlev bildirimi yerel değişken atama deyimi tamamlanmadan önce işlendiğinden, işlev gövdesi içindeki "factorial" bir dış kapsamda bu adın (muhtemelen tanımsız) değişkenini ifade eder. Bu sorun, önce yerel değişkeni bildirip bir sonraki deyimde atayarak veya işlev bildirimi deyimi sözdizimi kullanılarak önlenebilir.

İfadeler
Bir ifade temel yürütme birimidir: bir atama, kontrol yapısı, işlev çağrısı, değişken bildirimi, vb.

Bir yığın isteğe bağlı olarak noktalı virgülle ayrılmış bir ifade dizisidir. Bir yığın temel olarak anonim bir işlevin gövdesi olarak kabul edilir, böylece yerel değişkenleri bildirebilir, bağımsız değişkenler alabilir ve değerleri döndürebilir.

Bir blok da tıpkı bir yığın gibi bir ifade dizisidir. Bir blok, tek bir ifade oluşturmak için sınırlandırılabilir:. Bunlar, yerel değişkenlerin kapsamını sınırlamak veya başka bir bloğun ortasına  veya   eklemek için kullanılabilir.

Atanmalar
variable-list, virgülle ayrılmış değişkenler listesidir; expression-list, bir veya daha fazla ifadenin virgülle ayrılmış listesidir. Tüm ifadeler herhangi bir atanma yapılmadan önce değerlendir, bu yüzden, a ve b değerlerini değiştirecek.

Yerel değişken bildirimleri
Yerel değişkenler, block veya chunk içinde herhangi bir yerde bildirilebilir. İfade listesi olmayan ilk form değişkenleri bildirir ancak bir değer atamaz, böylece tüm değişkenler değer olarak nil olur. İkinci form, yukarıdaki Atanmalar da açıklandığı gibi yerel değişkenlere değerler atar.

Yerel değişkenin görünürlüğünün, yerel değişken bildiriminden sonraki ifadeyle başladığını unutmayın. Dolayısıyla,  gibi bir bildirim, yerel bir x değişkenini bildirir ve dış kapsamdan x değerini atar. Yerel değişken, yerel değişken bildirimini içeren en içteki bloğun sonuna kadar kapsamda kalır.

Kontrol yapıları
While ifadesi, bir ifade gerçek bir değer olarak değerlendirildiği sürece bir bloğu tekrarlar.

Repeat ifadesi, bir ifade gerçek bir değer olarak değerlendirilene kadar bir bloğu tekrarlar. Blok içinde bildirilen yerel değişkenlere ifadede erişilebilir.

For döngüsünün ilk biçimi yerel bir değişken bildirir ve her yinelemede exp1 ile exp2 ekleyerek exp3 değerleri için bloğu tekrar eder. exp3 ifadesinin tamamen atlanabileceğini unutmayın; bu durumda 1 kullanılır, ancak  ve   gibi sayısal olmayan değerlerin bir hata olduğunu unutmayın. Tüm ifadeler döngü başlamadan önce bir kez değerlendirilir.

For döngüsünün bu formu kabaca

ancak var, limit ve step değişkenlerine başka hiçbir yerde erişilemez. name değişkeninin blok için yerel olduğunu unutmayın; döngüden sonraki değeri kullanmak için, döngü dışında bildirilen bir değişkene kopyalanmalıdır.

For döngüsünün ikinci biçimi iterator işlevleriyle çalışır. İlk formda olduğu gibi, expression-list döngüye başlamadan önce yalnızca bir kez değerlendirilir.

For döngüsünün bu formu kabaca

ancak func, static ve var değişkenlerine başka hiçbir yerde erişilemez. var-list içindeki değişkenlerin blok için yerel olduğunu unutmayın; döngüden sonra kullanmak için, döngü dışında bildirilen değişkenlere kopyalanmalıdır.

Genellikle expression-list üç değeri döndüren tek bir işlev çağrısıdır. Yineleyici işlevi yalnızca içine geçirilen parametrelere bağlı olacak şekilde yazılabilirse, bu en verimli yöntemdir. Değilse, Lua'da programlama bir tablonun statik değişken olarak döndürülmesine ve her yinelemede üyelerinin güncellenmesine bir kapatmanın tercih edilmesini önerir.

exp1 true değerini döndürürse block1 öğesini, aksi takdirde exp2 true değerini döndürürse block2 öğesini, aksi takdirde block3 öğesini yürütür. kısmı atlanabilir ve  kısmı gerektiğinde tekrarlanabilir veya atlanabilir.

Return ifadesi, bir işlevden veya chunk (yalnızca bir işlevdir) değer döndürmek için kullanılır. Expression-list, sıfır veya daha fazla ifadenin virgülle ayrılmış listesidir.

Lua kuyruk özyineleme uygular: expression-list bir işlev çağrısı olan tam olarak bir ifadeden oluşuyorsa, geçerli yığın çerçevesi o işleve çağrı için yeniden kullanılır. Bunun çağrı yığını ile ilgili işlevler için bir anlamı vardır,  ve   gibidir.

Return deyimi, block içindeki son ifade olmalıdır. Herhangi bir nedenle bir bloğun ortasında bir dönüş gerekiyorsa, açık bir  bloğu kullanılabilir.

Break ifadesi, döngüden sonraki ifadeye atlayarak bir süre, tekrar veya döngü için yürütmeyi sonlandırmak için kullanılır.

Break ifadesi, block içindeki son ifade olmalıdır. Herhangi bir nedenden ötürü bir bloğun ortasında bir ayırtma gerekiyorsa, açık bir  bloğu kullanılabilir.

İfadeler olarak işlev çağrıları
Bir işlev çağrısı bir ifade olarak kullanılabilir; bu durumda, işlev yalnızca sahip olabileceği herhangi bir yan etki için çağrılır (örneğin mw.log günlük değerleri) ve herhangi bir dönüş değeri atılır.

İşlev bildirim ifadeleri
Lua, bir işlevi bildirmek ve bir değişkene daha doğal atamak için sözdizimsel şeker sağlar. Aşağıdaki bildirim çiftleri eşdeğerdir

-- Temel beyan function func( var-list ) block end func = function ( var-list ) block end

-- Yerel işlev local function func( var-list ) block end local func; func = function ( var-list ) block end

-- Tablodaki alan olarak işlev function table.func( var-list ) block end table.func = function ( var-list ) block end

-- Tabloda yöntem olarak işlev function table:func( var-list ) block end table.func = function ( self, var-list ) block end

Burada iki nokta üst üste işareti, bağımsız değişkenler listesinin başına "self" adlı örtük bir bağımsız değişken ekleyerek işlev çağrıları için iki nokta üst üste işareti ile paralellik gösterir.

Hata işleme
error ve assert işlevleri kullanılarak hatalar "atılabilir". Hataları "yakalamak" için pcall veya xpcall kullanın. Bazı dahili Scribunto hatalarının Lua kodunda yakalanamayacağını unutmayın.

Çöp toplama
Lua otomatik bellek yönetimi gerçekleştirir. Bu, yeni nesneler için bellek ayırma veya nesneler artık gerekli olmadığında boşaltma konusunda endişelenmeniz gerektiği anlamına gelir. Lua, zaman zaman tüm ölü nesneleri (yani, Lua'dan artık erişilemeyen nesneleri) ve yalnızca zayıf kaynakça aracılığıyla erişilebilen nesneleri toplamak için zaman zaman bir çöp toplayıcı çalıştırarak belleği otomatik olarak yönetir. Lua tarafından kullanılan tüm bellek otomatik yönetime tabidir: tablolar, işlevler, dizeler vb.

Çöp toplama otomatik olarak gerçekleşir ve Scribunto içinden yapılandırılamaz.

Standart kütüphaneler
Standart Lua kütüphaneleri, Lua'ya temel hizmetler ve kritik performans fonksiyonları sağlar. Burada standart kütüphanelerin sadece Scribunto'da bulunan kısımları belgelenmiştir.

_G


Bu değişken, geçerli genel değişken tablosuna bir referans tutar;  genel değişkenine de   olarak erişilebilir. Ancak, _G kendisi hakkında özel bir şey olmadığını unutmayın; diğer değişkenlerle aynı şekilde yeniden atanabilir:

Küresel değişken tablosu, diğer tablolar gibi kullanılabilir. Örneğin,

_VERSION


Lua'nın çalışan sürümünü içeren bir dize, ör. "Lua 5.1".

assert
sıfır veya yanlışsa bir hata verir. Bu durumda, hatanın metni olarak  kullanılır: nil (veya belirtilmemişse), metin "onaylama başarısız!"; bir dize veya sayı varsa, metin bu değerdir; aksi taktirde kendi başına bir hata ortaya çıkar.

başka bir değerse, assert  ve   dahil tüm bağımsız değişkenleri döndürür.

Lua'da biraz yaygın bir deyim, bir işlevin normal çalışmada "true" değerini döndürmesi ve başarısızlık durumunda ilk değer olarak nil veya false ve ikinci değer olarak bir hata mesajı döndürmesidir. Daha sonra kolay hata kontrolü çağrı  çağrısına sarılarak yapılabilir:

error
metniyle hata verir.

normalde hatanın yeri hakkında bazı bilgiler ekler. 1 veya atlanmışsa, bu bilgi  çağrısının kendisidir; 2, hata adı verilen işlevin çağrısının yerini kullanır; ve bunun gibi. 0 geçilmesi konum bilgilerinin dahil edilmesini atlar.

getfenv
Motor yapılandırmasındaki  değerine bağlı olarak bu işlevin kullanılamayabileceğini unutmayın.

ile belirtildiği gibi bir ortam (genel değişken tablosu) döndürür:


 * 1, nil veya atlanmışsa,  çağıran işlevin ortamını döndürür. Genellikle bu _G ile aynı olacaktır.
 * Tamsayılar 2-10, çağrı yığınındaki fonksiyonların ortamını döndürür. Örneğin, 2, geçerli işlev olarak adlandırılan işlevin ortamını döndürür, 3 bu işlevi çağıran işlevin ortamını döndürür, vb. değer yığındaki işlev çağrılarının sayısından daha yüksekse veya hedeflenen yığın düzeyi bir kuyruk çağrısıyla döndürüldüğünde bir hata ortaya çıkar.
 * Bir işlevin iletilmesi, o işlev çağrıldığında kullanılacak ortamı döndürür.

Tüm standart kütüphane işlevleri ve Scribunto kütüphane işlevleri tarafından kullanılan ortamlar korunur. Bu ortamlara  kullanarak erişmeye çalışmak bunun yerine sıfır döndürür.

getmetatable
table öğesinin metatable değerini döndürür. Başka herhangi bir tür sıfır döndürür.

Metatable'ın  alanı varsa, gerçek metatable yerine bu değer döndürülür.

ipairs
Üç değer döndürür: bir yineleyici işlevi,  ve 0 tablosu. Bu,  yineleyici formunda kullanılmak üzere tasarlanmıştır:

Bu, çiftler ( 1, t[1] ), ( 2, t[2] ) üzerinde tekrar eder ve bu şekilde, t[i] sıfır olduğunda durur.

metamethod sağlayarak standart davranış geçersiz kılınabilir. Bu meta yöntem mevcutsa, ipairs çağrısı bunun yerine  ile döndürülen üç değeri döndürür.

next
Bu, tablodaki anahtarların üzerinden yineleme yapılmasını sağlar. sıfır veya belirtilmemişse, tablodaki "first" anahtarı ve değerini döndürür; aksi takdirde, "next" anahtarı ve değerini döndürür. Başka anahtar yoksa, nil değerini döndürür. ifadesini kullanarak bir tablonun boş olup olmadığını kontrol etmek mümkündür.

Sayısal dizinleri olan tablolar için bile anahtarların döndürülme sırasının belirtilmediğini unutmayın. Bir tabloyu sayısal sırada hareket ettirmek için bir numerical for veya ipairs kullanın.

Geçiş için sonraki öğeyi kullanırken, var olmayan herhangi bir anahtara bir değer atandığında davranış tanımsızdır. Mevcut bir alana yeni bir değer (nil dahil) atanmasına izin verilir.

pairs
Üç değer döndürür: bir yineleyici işlevi (next veya benzer şekilde),  tablosu ve nil. Bu, yineleyici formunda kullanım için tasarlanmıştır:

Bu, next gibi anahtar/değer çiftlerini  olarak yineleyecektir; tarama sırasında tabloyu değiştirmeyle ilgili kısıtlamalar için next belgelerine bakın.

__pairs metamethod sağlanarak standart davranış geçersiz kılınabilir. Bu meta yöntem mevcutsa, çiftlere çağrı, bunun yerine  ile döndürülen üç değeri döndürür.

pcall
protected mode verilen bağımsız değişkenlerle  işlevini çağırır. Bu,  çağrısı sırasında bir hata ortaya çıkarsa, pcall işlevinin false döndüreceği ve hata mesajının yükseltileceği anlamına gelir. Hata oluşmazsa, pcall true değerini ve çağrı tarafından döndürülen tüm değerleri döndürür.

pseudocode içinde,  şu şekilde tanımlanabilir:

rawequal
Bu, __eq metamethod yok sayması dışında  ile eşdeğerdir.

rawget
Bu, __index metamethod yok sayması dışında  ile eşdeğerdir.

rawset
Bu, __newindex metamethod yok sayması dışında  ile eşdeğerdir.

select
bir sayı ise, bu dizinden sonraki tüm argümanları  olarak döndürür. '#' dizgiyse, argüman sayısını  olarak döndürür.

Başka bir deyişle,  kabaca aşağıdaki gibi bir şeydir, ancak   nil değerleri içerdiğinde bile düzgün çalışacaktır (nils sorunu için # ve unpack belgelerine bakın).

setmetatable
Sets the metatable of a table. may be nil, but must be explicitly provided.

If the current metatable has a __metatable field,  will throw an error.

tonumber
Tries to convert  to a number. If it is already a number or a string convertible to a number, then  returns this number; otherwise, it returns nil.

The optional  (default 10) specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter 'A' (in either upper or lower case) represents 10, 'B' represents 11, and so forth, with 'Z' representing 35.

In base 10, the value may have a decimal part, be expressed in E notation, and may have a leading "0x" to indicate base 16. In other bases, only unsigned integers are accepted.

tostring
Converts  to a string. See Data types above for details on how each type is converted.

The standard behavior for tables may be overridden by providing a __tostring metamethod. If that metamethod exists, the call to tostring will return the single value returned by  instead.

type
Returns the type of  as a string: ,  ,  ,  ,  , or.

unpack
Returns values from the given table, something like  would do if written out manually. If nil or not given,  defaults to 1 and   defaults to.

Note that results are not deterministic if  is not a sequence and   is nil or unspecified; see Length operator for details.

xpcall
This is much like, except that the error message is passed to the function   before being returned.

In pseudocode,  might be defined something like this:

debug.traceback
Returns a string with a traceback of the call stack. An optional message string is appended at the beginning of the traceback. An optional level number tells at which stack level to start the traceback.

math.abs
Returns the absolute value of.

math.acos
Returns the arc cosine of  (given in radians).

math.asin
Returns the arc sine of  (given in radians).

math.atan
Returns the arc tangent of  (given in radians).

math.atan2
Returns the arc tangent of  (given in radians), using the signs of both parameters to find the quadrant of the result.

math.ceil
Returns the smallest integer larger than or equal to.

math.cos
Returns the cosine of  (given in radians).

math.cosh
Returns the hyperbolic cosine of.

math.deg
Returns the angle  (given in radians) in degrees.

math.exp
Returns the value $$e^x$$.

math.floor
Returns the largest integer smaller than or equal to.

math.fmod
Returns the remainder of the division of  by   that rounds the quotient towards zero. For example,  yields.

math.frexp
Returns two values  and   such that:


 * If  is finite and non-zero: $$x = m \times 2^e$$,   is an integer, and the absolute value of   is in the range $$[0.5, 1)$$
 * If  is zero:   and   are 0
 * If  is NaN or infinite:   is   and   is not specified

math.huge
The value representing positive infinity; larger than or equal to any other numerical value.

math.ldexp
Returns $$m \times 2^e$$ ( should be an integer).

math.log
Returns the natural logarithm of.

math.log10
Returns the base-10 logarithm of.

math.max
Returns the maximum value among its arguments.

Behavior with NaNs is not specified. With the current implementation, NaN will be returned if  is NaN, but any other NaNs will be ignored.

math.min
Returns the minimum value among its arguments.

Behavior with NaNs is not specified. With the current implementation, NaN will be returned if  is NaN, but any other NaNs will be ignored.

math.modf
Returns two numbers, the integral part of  and the fractional part of. For example,  yields.

math.pi
The value of $$\pi$$.

math.pow
Equivalent to.

math.rad
Returns the angle  (given in degrees) in radians.

math.random
Returns a pseudo-random number.

The arguments  and   may be omitted, but if specified must be convertible to integers.


 * With no arguments, returns a real number in the range $$[0,1)$$
 * With one argument, returns an integer in the range $$[1,m]$$
 * With two arguments, returns an integer in the range $$[m,n]$$

math.randomseed
Sets  as the seed for the pseudo-random generator.

Note that using the same seed will cause  to output the same sequence of numbers.

math.sin
Returns the sine of  (given in radians).

math.sinh
Returns the hyperbolic sine of.

math.sqrt
Returns the square root of. Equivalent to.

math.tan
Returns the tangent of  (given in radians).

math.tanh
Returns the hyperbolic tangent of.

os.clock
Returns an approximation of the amount in seconds of CPU time used by the program.

os.date

 * Language library's formatDate may be used for more comprehensive date formatting

Returns a string or a table containing date and time, formatted according to. If the format is omitted or nil, "%c" is used.

If  is given, it is the time to be formatted (see  ). Otherwise the current time is used.

If  starts with '!', then the date is formatted in UTC rather than the server's local time. After this optional character, if format is the string "*t", then date returns a table with the following fields:


 * year (full)
 * month (1–12)
 * day (1–31)
 * hour (0–23)
 * min (0–59)
 * sec (0–60)
 * wday (weekday, Sunday is 1)
 * yday (day of the year)
 * isdst (daylight saving flag, a boolean; may be absent if the information is not available)

If format is not "*t", then date returns the date as a string, formatted according to the same rules as the C function strftime.

os.difftime
Returns the number of seconds from  to.

os.time
Returns a number representing the current time.

When called without arguments, returns the current time. If passed a table, the time encoded in the table will be parsed. The table must have the fields "year", "month", and "day", and may also include "hour" (default 12), "min" (default 0), "sec" (default 0), and "isdst".

require
Loads the specified module.

First, it looks in  to see if the module is already loaded. If so, returns.

Otherwise, it calls each loader in the  sequence to attempt to find a loader for the module. If a loader is found, that loader is called. The value returned by the loader is stored into  and is returned.

See the documentation for  for information on the loaders available.

For example, if you have a module "Module:Giving" containing the following:

You can load this in another module with code such as this:

package.loaded
This table holds the loaded modules. The keys are the module names, and the values are the values returned when the module was loaded.

package.loaders
This table holds the sequence of searcher functions to use when loading modules. Each searcher function is called with a single argument, the name of the module to load. If the module is found, the searcher must return a function that will actually load the module and return the value to be returned by require. Otherwise, it must return nil.

Scribunto provides two searchers:


 * 1) Look in   for the loader function
 * 2) Look in the modules provided with Scribunto for the module name, and if that fails look in the Module: namespace. The "Module:" prefix must be provided.

Note that the standard Lua loaders are not included.

package.preload
This table holds loader functions, used by the first searcher Scribunto includes in package.loaders.

package.seeall
Sets the __index metamethod for  to _G.

String library
In all string functions, the first character is at position 1, not position 0 as in C, PHP, and JavaScript. Indexes may be negative, in which case they count from the end of the string: position -1 is the last character in the string, -2 is the second-last, and so on.

The string library assumes one-byte character encodings. It cannot handle Unicode characters. To operate on Unicode strings, use the corresponding methods in the Scribunto Ustring library.

string.byte
If the string is considered as an array of bytes, returns the byte values for,  , ···,. The default value for  is 1; the default value for  is. Identical to mw.ustring.byte.

string.char
Receives zero or more integers. Returns a string with length equal to the number of arguments, in which each character has the byte value equal to its corresponding argument.

See mw.ustring.char for a similar function that uses Unicode codepoints rather than byte values.

string.find
Looks for the first match of  in the string. If it finds a match, then  returns the offsets in   where this occurrence starts and ends; otherwise, it returns nil. If the pattern has captures, then in a successful match the captured values are also returned after the two indices.

A third, optional numerical argument  specifies where to start the search; its default value is 1 and can be negative. A value of true as a fourth, optional argument  turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in   being considered "magic".

Note that if  is given, then   must be given as well.

See mw.ustring.find for a similar function extended as described in Ustring patterns and where the  offset is in characters rather than bytes.

string.format
Returns a formatted version of its variable number of arguments following the description given in its first argument (which must be a string).

The format string uses a limited subset of the format specifiers:


 * Recognized flags are '-', '+', ' ', '#', and '0'.
 * Integer field widths up to 99 are supported. '*' is not supported.
 * Integer precisions up to 99 are supported. '*' is not supported.
 * Length modifiers are not supported.
 * Recognized conversion specifiers are 'c', 'd', 'i', 'o', 'u', 'x', 'X', 'e', 'E', 'f', 'g', 'G', 's', '%', and the non-standard 'q'.
 * Positional specifiers (e.g. "%2$s") are not supported.

The conversion specifier 'q' is like 's', but formats the string in a form suitable to be safely read back by the Lua interpreter: the string is written between double quotes, and all double quotes, newlines, embedded zeros, and backslashes in the string are correctly escaped when written.

Conversion between strings and numbers is performed as specified in Data types; other types are not automatically converted to strings. Strings containing NUL characters (byte value 0) are not properly handled.

Identical to mw.ustring.format.

string.gmatch
Returns an iterator function that, each time it is called, returns the next captures from  over string. If  specifies no captures, then the whole match is produced in each call.

For this function, a ' ' at the start of a pattern is not magic, as this would prevent the iteration. It is treated as a literal character.

See mw.ustring.gmatch for a similar function for which the pattern is extended as described in Ustring patterns.

string.gsub
Returns a copy of  in which all (or the first , if given) occurrences of the   have been replaced by a replacement string specified by  , which can be a string, a table, or a function. also returns, as its second value, the total number of matches that occurred.

If  is a string, then its value is used for replacement. The character  works as an escape character: any sequence in   of the form  , with n between 1 and 9, stands for the value of the n-th captured substring. The sequence  stands for the whole match, and the sequence   stands for a single.

If  is a table, then the table is queried for every match, using the first capture as the key; if the pattern specifies no captures, then the whole match is used as the key.

If  is a function, then this function is called every time a match occurs, with all captured substrings passed as arguments, in order; if the pattern specifies no captures, then the whole match is passed as a sole argument.

If the value returned by the table query or by the function call is a string or a number, then it is used as the replacement string; otherwise, if it is false or nil, then there is no replacement (that is, the original match is kept in the string).

See mw.ustring.gsub for a similar function in which the pattern is extended as described in Ustring patterns.

string.len
Returns the length of the string, in bytes. Is not confused by ASCII NUL characters. Equivalent to.

See mw.ustring.len for a similar function using Unicode codepoints rather than bytes.

string.lower
Returns a copy of this string with all ASCII uppercase letters changed to lowercase. All other characters are left unchanged.

See mw.ustring.lower for a similar function in which all characters with uppercase to lowercase definitions in Unicode are converted.

string.match
Looks for the first match of  in the string. If it finds one, then  returns the captures from the pattern; otherwise it returns nil. If  specifies no captures, then the whole match is returned.

A third, optional numerical argument  specifies where to start the search; its default value is 1 and can be negative.

See mw.ustring.match for a similar function in which the pattern is extended as described in Ustring patterns and the  offset is in characters rather than bytes.

string.rep
Returns a string that is the concatenation of  copies of the string. Identical to mw.ustring.rep.

string.reverse
Returns a string that is the string  reversed (bytewise).

string.sub
Returns the substring of  that starts at   and continues until  ;   and   can be negative. If  is nil or omitted, it will continue until the end of the string.

Note that a string in Lua begins at index 1. Also, when using this function, the indices at both ends are inclusive.

In particular, the call  returns a prefix of   with length , and   returns a suffix of   with length.

See mw.ustring.sub for a similar function in which the offsets are characters rather than bytes.

string.upper
Returns a copy of this string with all ASCII lowercase letters changed to uppercase. All other characters are left unchanged.

See mw.ustring.upper for a similar function in which all characters with lowercase to uppercase definitions in Unicode are converted.

Patterns
Note that Lua's patterns are similar to regular expressions, but are not identical. In particular, note the following differences from regular expressions and PCRE:


 * The quoting character is percent, not backslash.
 * Dot always matches all characters, including newlines.
 * No case-insensitive mode.
 * No alternation (the  operator).
 * Quantifiers (, ,  , and  ) may only be applied to individual characters or character classes, not to capture groups.
 * The only non-greedy quantifier is, which is equivalent to PCRE's   quantifier.
 * No generalized finite quantifier (e.g. the  quantifier in PCRE).
 * The only zero-width assertions are,  , and the   "frontier" pattern; assertions such as PCRE's   or   are not present.
 * Patterns themselves do not recognize character escapes such as '\ddd'. However, since patterns are strings these sort of escapes may be used in the string literals used to create the pattern-string.

Also note that a pattern cannot contain embedded zero bytes (ASCII NUL, ). Use  instead.

Also see Ustring patterns for a similar pattern-matching scheme using Unicode characters.

Character class
A character class is used to represent a set of characters. The following combinations are allowed in describing a character class:


 * x: (where x is not one of the magic characters ) represents the character x itself.
 *  : (a dot) represents all characters.
 *  : represents all ASCII letters.
 *  : represents all ASCII control characters.
 *  : represents all digits.
 *  : represents all ASCII lowercase letters.
 *  : represents all punctuation characters.
 *  : represents all ASCII space characters.
 *  : represents all ASCII uppercase letters.
 *  : represents all ASCII alphanumeric characters.
 *  : represents all hexadecimal digits.
 *  : represents ASCII NUL, the zero byte.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : (where x is any non-alphanumeric character) represents the character x. This is the standard way to escape the magic characters. Any punctuation character (even the non magic) can be preceded by a ' ' when used to represent itself in a pattern.
 *  : represents the class which is the union of all characters in set. A range of characters can be specified by separating the end characters of the range with a ' '. All classes  described above can also be used as components in set. All other characters in set represent themselves. For example,   (or  ) represents all alphanumeric characters plus the underscore,   represents the octal digits, and   represents the octal digits plus the lowercase letters plus the ' ' character. The interaction between ranges and classes is not defined. Therefore, patterns like   or   have no meaning.
 *  : represents the complement of set, where set is interpreted as above.

Pattern items
A pattern item can be


 * a single character class, which matches any single character in the class;
 * a single character class followed by ' ', which matches 0 or more repetitions of characters in the class. These repetition items will always match the longest possible sequence;
 * a single character class followed by ' ', which matches 1 or more repetitions of characters in the class. These repetition items will always match the longest possible sequence;
 * a single character class followed by ' ', which also matches 0 or more repetitions of characters in the class. Unlike ' ', these repetition items will always match the shortest possible sequence;
 * a single character class followed by ' ', which matches 0 or 1 occurrence of a character in the class;
 * , for n between 1 and 9; such item matches a substring equal to the n-th captured string (see below);
 * , where x and y are two distinct characters; such item matches strings that start with x, end with y, and where the x and y are balanced. This means that, if one reads the string from left to right, counting +1 for an x and -1 for a y, the ending y is the first y where the count reaches 0. For instance, the item  matches expressions with balanced parentheses.


 * , a frontier pattern; such item matches an empty string at any position such that the next character belongs to set and the previous character does not belong to set. The set set is interpreted as previously described. The beginning and the end of the subject are handled as if they were the character '\0'. Note that frontier patterns were present but undocumented in Lua 5.1, and officially added to Lua in 5.2. The implementation in Lua 5.2.1 is unchanged from that in 5.1.0.

Pattern
A pattern is a sequence of pattern items.

A ' ' at the beginning of a pattern anchors the match at the beginning of the subject string. A ' ' at the end of a pattern anchors the match at the end of the subject string. At other positions, ' ' and ' ' have no special meaning and represent themselves.

Captures
A pattern can contain sub-patterns enclosed in parentheses; they describe captures. When a match succeeds, the substrings of the subject string that match captures are stored ("captured") for future use. Captures are numbered according to their left parentheses. For instance, in the pattern, the part of the string matching   is stored as the first capture (and therefore has number 1); the character matching   is captured with number 2, and the part matching   has number 3.

Capture references can appear in the pattern string itself, and refer back to text that was captured earlier in the match. For example,  will match any pair of identical lowercase letters, while   will match any 7-letter palindrome.

As a special case, the empty capture  captures the current string position (a number). For instance, if we apply the pattern  on the string , there will be two captures: 3 and 5.

Table library
Most functions in the table library assume that the table represents a sequence.

The functions,  , and   may be available but are deprecated. Use a for loop with pairs, a for loop with ipairs, and the length operator instead.

table.concat
Given an array where all elements are strings or numbers, returns.

The default value for  is the empty string, the default for   is 1, and the default for   is the length of the table. If  is greater than , returns the empty string.

table.insert
Inserts element  at position   in , shifting up other elements to open space, if necessary. The default value for  is the length of the table plus 1, so that a call   inserts   at the end of table.

Elements up to  are shifted; see Length operator for caveats if the table is not a sequence.

table.maxn
Returns the largest positive numerical index of the given table, or zero if the table has no positive numerical indices.

To do this, it iterates over the whole table. This is roughly equivalent to

table.remove
Removes from  the element at position  , shifting down other elements to close the space, if necessary. Returns the value of the removed element. The default value for  is the length of the table, so that a call   removes the last element of table.

Elements up to  are shifted; see Length operator for caveats if the table is not a sequence.

table.sort
Sorts table elements in a given order, in-place, from  to. If  is given, then it must be a function that receives two table elements, and returns true when the first is less than the second (so that   will be true after the sort). If  is not given, then the standard Lua operator   is used instead.

The sort algorithm is not stable; that is, elements considered equal by the given order may have their relative positions changed by the sort.

Scribunto libraries
All Scribunto libraries are located in the table.

mw.addWarning
Adds a warning which is displayed above the preview when previewing an edit. is parsed as wikitext.

mw.allToString
Calls tostring on all arguments, then concatenates them with tabs as separators.

mw.clone
Creates a deep copy of a value. All tables (and their metatables) are reconstructed from scratch. Functions are still shared, however.

mw.getCurrentFrame
Returns the current frame object, typically the frame object from the most recent.

mw.incrementExpensiveFunctionCount
Adds one to the "expensive parser function" count, and throws an exception if it exceeds the limit (see ).

mw.isSubsting
Returns true if the current  is being substed, false otherwise. See Returning text above for discussion on differences when substing versus not substing.

mw.loadData
Sometimes a module needs large tables of data; for example, a general-purpose module to convert units of measure might need a large table of recognized units and their conversion factors. And sometimes these modules will be used many times in one page. Parsing the large data table for every  can use a significant amount of time. To avoid this issue,  is provided.

works like, with the following differences:


 * The loaded module is evaluated only once per page, rather than once per  call.
 * The loaded module is not recorded in.
 * The value returned from the loaded module must be a table. Other data types are not supported.
 * The returned table (and all subtables) may contain only booleans, numbers, strings, and other tables. Other data types, particularly functions, are not allowed.
 * The returned table (and all subtables) may not have a metatable.
 * All table keys must be booleans, numbers, or strings.
 * The table actually returned by  has metamethods that provide read-only access to the table returned by the module. Since it does not contain the data directly,   and   will work but other methods, including ,  , and the functions in the Table library, will not work correctly.

The hypothetical unit-conversion module mentioned above might store its code in "Module:Convert" and its data in "Module:Convert/data", and "Module:Convert" would use  to efficiently load the data.

mw.dumpObject
Serializes  to a human-readable representation, then returns the resulting string.

mw.log
Passes the arguments to mw.allToString, then appends the resulting string to the log buffer.

In the debug console, the function  is an alias for this function.

mw.logObject
Calls mw.dumpObject and appends the resulting string to the log buffer. If  is given, it will be added to the log buffer followed by an equals sign before the serialized string is appended (i.e. the logged text will be "prefix = object-string").

Frame object
The frame object is the interface to the parameters passed to, and to the parser.

Note that there is no frame library, and there is no global variable named. A frame object is typically obtained by being passed as a parameter to the function called by, and can also be obtained from.

frame.args
A table for accessing the arguments passed to the frame. For example, if a module is called from wikitext with

then  will return ,   will return  , and   (or  ) will return. It is also possible to iterate over arguments using  or. However, due to how Lua implements table iterators, iterating over arguments will return them in an unspecified order, and there's no way to know the original order as they appear in wikitext.

Note that values in this table are always strings;  may be used to convert them to numbers, if necessary. Keys, however, are numbers even if explicitly supplied in the invocation:  gives string values   and   indexed by numeric keys   and.

As in MediaWiki template invocations, named arguments will have leading and trailing whitespace removed from both the name and the value before they are passed to Lua, whereas unnamed arguments will not have whitespace stripped.

For performance reasons,  uses a metatable, rather than directly containing the arguments. Argument values are requested from MediaWiki on demand. This means that most other table methods will not work correctly, including,  , and the functions in the Table library.

If preprocessor syntax such as template invocations and triple-brace arguments are included within an argument to #invoke, they will not be expanded, after being passed to Lua, until their values are being requested in Lua. If certain special tags written in XML notation, such as,  ,   and  , are included as arguments to #invoke, then these tags will be converted to "strip markers" — special strings which begin with a delete character (ASCII 127), to be replaced with HTML after they are returned from #invoke.

frame:callParserFunction

 * Note the use of named arguments.

Call a parser function, returning an appropriate string. Whenever possible, native Lua functions or Scribunto library functions should be preferred to this interface.

The following calls are approximately equivalent to the indicated wikitext:

Note that, as with frame:expandTemplate, the function name and arguments are not preprocessed before being passed to the parser function.

frame:expandTemplate

 * Note the use of named arguments.

This is transclusion. The call

frame:expandTemplate{ title = 'template', args = { 'arg1', 'arg2', name = 'arg3' } }

does roughly the same thing from Lua that  does in wikitext. As in transclusion, if the passed title does not contain a namespace prefix it will be assumed to be in the Template: namespace.

Note that the title and arguments are not preprocessed before being passed into the template:

frame:extensionTag
This is equivalent to a call to frame:callParserFunction with function name  and with   prepended to.

frame:getParent
Called on the frame created by, returns the frame for the page that called. Called on that frame, returns nil.

For instance, if the template  contains the code , and a page transcludes that template and supplies arguments to it , calling   in Module:ModuleName will return.

frame:getTitle
Returns the title associated with the frame as a string. For the frame created by, this is the title of the module invoked.

frame:newChild

 * Note the use of named arguments.

Create a new Frame object that is a child of the current frame, with optional arguments and title.

This is mainly intended for use in the debug console for testing functions that would normally be called by. The number of frames that may be created at any one time is limited.

frame:preprocess
This expands wikitext in the context of the frame, i.e. templates, parser functions, and parameters such as  are expanded. Certain special tags written in XML-style notation, such as,  ,   and  , will be replaced with "strip markers" &mdash; special strings which begin with a delete character (ASCII 127), to be replaced with HTML after they are returned from.

If you are expanding a single template, use  instead of trying to construct a wikitext string to pass to this method. It's faster and less prone to error if the arguments contain pipe characters or other wikimarkup.

If you are expanding a single parser function, use  for the same reasons.

frame:getArgument
Gets an object for the specified argument, or nil if the argument is not provided.

The returned object has one method,, that returns the expanded wikitext for the argument.

frame:newParserValue
Returns an object with one method,, that returns the result of.

frame:newTemplateParserValue

 * Note the use of named arguments.

Returns an object with one method,, that returns the result of   called with the given arguments.

frame:argumentPairs
Same as. Included for backwards compatibility.

mw.hash.hashValue
Hashes a string value with the specified algorithm. Valid algorithms may be fetched using mw.hash.listAlgorithms.

mw.hash.listAlgorithms
Returns a list of supported hashing algorithms, for use in mw.hash.hashValue.

HTML library
is a fluent interface for building complex HTML from Lua. A mw.html object can be created using.

Functions documented as  are available on the global   table; functions documented as   and   are methods of an mw.html object (see  ).

A basic example could look like this:

mw.html.create
Creates a new mw.html object containing a  html element. You can also pass an empty string or nil as  in order to create an empty mw.html object.

can be a table with the following keys:


 * : Force the current tag to be self-closing, even if mw.html doesn't recognize it as self-closing
 * : Parent of the current mw.html instance (intended for internal usage)

mw.html:node
Appends a child mw.html node to the current mw.html instance. If a nil parameter is passed, this is a no-op. A node is a string representation of an html element.

mw.html:wikitext
Appends an undetermined number of wikitext strings to the mw.html object.

Note that this stops at the first nil item.

mw.html:newline
Appends a newline to the mw.html object.

mw.html:tag
Appends a new child node with the given  to the builder, and returns a mw.html instance representing that new node. The  parameter is identical to that of

mw.html:attr
Set an HTML attribute with the given  and   on the node. Alternatively a table holding name->value pairs of attributes to set can be passed. In the first form, a value of nil causes any attribute with the given name to be unset if it was previously set.

mw.html:getAttr
Get the value of a html attribute previously set using  with the given.

mw.html:addClass
Adds a class name to the node's class attribute. If a nil parameter is passed, this is a no-op.

mw.html:css
Set a CSS property with the given  and   on the node. Alternatively a table holding name->value pairs of properties to set can be passed. In the first form, a value of nil causes any property with the given name to be unset if it was previously set.

mw.html:cssText
Add some raw  to the node's style attribute. If a nil parameter is passed, this is a no-op.

mw.html:done
Returns the parent node under which the current node was created. Like jQuery.end, this is a convenience function to allow the construction of several child nodes to be chained together into a single statement.

mw.html:allDone
Like, but traverses all the way to the root node of the tree and returns it.

Language library
Language codes are described at language code. Many of MediaWiki's language codes are similar to IETF language tags, but not all MediaWiki language codes are valid IETF tags or vice versa.

Functions documented as  are available on the global   table; functions documented as   and   are methods of a language object (see   or  ).

mw.language.fetchLanguageName
The full name of the language for the given language code: native name (language autonym) by default, name translated in target language if a value is given for.

mw.language.fetchLanguageNames
Fetch the list of languages known to MediaWiki, returning a table mapping language code to language name.

By default the name returned is the language autonym; passing a language code for  returns all names in that language.

By default, only language names known to MediaWiki are returned; passing  for   will return all available languages (e.g. from Extension:CLDR), while passing   will include only languages having customized messages included with MediaWiki core or enabled extensions. To explicitly select the default,  may be passed.

mw.language.getContentLanguage
Returns a new language object for the wiki's default content language.

mw.language.getFallbacksFor


Returns a list of MediaWiki's fallback language codes for the specified code.

mw.language.isKnownLanguageTag
Returns true if a language code is known to MediaWiki.

A language code is "known" if it is a "valid built-in code" (i.e. it returns true for ) and returns a non-empty string for.

mw.language.isSupportedLanguage
Checks whether any localisation is available for that language code in MediaWiki.

A language code is "supported" if it is a "valid" code (returns true for ), contains no uppercase letters, and has a message file in the currently-running version of MediaWiki.

It is possible for a language code to be "supported" but not "known" (i.e. returning true for ). Also note that certain codes are "supported" despite  returning false.

mw.language.isValidBuiltInCode
Returns true if a language code is of a valid form for the purposes of internal customisation of MediaWiki.

The code may not actually correspond to any known language.

A language code is a "valid built-in code" if it is a "valid" code (i.e. it returns true for ); consists of only ASCII letters, numbers, and hyphens; and is at least two characters long.

Note that some codes are "supported" (i.e. returning true from ) even though this function returns false.

mw.language.isValidCode
Returns true if a language code string is of a valid form, whether or not it exists. This includes codes which are used solely for customisation via the MediaWiki namespace.

The code may not actually correspond to any known language.

A language code is valid if it does not contain certain unsafe characters (colons, single- or double-quotes, slashs, backslashs, angle brackets, ampersands, or ASCII NULs) and is otherwise allowed in a page title.

mw.language.new
Creates a new language object. Language objects do not have any publicly accessible properties, but they do have several methods, which are documented below.

There is a limit on the number of distinct language codes that may be used on a page. Exceeding this limit will result in errors.

mw.language:getCode
Returns the language code for this language object.

mw.language:getFallbackLanguages
Returns a list of MediaWiki's fallback language codes for this language object. Equivalent to.

mw.language:isRTL
Returns true if the language is written right-to-left, false if it is written left-to-right.

mw.language:lc
Converts the string to lowercase, honoring any special rules for the given language.

When the Ustring library is loaded, the mw.ustring.lower function is implemented as a call to.

mw.language:lcfirst
Converts the first character of the string to lowercase, as with lang:lc.

mw.language:uc
Converts the string to uppercase, honoring any special rules for the given language.

When the Ustring library is loaded, the mw.ustring.upper function is implemented as a call to.

mw.language:ucfirst
Converts the first character of the string to uppercase, as with lang:uc.

mw.language:caseFold
Converts the string to a representation appropriate for case-insensitive comparison. Note that the result may not make any sense when displayed.

mw.language:formatNum
Formats a number with grouping and decimal separators appropriate for the given language. Given 123456.78, this may produce "123,456.78", "123.456,78", or even something like "١٢٣٬٤٥٦٫٧٨" depending on the language and wiki configuration.

The  is a table of options, which can be:


 * : Set true to omit grouping separators and use a dot as the decimal separator. Digit transformation may still occur, which may include transforming the decimal separator.

mw.language:formatDate
Formats a date according to the given format string. If  is omitted, the default is the current time. The value for  must be a boolean or nil; if true, the time is formatted in the wiki's local time rather than in UTC.

The format string and supported values for  are identical to those for the #time parser function from Extension:ParserFunctions. Note however that backslashes may need to be doubled in a Lua string literal, since Lua also uses backslash as an escape character while wikitext does not:

mw.language:formatDuration
Breaks a duration in seconds into more human-readable units, e.g. 12345 to 3 hours, 25 minutes and 45 seconds, returning the result as a string.

, if given, is a table with values naming the interval units to use in the response. These include 'millennia', 'centuries', 'decades', 'years', 'weeks', 'days', 'hours', 'minutes', and 'seconds'.

mw.language:parseFormattedNumber
This takes a number as formatted by lang:formatNum and returns the actual number. In other words, this is basically a language-aware version of.

mw.language:convertPlural
This chooses the appropriate grammatical form from  (which must be a sequence table) or   based on the number. For example, in English you might use  or   to generate grammatically-correct text whether there is only 1 sock or 200 socks.

The necessary values for the sequence are language-dependent, see localization of magic words and translatewiki's FAQ on PLURAL for some details.

mw.language:convertGrammar

 * Note the different parameter order between the two aliases.  matches the order of the method of the same name on MediaWiki's Language object, while   matches the order of the parser function of the same name, documented at Special:MyLanguage/Help:Magic words.

This chooses the appropriate inflected form of  for the given inflection code.

The possible values for  and   are language-dependent, see Special:MyLanguage/Help:Magic words and translatewiki:Grammar for some details.

mw.language:gender
Chooses the string corresponding to the gender of, which may be "male", "female", or a registered user name.

mw.language:getArrow
Returns a Unicode arrow character corresponding to :


 * forwards: Either "→" or "←" depending on the directionality of the language.
 * backwards: Either "←" or "→" depending on the directionality of the language.
 * left: "←"
 * right: "→"
 * up: "↑"
 * down: "↓"

mw.language:getDir
Returns "ltr" or "rtl", depending on the directionality of the language.

mw.language:getDirMark
Returns a string containing either U+200E (the left-to-right mark) or U+200F (the right-to-left mark), depending on the directionality of the language and whether  is a true or false value.

mw.language:getDirMarkEntity
Returns "&amp;lrm;" or "&amp;rlm;", depending on the directionality of the language and whether  is a true or false value.

mw.language:getDurationIntervals
Breaks a duration in seconds into more human-readable units, e.g. 12345 to 3 hours, 25 minutes and 45 seconds, returning the result as a table mapping unit names to numbers.

For example,

, if given, is a table with values naming the interval units to use in the response. These include 'millennia', 'centuries', 'decades', 'years', 'days', 'hours', 'minutes', and 'seconds'.

The unit names in  may be specified in any order (currently in English only, indendantly of the language object used, and with their plural unabbreviated form only like in the returned table, where unit names are symbolic but still not translated and not grammatically changed according to their assigned value). If the input table contains only unsupported unit names, the returned table will be empty. If the input table is not specified, is nil, or is empty, a static table for any supported units (including 'seconds' for the shortest unit) will be used by default.

The specified duration in seconds is first rounded down to an integer number of the shortest desired unit. The number of members in the returned array is variable, and only unit names mapped to a non-zero value are kept in the returned table if the rounded number of seconds is strictly positive. Otherwise only the member for the shortest desired unit name ('seconds' by default) will be set to the rounded down duration.

Message library
This library is an interface to the localisation messages and the MediaWiki: namespace.

Functions documented as  are available on the global   table; functions documented as   and   are methods of a message object (see  ).

mw.message.new
Creates a new message object for the given message. The remaining parameters are passed to the new object's  method.

The message object has no properties, but has several methods documented below.

mw.message.newFallbackSequence
Creates a new message object for the given messages (the first one that exists will be used).

The message object has no properties, but has several methods documented below.

mw.message.newRawMessage
Creates a new message object, using the given text directly rather than looking up an internationalized message. The remaining parameters are passed to the new object's  method.

The message object has no properties, but has several methods documented below.

mw.message.rawParam
Wraps the value so that it will not be parsed as wikitext by.

mw.message.numParam
Wraps the value so that it will automatically be formatted as by. Note this does not depend on the Language library actually being available.

mw.message.getDefaultLanguage
Returns a Language object for the default language.

mw.message:params
Add parameters to the message, which may be passed as individual arguments or as a sequence table. Parameters must be numbers, strings, or the special values returned by mw.message.numParam or mw.message.rawParam. If a sequence table is used, parameters must be directly present in the table; references using the __index metamethod will not work.

Returns the  object, to allow for call chaining.

mw.message:rawParams
Like params, but has the effect of passing all the parameters through mw.message.rawParam first.

Returns the  object, to allow for call chaining.

mw.message:numParams
Like params, but has the effect of passing all the parameters through mw.message.numParam first.

Returns the  object, to allow for call chaining.

mw.message:inLanguage
Specifies the language to use when processing the message. may be a string or a table with a  method (i.e. a Language object).

The default language is the one returned by.

Returns the  object, to allow for call chaining.

mw.message:useDatabase
Specifies whether to look up messages in the MediaWiki: namespace (i.e. look in the database), or just use the default messages distributed with MediaWiki.

The default is true.

Returns the  object, to allow for call chaining.

mw.message:plain
Substitutes the parameters and returns the message wikitext as-is. Template calls and parser functions are intact.

mw.message:exists
Returns a boolean indicating whether the message key exists.

mw.message:isBlank
Returns a boolean indicating whether the message key has content. Returns true if the message key does not exist or the message is the empty string.

mw.message:isDisabled
Returns a boolean indicating whether the message key is disabled. Returns true if the message key does not exist or if the message is the empty string or the string "-".

mw.site.currentVersion
A string holding the current version of MediaWiki.

mw.site.scriptPath
The value of.

mw.site.server
The value of.

mw.site.siteName
The value of.

mw.site.stylePath
The value of.

mw.site.namespaces
Table holding data for all namespaces, indexed by number.

The data available is:


 * id: Namespace number.
 * name: Local namespace name.
 * canonicalName: Canonical namespace name.
 * displayName: Set on namespace 0, the name to be used for display (since the name is often the empty string).
 * hasSubpages: Whether subpages are enabled for the namespace.
 * hasGenderDistinction: Whether the namespace has different aliases for different genders.
 * isCapitalized: Whether the first letter of pages in the namespace is capitalized.
 * isContent: Whether this is a content namespace.
 * isIncludable: Whether pages in the namespace can be transcluded.
 * isMovable: Whether pages in the namespace can be moved.
 * isSubject: Whether this is a subject namespace.
 * isTalk: Whether this is a talk namespace.
 * defaultContentModel: The default content model for the namespace, as a string.
 * aliases: List of aliases for the namespace.
 * subject: Reference to the corresponding subject namespace's data.
 * talk: Reference to the corresponding talk namespace's data.
 * associated: Reference to the associated namespace's data.

A metatable is also set that allows for looking up namespaces by name (localized or canonical). For example, both  and   will return information about the Project namespace.

mw.site.contentNamespaces
Table holding just the content namespaces, indexed by number. See mw.site.namespaces for details.

mw.site.subjectNamespaces
Table holding just the subject namespaces, indexed by number. See mw.site.namespaces for details.

mw.site.talkNamespaces
Table holding just the talk namespaces, indexed by number. See mw.site.namespaces for details.

mw.site.stats
Table holding site statistics. Available statistics are:


 * pages: Number of pages in the wiki.
 * articles: Number of articles in the wiki.
 * files: Number of files in the wiki.
 * edits: Number of edits in the wiki.
 * users: Number of users in the wiki.
 * activeUsers: Number of active users in the wiki.
 * admins: Number of users in group 'sysop' in the wiki.

mw.site.stats.pagesInCategory


Gets statistics about the category. If  is unspecified, nil, or "*", returns a table with the following properties:


 * all: Total pages, files, and subcategories.
 * subcats: Number of subcategories.
 * files: Number of files.
 * pages: Number of pages.

If  is one of the above keys, just the corresponding value is returned instead.

Each new category queried will increment the expensive function count.

mw.site.stats.pagesInNamespace
Returns the number of pages in the given namespace (specify by number).

mw.site.stats.usersInGroup
Returns the number of users in the given group.

mw.site.interwikiMap
Returns a table holding data about available interwiki prefixes. If  is the string "local", then only data for local interwiki prefixes is returned. If  is the string "!local", then only data for non-local prefixes is returned. If no filter is specified, data for all prefixes is returned. A "local" prefix in this context is one that is for the same project. For example, on the English Wikipedia, other-language Wikipedias are considered local, while Wiktionary and such are not.

Keys in the table returned by this function are interwiki prefixes, and the values are subtables with the following properties:


 * prefix - the interwiki prefix.
 * url - the URL that the interwiki points to. The page name is represented by the parameter $1.
 * isProtocolRelative - a boolean showing whether the URL is protocol-relative.
 * isLocal - whether the URL is for a site in the current project.
 * isCurrentWiki - whether the URL is for the current wiki.
 * isTranscludable - whether pages using this interwiki prefix are transcludable. This requires scary transclusion, which is disabled on Wikimedia wikis.
 * isExtraLanguageLink - whether the interwiki is listed in.
 * displayText - for links listed in $wgExtraInterlanguageLinkPrefixes, this is the display text shown for the interlanguage link. Nil if not specified.
 * tooltip - for links listed in $wgExtraInterlanguageLinkPrefixes, this is the tooltip text shown when users hover over the interlanguage link. Nil if not specified.

Text library
The text library provides some common text processing functions missing from the String library and the Ustring library. These functions are safe for use with UTF-8 strings.

mw.text.decode
Replaces HTML entities in the string with the corresponding characters.

If boolean  is omitted or false, the only named entities recognized are '&amp;lt;', '&amp;gt;', '&amp;amp;', '&amp;quot;', and '&amp;nbsp;'. Otherwise, the list of HTML5 named entities to recognize is loaded from PHP's function.

mw.text.encode
Replaces characters in a string with HTML entities. Characters '<', '>', '&', '"', and the non-breaking space are replaced with the appropriate named entities; all others are replaced with numeric entities.

If  is supplied, it should be a string as appropriate to go inside brackets in a Ustring pattern, i.e. the "set" in. The default charset is  (the space at the end is the non-breaking space, U+00A0).

mw.text.jsonDecode
Decodes a JSON string. is 0 or a combination (use ) of the flags   and.

Normally JSON's zero-based arrays are renumbered to Lua one-based sequence tables; to prevent this, pass.

To relax certain requirements in JSON, such as no terminal comma in arrays or objects, pass. This is not recommended.

Limitations:


 * Decoded JSON arrays may not be Lua sequences if the array contains null values.
 * JSON objects will drop keys having null values.
 * It is not possible to directly tell whether the input was a JSON array or a JSON object with sequential integer keys.
 * A JSON object having sequential integer keys beginning with 1 will decode to the same table structure as a JSON array with the same values, despite these not being at all equivalent, unless  is used.

mw.text.jsonEncode
Encode a JSON string. Errors are raised if the passed value cannot be encoded in JSON. is 0 or a combination (use ) of the flags   and.

Normally Lua one-based sequence tables are encoded as JSON zero-based arrays; when  is set in , zero-based sequence tables are encoded as JSON arrays.

Limitations:


 * Empty tables are always encoded as empty arrays, not empty objects.
 * Sequence tables cannot be encoded as JSON objects without adding a "dummy" element.
 * To produce objects or arrays with nil values, a tricky implementation of the  metamethod is required.
 * A Lua table having sequential integer keys beginning with 0 will encode as a JSON array, the same as a Lua table having integer keys beginning with 1, unless  is used.
 * When both a number and the string representation of that number are used as keys in the same table, behavior is unspecified.

mw.text.killMarkers
Removes all MediaWiki strip markers from a string.

mw.text.listToText
Joins a list, prose-style. In other words, it's like  but with a different separator before the final item.

The default separator is taken from MediaWiki:comma-separator in the wiki's content language, and the default conjunction is MediaWiki:and concatenated with MediaWiki:word-separator.

Examples, using the default values for the messages:

mw.text.nowiki
Replaces various characters in the string with HTML entities to prevent their interpretation as wikitext. This includes:


 * The following characters: '"', '&', "'", '<', '=', '>', '[', ']', '{', '|', '}'
 * The following characters at the start of the string or immediately after a newline: '#', '*', ':', ';', space, tab ('\t')
 * Blank lines will have one of the associated newline or carriage return characters escaped
 * "" at the start of the string or immediately after a newline will have the first '-' escaped
 * "__" will have one underscore escaped
 * "://" will have the colon escaped
 * A whitespace character following "ISBN", "RFC", or "PMID" will be escaped

mw.text.split
Splits the string into substrings at boundaries matching the Ustring pattern. If  is specified and true,   will be interpreted as a literal string rather than as a Lua pattern (just as with the parameter of the same name for  ). Returns a table containing the substrings.

For example,  would return a table.

If  matches the empty string,   will be split into individual characters.

mw.text.gsplit
Returns an iterator function that will iterate over the substrings that would be returned by the equivalent call to.

mw.text.tag

 * Note the use of named arguments.

Generates an HTML-style tag for.

If  is given, it must be a table with string keys. String and number values are used as the value of the attribute; boolean true results in the key being output as an HTML5 valueless parameter; boolean false skips the key entirely; and anything else is an error.

If  is not given (or is nil), only the opening tag is returned. If  is boolean false, a self-closed tag is returned. Otherwise it must be a string or number, in which case that content is enclosed in the constructed opening and closing tag. Note the content is not automatically HTML-encoded; use mw.text.encode if needed.

For properly returning extension tags such as, use frame:extensionTag instead.

mw.text.trim
Remove whitespace or other characters from the beginning and end of a string.

If  is supplied, it should be a string as appropriate to go inside brackets in a Ustring pattern, i.e. the "set" in. The default charset is ASCII whitespace,.

mw.text.truncate
Truncates  to the specified length, adding   if truncation was performed. If length is positive, the end of the string will be truncated; if negative, the beginning will be removed. If  is given and true, the resulting string including ellipsis will not be longer than the specified length.

The default value for  is taken from MediaWiki:ellipsis in the wiki's content language.

Examples, using the default "..." ellipsis:

mw.text.unstripNoWiki
Replaces MediaWiki &lt;nowiki&gt; strip markers with the corresponding text. Other types of strip markers are not changed.

mw.text.unstrip
Equivalent to.

This no longer reveals the HTML behind special page transclusion, &lt;ref&gt; tags, and so on as it did in earlier versions of Scribunto.

mw.title.equals
Test for whether two titles are equal. Note that fragments are ignored in the comparison.

mw.title.compare
Returns -1, 0, or 1 to indicate whether the title  is less than, equal to, or greater than title.

This compares titles by interwiki prefix (if any) as strings, then by namespace number, then by the unprefixed title text as a string. These string comparisons use Lua's standard  operator.

mw.title.getCurrentTitle
Returns the title object for the current page.

mw.title.new


Creates a new title object.

If a number  is given, an object is created for the title with that page_id. The title referenced will be counted as linked from the current page. If the page_id does not exist, returns nil. The expensive function count will be incremented if the title object created is not for a title that has already been loaded.

If a string  is given instead, an object is created for that title (even if the page does not exist). If the text string does not specify a namespace,  (which may be any key found in  ) will be used. If the text is not a valid title, nil is returned.

mw.title.makeTitle
Creates a title object with title  in namespace , optionally with the specified   and   prefix. may be any key found in. If the resulting title is not valid, returns nil.

Note that, unlike, this method will always apply the specified namespace. For example,  will create an object for the page Template:Module:Foo, while   will create an object for the page Module:Foo.

Title objects
A title object has a number of properties and methods. Most of the properties are read-only.

Note that fields ending with  return titles as string values whereas the fields ending with   return title objects.


 * id: The page_id. 0 if the page does not exist..
 * interwiki: The interwiki prefix, or the empty string if none.
 * namespace: The namespace number.
 * fragment: The fragment, or the empty string. May be assigned.
 * nsText: The text of the namespace for the page.
 * subjectNsText: The text of the subject namespace for the page.
 * text: The title of the page, without the namespace or interwiki prefixes.
 * prefixedText: The title of the page, with the namespace and interwiki prefixes.
 * fullText: The title of the page, with the namespace and interwiki prefixes and the fragment. Interwiki is not returned if equal to the current.
 * rootText: If this is a subpage, the title of the root page without prefixes. Otherwise, the same as.
 * baseText: If this is a subpage, the title of the page it is a subpage of without prefixes. Otherwise, the same as.
 * subpageText: If this is a subpage, just the subpage name. Otherwise, the same as.
 * canTalk: Whether the page for this title could have a talk page.
 * exists: Whether the page exists. Alias for file.exists for Media-namespace titles. For File-namespace titles this checks the existence of the file description page, not the file itself..
 * file, fileExists: See below.
 * isContentPage: Whether this title is in a content namespace.
 * isExternal: Whether this title has an interwiki prefix.
 * isLocal: Whether this title is in this project. For example, on the English Wikipedia, any other Wikipedia is considered "local" while Wiktionary and such are not.
 * isRedirect: Whether this is the title for a page that is a redirect..
 * isSpecialPage: Whether this is the title for a possible special page (i.e. a page in the Special: namespace).
 * isSubpage: Whether this title is a subpage of some other title.
 * isTalkPage: Whether this is a title for a talk page.
 * isSubpageOf( title2 ): Whether this title is a subpage of the given title.
 * inNamespace( ns ): Whether this title is in the given namespace. Namespaces may be specified by anything that is a key found in.
 * inNamespaces( ... ): Whether this title is in any of the given namespaces. Namespaces may be specified by anything that is a key found in.
 * hasSubjectNamespace( ns ): Whether this title's subject namespace is in the given namespace. Namespaces may be specified by anything that is a key found in.
 * contentModel: The content model for this title, as a string..
 * basePageTitle: The same as.
 * rootPageTitle: The same as.
 * talkPageTitle: The same as, or nil if this title cannot have a talk page.
 * subjectPageTitle: The same as.
 * redirectTarget: Returns a title object of the target of the redirect page if the page is a redirect and the page exists, returns false otherwise.
 * protectionLevels: The page's protection levels. This is a table with keys corresponding to each action (e.g., "edit" and "move"). The table values are arrays, the first item of which is a string containing the protection level. If the page is unprotected, either the table values or the array items will be nil..
 * cascadingProtection: The cascading protections applicable to the page. This is a table with keys "restrictions" (itself a table with keys like protectionLevels has) and "sources" (an array listing titles where the protections cascade from). If no protections cascade to the page, "restrictions" and "sources" will be empty..
 * subPageTitle( text ): The same as.
 * partialUrl: Returns  encoded as it would be in a URL.
 * fullUrl( query, proto ): Returns the full URL (with optional query table/string) for this title.  may be specified to control the scheme of the resulting url: "http", "https", "relative" (the default), or "canonical".
 * localUrl( query ): Returns the local URL (with optional query table/string) for this title.
 * canonicalUrl( query ): Returns the canonical URL (with optional query table/string) for this title.
 * getContent: Returns the (unparsed) content of the page, or nil if there is no page. The page will be recorded as a transclusion.

Title objects may be compared using relational operators. will return.

Since people find the fact surprising, note that accessing any expensive field on a title object records a "link" to the page (as shown on Special:WhatLinksHere, for example). Using the title object's  method or accessing the   field records it as a "", and accessing the title object's   or   fields records it as a "".

File metadata
Title objects representing a page in the File or Media namespace will have a property called. This is a table, structured as follows:


 * exists: Whether the file exists. It will be recorded as an image usage. The  property on a Title object exists for backwards compatibility reasons and is an alias for this property. If this is false, all other file properties will be nil.
 * width: The width of the file. If the file contains multiple pages, this is the width of the first page.
 * height: The height of the file. If the file contains multiple pages, this is the height of the first page.
 * pages: If the file format supports multiple pages, this is a table containing tables for each page of the file; otherwise, it is nil. The # operator can be used to get the number of pages in the file. Each individual page table contains a width and height property.
 * size: The size of the file in bytes.
 * mimeType: The MIME type of the file.

Expensive properties
The properties id, isRedirect, exists, and contentModel require fetching data about the title from the database. For this reason, the expensive function count is incremented the first time one of them is accessed for a page other than the current page. Subsequent accesses of any of these properties for that page will not increment the expensive function count again.

Other properties marked as expensive will always increment the expensive function count the first time they are accessed for a page other than the current page.

mw.uri.encode
Percent-encodes the string. The default type,, encodes spaces using '+' for use in query strings;   encodes spaces as %20; and   encodes spaces as '_'.

Note that the "WIKI" format is not entirely reversible, as both spaces and underscores are encoded as '_'.

mw.uri.decode
Percent-decodes the string. The default type,, decodes '+' to space;   does not perform any extra decoding; and   decodes '_' to space.

mw.uri.anchorEncode
Encodes a string for use in a MediaWiki URI fragment.

mw.uri.buildQueryString
Encodes a table as a URI query string. Keys should be strings; values may be strings or numbers, sequence tables, or boolean false.

mw.uri.parseQueryString
Decodes the query string  to a table. Keys in the string without values will have a value of false; keys repeated multiple times will have sequence tables as values; and others will have strings as values.

The optional numerical arguments  and   can be used to specify a substring of   to be parsed, rather than the entire string. is the position of the first character of the substring, and defaults to 1. is the position of the last character of the substring, and defaults to the length of the string. Both  and   can be negative, as in string.sub.

mw.uri.canonicalUrl
Returns a URI object for the canonical URL for a page, with optional query string/table.

mw.uri.fullUrl
Returns a URI object for the full URL for a page, with optional query string/table.

mw.uri.localUrl
Returns a URI object for the local URL for a page, with optional query string/table.

mw.uri.new
Constructs a new URI object for the passed string or table. See the description of URI objects for the possible fields for the table.

mw.uri.validate
Validates the passed table (or URI object). Returns a boolean indicating whether the table was valid, and on failure a string explaining what problems were found.

URI object
The URI object has the following fields, some or all of which may be nil:


 * protocol: String protocol/scheme
 * user: String user
 * password: String password
 * host: String host name
 * port: Integer port
 * path: String path
 * query: A table, as from mw.uri.parseQueryString
 * fragment: String fragment.

The following properties are also available:
 * userInfo: String user and password
 * hostPort: String host and port
 * authority: String user, password, host, and port
 * queryString: String version of the query table
 * relativePath: String path, query string, and fragment

will give the URI string.

Methods of the URI object are:

mw.uri:parse
Parses a string into the current URI object. Any fields specified in the string will be replaced in the current object; fields not specified will keep their old values.

mw.uri:clone
Makes a copy of the URI object.

mw.uri:extend
Merges the parameters table into the object's query table.

Ustring library
The ustring library is intended to be a direct reimplementation of the standard String library, except that the methods operate on characters in UTF-8 encoded strings rather than bytes.

Most functions will raise an error if the string is not valid UTF-8; exceptions are noted.

mw.ustring.maxPatternLength
The maximum allowed length of a pattern, in bytes.

mw.ustring.maxStringLength
The maximum allowed length of a string, in bytes.

mw.ustring.byte
Returns individual bytes; identical to string.byte.

mw.ustring.byteoffset
Returns the byte offset of a character in the string. The default for both  and   is 1. may be negative, in which case it counts from the end of the string.

The character at  == 1 is the first character starting at or after byte  ; the character at   == 0 is the first character starting at or before byte. Note this may be the same character. Greater or lesser values of  are calculated relative to these.

mw.ustring.char
Much like string.char, except that the integers are Unicode codepoints rather than byte values.

mw.ustring.codepoint
Much like string.byte, except that the return values are codepoints and the offsets are characters rather than bytes.

mw.ustring.find
Much like string.find, except that the pattern is extended as described in Ustring patterns and the  offset is in characters rather than bytes.

mw.ustring.format
Identical to string.format. Widths and precisions for strings are expressed in bytes, not codepoints.

mw.ustring.gcodepoint
Returns three values for iterating over the codepoints in the string. defaults to 1, and  to -1. This is intended for use in the iterator form of :

mw.ustring.gmatch
Much like string.gmatch, except that the pattern is extended as described in Ustring patterns.

mw.ustring.gsub
Much like string.gsub, except that the pattern is extended as described in Ustring patterns.

mw.ustring.isutf8
Returns true if the string is valid UTF-8, false if not.

mw.ustring.len
Returns the length of the string in codepoints, or nil if the string is not valid UTF-8.

See string.len for a similar function that uses byte length rather than codepoints.

mw.ustring.lower
Much like string.lower, except that all characters with lowercase to uppercase definitions in Unicode are converted.

If the Language library is also loaded, this will instead call lc on the default language object.

mw.ustring.match
Much like string.match, except that the pattern is extended as described in Ustring patterns and the  offset is in characters rather than bytes.

mw.ustring.rep
Identical to string.rep.

mw.ustring.sub
Much like string.sub, except that the offsets are characters rather than bytes.

mw.ustring.toNFC
Converts the string to Normalization Form C. Returns nil if the string is not valid UTF-8.

mw.ustring.toNFD
Converts the string to Normalization Form D. Returns nil if the string is not valid UTF-8.

mw.ustring.upper
Much like string.upper, except that all characters with uppercase to lowercase definitions in Unicode are converted.

If the Language library is also loaded, this will instead call uc on the default language object.

Ustring patterns
Patterns in the ustring functions use the same syntax as the String library patterns. The major difference is that the character classes are redefined in terms of Unicode character properties:


 *  : represents all characters with General Category "Letter".
 *  : represents all characters with General Category "Control".
 *  : represents all characters with General Category "Number, decimal digit".
 *  : represents all characters with General Category "Lowercase Letter".
 *  : represents all characters with General Category "Punctuation".
 *  : represents all characters with General Category "Separator", plus tab, linefeed, carriage return, vertical tab, and form feed.
 *  : represents all characters with General Category "Uppercase Letter".
 *  : represents all characters with General Category "Letter" or "Decimal Number".
 *  : adds fullwidth character versions of the hex digits.

Like in String library patterns,  ,  ,  ,  ,  ,  ,    here represent the complementary set ("all characters without given General Category").

In all cases, characters are interpreted as Unicode characters instead of bytes, so ranges such as, patterns such as  , and quantifiers applied to multibyte characters will work correctly. Empty captures will capture the position in code points rather than bytes.

Loadable libraries
These libraries are not included by default, but if needed may be loaded using.

bit32
This emulation of the Lua 5.2  library may be loaded using

bit32 = require( 'bit32' )

The bit32 library provides bitwise operations on unsigned 32-bit integers. Input numbers are truncated to integers (in an unspecified manner) and reduced modulo 232 so the value is in the range 0 to 232−1; return values are also in this range.

When bits are numbered (as in bit32.extract), 0 is the least-significant bit (the one with value 20) and 31 is the most-significant (the one with value 231).

bit32.band
Returns the bitwise AND of its arguments: the result has a bit set only if that bit is set in all of the arguments.

If given zero arguments, the result has all bits set.

bit32.bnot
Returns the bitwise complement of.

bit32.bor
Returns the bitwise OR of its arguments: the result has a bit set if that bit is set in any of the arguments.

If given zero arguments, the result has all bits clear.

bit32.btest
Equivalent to

bit32.bxor
Returns the bitwise XOR of its arguments: the result has a bit set if that bit is set in an odd number of the arguments.

If given zero arguments, the result has all bits clear.

bit32.extract
Extracts  bits from , starting with bit. Accessing bits outside of the range 0 to 31 is an error.

If not specified, the default for  is 1.

bit32.replace
Replaces  bits in , starting with bit  , with the low   bits from. Accessing bits outside of the range 0 to 31 is an error.

If not specified, the default for  is 1.

bit32.lshift
Returns the number  shifted   bits to the left. This is a logical shift: inserted bits are 0. This is generally equivalent to multiplying by 2undefined.

Note that a displacement over 31 will result in 0.

bit32.rshift
Returns the number  shifted   bits to the right. This is a logical shift: inserted bits are 0. This is generally equivalent to dividing by 2undefined.

Note that a displacement over 31 will result in 0.

bit32.arshift
Returns the number  shifted   bits to the right. This is an arithmetic shift: if  is positive, the inserted bits will be the same as bit 31 in the original number.

Note that a displacement over 31 will result in 0 or 4294967295.

bit32.lrotate
Returns the number  rotated   bits to the left.

Note that rotations are equivalent modulo 32: a rotation of 32 is the same as a rotation of 0, 33 is the same as 1, and so on.

bit32.rrotate
Returns the number  rotated   bits to the right.

Note that rotations are equivalent modulo 32: a rotation of 32 is the same as a rotation of 0, 33 is the same as 1, and so on.

libraryUtil
This library contains methods useful when implementing Scribunto libraries. It may be loaded using

libraryUtil = require( 'libraryUtil' )

libraryUtil.checkType
Raises an error if  does not match. In addition, no error will be raised if  is nil and   is true.

is the name of the calling function, and  is the position of the argument in the argument list. These are used in formatting the error message.

libraryUtil.checkTypeMulti
Raises an error if  does not match any of the strings in the array.

This is for arguments that have more than one valid type.

libraryUtil.checkTypeForIndex
Raises an error if  does not match.

This is intended for use in implementing a  metamethod.

libraryUtil.checkTypeForNamedArg
Raises an error if  does not match. In addition, no error will be raised if  is nil and   is true.

This is intended to be used as an equivalent to  in methods called using Lua's "named argument" syntax,.

libraryUtil.makeCheckSelfFunction
This is intended for use in implementing "methods" on object tables that are intended to be called with the  syntax. It returns a function that should be called at the top of these methods with the  argument and the method name, which will raise an error if that   object is not.

This function will generally be used in a library's constructor function, something like this:

luabit
The luabit library modules "bit" and "hex" may be loaded using

bit = require( 'luabit.bit' ) hex = require( 'luabit.hex' )

Note that the bit32 library contains the same operations as "luabit.bit", and the operations in "luabit.hex" may be performed using  and.

The luabit module "noki" is not available, as it is entirely useless in Scribunto. The luabit module "utf8" is also not available, as it was considered redundant to the Ustring library.

ustring
The pure-Lua backend to the Ustring library may be loaded using

ustring = require( 'ustring' )

In all cases the Ustring library should be used instead, as that replaces many of the slower and more memory-intensive operations with callbacks into PHP code.

Extension libraries
Some MediaWiki extensions provide additional Scribunto libraries. These are also located in the table, usually in the table  , however, they are only present when certain extensions are installed (in addition to the Scribunto extension itself).

Such extensions use Scribunto provided hooks:
 * ScribuntoExternalLibraries
 * ScribuntoExternalLibraryPaths

Writing Scribunto libraries provides information on how such libraries can be developed to provide Lua interfaces for MediaWiki extensions.

The following libraries are planned, or are in Gerrit pending review.


 * (none at this time)

mw.wikibase
Wikibase Client provides access to localizable structured data. See Extension:Wikibase Client/Lua. This is supported by Wikidata.

mw.wikibase.lexeme
WikibaseLexeme provides access to Wikibase Lexeme entities. This is supported by Wikidata:Lexicographical data.

mw.wikibase.mediainfo
WikibaseMediaInfo provides access to Wikibase MediaInfo entities. See Extension:WikibaseMediaInfo/Lua. This is supported by Structured Data on Commons. See Commons:Structured data/Lua.

mw.bcmath
BCmath provides arbitrary-precision arithmetic to Lua modules. See BCmath documentation via "LDoc" link at Extension:BCmath.

mw.smw
Semantic Scribunto provides native support for the Scribunto extension to Semantic MediaWiki extension.

mw.ext.data
JsonConfig provides access to localizable tabular and map data. See Extension:JsonConfig/Tabular. Tabular Data and GeoJSON Map Data is supported in Commons "Data:" namespace.

mw.ext.cargo
Cargo provides a means to query its data store from Lua. See Extension:Cargo/Other features.

mw.ext.cattools
CategoryToolbox provides a means to check from Lua if a certain page belongs to a category

mw.ext.FlaggedRevs
FlaggedRevs provides a means to access the stability settings of a page from Lua.

mw.ext.TitleBlacklist
TitleBlacklist provides a means to test and obtain information about blacklisted page naming entries from Lua.

mw.ext.ParserFunctions
ParserFunctions provides a means to evaluate a parser function expressions from Lua.

mw.ext.articlePlaceholder
ArticlePlaceholder provides a means to override default Wikibase renderings from Lua. See Extension:ArticlePlaceholder/Module:AboutTopic.

Changed functions
The following functions have been modified:
 * setfenv
 * getfenv: May not be available, depending on the configuration. If available, attempts to access parent environments will fail.
 * getmetatable: Works on tables only to prevent unauthorized access to parent environments.
 * tostring: Pointer addresses of tables and functions are not provided. This is to make memory corruption vulnerabilities more difficult to exploit.
 * pairs
 * ipairs: Support for the __pairs and __ipairs metamethods (added in Lua 5.2) has been added.
 * pcall
 * xpcall: Certain internal errors cannot be intercepted.
 * require: Can fetch certain built-in modules distributed with Scribunto, as well as modules present in the Module namespace of the wiki. To fetch wiki modules, use the full page name including the namespace. Cannot otherwise access the local filesystem.

Removed functions and packages
The following packages are mostly removed. Only those functions listed are available:
 * package.*: Filesystem and C library access has been removed. Available functions and tables are:
 * package.loaded
 * package.preload
 * package.loaders: Loaders which access the local filesystem or load C libraries are not present. A loader for Module-namespace pages is added.
 * package.seeall


 * os.*: There are some insecure functions in here, such as os.execute, which can't be allowed. Available functions are:
 * os.clock
 * os.date
 * os.difftime
 * os.time


 * debug.*: Most of the functions are insecure. Available functions are:
 * debug.traceback

The following functions and packages are not available:
 * collectgarbage
 * module
 * coroutine.*: No application is known for us, so it has not been reviewed for security.
 * dofile
 * loadfile
 * io.*, file.*: Güvenli olmayan yerel dosya sistemi erişimine izin verir.
 * load
 * loadstring: Lua kaynak kodunun statik analizine izin vermek için bunlar atlanmıştır. Ayrıca, bunlara izin vermek, Lua kodunun makale ve şablon sayfalarına doğrudan eklenmesine izin verir, bu da kullanılabilirlik nedenleriyle istenmez.
 * print: Bu wikitech-l üzerinde tartışılan idi ve kod kalitesini artırmak için dönüş değerleri lehine çıkarılması gerektiğine karar verildi. Gerekirse, hata ayıklama konsoluna bilgi çıkışı için mw.log kullanılabilir.
 * string.dump: Üst verilerden gizli verileri açığa çıkarabilir.

Ek uyarılar

 * Kaynak veri yapıları: Aynı düğüme birden fazla yolla ulaşılabilen dairesel veri yapıları ve veri yapıları PHP'ye doğru bir şekilde gönderilemez. Bunu yapmaya çalışmak tanımsız davranışa neden olur. Bu, bu tür veri yapılarının  tarafından çağrılan modülden döndürülmesini ve bunun gibi parametrelerin Scribunto kütüphanesi işlevlerine aktarılmasını içerir (ancak bunlarla sınırlı değildir). PHP'ye geri çağrı olarak uygulanır. Bu tür veri yapıları,   ile yüklenen modüllerin dönüş değerleri de dahil olmak üzere Lua içinde serbestçe kullanılabilir.

Scribunto kütüphaneleri yazma
Bu bilgiler, Scribunto'nun içine dahil etmek veya kendi uzantıları için bir arabirim sağlamak için ek Scribunto kitaplıkları yazan geliştiriciler için yararlıdır.

Bir Scribunto kütüphanesi genellikle beş bölümden oluşur:


 * Kütüphanenin PHP bölümü.
 * Kütüphanenin Lua kısmı.
 * Test senaryolarının PHP kısmı.
 * Test vakalarının Lua kısmı.
 * Belgelendirme.

Mevcut kütüphaneler buna iyi bir örnektir.

Kütüphane
Kütüphanenin PHP kısmı,  genişletmesi gereken bir sınıftır. Uygulama ayrıntıları için o sınıfın belgelerine bakın. Scribunto uzantısında, bu dosya  içine yerleştirilmeli ve   bir eşleme eklenmelidir. Diğer uzantılar ScribuntoExternalLibraries kancasını kullanmalıdır. Her iki durumda da, anahtar Lua modülü adıyla eşleşmelidir (Scribunto'daki kütüphaneler için "mw.name" veya uzantı kütüphaneleri için "mw.ext.name").

Kütüphanenin Lua kısmı, Lua modüllerinden çağrılabilen işlevleri içeren bir tablo oluşturur. Scribunto uzantısında, dosya  içine yerleştirilmelidir. Bu dosya genellikle böyle bir şeyi içermelidir:

içindeki modül (bunu  ile yükleyin) yardımcı olabilecek bazı işlevler içerir.

Scribunto test senaryolarını, kütüphaneniz test senaryoları sağlamasa bile, kütüphaneniz yüklü olarak çalıştırdığınızdan emin olun. Standart test senaryoları, beklenmedik global değişkenler ekleyen kütüphaneler gibi şeyleri içeren testleri içerir. Ayrıca, kitaplık PHP ile yüklüyse, Lua işlevlerinin sahip olduğu yükseltmeler #invoke arasında sıfırlanmaz. Modüllerin #invoke arasında bilgi aktarmak için bunu kötüye kullanmamasına dikkat edilmelidir.

Test senaryoları
Scribunto uzantısı, testleri hem LuaSandbox hem de LuaStandalone motorlarına karşı çalıştıracak  test senaryoları için bir temel sınıf içerir. Kitaplığın test durumu bu sınıfı genişletmeli ve  geçersiz kılmamalıdır. Scribunto uzantısında, test durumu  olmalı ve diziye   (  olarak) eklenmelidir; uzantıları test durumunu kendi   kanca işlevine eklemelidir, muhtemelen   ayarlanıp ayarlanmadığına bağlıdır.

Çoğu zaman, test senaryosunu yapmak için gereken tek şey şudur:

class ClassNameTest extends Scribunto_LuaEngineTestBase { protected static $moduleName = 'ClassNameTest'; function getTestModules { return parent::getTestModules + array(             'ClassNameTest' => __DIR__ . '/ClassNameTests.lua';          ); } }

Bu,  dosyasını "Modüi:ClassNameTests" sayfasındaymış gibi yükler ve aşağıdaki özelliklere sahip bir nesneyi döndürmesini bekler:


 * count: Tam sayı, test sayısı
 * provide( n ): Üç değer döndüren işlev:, test kodu   ve test   için beklenen çıkış olan bir dize.
 * run( n ):  testini çalıştıran ve bir dize döndüren işlev.

gösterildiği gibi bildirilirse, birçok yararlı yardımcı yöntem sağlayan "Modül:TestFramework" kullanılabilir. Bu kullanılırsa,  şuna benzer:

local testframework = require 'Module:TestFramework' return testframework.getTestProvider( {    -- Testler buraya gider } )

Her testin kendisi, aşağıdaki özelliklere sahip bir tablodur:


 * name: Testin adı.
 * func: Yürütülecek işlev.
 * args: İşleve iletilecek isteğe bağlı bağımsız değişken tablosu.
 * expect: Beklenecek sonuçlar.
 * type: Testin isteğe bağlı "type", varsayılan "Normal".

Tür,  biçimini ve   öğesinin nasıl çağrıldığını denetler. Dahil edilen türler:


 * Normal:, bir dönüş değerleri tablosu veya testin bir hata oluşturması gerekiyorsa bir dizedir.   basitçe çağrılır.
 * Iterator:, dönüş değerleri tablosunun bir tablosudur.  , döngü için yinelenir ile çağrılır ve her yinelemenin dönüş değerleri toplanır.
 * ToString: "Normal" gibi, ancak her dönüş değeri  öğesinden geçirilir.

Başka bir uzantıdaki test senaryoları
PHPUnit testlerini çalıştırmanın (en az) iki yolu vardır:


 * 1) Çekirdeklere karşı phpunit komutunu çalıştırın ve tests/phpunit/suites/ExtensionsTestSuite.php dosyasının UnitTestsList kancası kullanarak uzantının testlerini bulmasına izin verin. Uzantınızın test sınıfı adlarının tümü benzersiz bir bileşen içeriyorsa (örn. uzantının adı),   seçeneği yalnızca uzantınızın testlerini çalıştırmak için kullanılabilir.
 * 2) Phpunit'i, "Test.php" ile biten herhangi bir dosyayı alacağı uzantı dizinine karşı çalıştırın.

Scribunto LocalSettings.php dosyasına yüklenmişse, bunlardan her ikisi de iyi çalışır. ayarlanmadığında UnitTestsList kancası Scribunto testini döndürmekten kaçınmak için Scribunto yüklü değilse yöntem 1'in çalışması kolaydır.

Ancak Jenkins yöntem #2'yi kullanır. Jenkins'in testleri düzgün bir şekilde yürütmesi için, uzantınıza bağımlılık olarak Scribunto eklemeniz gerekir. Bunun nasıl yapıldığına dair bir örnek için sayfasına bakın.

Herhangi bir nedenle testlerin Scribunto yüklenmeden #2 yöntemini kullanarak çalışabilmesi gerekiyorsa, bir çözüm, bu denetimi birim test dosyanızın üstüne eklemektir:

Belgelendirme
Scribunto'da bulunan modüller, yukarıdaki Scribunto kütüphaneleri bölümündeki belgeleri içermelidir. Uzantı kitaplıkları, kendi uzantı sayfalarının bir alt sayfasına belge içermeli ve yukarıdaki Uzantı kitaplıkları alt bölümündeki dokümanlara bağlantı vermelidir.

Ayrıca bakınız

 * tr:Lua (programlama dili)

Lisans
Bu kılavuz, MIT lisansı altında bulunan Lua 5.1 kaynak kılavuzundan türetilmiştir.

Bu türev kitapçığı aynı lisansın koşulları altında da kopyalanabilir.