Участник:NirvanaBot/Новые статьи/doc

О шаблоне

Этот шаблон нужен для указания персональных настроек секции портала, чтобы она обновлялась ботом NirvanaBot. Шаблон задаёт все данные, как обновлять секцию. NirvanaBot обновляет в порталах и проектах такие секции как Новые статьи (пример), Новые шаблоны (пример), Новые категории (пример), Новые изображения (пример), Изображения новых статей (пример) и т.п., а также Список наблюдения (пример/пример), К удалению (пример), К переименованию, К улучшению, и статьи, выбранные по определенным критериям, например Статьи с сомнительной значимостью (пример), Лучшие статьи (добротные, хорошие, избранные) (пример).

Как пользоваться

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

Ошибки и статус работы показывается в u:NirvanaBot/Новые статьи/Отчёт.

Для копирования

Полностью	Только основные	Минимум
{{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 подкатегорий), то желательно внести их самые крупные вложенные категории также. Для каждой отдельной категории можно ограничить глубину её просмотра добавив после названия символ # и число. Например НазваниеКатегории#2, а НазваниеКатегории#0 равнозначно не искать в подкатегориях.
игнорировать		Список категорий (и их подкатегорий), страницы которых надо игнорировать при формировании списка. Категории должны перечисляться через запятую. Категории можно указывать в двойных кавычках, но необязательно.
сервис	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 или 4. Если тема (категория) большая и бот находит не все статьи, рекомендуется увеличить до 7-8 (значение более 8 не рекомендуется). Глубина 0 означает что бот просмотрит статьи только в данной категории, но не полезет вглубь в подкатегории.
формат элемента		Шаблон, по которому создаётся элемент (строка) списка. По умолчанию — «[[%(название)]]». Можно использовать следующие переменные (на месте этих переменных бот подставит какое-либо значение): %(название) — название страницы без указания пространства имён. Например, для статьи Византия вместо строчки «%(название)» бот подставит «Византия», а для категории Математика бот подставит «Математика»; %(автор) — имя участника, сделавшего первую правку на странице; %(дата) — дата и время первой правки на странице в универсальном формате (для списков "новые статьи", "новые статьи с изображениями"); дата обсуждения в формате "1 января 2000" (для списков "обсуждаемые статьи"); %(имя файла) — название файла, найденного на странице (только для типов «список новых статей с изображениями …»); %(обсуждение) — вики-ссылка на обсуждение, к примеру: [[Википедия:К удалению/25 сентября 2017#плохая статья|к удалению]]; бот сам подставит слово "к удалению", "к переименованию", "к объединению", "к улучшению", видя куда ведёт вики-ссылка. Шаблоны и названия конфигурируются здесь: Участник:NirvanaBot/Новые статьи/Настройки обсуждаемых статей.js Наиболее часто используемые варианты: формат элемента как выглядит [[%(название)]] Нептун {{Новая статья|%(название)|%(дата)|%(автор)}} Нептун — начато 28 июля 2003 участником Sergiusz {{Новая статья|%(название)|%(дата)|%(автор)|size=1}} Toyota Sports 800 (8239 байт) — начато 24 мая 2016 участником Korol Bumi * {{Шаблон:Новые статьи по дням/Новая статья|%(название)|%(автор)|%(дата)}} 17:06 — Нептун   Sergiusz * [[:Файл:%(название)|%(название)]] см. здесь Файл:%(имя файла)|[[%(название)]] см. здесь # [[Шаблон:%(название)|%(название)]] # Система Нептуна # {{cl|%(название)|1}} # [[Категория:Астрономические объекты, открытые в 1846 году]]
архив		Страница, на которую нужно помещать элементы списка, которые бот удаляет. По умолчанию архив не создаётся и удаляемые элементы просто исчезают. Если задать архив, то он будет содержать всю историю создания статей по заданным категориям. Архив может быть единым, или разбиваться на годы, кварталы (сезоны). Для разбиения нужно вставить соответствующую переменную (можно две). Переменные: %(год) — год, будет подставляться текущий год: 2011,2012,2013 и т.д. %(квартал) — квартал, будет подставляться текущий квартал: 1,2,3,4. %(сезон) — сезон, будет подставляться текущий сезон: зима, весна, лето, осень. Сезоны соответствуют кварталам 1,2,3,4. Примеры: архив = Проект:Музыка/Статьи/%(год)-%(квартал) архив = Проект:Астероиды/Новые статьи/Архив %(год)
помечать правки	бот, малая бот малая нет	Помечать правки бота как ботоправки и малые. Значение по умолчанию: бот, малая.
пространство имён	0, 0..15 или 100..106	Задаёт номер пространства имён, в котором требуется искать страницы заданной категории. По умолчанию — 0, основное пространство. Другие пространства имён: картинки — 6, категории — 14, шаблоны — 10, порталы — 100, проекты — 104, личное — 2.
шапка		Значение этого параметра бот поместит в начало списка. Строчка «\n» будет заменена на перевод строки. По умолчанию этот параметр пуст.
подвал		Значение этого параметра бот поместит в конец списка. Строчка «\n» будет заменена на перевод строки. По умолчанию: \n<noinclude> [[Категория:Википедия:Списки новых статей по темам|{{PAGENAME}}]] </noinclude>. При установке своего значения параметра "подвал" рекомендуется добавлять в конец значение по умолчанию.
шаблоны		Список шаблонов через запятую, которые должны присутствовать в статье. Только для типов статьи и обсуждаемые статьи. Как правило, используется для выборки добротных, хороших, избранных статей, статей года, и кандидатов в эти звания, также это может применяться для списков "К удалению", "К созданию" и "К переименованию". Если перечислить через запятую, бот будет искать статьи с любым из шаблонов в списке, если через ";" , бот будет искать статьи со всеми указанными шаблонами, если перед названием шаблона указать значок "!" или "^", то бот будет искать статьи, в которых нет ни одного из указанных шаблонов.
шаблоны с параметром		Наборы параметров, которые должны присутствовать в статье. Список наборов перечисляется через запятую. Каждый набор состоит из 3 частей: шаблон/параметр/значение Бот будет искать только те статьи, в которых найден шаблон "шаблон", в теле которого указан параметр "параметр", и в значении этого параметра найдена строка "значение". Например, если задать такие наборы: шаблоны с параметром = Музыкальный коллектив/Язык/Русский язык, Музыкальный коллектив/Язык/русский язык то бот будет искать статьи с шаблоном {{Музыкальный коллектив}}, в данных которого в параметре "язык" указан русский язык.
префикс	Википедия:К удалению/ Википедия:К переименованию/ Википедия:К объединению/ Википедия:К улучшению/ и т.д.	Может быть нужен для списков "обсуждаемые статьи". Обычно он не нужен, т.к. все популярные префиксы уже определены здесь: Участник:NirvanaBot/Новые статьи/Настройки обсуждаемых статей.js. Но если необходимого вам префикса нет, то его можно указать в этом параметре. Можно задавать несколько префиксов через запятую.
разделитель	\n ", " ; и др. варианты	Разделитель между элементами списка. Значение по умолчанию — \n (перевод строки). Чтобы указать разделитель, содержащий пробел(пробелы), укажите его в двойных кавычках.
параметры архива	сверху снизу нумерация решетками нумерация html-кодом глобальная нумерация html-кодом	По умолчанию архив представляет собой длинный список, который дополняется сверху новыми элементами. В этом поле можно задавать особые настройки для формирования архива. Желаемые значения нужно перечислить через запятую. Параметры обновления (по умолчанию — сверху): сверху — архив будет обновляться сверху снизу — архив будет обновляться снизу Нумерация (опционально, по умолчанию — нет нумерации). Нумерация действует только сверху вниз. нумерация решетками — каждому элементу будет добавлен символ # (этот тип нумерации не работает для шаблона {{Новая статья2}}). нумерация html-кодом — (Устаревший параметр) элементы будут пронумерованы (в каждой секции отдельно) глобальная нумерация html-кодом — (Устаревший параметр) элементы будут пронумерованы (единая нумерация на весь архив)
формат заголовка в архиве		Шаблон, по которому создаются заголовки в архиве (для того чтобы разбивать архив на разделы). По умолчанию он пуст и заголовки не создаются. Если указать шаблон, будут создаваться заголовки. Шаблон должен задавать заголовок уровня 2 (с двумя '='). Доступные переменные: %(год) %(квартал) %(сезон) %(месяц) %(месяц в родительном падеже) %(день) Примеры: формат заголовка в архиве = == %(месяц) %(год) ==
формат подзаголовка в архиве		Шаблон, по которому создаются заголовки в архиве (чтобы разбивать разделы архива на подразделы). По умолчанию пуст и подразделы не создаются. Шаблон должен задавать заголовок уровня 3 (с тремя '='). По умолчанию он пусти и заголовки не создаются. Справку по шаблону см. выше. Примеры: формат подзаголовка в архиве = === %(день) %(месяц в родительном падеже) ===
поиск картинки		Только для типов список новых статей с изображениями и список новых статей с изображениями в карточке. Параметр указывает по каким тегам искать картинку в карточке статьи. Также можно указать, в каких шаблонах искать данные теги. Формат: шаблон1:поле1,поле2;шаблон2:поле1;шаблон3:поле1,поле2,поле3;:полеХ,полеY . В данном случае поле1, поле2, поле3 ищутся в отдельных шаблонах, а полеХ и полеY ищется в любом шаблоне (двоеточие необязательно). Примеры: поиск картинки = image file,Фото,портрет,Изображение (значение по умолчанию) поиск картинки = Монета:Аверс,Реверс,Изображение аверса,Изображение реверса;image file,Фото,портрет,Изображение (для портала Нумизматика и бонистика)
частота обновлений	1, 1..2	Частота обновлений списка (раз в сутки). По умолчанию 1, максимум - зависит от конфигурации бота.
быстрый режим	да, нет	Быстрый режим. Обычно бот работает в быстром режиме. Это значит, он один раз запрашивает список новых статей у сервиса, посылая список категорий и игнорируемых категорий, и сразу, за один раз, получает все данные. Это быстро, поэтому и название - "быстрый режим". Иногда сервис не может осилить большой объём данных так сразу. Обычно это бывает, когда запрашивают "тяжелые" категории (категории, в которых колиество вложенных подкатегорий от тысячи и выше). В этом случае помогает отключение быстрого режима. Бот будет запрашивать каждую категорию по отдельности и сам будет обрабатывать результат (генерить 1 общий список из нескольких). Но если в параметрах запрашивается только 1 категория, то этот фокус не даст эффекта.
середина		Устаревший параметр. Используйте шаблон {{Колонки}} для разбиения списка на столбцы.
переименованные статьи	новое название	Устаревший параметр. Бот всегда подставляет новое название.
удаленные статьи	удалять	Устаревший параметр. Бот всегда удаляет статьи, которые были удалены из Википедии, и не оставляет красных ссылок.
игнорировать авторов		Устаревший параметр.

Тестирование шаблона

Для тестирования шаблона используйте следующие страницы:

• Участник:NirvanaBot/Новые статьи/песочница
• Участник:NirvanaBot/Новые статьи/тесты