Шаблон:Scribunto/документація

Використання

Цей шаблон допомагає створювати сторінки документацій для метамодулів Lua, що посилаються на Документація Scribunto або певну функцію з нього.

{{scribunto
|<!--якірець-->
|<!--текст посилання-->
}}

Якщо якірець надано, то посилання буде обгорнути в <code>...</code>. Наприклад:{{scribunto|mw.html.create}}створює це посилання:  mw.html.create

{{scribunto|HTML_library|mw.html}}створює це посилання: mw.html

Розширене використання

|self= та |args=

Шаблон:Seealso2 Ви можете також використати |self={{PAGENAME}}, щоб посилатися на ваші власні функції, та |args=, щоб вказати аргументи, наприклад:{{scribunto|self=Buffer/doc|:_all|args=...}}створює це посилання:  Buffer:_all( ... )

Якщо перший символ збігається з шаблоном ^[:%.], тоді назва, що вказана в |self=, буде вставлена на початку, мінус будь-які підсторінки, якщо не зроблено екранування через використання \: {{scribunto|self=Example\/testcases/doc|.test1|args=string}}створює:  Example/testcases.test1( string )

без 'main'

Якщо ваш модуль не має методу «main» (наприклад, Модуль:Buffer), ви можете передати символ екранування \ як перший символ в назві функції, щоб зробити самопосилання:{{scribunto|self=Buffer/doc|\|args=...}}створює:  Buffer( ... ) '

Якщо другий параметр містить ***, тоді буде підставлено перший параметр (або зроблено самопосилення, залежно від ситуації): {{scribunto|self=Buffer|\|require('Module:***')|args=...}}require('Module:Buffer')( ... )

|args2= та |args3=

Використовується, щоб зазначати до 3 варіантів аргументів.{{scribunto|table.insert|args=table, value|args2=table, pos, value}} table.insert( table, value )

table.insert( table, pos, value )

|plain=

Якщо встановлено будь-яке значення, то результат більше не буде огорнутий в <code>...</code>.

Див. також

• {{Scribunto/helper}} та {{Scribunto/helper2}}, два допоміжних шаблони. Вони не повинні викликатися напряму.
• {{Luaself}}, шаблон-обгортка, що спрощує створення самореференції Lua.
• Модуль:Ustring/документація, приклад документації, що використовує цей шаблон
• {{Lua}}
• Категорія:Метамодулі Lua