Користувач:NirvanaBot/Нові статті/документація

Про шаблон

Цей шаблон потрібен для зазначення персональних налаштувань секції порталу, щоб вона оновлювалася ботом NirvanaBot. Шаблон задає всі дані, як оновлювати рубрику. NirvanaBot оновлює в порталах і проектах такі розділи як Нові статті (приклад), Нові шаблони (приклад), Нові категорії (приклад), Нові зображення (приклад), Зображення нових статей (приклад) і т.д., а також Список спостереження (приклад/приклад). Для секцій "На видалення", "На перейменування", "На поліпшення" й т.п.. Див. шаблон User:ClaymoreBot/Нові статті.

Як користуватися

Створіть сторінку з адресою Портал(Проект):Назва_порталу/Нова стаття(Нова категорія)/Параметри. Скопіюйте туди підходящий вам варіант шаблону з параметрами. Заповніть параметри дотримуючись інструкції нижче. Необов'язково заповнювати всі рядки. Обов'язкові рядки 3: тип, категорія (або категорії), сторінка. Якщо був обраний короткий варіант шаблону, або в ньому не всі параметри були заповнені, то вони залишаться порожніми або візьмуть значення за замовчуванням. Значення за замовчуванням для деяких рядків беруться звідси, інші задані в тілі бота.

Для копіювання

Повністю	Тільки основні	Мінімум
{{User:NirvanaBot/Нові статті |тип = |категорії = |ігнорувати = |сторінка = |елементів = |годин = |глибина = |формат елементу = |архів = |позначати правки = |простір назв = |шапка = |підвал = \n<noinclude> [[Категорія:Вікіпедія:Списки нових статтей за темами|{{PAGENAME}}]] </noinclude> |шаблони = |префікс = |роздільник = |параметри архіву = |формат заголовку в архіві = |формат підзаголовку в архіві = |пошук картинки = |сервіс = |частота оновлень = }}	{{User:NirvanaBot/Нові статті |тип = |категорії = |ігнорувати = |сторінка = |елементів = |годин = |глибина = |формат елементу = |архів = |позначати правки = }}	{{User:NirvanaBot/Нові статті |тип = |категорії = |сторінка = }}

Стандартні набори

Нові статті

{{User:NirvanaBot/Нові статті
|тип = нові статті
|категорії = 
|ігнорувати = 
|сторінка = 
|елементів = 20
|годин = 500
|глибина = 6
|формат елементу = {{Нова стаття|%(назва)|%(дата)|%(автор)}}
|архів = 
}}

Нові шаблони

{{User:NirvanaBot/Нові статті
|тип = нові статті
|категорії = 
|ігнорувати = 
|сторінка = 
|елементів = 10
|простір назв = 10
|годин = 5000
|глибина = 6
|формат елементу = # [[Шаблон:%(назва)|%(назва)]]
|архів = 
}}

Нові категорії

{{User:NirvanaBot/Нові статті
|тип = нові статті
|категорії = 
|ігнорувати = 
|сторінка = 
|елементів = 10
|простір назв = 14
|годин = 500
|глибина = 6
|формат елементу = # {{cl|%(назва)|1}}
|архів = 
}}

Параметри

Обов'язкові параметри виділені жирним шрифтом. Увага! Деякі параметри за замовчуванням можуть бути перевизначені в в головних налаштуваннях

Параметр	Допустимі значення	Значення параметру
сторінка		Сторінка, яку повинен оновлювати бот, обов'язковий параметр
тип		Тип списку, обов'язковий параметр. Допустимо тільки одне значення з наступного списку: нові статті (або список нових статей) нові статті з зображеннями (або список нових статей з зображеннями) нові статті з зображеннями в карточці (або список нових статей з зображеннями в карточці) нові статті з зображеннями в тексті (або список нових статей з зображеннями в тексті) нові статті по дням (або списки нових статей по дням) список спостереження
категорії		Список категорій, в які повинні входити сторінки зі списку, обов'язковий параметр, якщо не використовується параметр категорія. Категорії повинні перераховуватися через кому. Категорії можна вказувати в подвійних лапках, але необов'язково. Якщо якісь категорії завеликі (понад 500 підкатегорій), то бажано внести їх найбільші вкладені категорії також.
ігнорувати		Список категорій (і їх підкатегорій), сторінки яких треба ігнорувати при формуванні списку. Категорії повинні перераховуватися через кому. Категорії можна вказувати в подвійних лапках, але необов'язково.
сервіс	auto petscan petscan1 catscan3 catscan2 catscan	Вибір сервісу. Доступно два сервісу: petscan, petscan1. auto - автоматичний вибір. За замовчуванням використовується auto.
елементів	20, 1..5000	Кількість елементів у списку. За замовчуванням - 20. Максимальне значення - 5000.
годин	350, 1..8928	Брати тільки сторінки, створені стільки годин тому. За замовчуванням - 350, максимальне значення - 8928 (1 рік).
глибина	6, 0..15	Глибина дерева категорій, яку буде переглядати бот. За замовчуванням - 6, максимальне значення - 15. Якщо бот знаходить багато нерелевантних статей, рекомендується знизити глибину до 5. Якщо тема (категорія) велика і бот знаходить не всі статті, рекомендується збільшити до 7 або 8.
формат елементу		Шаблон, за яким створюється елемент (рядок) списку. за замовчуванням — «[[%(назва)]]». Можна використовувати такі змінні (на місці цих змінних бот підставить якесь значення): %(назва) — назва сторінки без вказівки простору назв. Наприклад, для статті Візантія замість строки «%(назва)» бот підставить «Візантія», а для категорії Категорія:Математика бот підставить «Математика»; %(автор) — ім'я користувача, зробившого першу правку (редагування) на сторінці %(дата) — дата та час першої правки на сторінці %(назва файлу) — назва файлу, знайденого на сторінці (тільки для типів «список нових статей із зображеннями ...»); Найбільш часто використовувані варіанти: формат елементу як виглядає [[%(назва)]] Нептун {{Нова стаття|%(назва)|%(дата)|%(автор)}} Нептун — започаткував 13 березня 2009 користувач Ilya * {{Вікіпедія:Проект:Білорусь/Нова стаття|%(назва)|%(автор)|%(дата)}} Вікіпедія:Проект:Білорусь/Нова стаття * [[:Файл:%(назва)|%(назва)]] див. тут Файл:%(назва файлу)|[[%(назва)]] див. тут # [[Шаблон:%(назва)|%(назва)]] # Система Нептуна # {{cl|%(назва)|1}} # 1
архів		Сторінка, на яку потрібно поміщати елементи списку, які бот видаляє. За замовчуванням архів не створюється і видалені елементи просто зникають. Якщо задати архів, то він буде містити всю історію створення статей за заданими категоріями. Архів може бути єдиним, або розбиватися на роки, квартали (сезони). Для розбивки потрібно вставити відповідну змінну (можна дві). змінні: %(рік) — рік, буде підставлятися поточний рік: 2014,2015,2016,2017 й т.п. %(квартал) — квартал, буде підставлятися поточний квартал: 1,2,3,4. %(сезон) — сезон, буде підставлятися поточний сезон: літо, осінь, зима, весна. Сезони відповідають кварталам 1,2,3,4. Приклади: архів = Вікіпедія:Проект:Білорусь/Статті/%(рік)-%(квартал) архів = Вікіпедія:Проект:Освіта/Нові статті/Архів %(рік)
позначати правки	бот, мала бот мала ні	Позначати правки бота як ботоправки та малі. Значення за замовчуванням: бот, мала.
простір назв	0..15 чи 100..106	Задає номер простору назв, в якому вимагається шукати сторінки заданої категорії. За замовчуванням - 0, основний простір. Інші простори назв: картинки - 6, категорії - 14, шаблони - 10, портали - 100, проекти - 104, особисте - 2.
шапка		Значення цього параметру бот помістить на початок списку. Рядок «\n» буде замінена на переклад рядка. За замовчуванням цей параметр порожній.
підвал		Значення цього параметру бот помістить у кінець списку. Рядок «\n» буде замінена на переклад рядка. За замовчуванням: \n<noinclude> [[Категорія:Вікіпедія:Списки нових статтей за темами|{{PAGENAME}}]] </noinclude>. При установці свого значення параметру "підвал" рекомендується додавати в кінець значення за замовчуванням.
шаблони		не використовується
префікс		не використовується
роздільник	\n ", " ; та ін. варіанти	Роздільник між елементами списку. Значення за замовчуванням — \n (переклад рядка). Щоб вказати роздільник, що містить пробіл (пробіли), вкажіть його в подвійних лапках.
параметри архіву	зверху знизу нумерація решітками нумерація html-кодом глобальна нумерація html-кодом	За замовчуванням архів представляє собою довгий список, який доповнюється зверху новими елементами. В цьому рядку можна задавати особливі настройки для формування архіву. Бажані значення потрібно перелічити через кому. Параметри оновлення (за замовчуванням - зверху): зверху — архів буде оновлятися зверху знизу — архів буде оновлятися знизу Нумерація (опціонально, за замовчуванням — нема нумерації). Нумерація діє тільки зверху до долу. нумерація решітками — кожному елементові буде добавлений символ # (цей тип нумерації не працює для шаблону {{Нова стаття}}). нумерація html-кодом — елементи будуть пронумеровані (в кожній секції окремо) глобальна нумерація html-кодом — елементи будуть пронумеровані (єдина нумерація на весь архів)
формат заголовку в архіві		Шаблон, за яким створюються заголовки в архіві (для того щоб розбивати архів на розділи). За замовчуванням він порожній і заголовки не створюються. Якщо вказати шаблон, будуть створюватися заголовки. Шаблон повинен задавати заголовок рівня 2 (з двома '='). доступні змінні: %(рік) %(квартал) %(сезон) %(місяць) %(місяць у родовому відмінку) %(день) %(кількість) — кількість статтей за даний період, кількість статтей у розділі (див. приклад) Приклади: формат заголовку в архіві = == %(місяць) %(рік) == формат заголовку в архіві = == %(місяць) (%(кількість)) ==
формат підзаголовку в архіві		Шаблон, за яким створюються заголовки в архіві (щоб розбивати розділи архіву на підрозділи). За замовчуванням порожній і підрозділи не створюються. Шаблон повинен задавати заголовок рівня 3 (з трьома '='). За замовчуванням він пустий і заголовки не створюються. Довідку на шаблон див. вище. Приклади: формат підзаголовку в архіві = === %(день) %(місяць в родовому відмінку) ===
пошук картинки		Тільки для типів список нових статей із зображеннями та список нових статей із зображеннями в картці. Параметр вказує по яким тегам шукати картинку в картці статті. Також можна вказати, в яких шаблонах шукати дані теги. Формат: шаблон1:рядок1,рядок2;шаблон2:рядок1;шаблон3:рядок1,рядок2,рядок3;:рядокХ,рядокY . У даному випадку рядок1, рядок2, рядок3 шукається в окремих шаблонах, а рядокХ і рядокY шукається в будь-якому шаблоні (двокрапка необов'язково). Приклади: пошук картинки = image file,Фото,портрет,Зображення (значення за замовчуванням) пошук картинки = Монета:Аверс,Реверс,Зображення аверсу,Зображення реверсу;image file,Фото,портрет,Зображення (для порталу Нумізматика)
частота оновлень	1..2	Частота оновлень списку (один раз на добу). За замовчуванням 1, максимум - залежить від конфігурації боту.
ігнорувати авторів		Застарілий параметр.
перейменовані статті	нова назва	Застарілий параметр. Бот завжди підставляє нову назву.
видалені статті	видаляти	Застарілий параметр. Червоні посилання будуть видалені при оновленні.

Тестування шаблону

Для тестування шаблону використовуйте наступні сторінки:

• Користувач:NirvanaBot/Нові статті/пісочниця
• Користувач:NirvanaBot/Нові статті/тести