Користувач:DixonDBot II/Інструкції
Налаштування архівування
ред.Додайте такий код на сторінку, для якої ви хочете налаштувати автоматичне архівування ботом DixonDBot II:
{{Користувач:DixonDBot II/config | olderThan = *кількість днів*d | archive = *шаблон назви сторінок архіву* [інші параметри - див. нижче] }}
Заготовки конфігурації
ред.Приклад 1 - архіви з авторозбиттям
ред.{{Користувач:DixonDBot II/config | olderThan = 90d | archive = {{subst:FULLPAGENAME}}/Архів %counter% | counter = 1 | maxArchiveSize = 70K | archiveHeader = {{Архів обговорення}} | minThreadsToArchive = 2 | minThreadsLeft = 5 }}
Ця конфігурація може підійти більшості користувачам і використовує значення параметрів по замовчуванню. Тому, якщо вони вас задовільняють, ви можете використати просто
{{Користувач:DixonDBot II/config}}
Детальніше, згідно з цієї конфігурацією бот буде архівувати обговорення старіші, ніж 3 місяці тому (90 днів). Спочатку він розпочне архівування до підсторінки "/Архів 1". Після того, як буде досягнуто обмеження по розміру (70КБ), бот буде архівувати обговорення до сторінки "/Архів 2" і так далі. Більш детально, пояснення параметрів, див. Параметри.
Приклад 2 - архіви по місяцях
ред.{{Користувач:DixonDBot II/config | olderThan = 30d | archive = {{subst:FULLPAGENAME}}/Архіви/%year%/%monthname% }}
Згідно з цією конфігурацією обговорення, старіші ніж 30 днів, будуть переміщені до архівів відповідно до їхньої дати (дати останнього підпису у обговоренні). Більше про змінні, які можна використовувати у шаблоні назви сторінок архівів, читайте тут.
Приклад 3 - статичний архів
ред.{{Користувач:DixonDBot II/config | olderThan = 10d | archive = {{subst:FULLPAGENAME}}/Архів }}
Найпростіший, але напевно не найкращий варіант. Обговорення, старіші, ніж 10 днів, будуть переміщені завжди на одну й ту ж сторінку.
Приклад 4 - ретроспективне архівування
ред.Будь-який з попередніх прикладів можна використати разом з ретроспективним архівуванням, яке дозволить заархівувати всі минулі обговорення, що є у історії сторінки. Ця опція корисна, якщо вам потрібно переформатувати архіви з одного формату в інший. Інші зауваження щодо ретроспективного архівування ви можете знайти у розділі Параметри.
Приклад архівів з авторозбиттям та ретроспективним архівуванням:
{{Користувач:DixonDBot II/config | olderThan = 30d | archive = {{subst:FULLPAGENAME}}/Архів %counter% | counter = 1 | maxArchiveSize = 150K | retrospective = True }}
Параметри
ред.{{Користувач:DixonDBot II/config | olderThan = | archive = | counter = | maxArchiveSize = | archiveHeader = | minThreadsToArchive = | minThreadsLeft = | retrospective = | signUnsigned = }}
Параметр | Опис | Значення по замовчуванню |
---|---|---|
olderThan | Час, після якого обговорення переміщаються до архіву. На даний час, підтримуються два формати - у годинах або днях: (24h, 72h, 5d, 21d тощо) | 90d |
archive | Назва сторінки, на яку будуть переміщуватися заархівовані обговорення. Цей параметр підтримує використання змінних, за допомогою яких можна налаштувати динамічні назви архівів. Зауважте, що назви, які не є підсторінками сторінки, що архівується, не будуть працювати | {{subst:FULLPAGENAME}}/Архів %counter% |
counter | Поточне значення лічильника архівів. Має сенс тільки, якщо параметр archive використовує змінну %counter%. Бот автоматично оновлює значення цього параметру, якщо потрібно | 1 |
maxArchiveSize | Максимальний розмір архіву перед тим, як переходити до наступного (збільшивши лічильник). Ігнорується, якщо %counter% не використовується. Значення може бути просто числом байт або містити "K" або "К" в кінці, що означає кілобайти. Наприклад: {{{1}}} | 70K |
minThreadsLeft | Мінімальна кількість обговорень, яка залишається на сторінці (щоб не залишати порожні сторінки). | 5 |
minThreadsToArchive | Мінімальна кількість обговорень, яку слід переміщати до архіву. Якщо кількість обговорень, що потрібно архівувати, є меншою, ніж це значення, бот не буде робити нічого на сторінці. | 2 |
archiveHeader | Текст, що буде поміщатися зверху новостворених архівів. Зазвичай є включенням шаблону на кшталт {{архів}}. | {{Архів обговорення}} |
retrospective | Логічне значення (так/ні), що вказує чи виконувати "ретроспективне архівування". Цей тип архівування означає, що бот пройдеться по всій історії сторінки, і заархівує всі обговорення, які були коли-небудь вилучені. Зауважте, що це може дати в результаті зайві обговорення (скажімо, вилучений вандалізм) та дуплікати (наприклад, назва розділу і текст були дещо змінені - бот не зрозуміє, що це одне і те ж обговорення), тому варто переглянути архіви після завершення цього типу архівування. Після першого архівування бот автоматично вилучить цей параметр з конфігурації. | False |
signUnsigned | Логічне значення (так/ні), що вказує чи потрібно ставити поточну дату на обговореннях, що не містять жодного підпису з датою. Оскільки бот не архівує обговорень без дат, це потрібно, щоб обговорення було врешті-решт колись заархівовано. | True |
Змінні назви архіву
ред.Змінна | Замінються на... |
---|---|
%counter% | поточне значення лічильника |
%year% | рік обговорення, що архівується |
%month% | місяць (як число 1-12) обговорення, що архівується |
%monthname% | назва місяця обговорення, що архівується |
Зауваження
ред.- Як вже було сказано, бот не архівує розділи без підписів з датою.
- Бот не архівує обговорення перед першим розділом.
- Бот вважає, що всі шаблони, категорії, інтервіки, коментарі внизу сторінки не належать до останнього обговорення.
Проблеми чи питання?
ред.Напишіть коментар на сторінці обговорення бота.