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

Материал из Буквицы
Перейти к навигации Перейти к поиску
м
м
Метка: отменено
Строка 25: Строка 25:
'''Техническое замечание''': шаблон поддерживает параметры трёх видов:
'''Техническое замечание''': шаблон поддерживает параметры трёх видов:
* общие параметры — например ''from'', с помощью которого можно сменить ID элемента, из которого нужно получить данные, работает для любого свойства;
* общие параметры — например ''from'', с помощью которого можно сменить ID элемента, из которого нужно получить данные, работает для любого свойства;
* параметры, работающие для свойств определённых [[d:Special:ListDatatypes|типов данных]] — например, ''caption'' предназначен для типа данных «медиафайл с Викисклада» (к которому относятся, например, свойства {{WD|P18}} и {{WD|P41}}) и задаёт описание изображения;
* параметры, работающие для свойств определённых [[d:Special:ListDatatypes|типов данных]] — например, ''caption'' предназначен для типа данных «медиафайл с Викисклада» (к которому относятся, например, свойства {{WD|P4}} и {{WD|P41}}) и задаёт описание изображения;
* параметры, работающие для отдельных свойств — например, ''icon_size'' предназначен для свойства {{WD|P373}} и меняет размер иконки рядом с ссылкой на Викисклад; при этом свойство {{WD|P373}} имеет тип «строка», но для других свойств типа «строка» параметр ''icon_size'' работать не будет.
* параметры, работающие для отдельных свойств — например, ''icon_size'' предназначен для свойства {{WD|P373}} и меняет размер иконки рядом с ссылкой на Викисклад; при этом свойство {{WD|P373}} имеет тип «строка», но для других свойств типа «строка» параметр ''icon_size'' работать не будет.



Версия 09:23, 27 декабря 2021


Шаблон, упрощающий работу со свойствами из Викиданных — их использование в шаблонах и статьях.

{{Wikidata|1=Свойство|2=Локальное значение}}

{{wikidata|p559|{{{конечные|{{{Конечные|}}}}}}|separator=<br>|conjunction=<br>}}

1: Идентификатор свойства на Викиданных в формате pXXXX, список доступных свойств: Special:AllPages:Properties.
2: Значение, перекрывающее информацию с Викиданных, обычно это параметр шаблона в форме {{{parameter|}}}.
Если это значение пусто, то только тогда оно будет затребовано с Викиданных.
Рекомендуется не задавать в этом параметре значение, если оно равно значению на Викиданных. В таком случае, при его изменении в базе данных, оно может быть использовано сразу.
Если в параметре содержится значение -, то значение из Викиданных не будет показываться.

Если параметры для форматирования одинаковы при всех вызовах шаблона для одного свойства, то лучше перенести иx в Модуль:Wikidata/config и вызывать шаблон без лишних параметров.

Параметры форматирования передаются обрабатывающему соответствующее свойство модулю (например, Модуль:Wikidata/Places), поэтому, если он отличается от стандартного Модуль:Wikidata, то некоторые из них могут не поддерживаться, хотя вполне иметь смысл.

TemplateData

Техническое замечание: шаблон поддерживает параметры трёх видов:

  • общие параметры — например from, с помощью которого можно сменить ID элемента, из которого нужно получить данные, работает для любого свойства;
  • параметры, работающие для свойств определённых типов данных — например, caption предназначен для типа данных «медиафайл с Викисклада» (к которому относятся, например, свойства Ошибка Lua в Модуль:WD на строке 450: attempt to index field 'wikibase' (a nil value). и Ошибка Lua в Модуль:WD на строке 450: attempt to index field 'wikibase' (a nil value).) и задаёт описание изображения;
  • параметры, работающие для отдельных свойств — например, icon_size предназначен для свойства Ошибка Lua в Модуль:WD на строке 450: attempt to index field 'wikibase' (a nil value). и меняет размер иконки рядом с ссылкой на Викисклад; при этом свойство Ошибка Lua в Модуль:WD на строке 450: attempt to index field 'wikibase' (a nil value). имеет тип «строка», но для других свойств типа «строка» параметр icon_size работать не будет.

В документации ниже перечислены только параметры первых двух видов. Это связано с тем, что шаблон потенциально принимает неограниченное число параметров за счёт задания кастомизированных обработчиков в параметрах …-module/…-function, см. документацию Модуль:Wikidata. Для многих свойств такие обработчики уже включены по умолчанию в Модуль:Wikidata/config и добавляют шаблону новые параметры третьего вида — например, для Ошибка Lua в Модуль:WD на строке 450: attempt to index field 'wikibase' (a nil value). включен параметр icon_size, который обрабатывается в Модуль:Wikidata/media, а для Ошибка Lua в Модуль:WD на строке 450: attempt to index field 'wikibase' (a nil value). включен параметр prefix, который обрабатывается в Модуль:Wikidata/link. Однако перечисление всех параметров третьего вида сделало бы документацию слишком громоздкой.


Шаблон, упрощающий работу со свойствами Викиданных, их использование в шаблонах и статьях.

Параметры шаблона

Шаблон использует строчное форматирование параметров.

ПараметрОписаниеТипСтатус
Свойство1

Идентификатор свойства на Викиданных, может содержать селекторы (см. Модуль:WikidataSelectors)

Пример
p1234
Строковый (без форматирования)обязательный
Локальное значение2

Значение, перекрывающее информацию с Викиданных, обычно это параметр шаблона в форме {{{параметр|}}}. Если значение равно «-», то будет возвращена пустая строка

Строковый (без форматирования)необязательный
Элемент Викиданныхfrom

ID элемента, из которого нужно получить данные. По умолчанию берутся из элемента, связанного с текущей страницей

Пример
Q5
Однострочныйнеобязательный
Простое значениеplain

Если не 0, не пустая строка и не false, то значение возвращается в виде простой строки со значением без вики-форматирования

По умолчанию
false
Логическое значениенеобязательный
Префиксbefore

Префикс перед первым элементом списка, отображается только если список непуст

Пример
<ul><li>
Строковый (без форматирования)необязательный
Разделительseparator

Для создания текста со списком оформленных заявлений из таблицы

Пример
,<br>
Строковый (без форматирования)необязательный
Последний разделительconjunction

Разделитель для последнего элемента списка

По умолчанию
и
Пример
или
Строковый (без форматирования)необязательный
Постфиксafter

Постфикс после последнего элемента списка, отображается только если список непуст

Пример
</li></ul>
Строковый (без форматирования)необязательный
Значение неизвестноsomevalue

Текст, который выводится, если в Викиданных выбрано «значение неизвестно»

По умолчанию
''неизвестно''
Однострочныйнеобязательный
Значение отсутствуетnovalue

Текст, который выводится, если в Викиданных выбрано «значение отсутствует»

Однострочныйнеобязательный
Nocatnocat

Отключить автоматическое добавление категории (работа зависит от поддержки конкретным подмодулем)

По умолчанию
false
Пример
true
Логическое значениенеобязательный
Максимальное число значенийlimit

Наибольшее число значений, которое нужно выдать (- для бесконечности)

По умолчанию
-
Пример
1
Числонеобязательный
Квалификаторqualifier

Квалификатор, который нужно добавить в скобках после основного значения

Пример
P155
Однострочныйнеобязательный
Свойство для категорииcategory

Свойство, из которого брать автоматически добавляемую категорию

Пример
P910
Однострочныйнеобязательный
Сноски с источникамиreferences

Отображать ли сноски с источниками

По умолчанию
true
Пример
false
Логическое значениенеобязательный
Форматformat

(для свойств типа «элемент Викиданных») TODO: Описать смысл

Неизвестнонеобязательный
Текстtext

(для свойств типа «элемент Викиданных» и «URL») Замещающий текст, отображаемый вместо элемента Викиданных (ссылка на сам элемент при этом сохраняется)

Пример
ссылка
Строковый (без форматирования)необязательный
Максимальная длинаlength

(для свойств типа «URL») Максимальная показываемая длина URL'а

По умолчанию
max(18, 25 - длина языковых ссылок)
Пример
10
Числонеобязательный
Шаблон моноязычного текста monolingualLangTemplate

(для свойств типа «моноязычный текст») шаблон, в который оборачивается моноязычный текст

Пример
lang или ref
Однострочныйнеобязательный
Размер медиафайлаsize

(для свойств типа «медиафайл с Викисклада») Ширина и высота изображения или видео

Пример
250x350px
Однострочныйнеобязательный
Подписьcaption

(для свойств типа «медиафайл с Викисклада») Описание изображения

Пример
Фотография на балу, 2005 год
Однострочныйнеобязательный
Alt-текст медиафайлаalt

(для свойств типа «медиафайл с Викисклада») Замена изображения текстовым описанием для слабовидящих или людей с текстовым браузером

Пример
Мужчина в чёрном костюме и шляпе
Однострочныйнеобязательный
Рамка изображенияborder

(для свойств типа «медиафайл с Викисклада») Нужно ли показывать тонкую серую рамку вокруг изображения

По умолчанию
false
Пример
true
Логическое значениенеобязательный
Добавить момент времениappendTimestamp

(для свойств типа «медиафайл с Викисклада») Добавить момент времени

По умолчанию
false
Пример
true
Логическое значениенеобязательный
Положение координатdisplay

(для свойств типа «глобальные координаты») Где отображаются координаты: вверху страницы и/или на месте вставки

По умолчанию
title
Пример
inline,title
Автозначение
inline,title
Однострочныйнеобязательный
Nocoordnocoord

(для свойств типа «глобальные координаты») Не выводить координаты

По умолчанию
false
Пример
true
Логическое значениенеобязательный
Тип картыtype

(для свойств типа «глобальные координаты») Тип карты, передаваемый шаблону coord

Пример
city
Однострочныйнеобязательный
Часть значенияsubvalue

(для свойств типа «глобальные координаты») Вернуть только часть значения и в сыром виде

Пример
latitude или longitude
Однострочныйнеобязательный
Небесное телоglobe

(для свойств типа «глобальные координаты») Небесное тело, на котором находится объект

По умолчанию
earth
Пример
moon
Однострочныйнеобязательный
Строка форматированияformatter

(для свойств типа «внешний идентификатор») Строка для форматирования ссылки из идентификатора

Пример
https://example.com/id=$1
Строковый (без форматирования)необязательный
Заголовок ссылкиtitle

(для свойств типа «внешний идентификатор») Заголовок ссылки с внешним идентификатором (работает, только если задана строка форматирования)

Пример
Страница в базе такой-то
Строковый (без форматирования)необязательный
Префикс категорииcategoryPrefix

(для свойств типа «момент времени») Префикс автоматически добавляемой категории

Пример
Родившиеся
Строковый (без форматирования)необязательный
Единица измеренияunit

(для свойств типа «количество») Единица измерения, добавляемая после величины

Пример
км
Однострочныйнеобязательный
Преобразовать в СИsiConversion

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

По умолчанию
false
Пример
true
Логическое значениенеобязательный

Другие шаблоны для вывода информации из Викиданных

См. также

  • {{WD}} — для создания ссылок на элементы и свойства Викиданных