Модуль:Arguments/doc - История изменений

Andras в 10:49, 18 июня 2023

2023-06-18T10:49:04Z

← Предыдущая версия		Версия от 10:49, 18 июня 2023
Строка 1:		Строка 1:
	{{Docpage}}		{{Docpage}}
	{{СИШ\|nocat=1}}		{{СИШ\|nocat=1}}
	{{~~Module rating~~\|protected}}		{{Рейтинг модуля\|protected}}
	{{Используйте песочницу}}		{{Используйте песочницу}}
	Данный модуль служит для облегчения обработки аргументов, передаваемых в {{Code\|#invoke}}. Это мета-модуль, предназначенный для использования в других модулях, а не вики-страницах напрямую. Его функционал включает:		Данный модуль служит для облегчения обработки аргументов, передаваемых в {{Code\|#invoke}}. Это мета-модуль, предназначенный для использования в других модулях, а не вики-страницах напрямую. Его функционал включает:

Andras в 15:35, 15 мая 2023

2023-05-15T15:35:11Z

← Предыдущая версия		Версия от 15:35, 15 мая 2023
Строка 7:		Строка 7:
	* Аргументы, передаваемые не только текущим фреймов, но и родительским фреймом. (См. ниже)		* Аргументы, передаваемые не только текущим фреймов, но и родительским фреймом. (См. ниже)
	* Аргументы, передаваемые из другого модуля или отладочной консоли.		* Аргументы, передаваемые из другого модуля или отладочной консоли.
	* Аргументы передаются как надо, что может помочь избежать части проблем с тэгами {{~~xtag~~\|ref\|p}}.		* Аргументы передаются как надо, что может помочь избежать части проблем с тэгами {{Xtag\|ref\|p}}.
	* Большинство возможностей поддаются настройке.		* Большинство возможностей поддаются настройке.

Строка 326:		Строка 326:

	=== Тэги ref ===		=== Тэги ref ===
	Данный модуль использует [[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}} для доступа к аргументам, поскольку эта функция осуществляет доступ ко всем доступным аргументам.

Andras в 11:36, 15 мая 2023

2023-05-15T11:36:35Z

← Предыдущая версия		Версия от 11:36, 15 мая 2023
Строка 187:		Строка 187:
	})		})
	}}		}}
	{{~~конец~~ скрытого блока}}		{{Конец скрытого блока}}

	Также следует обращать внимание, что функция {{Code\|valueFunc}} вызывается приблизительно при каждом запросе к таблице {{Code\|args}}, так что если стоит вопрос производительности, эта функция не должна быть дорогой.		Также следует обращать внимание, что функция {{Code\|valueFunc}} вызывается приблизительно при каждом запросе к таблице {{Code\|args}}, так что если стоит вопрос производительности, эта функция не должна быть дорогой.
Строка 212:		Строка 212:
	return p		return p
	}}		}}
	{{~~конец~~ скрытого блока}}		{{Конец скрытого блока}}

	{{Code\|Модуль:ExampleArgs}} вызывается шаблоном {{Tc\|ExampleArgs}}, код которого — {{Tc\|#invoke:ExampleArgs\|main\|первый_аргумент_вызова}}. По умолчанию он возвращает текст «первый_аргумент_вызова».		{{Code\|Модуль:ExampleArgs}} вызывается шаблоном {{Tc\|ExampleArgs}}, код которого — {{Tc\|#invoke:ExampleArgs\|main\|первый_аргумент_вызова}}. По умолчанию он возвращает текст «первый_аргумент_вызова».

Andras в 20:40, 14 мая 2023

2023-05-14T20:40:54Z

← Предыдущая версия		Версия от 20:40, 14 мая 2023
Строка 147:		Строка 147:
	}}		}}

	Замечание: функции выше выдадут ошибку, если входные аргументы не будут принадлежать к типу {{Code\|string}} или {{~~Luanil~~}}. Это может произойти при вызове функции {{Code\|getArgs}} из другого модуля. В этом случае требуется проверка типов. В обычном случае при вызове из {{Code\|#invoke}} такая проблема не стоит.		Замечание: функции выше выдадут ошибку, если входные аргументы не будут принадлежать к типу {{Code\|string}} или {{LuaNil}}. Это может произойти при вызове функции {{Code\|getArgs}} из другого модуля. В этом случае требуется проверка типов. В обычном случае при вызове из {{Code\|#invoke}} такая проблема не стоит.

	{{Начало скрытого блока\|Примеры 1 и 2 с проверкой типов}}		{{Начало скрытого блока\|Примеры 1 и 2 с проверкой типов}}

Andras в 19:43, 14 мая 2023

2023-05-14T19:43:18Z

← Предыдущая версия		Версия от 19:43, 14 мая 2023
Строка 147:		Строка 147:
	}}		}}

	Замечание: функции выше выдадут ошибку, если входные аргументы не будут принадлежать к типу {{Code\|string}} или {{~~luanil~~}}. Это может произойти при вызове функции {{Code\|getArgs}} из другого модуля. В этом случае требуется проверка типов. В обычном случае при вызове из {{Code\|#invoke}} такая проблема не стоит.		Замечание: функции выше выдадут ошибку, если входные аргументы не будут принадлежать к типу {{Code\|string}} или {{Luanil}}. Это может произойти при вызове функции {{Code\|getArgs}} из другого модуля. В этом случае требуется проверка типов. В обычном случае при вызове из {{Code\|#invoke}} такая проблема не стоит.

	{{Начало скрытого блока\|Примеры 1 и 2 с проверкой типов}}		{{Начало скрытого блока\|Примеры 1 и 2 с проверкой типов}}

Andras в 19:40, 14 мая 2023

2023-05-14T19:40:53Z

← Предыдущая версия		Версия от 19:40, 14 мая 2023
Строка 98:		Строка 98:

	=== Обрезка и удаление пробелов ===		=== Обрезка и удаление пробелов ===
	Пустые аргументы могут представлять сложность при портировании кода шаблонов на Lua. В синтаксисе шаблонов пустые строки или строки из пробелов приравниваются к {{~~luafalse~~}}. В Lua же такие строки соответствуют {{LuaTrue}}. Поэтому, если вы уделите недостаточно внимания обработке таких аргументов, может нарушиться задуманная логика шаблона. Чтобы избежать такого развития событий, по умолчанию модуль удаляет все пустые аргументы.		Пустые аргументы могут представлять сложность при портировании кода шаблонов на Lua. В синтаксисе шаблонов пустые строки или строки из пробелов приравниваются к {{LuaFalse}}. В Lua же такие строки соответствуют {{LuaTrue}}. Поэтому, если вы уделите недостаточно внимания обработке таких аргументов, может нарушиться задуманная логика шаблона. Чтобы избежать такого развития событий, по умолчанию модуль удаляет все пустые аргументы.

	Кроме того, пробелы могут вызывать проблемы при обработке позиционных аргументов. При вызове {{Code\|#invoke}} из именованных параметров пробелы по краям удаляются сами, но сохраняются для позиционных параметров. Большинство таких пробелов на самом деле не нужно, поэтому модуль по умолчанию их обрезает.		Кроме того, пробелы могут вызывать проблемы при обработке позиционных аргументов. При вызове {{Code\|#invoke}} из именованных параметров пробелы по краям удаляются сами, но сохраняются для позиционных параметров. Большинство таких пробелов на самом деле не нужно, поэтому модуль по умолчанию их обрезает.

	Однако же, если требуется сохранить эти пробелы, можно задать опциям {{Code\|trim}} и {{Code\|removeBlanks}} значение {{~~luafalse~~}}.		Однако же, если требуется сохранить эти пробелы, можно задать опциям {{Code\|trim}} и {{Code\|removeBlanks}} значение {{LuaFalse}}.

	{{LuaCode\|1=		{{LuaCode\|1=
Строка 313:		Строка 313:
	Замечания:		Замечания:
	# Модуль автоматически определяет, если вызывается с подстраницы /песочница шаблона-обёртки, такие страницы не надо задавать явным образом.		# Модуль автоматически определяет, если вызывается с подстраницы /песочница шаблона-обёртки, такие страницы не надо задавать явным образом.
	# Опция{{Var\|wrappers}} изменяет поведение по умолчанию опций {{Var\|frameOnly}} и {{Var\|parentOnly}}. Например, если {{Var\|parentOnly}} явным образом установлена в {{~~luafalse~~}} при установленных {{Var\|wrappers}}, вызов через обёртку будет приводить к проверке аргументов текущего и родительского фрейма, тогда как другие вызовы будут проверять только текущие аргументы.		# Опция{{Var\|wrappers}} изменяет поведение по умолчанию опций {{Var\|frameOnly}} и {{Var\|parentOnly}}. Например, если {{Var\|parentOnly}} явным образом установлена в {{LuaFalse}} при установленных {{Var\|wrappers}}, вызов через обёртку будет приводить к проверке аргументов текущего и родительского фрейма, тогда как другие вызовы будут проверять только текущие аргументы.
	# Если опция {{Var\|wrappers}} установлена и родительский фрейм недоступен, модуль всегда будет получать аргументы, переданные функции {{Code\|getArgs}}.		# Если опция {{Var\|wrappers}} установлена и родительский фрейм недоступен, модуль всегда будет получать аргументы, переданные функции {{Code\|getArgs}}.

Andras в 19:39, 14 мая 2023

2023-05-14T19:39:29Z

← Предыдущая версия		Версия от 19:39, 14 мая 2023
Строка 98:		Строка 98:

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

	Кроме того, пробелы могут вызывать проблемы при обработке позиционных аргументов. При вызове {{Code\|#invoke}} из именованных параметров пробелы по краям удаляются сами, но сохраняются для позиционных параметров. Большинство таких пробелов на самом деле не нужно, поэтому модуль по умолчанию их обрезает.		Кроме того, пробелы могут вызывать проблемы при обработке позиционных аргументов. При вызове {{Code\|#invoke}} из именованных параметров пробелы по краям удаляются сами, но сохраняются для позиционных параметров. Большинство таких пробелов на самом деле не нужно, поэтому модуль по умолчанию их обрезает.

Andras в 19:34, 14 мая 2023

2023-05-14T19:34:28Z

← Предыдущая версия		Версия от 19:34, 14 мая 2023
Строка 112:		Строка 112:

	=== Произвольное форматирование аргументов ===		=== Произвольное форматирование аргументов ===
	В некоторых случаях может потребоваться удалить только часть пустых аргументов или, например, привести все позиционные аргументы к нижнему регистру. Для этого можно использовать опцию {{Code\|valueFunc}}. На вход этой опции должна подавиться функция от двух параметров, {{~~var~~\|key}} и {{~~var~~\|value}}, возвращающая единственное значение. Это значение будет записано в поле {{Code\|key}} таблицы {{Code\|args}}.		В некоторых случаях может потребоваться удалить только часть пустых аргументов или, например, привести все позиционные аргументы к нижнему регистру. Для этого можно использовать опцию {{Code\|valueFunc}}. На вход этой опции должна подавиться функция от двух параметров, {{Var\|key}} и {{Var\|value}}, возвращающая единственное значение. Это значение будет записано в поле {{Code\|key}} таблицы {{Code\|args}}.

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

	=== Обёртки ===		=== Обёртки ===
	Опция {{~~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> будет работать на всех страницах, не проверяя аргументы на странице шаблона.

	Обёртки могут задаваться строкой или массивом строк.		Обёртки могут задаваться строкой или массивом строк.
Строка 313:		Строка 313:
	Замечания:		Замечания:
	# Модуль автоматически определяет, если вызывается с подстраницы /песочница шаблона-обёртки, такие страницы не надо задавать явным образом.		# Модуль автоматически определяет, если вызывается с подстраницы /песочница шаблона-обёртки, такие страницы не надо задавать явным образом.
	# Опция{{~~var~~\|wrappers}} изменяет поведение по умолчанию опций {{~~var~~\|frameOnly}} и {{~~var~~\|parentOnly}}. Например, если {{~~var~~\|parentOnly}} явным образом установлена в {{luafalse}} при установленных {{~~var~~\|wrappers}}, вызов через обёртку будет приводить к проверке аргументов текущего и родительского фрейма, тогда как другие вызовы будут проверять только текущие аргументы.		# Опция{{Var\|wrappers}} изменяет поведение по умолчанию опций {{Var\|frameOnly}} и {{Var\|parentOnly}}. Например, если {{Var\|parentOnly}} явным образом установлена в {{luafalse}} при установленных {{Var\|wrappers}}, вызов через обёртку будет приводить к проверке аргументов текущего и родительского фрейма, тогда как другие вызовы будут проверять только текущие аргументы.
	# Если опция {{~~var~~\|wrappers}} установлена и родительский фрейм недоступен, модуль всегда будет получать аргументы, переданные функции {{Code\|getArgs}}.		# Если опция {{Var\|wrappers}} установлена и родительский фрейм недоступен, модуль всегда будет получать аргументы, переданные функции {{Code\|getArgs}}.

	=== Запись в таблицу args ===		=== Запись в таблицу args ===
Строка 323:		Строка 323:
	}}		}}

	С помощью установки опций {{~~var~~\|readOnly}} и {{~~var~~\|noOverwrite}} это поведение можно переопределить. Если установлена опция {{~~var~~\|readOnly}}, в таблицу {{Code\|args}} нельзя вносить изменения вообще. При установке же опции {{~~var~~\|noOverwrite}} можно добавлять новые значения, но нельзя менять уже имеющиеся в таблице значения, полученные из {{Code\|#invoke}}.		С помощью установки опций {{Var\|readOnly}} и {{Var\|noOverwrite}} это поведение можно переопределить. Если установлена опция {{Var\|readOnly}}, в таблицу {{Code\|args}} нельзя вносить изменения вообще. При установке же опции {{Var\|noOverwrite}} можно добавлять новые значения, но нельзя менять уже имеющиеся в таблице значения, полученные из {{Code\|#invoke}}.

	=== Тэги ref ===		=== Тэги ref ===

Andras в 19:02, 14 мая 2023

2023-05-14T19:02:04Z

← Предыдущая версия		Версия от 19:02, 14 мая 2023
Строка 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> будет работать на всех страницах, не проверяя аргументы на странице шаблона.

	Обёртки могут задаваться строкой или массивом строк.		Обёртки могут задаваться строкой или массивом строк.

Andras в 18:56, 14 мая 2023

2023-05-14T18:56:12Z

Внесённые изменения