Відмінності між версіями «Модуль:Wikidata/документація»

Матеріал з Вікіпедії — вільної енциклопедії.
Перейти до навігації Перейти до пошуку
[неперевірена версія][неперевірена версія]
(переклад)
Рядок 5: Рядок 5:
 
Використовується в {{tl|Wikidata}}.
 
Використовується в {{tl|Wikidata}}.
   
Функції цього модуля не призначені для прямого виклику з шаблонів карток чи інших модулів, що не є його функціями розширення. Для виклику з шаблонів карток використовуйте шаблон {{tl|wikidata}} чи один зі спеціалізованих шаблонів для властивостей. Для виклику функцій Вікіданих, що призначені для відображення, зазвичай достатньо виклику <tt>frame:expandTemplate{}</tt> з викликом шаблону, що відповідає за відображення властивості. З іншого боку, виклик окремих функцій модуля (в основному це стосується <tt>getEntityObject()</tt>) може в наступному стати предпочтительным (наприклад, коли з'явиться можливість виклику getEntityObject для довільного елемента з ціллю кешування і вкладених викликів). Даний Lua-функціонал в будь-якому випадку слід розглядати як нестабільний з точки зору збереження сумісності на рівні коду (разом з відповідними функціями API для Wikibase Client).
+
Функції цього модуля не призначені для прямого виклику з шаблонів карток чи інших модулів, що не є його функціями розширення. Для виклику з шаблонів карток використовуйте шаблон {{tl|wikidata}} чи один зі спеціалізованих шаблонів для властивостей. Для виклику функцій Вікіданих, що призначені для відображення, зазвичай достатньо виклику <tt>frame:expandTemplate{}</tt> з викликом шаблону, що відповідає за відображення властивості. З іншого боку, виклик окремих функцій модуля (в основному це стосується <tt>getEntityObject()</tt>) може в подальшому стати кращим (наприклад, коли з'явиться можливість виклику getEntityObject для довільного елемента з ціллю кешування і вкладених викликів). Даний Lua-функціонал в будь-якому разі треба розглядати як нестабільний з точки зору збереження сумісності на рівні коду (разом з відповідними функціями API для Wikibase Client).
   
Далі описується внутрішня документація. Назви функцій і параметрів можуть змінитися. При їх зміненні автор змін зобов'язаний оновити шаблон {{tl|wikidata}} та спеціалізовані шаблони властивостей. Зміни в інших місцях, якщо хтось всё ж таки викликає функції модуля напряму, залишаються на сумлінні автора «костиля». Итак, при вызове шаблона {{tl|wikidata}} или специализированного шаблона свойства управление отдаётся на функцию formatStatements, которая принимает frame. Из frame достаются следующие опции, которые так или иначе передаются в остальные функции:
+
Далі описується внутрішня документація. Назви функцій і параметрів можуть змінитися. При їх зміненні автор змін зобов'язаний оновити шаблон {{tl|wikidata}} та спеціалізовані шаблони властивостей. Зміни в інших місцях, якщо хтось все ж таки викликає функції модуля напряму, залишаються на сумлінні автора «костиля». Отже, при виклику шаблона {{tl|wikidata}} або спеціалізованого шаблона властивості управління віддається на функцію formatStatements, котра приймає frame. Із frame добуваються такі опції, які так чи інакше передаються в решту функцій:
* <code>plain</code> — булевый переключатель (по умолчанию false). Если true, результат совпадает с обычным вызовом <tt><nowiki>{{#property:pNNN}}</nowiki></tt> (по факту им и будет являться)
+
* <code>plain</code> — булевий перемикач (за умовчанням false). Якщо true, результат збігається зі звичайним викликом <tt><nowiki>{{#property:pNNN}}</nowiki></tt> (за фактом ним і буде)
  +
* <code>references</code> — булевий перемикач (за умовчанням true). Якщо true, після виводу значення параметра додатково виводить посилання джерела, що вказані у Вікіданих. Для виводу використовується [[Модуль:Sources]]. Зазвичай вимикається для тих властивостей, які є «самоописуваними», наприклад, зовнішніми ідентифікаторами або посиланнями (коли таке посилання є доказом своєї актуальності), наприклад, ідентифікатори IMDb.
* <code>references</code> — булевый переключатель (по умолчанию true). Если true, после вывода значения параметра дополнительно выводит ссылки на источники, указанные в Викиданных. Для вывода используется [[Модуль:Sources]]. Обычно отключается для тех свойств, которые являются «самоописываемыми», например, внешними идентификаторами или ссылками (когда такая ссылка является доказательством своей актуальности), например, идентификаторы IMDb.
 
* <code>value</code> — значення, яке треба виводити ''замість'' значень з Вікіданних (використовується, якщо щось задано вже в картці у вигляді т. з. локальної властивості).
+
* <code>value</code> — значення, яке треба виводити ''замість'' значень із Вікіданих (використовується, якщо щось задано вже в картці у вигляді т. з. локальної властивості).
   
 
За замовчанням модуль підтримує виведення наступних значень без додаткових налаштувань:
 
За замовчанням модуль підтримує виведення наступних значень без додаткових налаштувань:
 
* географічні координати (coordinates)
 
* географічні координати (coordinates)
* кількістьні значення (quantity)
+
* кількісні значення (quantity)
 
* одномовний текст (monolingualtext)
 
* одномовний текст (monolingualtext)
 
* рядки (string)
 
* рядки (string)
 
* дати (time)
 
* дати (time)
Інщі типи даних потребують указання функції форматування значення.
+
Інші типи даних потребують указання функції форматування значення.
   
Поддерживаются два типа параметрів-функцій, которые дополнительно указывают, як треба форматувати значення:
+
Підтримуються два типи параметрів-функцій, які додатково вказують, як треба форматувати значення:
 
* <code>claim-module</code>, <code>claim-function</code> — назва модуля та функції модуля, які відповідають за форматування виводу значення ''властивості'' (statement, claim) враховуючи кваліфікатори, посилання та інше. Може, наприклад, додатково до основного значення (main snak) вивести значення кваліфікаторів. Характерні приклади:
 
* <code>claim-module</code>, <code>claim-function</code> — назва модуля та функції модуля, які відповідають за форматування виводу значення ''властивості'' (statement, claim) враховуючи кваліфікатори, посилання та інше. Може, наприклад, додатково до основного значення (main snak) вивести значення кваліфікаторів. Характерні приклади:
** вивід вышестоящих адміністративних одиниць і країни в {{tl|wikidata/p19}}, {{tl|wikidata/p20}} та [[Модуль:Wikidata/Places]]
+
** вивід вищестоячих адміністративних одиниць і країни в {{tl|wikidata/p19}}, {{tl|wikidata/p20}} та [[Модуль:Wikidata/Places]]
 
** вивід авторів латинської назви і дати публікації в {{tl|wikidata/p225}} та [[Модуль:Wikidata/Biology]]
 
** вивід авторів латинської назви і дати публікації в {{tl|wikidata/p225}} та [[Модуль:Wikidata/Biology]]
 
** вивід операційної системи і дати релізу в {{tl|wikidata/p348}} та [[Модуль:Wikidata/Software]]
 
** вивід операційної системи і дати релізу в {{tl|wikidata/p348}} та [[Модуль:Wikidata/Software]]
Рядок 28: Рядок 28:
 
*: Специфікація функції: <code>function p.…( context, statement )</code>
 
*: Специфікація функції: <code>function p.…( context, statement )</code>
   
* <code>value-module</code>, <code>value-function</code> — назва модуля та функції модуля, які відповідають за форматоване ''значення'' (snak, snak data value), залежно від контексту, как значень властивості, так і значень кваліфікатора (якщо викликається з <tt>claim-module/claim-function</tt>). Необхідно для змінення відображення властивості, наприклад, генерації вікіпосиланн. замість простого рядка чи навіть вставки зображення замість відображення назви файла зображення (бо посилання на зображення зберігаються як рядки). Характерні приклади:
+
* <code>value-module</code>, <code>value-function</code> — назва модуля та функції модуля, які відповідають за форматоване ''значення'' (snak, snak data value), залежно від контексту, як значень властивості, так і значень кваліфікатора (якщо викликається з <tt>claim-module/claim-function</tt>). Необхідно для змінення відображення властивості, наприклад, генерації вікіпосилань замість простого рядка чи навіть вставки зображення замість відображення назви файлу зображення (бо посилання на зображення зберігаються як рядки). Характерні приклади:
 
** вивід посилань на [[Вікісховище]] в {{tl|wikidata/p373}} та [[Модуль:Wikidata/media]]
 
** вивід посилань на [[Вікісховище]] в {{tl|wikidata/p373}} та [[Модуль:Wikidata/media]]
 
** вивід посилань на зовнішні сайти в {{tl|wikidata/link}} та [[Модуль:Wikidata/link]]
 
** вивід посилань на зовнішні сайти в {{tl|wikidata/link}} та [[Модуль:Wikidata/link]]

Версія за 14:43, 8 липня 2016

Модуль:Wikidata (обг. · [ред.] · історія · посилання · документація · підсторінки · тести – результати)


Використовується в {{Wikidata}}.

Функції цього модуля не призначені для прямого виклику з шаблонів карток чи інших модулів, що не є його функціями розширення. Для виклику з шаблонів карток використовуйте шаблон {{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 — значення, яке треба виводити замість значень із Вікіданих (використовується, якщо щось задано вже в картці у вигляді т. з. локальної властивості).

За замовчанням модуль підтримує виведення наступних значень без додаткових налаштувань:

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

Інші типи даних потребують указання функції форматування значення.

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

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