The plugin represents universal configured system of announcements on categories. Categories are adjusted, it is possible to create categories, subcategories and to delete them. Has possibility to appropriate to those or other categories of moderators from among users. Thus, the plugin scope is wide enough. Besides usual announcements on categories, the plugin can be applied as microforum, system of microblogs, announcements of novelties and etc. There is a possibility to activate an unloading of content of bulletin board in files by templates (for example for the publication on web-server). Has a system of search of announcements on keywords parametres and system of automatic removal of out-of-date announcements.
By command !doska_notice on/off notices in the general chat is made at addition of new announcements. On/off function of unloading of content in files is made by command !doska_write.
The editor of categories (and moderators of categories) is started by command !editor in PM. The editor of announcements (addition, removal or change) is started by command !message in PM. For reading and viewing of announcements in board use by command !read in PM. Function of search of announcements on key parametres is started by command !find in PM. For help use command !help in PM. Follow the further instructions of bot.
In table doska_Settings in file Vars.lua settings constants of plugin are contain. Here under indexes following parametres are set:
1 - plugin bot name;
2 - plugin bot description;
3 - plugin bot email;
4 - menu item name;
5 - users list visibility (1 - yes, 0 - no);
6 - the maximum resolved quantity of announcements of one user (on moderators of categories and administration does not extend);
7 - automatic removal of old announcements at addition by the user of the new announcement if the quantity of already available announcements exceeds the resolved limit (1 - yes, 0 - no). Does not extend on administration and moderators of categories if addition is made in category, where the user an moderator;
8 - quantity of days of storage of the announcement in board before automatic removal (0 - automatic removal disabled). It does not extend on announcements of administration and the announcement of moderators of categories;
9 - the maximum length of heading of the announcement symbols (0 - unlimited);
91 - the maximum length of the announcement symbols (0 - unlimited). Does not extend on administration and moderators of categories;
10 - the minimum class which is not checked on restrictions by quantity of announcements and length of content of the announcement;
11 - the table with list ways to files of templates and ways for final unloading of files. Here are one after another listed:
- way to template of the list of categories,
- way for an unloading of the list of categories,
- way to template of content of category,
- template of path for an unloading of content of category (flag [INDEX] in the address it is replaced with category index).
12 - way to folder for record of announcements;
13 - reception of templates for an unloading from URL, that is not from template file, and from web-page (1 - yes, 0 - no). In this case in ways to templates it is underlined full URL to template page;
14, 15, 16 - using GZip (1 - yes, 0 - no), the coding of page and the proxy-server address accordingly for function of reception of templates from URL;
17 - caching templates in memory (1 - yes, 0 - no). Do not use, if receive template from URL with dynamic contents.
In constant doska_PatternCodapage sets the pattern file codepage.
In the text of templates following flags are applied to an unloading:
[BotName], [hub], [time], [date] - bot name, the Hub name, time and date accordingly;
Flag [CATLIST:text1[SUBCATEGORIES:text2]text3] in template of the list of categories it is replaced with the list of categories with subcategories. Text2 serves for division of subcategories. Text1 and Text3 divide the basic category and subcategories before and after accordingly. Here flags %CATITEMS%, %CATPARENT%, %CATINDEX%, %CATNAME% are replaced with quantity of subcategories of the given category, an index of parental category, an index of category and the category name accordingly;
Flag [CATCONTENT:text1] in template of content of category it is replaced with category contents. Flags %FILENAME%, %FULLFILENAME%, %ITEMCONTENT%, %ITEMAUTHOR%, %ITEMNAME%, %ITEMINDEX%, %ITEMDATE%, %ITEMCONTENTLIMITn% (n - number of symbols of the text of the announcement for conclusion), %CATINDEX%, %CATNAME%, %CATPARENT% are replaced accordingly addressed to the announcement file, full way to an announcement file, the announcement text, the author Nick of the announcement, announcement heading, announcement index, announcement date, the text of the announcement with restriction to n symbols, category index, the name of category and an index of parental category.
In files OPHelp.txt and UserHelp.txt in plugin folder the text of the additional inquiry on plugin for operators and users can contain. The base of categories is stored in file doska_Kategorii.lua. The base of announcements is stored in file doska_Data.lua.