Модуль:High-use/документація

Це сторінка документації для Модуль:High-use

Цей модуль позначений як К:реліз, готовий до загального вжитку (27). Він досягнув стадії готовності і вважається, що вільний від помилок і може використовуватись всюди, де знадобиться. Його можна вживати на допоміжних сторінках та інших сторінках Вікіпедії як можливість для навчання новачків. Аби зменшити навантаження на сервери та некоректний показ сторінок, його можна вдосконалювати в рамцях чернеткового тестування, а не з застосуванням спроб і помилок.

Цей модуль залежить від наступних модулів:

Впроваджує {{High-use}}. Використовує значення, що оновлюються ботом, з підсторінок Module:Transclusion_count/data/, коли наявні.

Використання ред.

{{#invoke:High-use|main|1=кількість включень|2=сторінка обговорення або використання запису із +|all-pages=|info=|demo=|form=|expiry=}}

number of transclusions: Перший параметр є статичним числом кількості включень шаблону або словом «risk» (без лапок), щоб відобразити текст «дуже великій кількості сторінок» замість справжнього значення. Значення цього параметра ігнорується, якщо наявні дані включень для цієї сторінки.
сторінка обговорення або використання запису із +: Другий параметр є перевантаженим. Якщо встановлено значення «yes» (без лапок), то кількість включень відобразиться як «## ###+» замість «близько ## ###». Коли використано цей метод запису, то округлення відбувається в меншу сторону замість округлення до найближчого числа відповідною кількістю значущих цифр. Коли вказано будь-яке інше не пусте значення, то буде замінено посилання, що веде на сторінку обговорення шаблону, на значення, яке вказане в параметрі (наприклад, 2=ВП:КТП вставить посилання на ВП:КТП),
|all-pages=yes: Також відображатиме відсоток скільки сторінок використовують шаблон від усієї кількості сторінок. Це повинно використовуватися лише для шаблонів з дуже великою кількістю включень, а відсоток відображуватиметься лише, якщо він більший за 1%.
|info=додаткова інформація: Коли вказано непусте значення, то вставляється додаткова інформація в текст шаблону, якщо шаблон має більше ніж 10 000 включень або вказано значення «risk» в параметрі 1.
|demo=Назва_шаблону: буде використовувати кількість включень для шаблону Шаблон:Назва_шаблону замість визначення назви шаблону зі сторінки, де використано цей модуль. Капіталізація має точно відповідати значенню, що вказано в Спеціальна:Покажчик за початком назви/Module:Transclusion_count/data/.
|form=: Коли встановлено значення «editnotice», то повідомлення відображається за використанням {{editnotice}} замість {{ombox}}.
|expiry=: Встановлює параметр |expiry= для {{editnotice}}.
|system=в системних повідомленнях: якщо його зазначити, то цей модуль виглядатиме як {{Використовується в системі}}.
|fetch=: якщо вказано false, то модуль не намагатиметься отримати дані включень з модуля Модуль:Transclusion count.

Інші функції ред.

num: Створює текст і посилання на toolforge з приводу кількості включень.
risk: При виклику цієї функції, якщо передано risk в перший неназваний параметр або є вже більше ніж 100k включень, то вона поверне risk.
text: Повертає текст тіла цього шаблону, зі значенням кількості включень або nil.

{{#invoke:High-use|назва функції}}