Template:Pornbasedata/doc

From Porn Base Central, the free encyclopedia of gay porn
Jump to navigation Jump to search

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

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

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

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

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

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

TemplateData

Техническое замечание: Шаблон потенциально принимает неограниченное число параметров за счёт задания кастомизированных обработчиков в параметрах …-module/…-function, см. документацию Module:Pornbasedata. При этом для многих свойств такие обработчики уже включены по умолчанию в Module:Pornbasedata/config и потому добавляют шаблону новые параметры — например, icon_size для (P373) через Module:Pornbasedata/media или prefix для (P345) через Module:Pornbasedata/link, — однако ниже перечислены только те параметры, которые работают для целых типов данных.

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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Свойство1

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

Example
p1234
Stringrequired
Локальное значение2

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

Stringoptional
Элемент Викиданныхfrom

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

Example
Q5
Lineoptional
Простое значениеplain

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

Default
false
Booleanoptional
Разделительseparator

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

Example
,<br>
Stringoptional
Последний разделительconjunction

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

Default
и
Example
или
Stringoptional
Значение неизвестноsomevalue

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

Default
''неизвестно''
Lineoptional
Значение отсутствуетnovalue

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

Lineoptional
Nocatnocat

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

Default
false
Example
true
Booleanoptional
Максимальное число значенийlimit

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

Default
-
Example
1
Numberoptional
Квалификаторqualifier

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

Example
P155
Lineoptional
Свойство для категорииcategory

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

Example
P910
Lineoptional
Сноски с источникамиreferences

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

Default
true
Example
false
Booleanoptional
Форматformat

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

Unknownoptional
Текстtext

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

Example
ссылка
Stringoptional
Максимальная длинаlength

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

Default
max(18, 25 - длина языковых ссылок)
Example
10
Numberoptional
Шаблон моноязычного текста monolingualLangTemplate

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

Example
lang или ref
Lineoptional
Размер медиафайлаsize

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

Example
250x350px
Lineoptional
Подписьcaption description

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

Example
Фотография на балу, 2005 год
Lineoptional
Alt-текст медиафайлаalt

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

Example
Мужчина в чёрном костюме и шляпе
Lineoptional
Рамка изображенияborder

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

Default
false
Example
true
Booleanoptional
Добавить момент времениappendTimestamp

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

Default
false
Example
true
Booleanoptional
Положение координатdisplay

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

Default
title
Example
inline,title
Auto value
inline,title
Lineoptional
Nocoordnocoord

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

Default
false
Example
true
Booleanoptional
Тип картыtype

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

Example
city
Lineoptional
Часть значенияsubvalue

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

Example
latitude или longitude
Lineoptional
Небесное телоglobe

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

Default
earth
Example
moon
Lineoptional
Строка форматированияformatter

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

Example
https://example.com/id=$1
Stringoptional
Заголовок ссылкиtitle

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

Example
Страница в базе такой-то
Stringoptional
Префикс категорииcategoryPrefix

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

Example
Родившиеся
Stringoptional
Единица измеренияunit

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

Example
км
Lineoptional
Преобразовать в СИsiConversion

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

Default
false
Example
true
Booleanoptional