Модуль:GamesSport/doc

Это страница документации Модуль:GamesSport.

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

Реализует {{Спорт}} как замену куче проставленных вручную пиктограмм в спортивных статьях. Данные перечислены в Модуль:GamesSport/data.json. Страницы с видами спорта вне базы данных добавляются в Мегавики:Страницы с ошибками шаблона Спорт.

Страница данных

Страница данных имеет следующие параметры данных (под "data") с различными возможными значениями:

"icon" — может иметь значение формата Triathlon, что интерпретируется как Файл:Triathlon pictogram.svg (или Файл:Triathlon pictogram (Paralympics).svg при использовании шаблона с префиксом паралимпиада в названии спорта), или Triathlon pictogram.svg для добавления файла в ином формате.
- "paraicon" — может иметь значения аналогично icon, а также значение false (без кавычек, если необходимо всегда вызывать иконку паралимпиады для спорта).
- "paralympic" — при добавлении параметра с true (без кавычек) спорт будет интерпретироваться как паралимпийский по умолчанию (выводить паралимпийскую иконку без указания паралимпиада).
"title" — текущее название статьи о спорте. Будет использовано в статье при стандартном использовании шаблона.
"text" — отображаемое название вида спорта. Не следует указывать, если не отличается от "title".

Для добавления нового спорта нужно добавить данные в следующем формате (с дополнениями по необходимости):

"КЛЮЧ СПОРТА": {
	"icon": "ИКОНКА",
	"title": "НАЗВАНИЕ СТАТЬИ"
}

Ключ спорта указывается в строчных буквах и без буквы «ё». Модуль автоматически переводит все значения в строчные и заменяет «ё» на «е» при обработке ключей для простоты работы с данными (но название статьи и отображаемое название следует указывать с буквой «ё»).

Для добавления алиаса (синонима названия) спорта необходимо добавить данные в следующем формате в блок "aliases": "АЛИАС": "КЛЮЧ СПОРТА".

Тесты

Алиасы:
- {{#invoke:GamesSport|main|Бадминтон}} → Бадминтон
- {{#invoke:GamesSport|main|Air badminton}} → Бадминтон
- {{#invoke:GamesSport|main|BMX}} → BMX
Разный регистр:
- {{#invoke:GamesSport|main|Футбол}} → Футбол
- {{#invoke:GamesSport|main|футбол}} → Футбол
- {{#invoke:GamesSport|main|ФУТБОЛ}} → Футбол
Паралимпиады:
- {{#invoke:GamesSport|main|паралимпиада стрельба из лука}} → Стрельба из лука
- {{#invoke:GamesSport|main|Paralympic Triathlon}} → Триатлон
- {{#invoke:GamesSport|main|пара-сноуборд}} → Парасноуборд
- {{#invoke:GamesSport|main|параканоэ}} → Параканоэ
- сложные варианты:
  - алиас: {{#invoke:GamesSport|main|паралимпиада пара-сноуборд}} → Парасноуборд
  - кастомная иконка для паралимпиад: {{#invoke:GamesSport|main|паралимпиада биатлон}} → Биатлон
  - кастомная иконка без .svg: {{#invoke:GamesSport|main|паралимпиада гребля на байдарках и каноэ}} → Гребля на байдарках и каноэ
Второй и третий параметры:
- {{#invoke:GamesSport|main|велоспорт|Велоспорт на летних Олимпийских играх 2000}} → Велоспорт
  - сокращённо: {{#invoke:GamesSport|main|велоспорт|на летних Олимпийских играх 2000}} → Велоспорт
  - ещё более сокращённо: {{#invoke:GamesSport|main|велоспорт|летние 2000}} → Велоспорт
- {{#invoke:GamesSport|main|велоспорт|Велоспорт на летних Олимпийских играх 2000|Велоспорт на ОИ2000}} → Велоспорт на ОИ2000
Без ссылки: {{#invoke:GamesSport|main|хоккей на траве||Хоккей на траве в 2005 году|ссылка=нет}} → Хоккей на траве в 2005 году
С числом:
- {{#invoke:GamesSport|main|хоккей на траве||Хоккей на траве в 2005 году|число=17}} → Хоккей на траве в 2005 году (17)
- {{#invoke:GamesSport|main|хоккей на траве||Хоккей на траве в 2005 году|число=17|ссылка=нет}} → Хоккей на траве в 2005 году (17)
Только иконка: {{#invoke:GamesSport|main|велоспорт|иконка=да}} →
Ссылка на {{iw}}: {{#invoke:GamesSport|main|гандбол|{{iw|Чешский гандбол|||Czech handball}}}} → Чешский гандбол^[англ.]