Шаблон:OnLua/doc: различия между версиями
Andras (обсуждение | вклад) (Новая страница: «{{docpage}} {{OnLua|Transclude|npc|partly=1}}__NOTOC__ Шаблон для пометки шаблонов, использующих функционал расширения Scribunto. Обычно ставится в начале документаций шаблонов. == Использование == {{tpre|onLua<br> |''имя модуля''<br> {{optp|''имя функции''<br> |funcref {{=}} ''нестандартная...») |
Andras (обсуждение | вклад) Нет описания правки |
||
| (не показано 5 промежуточных версий этого же участника) | |||
| Строка 1: | Строка 1: | ||
{{ | {{Docpage}} | ||
{{OnLua|Transclude|npc|partly=1}}__NOTOC__ | {{OnLua|Transclude|npc|partly=1}}__NOTOC__ | ||
Шаблон для пометки шаблонов, использующих функционал расширения [[mw:Extension:Scribunto|Scribunto]]. Обычно ставится в начале документаций шаблонов. | Шаблон для пометки шаблонов, использующих функционал расширения [[mw:Extension:Scribunto|Scribunto]]. Обычно ставится в начале документаций шаблонов. | ||
== Использование == | == Использование == | ||
{{ | {{Tpre|OnLua<br> | ||
|''имя модуля''<br> | |''имя модуля''<br> | ||
{{ | {{Optp|''имя функции''<br> | ||
|funcref {{=}} ''нестандартная ссылка на функцию или'' | |funcref {{=}} ''нестандартная ссылка на функцию или'' | ||
|line {{=}} ''номер строки кода''<br> | |line {{=}} ''номер строки кода''<br> | ||
| Строка 18: | Строка 18: | ||
|nocat{{=}}1<br> | |nocat{{=}}1<br> | ||
|_spaced=1}}|_spaced=1}} | |_spaced=1}}|_spaced=1}} | ||
{{ | {{Optp/comment}} | ||
<pre>{{ | <pre>{{OnLua|модуль|функция}}</pre> | ||
или | или | ||
<pre>{{ | <pre>{{OnLua | ||
| 1 = модуль | | 1 = модуль | ||
| 2 = функция | | 2 = функция | ||
| Строка 32: | Строка 32: | ||
Можно перенаправить на любую другую страницу, указав параметр <code>funcref</code>, или дать ссылку на строку в редакторе модуля параметром <code>line</code> (переход будет непосредственно на редактирование). | Можно перенаправить на любую другую страницу, указав параметр <code>funcref</code>, или дать ссылку на строку в редакторе модуля параметром <code>line</code> (переход будет непосредственно на редактирование). | ||
Текст после слов «с использованием» можно переопределить параметром <code>tech</code>. Шаблон будет добавлен в категорию {{ | Текст после слов «с использованием» можно переопределить параметром <code>tech</code>. Шаблон будет добавлен в категорию {{Cl|Шаблоны, использующие Scribunto}}. При этом на подстранице документации (определяется по равенству переменной {{Mwmw|SUBPAGENAME}} параметру <code>doc</code>, по умолчанию «doc») категория не работает. | ||
Непустое значение параметра <code>partly</code> добавит слово «частично» к «реализован». | Непустое значение параметра <code>partly</code> добавит слово «частично» к «реализован». | ||
| Строка 39: | Строка 39: | ||
== Примеры == | == Примеры == | ||
{{ | {{Стопка примеров|style=pre|opener=*|nocat=1 | ||
|1=Ru\o | |1=Ru\o | ||
|2=partly=1\ParamValue2Value\_before=«Частично» реализован: | |2=partly=1\ParamValue2Value\_before=«Частично» реализован: | ||
Текущая версия от 07:30, 15 мая 2023
 |
 |
Шаблон для пометки шаблонов, использующих функционал расширения Scribunto. Обычно ставится в начале документаций шаблонов.
Использование
{{OnLua
|имя модуля
|имя функции
|funcref = нестандартная ссылка на функцию или |line = номер строки кода
|tech = текст после слов «с использованием»
|partly = если шаблон реализован на основе модуля частично
|module2…∞ = имя модуля 2…∞
|function2…∞ = имя функции 2…∞
|funcref2…∞ = нестандартная ссылка на функцию 2…∞
|line2…∞ = номер строки кода 2…∞
|tech2…∞ = текст после слов «с использованием» 2…∞
|nocat=1
}}
Серым показаны необязательные параметры.
{{OnLua|модуль|функция}}
или
{{OnLua
| 1 = модуль
| 2 = функция
}}
Whitespace characters (spaces, tabs, returns) are stripped from the beginnings and ends of named parameter names and values. This does not apply to unnamed parameters, where all whitespace characters are preserved. en:WP:PARAMETER
Первый параметр — название модуля, второй — имя функции. По умолчанию, если имя функции указано, оно оформляется ссылкой на раздел на странице модуля с таким именем.
Можно перенаправить на любую другую страницу, указав параметр funcref, или дать ссылку на строку в редакторе модуля параметром line (переход будет непосредственно на редактирование).
Текст после слов «с использованием» можно переопределить параметром tech. Шаблон будет добавлен в категорию Шаблоны, использующие Scribunto. При этом на подстранице документации (определяется по равенству переменной {{SUBPAGENAME}} параметру doc, по умолчанию «doc») категория не работает.
Непустое значение параметра partly добавит слово «частично» к «реализован».
Если модуль не указан, добавится Категория:Шаблоны, использующие Lua, без указания модуля.
Примеры
{{OnLua|Ru|o}}
- «Частично» реализован:
{{OnLua|partly=1|ParamValue2Value}}→Этот шаблон частично реализован на основе Lua с использованием модуля ParamValue2Value.
См. также
- {{onTS}} (стили шаблона)
- {{toLua}}
- Википедия:Модули