মডিউল:উইকিউপাত্ত২/নথি

উইকিপিডিয়া, মুক্ত বিশ্বকোষ থেকে

{{উইকিউপাত্ত}}-এ ব্যবহৃত (সেখানে প্যারামিটারের বিবরণ দেখুন)। মডিউল:উইকিডাটা/কনফিগার ব্যবহার করে কনফিগার করা হয়েছে।

এই মডিউলে কোনো পরিবর্তন করার আগে, অনুগ্রহ করে সেগুলো /খেলাঘর এ পরীক্ষা করে দেখুন। অনুগ্রহ করে মনে রাখবেন যে স্যান্ডবক্সে সবকিছু সঠিকভাবে কাজ করে না।

সাধারণ জ্ঞাতব্য[সম্পাদনা]

এই মডিউলের ফাংশনগুলি সরাসরি কার্ড টেমপ্লেট বা অন্য মডিউলগুলি থেকে কল করার উদ্দেশ্যে নয় যেগুলি এটির এক্সটেনশন ফাংশন নয়৷ কার্ড টেমপ্লেট থেকে কল করতে, {{উইকিউপাত্ত}} টেমপ্লেট বা বৈশিষ্ট্যগুলির জন্য বিশেষায়িত টেমপ্লেটগুলির একটি ব্যবহার করুন। প্রদর্শনের উদ্দেশ্যে উইকিডাটা ফাংশনগুলিকে কল করার জন্য, বেশিরভাগ ক্ষেত্রেই frame:expandTemplate{} কে কল করাই যথেষ্ট যা প্রপার্টি রেন্ডার করার জন্য দায়ী টেমপ্লেটে কল করে। অন্যদিকে, কিছু নির্দিষ্ট মডিউল ফাংশন কল করা (বেশিরভাগই getEntity()) ভবিষ্যতে পছন্দের হয়ে উঠতে পারে। যে কোনো ক্ষেত্রে, এই লুয়া কার্যকারিতা অস্থির বিবেচনা করা উচিত

নিম্নলিখিত অভ্যন্তরীণ ডকুমেন্টেশন বর্ণনা. ফাংশন এবং পরামিতি নাম পরিবর্তন হতে পারে. যখন তারা পরিবর্তন হয়, পরিবর্তনের লেখককে অবশ্যই {{wikidata}} টেমপ্লেট এবং বিশেষ সম্পত্তি টেমপ্লেট আপডেট করতে হবে। অন্য জায়গায় পরিবর্তন, যদি কেউ তা সত্ত্বেও সরাসরি মডিউল ফাংশন কল করে, "ক্র্যাচ" লেখকের বিবেকের উপর থাকে। সুতরাং, একটি {{wikidata}} টেমপ্লেট বা একটি বিশেষ সম্পত্তি টেমপ্লেট কল করার সময়, নিয়ন্ত্রণ ফরম্যাট স্টেটমেন্ট ফাংশনে দেওয়া হয়, যা একটি ফ্রেম গ্রহণ করে। Из frame достаются следующие опции, которые так или иначе передаются в остальные функции:

  • plain — булевый переключатель (по умолчанию false). Если true, результат совпадает с обычным вызовом {{#property:pNNN}} (по факту им и будет являться)
  • references — булевый переключатель (по умолчанию true). Если true, после вывода значения параметра дополнительно выводит ссылки на источники, указанные в Викиданных. Для вывода используется Модуль:Sources. Обычно отключается для тех свойств, которые являются «самоописываемыми», например, внешними идентификаторами или ссылками (когда такая ссылка является доказательством своей актуальности), например, идентификаторы IMDb.
  • value — значение, которое надо выводить вместо значений из Викиданных (используется, если что-то задано уже в карточке в виде т. н. локального свойства)

По умолчанию модуль поддерживает вывод следующих значений без дополнительных настроек:

  • географические координаты (coordinates)
  • количественные значения (quantity)
  • моноязычный текст (monolingualtext)
  • строки (string)
  • даты (time)

Остальные типы данных требуют указания функции форматирования значения.

Кастомизация[সম্পাদনা]

Поддерживаются три типа параметров-функций, которые дополнительно указывают, как надо форматировать значения:

  • property-module, property-function — название модуля и функции модуля, которые отвечают за форматирование вывода массива значений свойства (property) с учётом квалификаторов, ссылок и прочего. Например, оформляет множество выводов в таблицу или график. Характерные примеры:
    Спецификация функции: function p.…( context, options ), поведение по умолчанию: Модуль:Wikidata#formatPropertyDefault.
  • claim-module, claim-function — название модуля и функции модуля, которые отвечают за форматирование вывода значения свойства (statement, claim) с учётом квалификаторов, ссылок и прочего. Может, например, дополнительно к основному значению (main snak) вывести значения квалификаторов. Характерные примеры:
    Спецификация функции: function p.…( context, options, statement )
  • value-module, value-function — название модуля и функции модуля, которые отвечают за форматирование значения (snak, snak data value), в зависимости от контекста, как значений свойства, так и значений квалификатора (если вызывается из claim-module/claim-function). Необходимо для изменения отображения свойства, например, генерации викиссылки вместо простой строки или даже вставки изображения вместо отображения имени файла изображения (так как ссылки на изображения хранятся как строки). Характерные примеры:
    Спецификация функции: function p.…( value, options )

Заготовки функций[সম্পাদনা]

টেমপ্লেট:Скрытый টেমপ্লেট:Скрытый টেমপ্লেট:Скрытый

Context API[সম্পাদনা]

টেমপ্লেট:Заготовка раздела

Переменные[সম্পাদনা]

  • entity
  • frame

Методы[সম্পাদনা]

  • cloneOptions( options )
  • getSourcingCircumstances( statement )
  • formatProperty( options )
  • formatPropertyDefault( context, options )
  • formatSnak( options, snak, circumstances )
  • formatStatement( options, statement )
  • formatStatementDefault( context, options, statement )
  • formatRefs( options, statement )
  • formatValueDefault( context, options, value )
  • parseTimeBoundariesFromSnak( snak )
  • parseTimeFromSnak( snak )
  • selectClaims( options, propertyId )
  • wrapSnak( value, hash, attributes )
  • wrapStatement( value, propertyId, claimId, attributes )
  • wrapQualifier( value, qualifierId, attributes )

Функции для форматирования[সম্পাদনা]

property-function[সম্পাদনা]

claim-function[সম্পাদনা]

value-function[সম্পাদনা]

আরো দেখুন[সম্পাদনা]


Категория:Модули:Документация