Модуль:Arguments/doc: различия между версиями

Материал из Народные сказки
Перейти к навигации Перейти к поиску
Нет описания правки
Нет описания правки
Строка 290: Строка 290:
Опция {{var|wrappers}} используется для указания ограниченного числа шаблонов как ''шаблонов-обёрток'', то есть шаблонов, чьей единственной целью является вызов модуля. Если модуль обнаружит, что вызывается из шаблона-обёртки, то будут проверяться только аргументы родительского фрейма, иначе будут проверяться только аргументы непосредственного вызывающего фрейма. Это позволяет вызвать модули через {{code|#invoke}} и через шаблон-обёртку без потери производительности из-за поиска аргументов в двух фреймах.
Опция {{var|wrappers}} используется для указания ограниченного числа шаблонов как ''шаблонов-обёрток'', то есть шаблонов, чьей единственной целью является вызов модуля. Если модуль обнаружит, что вызывается из шаблона-обёртки, то будут проверяться только аргументы родительского фрейма, иначе будут проверяться только аргументы непосредственного вызывающего фрейма. Это позволяет вызвать модули через {{code|#invoke}} и через шаблон-обёртку без потери производительности из-за поиска аргументов в двух фреймах.


Например, единственное содержимое шаблона {{Tl|optp}} вне тэгов {{tag|noinclude}} это вызов <nowiki>{{#invoke:Template call code|onlyParams}}</nowiki>. Нет смысла проверять аргументы, передаваемые {{code|#invoke}} на странице шаблона, поскольку там их никогда не будет. Этого можно избежать с помощью опции {{var|parentOnly}}, но тогда {{code|#invoke}} не будет работать и на других страницах. В таком случае параметр {{Para|text|Некий текст}} в коде <code><nowiki>{{#invoke:Template call code|onlyParams|text=Некий текст}}</nowiki></code> игнорировался бы на всех страницах. Но если мы укажем в опции {{var|wrappers}}  'Шаблон:Optp', код <code><nowiki>{{#invoke:Template call code|onlyParams|text=Некий текст}}</nowiki></code> будет работать на всех страницах, не проверяя аргументы на странице шаблона.
Например, единственное содержимое шаблона {{Tl|optp}} вне тэгов {{Tag|noinclude}} это вызов <nowiki>{{#invoke:Template call code|onlyParams}}</nowiki>. Нет смысла проверять аргументы, передаваемые {{code|#invoke}} на странице шаблона, поскольку там их никогда не будет. Этого можно избежать с помощью опции {{var|parentOnly}}, но тогда {{code|#invoke}} не будет работать и на других страницах. В таком случае параметр {{Para|text|Некий текст}} в коде <code><nowiki>{{#invoke:Template call code|onlyParams|text=Некий текст}}</nowiki></code> игнорировался бы на всех страницах. Но если мы укажем в опции {{var|wrappers}}  'Шаблон:Optp', код <code><nowiki>{{#invoke:Template call code|onlyParams|text=Некий текст}}</nowiki></code> будет работать на всех страницах, не проверяя аргументы на странице шаблона.


Обёртки могут задаваться строкой или массивом строк.
Обёртки могут задаваться строкой или массивом строк.
Строка 328: Строка 328:
Данный модуль использует [[mw:Extension:Scribunto/Lua reference manual/ru#Metatables|метатаблицы]], чтобы получить аргументы {{code|#invoke}}. Это даёт доступ одновременно к аргументом фрейма и родительского фрейма без использования функции {{luacode|pairs()|inline=1}}. Это может быть полезно при передаче на вход тэгов {{xtag|ref|p}}.
Данный модуль использует [[mw:Extension:Scribunto/Lua reference manual/ru#Metatables|метатаблицы]], чтобы получить аргументы {{code|#invoke}}. Это даёт доступ одновременно к аргументом фрейма и родительского фрейма без использования функции {{luacode|pairs()|inline=1}}. Это может быть полезно при передаче на вход тэгов {{xtag|ref|p}}.


Поскольку из Lua происходит доступ к тэгам {{tag|ref}}, они обрабатываются движком MediaWiki и примечание появляется в списке примечаний ({{tag|referenes|s}}). Если модуль не выводит содержимое тэгов, то может появиться сноска-призрак, отображающаяся только в списке примечаний, но не в основном тексте. Это может являться проблемой для модулей, использующих {{luacode|pairs()|inline=1}} для доступа к аргументам, поскольку эта функция осуществляет доступ ко всем доступным аргументам.
Поскольку из Lua происходит доступ к тэгам {{Tag|ref}}, они обрабатываются движком MediaWiki и примечание появляется в списке примечаний ({{Tag|referenes|s}}). Если модуль не выводит содержимое тэгов, то может появиться сноска-призрак, отображающаяся только в списке примечаний, но не в основном тексте. Это может являться проблемой для модулей, использующих {{luacode|pairs()|inline=1}} для доступа к аргументам, поскольку эта функция осуществляет доступ ко всем доступным аргументам.


Эта проблема не стоит при использовании данного модуля, поскольку хотя доступ к аргументам производится только по необходимости. Однако же при явном вызове {{luacode|pairs(args)|inline=1}} в коде функций, ошибочное поведение может воспроизводиться.
Эта проблема не стоит при использовании данного модуля, поскольку хотя доступ к аргументам производится только по необходимости. Однако же при явном вызове {{luacode|pairs(args)|inline=1}} в коде функций, ошибочное поведение может воспроизводиться.

Версия от 23:04, 13 мая 2023

Шаблон:Module rating

Данный модуль служит для облегчения обработки аргументов, передаваемых в #invoke. Это мета-модуль, предназначенный для использования в других модулях, а не вики-страницах напрямую. Его функционал включает:

  • Облегчение обрезки аргументов и удаления пустых аргументов.
  • Аргументы, передаваемые не только текущим фреймов, но и родительским фреймом. (См. ниже)
  • Аргументы, передаваемые из другого модуля или отладочной консоли.
  • Аргументы передаются как надо, что может помочь избежать части проблем с тэгами Шаблон:xtag.
  • Большинство возможностей поддаются настройке.

Базовое использование

Первым делом, необходимо загрузить модуль. Он содержит всего одну функцию — Шаблон:code. Шаблон:Luacode В наиболее простом сценарии вы можете использовать Шаблон:code в главной функции вашего модуля. Переменная Шаблон:code содержит таблицу аргументов, переданных в Шаблон:code.

Шаблон:Luacode

Тем не менее, принятая практика заключается в использовании функции отдельной функции для получения аргуметов из Шаблон:code и отдельной функции для их обработки — чтобы было проще вызывать ваши функции из другого модуля без передачи аргумента Шаблон:code, что положительно влияет на производительность.

Шаблон:Luacode

Если вам нужно несколько разных функций, использующих аргументы вызова, вы можете использовать функцию-обёртку.

Шаблон:luacode

Опции

Доступные опции приведены ниже. Шаблон:luacode

Обрезка и удаление пробелов

Пустые аргументы могут представлять сложность при портировании кода шаблонов на Lua. В синтаксисе шаблонов пустые строки или строки из пробелов приравниваются к Шаблон:luafalse. В Lua же такие строки соответствуют Шаблон:luatrue. Поэтому, если вы уделите недостаточно внимания обработке таких аргументов, может нарушиться задуманная логика шаблона. Чтобы избежать такого развития событий, по умолчанию модуль удаляет все пустые аргументы.

Кроме того, пробелы могут вызывать проблемы при обработке позиционных аргументов. При вызове Шаблон:code из именованных параметров пробелы по краям удаляются сами, но сохраняются для позиционных параметров. Большинство таких пробелов на самом деле не нужно, поэтому модуль по умолчанию их обрезает.

Однако же, если требуется сохранить эти пробелы, можно задать опциям Шаблон:code и Шаблон:code значение Шаблон:luafalse.

Шаблон:luacode

Произвольное форматирование аргументов

В некоторых случаях может потребоваться удалить только часть пустых аргументов или, например, привести все позиционные аргументы к нижнему регистру. Для этого можно использовать опцию Шаблон:code. На вход этой опции должна подавиться функция от двух параметров, Шаблон:var и Шаблон:var, возвращающая единственное значение. Это значение будет записано в поле Шаблон:code таблицы Шаблон:code.

Пример 1: оставлять нетронутыми пробелы в первом позиционном аргументе и применять стандартную обрезку для прочих. Шаблон:luacode

Пример 2: удалить пробельные и пустые аргументы и привести все аргументы к нижнему регистру, но не обрезать пробелы из позиционных аргументов. Шаблон:luacode

Замечание: функции выше выдадут ошибку, если входные аргументы не будут принадлежать к типу Шаблон:code или Шаблон:luanil. Это может произойти при вызове функции Шаблон:code из другого модуля. В этом случае требуется проверка типов. В обычном случае при вызове из Шаблон:code такая проблема не стоит.