Цей модуль Lua використовується на близько 1 070 000 сторінках або близько 22% всіх сторінок. Для уникнення великомасштабних збоїв та непотрібного навантаження на сервер, будь-які зміни спочатку потрібно перевірити на підсторінках /пісочниці та /тестів цього модуля, або у вашій пісочниці модуля. Потім перевірені зміни можуть бути впроваджені на цій сторінці єдиним редагуванням. Будь ласка, обговорюйте будь-які зміни на сторінці обговорення перед їхнім впровадженням.
У документації цього модуля не вистачає або відсутній опис його функціоналу, або параметрів у його коді. Будь ласка, допоможіть покращити її.
Функції цього модуля не призначені для прямого виклику з шаблонів карток чи інших модулів, що не є його функціями розширення. Для виклику з шаблонів карток використовуйте шаблон {{wikidata}} чи один зі спеціалізованих шаблонів для властивостей. Для виклику функцій Вікіданих, що призначені для відображення, зазвичай достатньо виклику frame:expandTemplate{} з викликом шаблону, що відповідає за відображення властивості. З іншого боку, виклик окремих функцій модуля (в основному це стосується getEntityObject()) може в подальшому стати кращим (наприклад, коли з'явиться можливість виклику getEntityObject для довільного елемента з ціллю кешування і вкладених викликів). Даний Lua-функціонал в будь-якому разі треба розглядати як нестабільний з точки зору збереження сумісності на рівні коду (разом з відповідними функціями API для Wikibase Client).
Далі описується внутрішня документація. Назви функцій і параметрів можуть змінитися. При їх зміненні автор змін зобов'язаний оновити шаблон {{wikidata}} та спеціалізовані шаблони властивостей. Зміни в інших місцях, якщо хтось все ж таки викликає функції модуля напряму, залишаються на сумлінні автора «костиля». Отже, при виклику шаблона {{wikidata}} або спеціалізованого шаблона властивості управління віддається на функцію formatStatements, котра приймає frame. Із frame добуваються такі опції, які так чи інакше передаються в решту функцій:
plain — булевий перемикач (за умовчанням false). Якщо true, результат збігається зі звичайним викликом {{#property:pNNN}} (за фактом ним і буде)
references — булевий перемикач (за умовчанням true). Якщо true, після виводу значення параметра додатково виводить посилання джерела, що вказані у Вікіданих. Для виводу використовується Модуль:Sources. Зазвичай вимикається для тих властивостей, які є «самоописуваними», наприклад, зовнішніми ідентифікаторами або посиланнями (коли таке посилання є доказом своєї актуальності), наприклад, ідентифікатори IMDb.
value — значення, яке треба виводити замість значень із Вікіданих (використовується, якщо щось задано вже в картці у вигляді т. з. локальної властивості).
dvalue — значення, що містить дату смерті, взяту з картки, а не вікіданих (використовується лише в шаблоні {{wikidata/p569}} (обг. · викор. · ред.)).
За замовчанням модуль підтримує виведення наступних значень без додаткових налаштувань:
Інші типи даних потребують указання функції форматування значення.
Підтримуються два типи параметрів-функцій, які додатково вказують, як треба форматувати значення:
claim-module, claim-function — назва модуля та функції модуля, які відповідають за форматування виводу значення властивості (statement, claim) враховуючи кваліфікатори, посилання та інше. Може, наприклад, додатково до основного значення (main snak) вивести значення кваліфікаторів. Характерні приклади:
Специфікація функції: function p.…( context, statement )
value-module, value-function — назва модуля та функції модуля, які відповідають за форматоване значення (snak, snak data value), залежно від контексту, як значень властивості, так і значень кваліфікатора (якщо викликається з claim-module/claim-function). Необхідно для змінення відображення властивості, наприклад, генерації вікіпосилань замість простого рядка чи навіть вставки зображення замість відображення назви файлу зображення (бо посилання на зображення зберігаються як рядки). Характерні приклади: