Плагин представляет собой универсальную конфигурируемую систему объявлений по категориям. Категории настраиваются, можно создавать категории, подкатегории и удалять их. Есть возможность присваивать тем или иным категориям модераторов из числа пользователей. Таким образом, область применения плагина довольно широка. Помимо обычных объявлений по категориям, плагин можно применять как микрофорум, систему микроблогов, анонсов новинок и т.д. Есть возможность активировать выгрузку контента доски объявлений в файлы по шаблонам (например для публикации на web-сервере). Есть система поиска объявлений по ключевым параметрам и система автоматического удаления устаревших объявлений.
Командой !doska_notice производится включение/выключение уведомлений в общий чат при добавлении новых объявлений. Включение/выключение функции выгрузки контента в файлы производится по команде !doska_write.
Редактор категорий (и модераторов категорий) запускается по команде !editor в приват боту плагина. Редактор объявлений (добавление, удаление или изменение) запускается командой !message в приват боту плагина. Для чтения и просмотра объявлений в доске используйте команду !read в приват боту плагина. Функция поиска объявлений по ключевым параметрам запускается командой !find в приват боту плагина. Для справки используйте команду !help в приват боту плагина. Следуйте дальнейшим указаниям бота.
В таблице doska_Settings в файле Vars.lua содержатся константы настроек плагина. Здесь под индексами заданы следующие параметры:
1 - имя бота плагина;
2 - описание бота плагина;
3 - email бота плагина;
4 - название пункта меню;
5 - видимость бота плагина в списке пользователей (1 - виден, 0 - нет);
6 - максимальное разрешённое количество объявлений одного пользователя (на модераторов категорий и администрацию не распространяется);
7 - автоматическое удаление старых объявлений при добавлении пользователем нового объявления, если количество уже имеющихся объявлений превышает разрешённый лимит (1 - да, 0 - нет). Не распространяется на администрацию и модераторов категорий, если добавление производится в категорию, где пользователь модератор;
8 - количество суток хранения объявления в доске до автоматического удаления (0 - автоудаление отключено). Это не распространяется на объявления администрации и объявления модераторов категорий;
9 - максимальная длина заголовка объявления в символах (0 - неограниченно);
91 - максимальная длина объявления в символах (0 - неограниченно). Не распространяется на администрацию и модераторов категорий;
10 - минимальный класс, который не проверяется на ограничения по количеству объявлений и длине контента объявления;
11 - таблица с перечнем путей к файлам шаблонов и путей для конечной выгрузки файлов. Здесь по порядку перечислены:
- путь к шаблону списка категорий,
- путь для выгрузки списка категорий,
- путь к шаблону контента категории,
- шаблон пути для выгрузки контента категории (флаг [INDEX] в адресе заменяется на индекс категории).
12 - путь к папке для записи объявлений;
13 - получение шаблонов для выгрузки из URL, то есть не из файла шаблона, а из web-страницы (1 - да, 0 - нет). В этом случае в путях к шаблонам указывается полный URL к странице шаблона);
14, 15, 16 - использование GZip (1-да,0-нет), кодировка страницы и адрес прокси-сервера соответственно для функции получения шаблонов из URL;
17 - кэширование шаблонов в памяти (1-да,0-нет). Не используйте, если получаете шаблон из URL с динамическим содержимым.
В константе doska_PatternCodapage задаётся кодировка файла шаблона.
В тексте шаблонов для выгрузки применяются следующие флаги:
[BotName], [hub], [time], [date] - имя Бота, название Хаба, время и дата соответственно;
Флаг [CATLIST:текст1[SUBCATEGORIES:текст2]текст3] внутри шаблона списка категорий заменяется на перечень категорий с подкатегориями. Текст2 служит для разделения подкатегорий. Текст1 и Текст3 разделяют основную категорию и подкатегории до и после соответственно. Здесь вставки %CATITEMS%, %CATPARENT%, %CATINDEX%, %CATNAME% заменяются на количество подкатегорий данной категории, индекс родительской категории, индекс категории и название категории соответственно;
Флаг [CATCONTENT:текст1] внутри шаблона контента категории заменяется на содержимое категории. Вставки %FILENAME%, %FULLFILENAME%, %ITEMCONTENT%, %ITEMAUTHOR%, %ITEMNAME%, %ITEMINDEX%, %ITEMDATE%, %ITEMCONTENTLIMITn% (n - число символов текста объявления для вывода), %CATINDEX%, %CATNAME%, %CATPARENT% заменяются соответственно на имя файла объявления, полный путь к файлу объявления, текст объявления, ник автора объявления, заголовок объявления, индекс объявления, дата объявления, текст объявления с ограничением до n символов, индекс категории, название категории и индекс родительской категории.
В файлах OPHelp.txt и UserHelp.txt внутри папки плагина может содержаться текст дополнительной справки по плагину для операторов и пользователей. База категорий хранится в файле doska_Kategorii.lua. База объявлений хранится в файле doska_Data.lua.