Шаблон:OnLua/doc: различия между версиями

Материал из wikixw
Перейти к навигации Перейти к поиску
(Полностью удалено содержимое страницы)
Метки: очистка отменено
Метка: ручная отмена
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
{{docpage}}
{{OnLua|Transclude|npc|partly=1}}__NOTOC__
Шаблон для пометки шаблонов, использующих функционал расширения [[mw:Extension:Scribunto|Scribunto]]. Обычно ставится в начале документаций шаблонов.


== Использование ==
{{tpre|onLua<br>
|''имя модуля''<br>
{{optp|''имя функции''<br>
|funcref {{=}} ''нестандартная ссылка на функцию или''
|line {{=}} ''номер строки кода''<br>
|tech {{=}} ''текст после слов «с использованием»''<br>
|partly {{=}} ''если шаблон реализован на основе модуля частично''<br><br>
|module2…∞ {{=}} ''имя модуля 2…∞''<br>
|function2…∞ {{=}} ''имя функции 2…∞''<br>
|funcref2…∞ {{=}} ''нестандартная ссылка на функцию 2…∞''<br>
|line2…∞ {{=}} ''номер строки кода 2…∞''<br>
|tech2…∞ {{=}} ''текст после слов «с использованием» 2…∞''<br><br>
|nocat{{=}}1<br>
|_spaced=1}}|_spaced=1}}
{{optp/comment}}
<pre>{{onLua|модуль|функция}}</pre>
или
<pre>{{onLua
| 1 = модуль
| 2 = функция
}}</pre>
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]]
Первый параметр — название модуля, второй — имя функции. По умолчанию, если имя функции указано, оно оформляется ссылкой на раздел на странице модуля с таким именем.
Можно перенаправить на любую другую страницу, указав параметр <code>funcref</code>, или дать ссылку на строку в редакторе модуля параметром <code>line</code> (переход будет непосредственно на редактирование).
Текст после слов «с использованием» можно переопределить параметром <code>tech</code>. Шаблон будет добавлен в категорию {{cl|Шаблоны, использующие Scribunto}}. При этом на подстранице документации (определяется по равенству переменной {{mwmw|SUBPAGENAME}} параметру <code>doc</code>, по умолчанию «doc») категория не работает.
Непустое значение параметра <code>partly</code> добавит слово «частично» к «реализован».
Если модуль не указан, добавится [[:Категория:Шаблоны, использующие Lua, без указания модуля]].
== Примеры ==
{{стопка примеров|style=pre|opener=*|nocat=1
|1=Ru\o
|2=partly=1\ParamValue2Value\_before=«Частично» реализован:
}}
== См. также ==
* {{t|onTS}} (стили шаблона)
* {{t|toLua}}
* [[Wikixw:Модули]]
<includeonly>
[[Категория:Шаблоны:Для шаблонов]]
[[Категория:Шаблоны:Lua]]
[[Категория:Шаблоны:Ссылки на модули]]
</includeonly>

Текущая версия от 07:46, 29 июня 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. Шаблон будет добавлен в категорию . При этом на подстранице документации (определяется по равенству переменной {{SUBPAGENAME}} параметру doc, по умолчанию «doc») категория не работает.

Непустое значение параметра partly добавит слово «частично» к «реализован».

Если модуль не указан, добавится Категория:Шаблоны, использующие Lua, без указания модуля.

Примеры[править]

  •  
    {{OnLua|Ru|o}}
  • «Частично» реализован:
    {{OnLua|partly=1|ParamValue2Value}}

См. также[править]