Быстрый старт
Если вы хотите использовать параметры по умолчанию и просто запустить архивы на своей странице, вы можете использовать {{ subst : User: ClueBot III / JustArchiveThis }}. Просто поместите это вверху страницы обсуждения, которую вы хотите заархивировать:
{{subst: Пользователь: ClueBot III / JustArchiveThis}}
Если вы хотите настроить его больше, прочтите, как использовать полный шаблон ArchiveThis.
Как ваша страница архивируется
ClueBot III можно использовать для автоматического архивирования разделов / цепочек с заданной страницы. Обычно страница, с которой вы архивируете, будет страницей обсуждения. Страницы вашего архива могут быть организованы по дате или пронумерованы. Также возможны комбинации дат и нумерации. Это настраивается аргументами, используемыми для параметров формата и префикса архива . Пожалуйста, ознакомьтесь с описанием параметров и примерами некоторых из множества способов сделать это.
Как ClueBot III узнает, когда архивировать мою страницу?
ClueBot III работает на основе истории изменений рассматриваемой страницы, а не на основе временных меток, связанных с подписями. Это означает, что практика добавления метки времени вручную в будущем не поможет ClueBot III заархивировать поток. Кроме того, за один цикл архивирования ClueBot III выберет цель архива и заархивирует все подходящие потоки в этот архив. Это означает, что при первоначальной настройке ClueBot III, если у вас есть неопрятные архивы, он перенесет все старые разговоры в любой архив, который он считает текущим. Это также означает, что на страницах с очень длинными потоками обсуждения весь поток будет заархивирован в текущий архив, что может привести к небольшому переполнению архивов на основе размера.
Сохранение связи
После архивирования серии потоков ClueBot III ищет все страницы, которые могли быть связаны с перемещенными частями, и обновляет ссылки, которые необходимо исправить. Когда страница связана с огромным количеством других страниц, процесс занимает много времени. В любом случае, это причина коллапса, описанная в разговоре с пользователем: Jimbo Wales / Archive_202 # Conspiracy Unveiled . Сказано более четко: не используйте ClueBot III на странице, где ссылки "что" здесь большие.
Генерация индекса
Помимо архивирования вашей страницы, ClueBot III может также создать индекс всех ваших архивных страниц. Предполагая, что вы архивируете страницуОбсуждение: YourPage, индекс архива, сгенерированный ClueBot III, находится по адресу:
Пользователь: ClueBot III / Мастер подробных указателей / Обсуждение: YourPage
Вы можете использовать его напрямую или включив его в свой Обсуждение: YourPage / Archive indexстраница. Один из способов использовать это напрямую - включить его в качестве страницы индекса архива в ваше архивное окно. Например:
{{Archives |auto= short |index= User:ClueBot III/Master Detailed Indices/{{FULLPAGENAME}} |search= yes |bot= ClueBot III |age= 90}}
создаст окно архива с соответствующей ссылкой на ваш индекс.
Если вы хотите использовать этот индекс с шаблоном {{ talk header }}, вам нужно будет включить его в свойОбсуждение: YourPage / Archive indexстраница. Для этого вы должны поместить текст:
{{User:ClueBot III/Master Detailed Indices/{{NAMESPACE}}:{{BASEPAGENAME}}}}
на свойОбсуждение: YourPage / Archive index страница.
Общий формат шаблона
Общий формат шаблона архива:
{{Пользователь: ClueBot III / ArchiveThis| archiveprefix =| формат =| возраст =}}
Обязательные параметры
age
Тип : целое число без знака
По умолчанию : 0
Описание : Этот параметр должен быть установлен на количество часов, в течение которых поток может оставаться без ответа, прежде чем он должен быть заархивирован. Если вы не установите его, все потоки будут заархивированы. Для 30 дней введите 720, а для одного года введите 8760.
archiveprefix
Тип : строка
Описание : Этот параметр должен быть установлен на полное имя страницы под страницей, которую вы хотите заархивировать. Например, еслиОбсуждение пользователей: Кобиархивируется с использованием датированных архивов, тогда archiveprefix=User talk:Cobi/Archives/
было бы уместно. Для той же страницы, архивируемой с пронумерованными архивами, archiveprefix=User talk:Cobi/Archive
будет уместно. Неправильная установка этого параметра может привести к странным результатам. {{ FULLPAGENAME }} переменная не может быть фактически передан ClueBot III. Полное имя страницы должно быть жестко закодировано. Самый простой способ сделать это - использовать немедленную замену, например:
Для архивов, упорядоченных по дате, введите: Для пронумерованных архивов введите (примечание|archiveprefix={{subst:FULLPAGENAME}}/Archives/
/Архив вместо / Архивы /):|archiveprefix={{subst:FULLPAGENAME}}/Archive
Предупреждение: системные переменные, такие как {{SUBST: FULLPAGENAME}}, заменяются именем страницы для архивации, когда системная переменная сохраняется на странице для архивации. Однако некоторые знаки пунктуации, которые могут появляться в имени страницы ( "&'
), заменяются кодами символов HTML, которые не распознаются ботом ( подробности об этих и других символах см. В mediawikiwiki: Руководство: Кодировка PAGENAMEE ). Например '
, заменяется на '
(поэтому, если бот должен работать, его '
необходимо заменить на '
.
Формат
Тип : Строка По
умолчанию : «»
Описание : Этот параметр должен быть установлен на правильный аргумент PHP «s дата () функцию. Вы также можете включить%%я значение. %%япредназначен для пронумерованных архивов вместо датированных архивов и заменяется номером архива. После подстановки переменной она будет добавлена в конец значения archiveprefix . Результатом объединения будет имя страницы (страниц) архива. См. Примеры. Чаще всего, для архивов , организованный с использованием даты: |format=Y/F
. Это дает «Архив / 2016 / Январь». Чтобы получить "Архив / 2016/01 (Январь)", используйте |format=Y/m (F)
.
Для нумерованных архивов используйте: |format= %%i
Примечание для архивов на основе даты: Cluebot III сохраняет файлы на одной странице архива при каждом запуске . В архивах на основе даты имя страницы может быть любым.archiveprefix в сочетании с форматдля даты, являющейся СЕЙЧАС-возрастом (где возраст указан в часах). Например, если вы запускаете архивирование YYYY / Month с нуля с большим количеством старых потоков на архивируемой странице, ClueBot II поместит все потоки в один файл, а не в несколько файлов. Если вы хотите, чтобы один прогон архивирования был разделен на несколько файлов на основе последней даты в каждом потоке, вам нужно будет использовать строчные буквы sigmabot III .
Примечание: format= %%i
в большинстве случаев лучше. format=Y/F
может оказаться так много крошечных архивов, на просмотр которых вручную может уйти вечность, когда вы не знаете, какой поисковый запрос искать с помощью инструмента поиска в архивах.
Необязательные параметры
Эти параметры определяют поведение архиватора.
archivenow
Тип : массив строк, разделенных запятыми.
По умолчанию : ""
Описание : Этот необязательный параметр должен содержать список строк, разделенных запятыми, которые ClueBot III будет искать в потоках на странице. Если какая-либо из этих строк будет найдена в потоке, бот немедленно заархивирует поток. Бот также преобразует {{шаблоны}} в этом списке в {{tl | экранированные шаблоны}} при архивировании. Это может быть полезно для страниц, где используется {{ разрешено }} или подобное. Для этого доступен пустой шаблон {{ User: ClueBot III / ArchiveNow }}. Однако особых свойств у него нет. Это всего лишь еще одна строка, которая является шаблоном, который ClueBot III может найти. В дополнении к следующему типичному использованию, пример его использование показан ниже .
Типичное использование:|archivenow=
header
Тип : строка
По умолчанию : "{{ Talkarchive }}"
Описание : При создании новой страницы архива бот помещает ее в верхнюю часть новой страницы.
headerlevel
Тип : целое число без знака, от 1 до 7 включительно.
По умолчанию : 2
Описание : это уровень заголовка для потоков, которые бот будет архивировать. Все, что находится на странице до первого заголовка этого уровня, не будет заархивировано. Заголовок уровня 1 - = Header =
это заголовок потока по умолчанию (уровень 2) == Header ==
, а заголовок самого высокого уровня - это уровень 7 : ======= Header =======
.
key
Тип : строка
По умолчанию : ""
Описание : Значение этого параметра должно соответствовать внутреннему сгенерированному ключу, чтобы архивы могли храниться где-либо, кроме как подстраницы архивируемой страницы.
maxarchsize
Тип : целое число без знака, больше 10000
По умолчанию : 0
Описание : Целевой максимальный размер архива в байтах до увеличения %% i (см. формат ). Если 0, это отключено. Обычно этот параметр используется для пронумерованных архивов, но не для архивов, упорядоченных по дате. Это не жесткий предел. Размеры результирующих страниц архива почти всегда будут превышать это число, возможно, намного. Каждый раз, когда ClueBot III запускается на странице, он архивирует все потоки, которые достаточно старые, чтобы их можно было архивировать, в один файл. Если у вас есть maxarchsize=100000
текущий размер файла архива 90 КБ, и в итоге осталось 60 потоков для архивации с общим размером 250 КБ, то текущий архив будет расширен до 340 КБ, несмотря на ограничение в 100 КБ.
maxkeepbytes
Тип : целое число без знака
По умолчанию : 0
Описание : Если больше 0, это максимальное количество байтов содержимого потока, которое необходимо сохранить на странице обсуждения. Старые потоки принудительно архивируются, если на странице больше, чем это количество байтов содержимого потока. Если 0, эта опция отключена.
maxkeepthreads
Тип : целое число без знака
По умолчанию : 0
Описание : Если больше 0, это максимальное количество потоков, которые необходимо сохранить на странице обсуждения. Старые темы принудительно архивируются, если количество потоков на странице превышает указанное. Если 0, эта опция отключена.
minarchthreads
Тип : целое число без знака
По умолчанию : 0
Описание : бот не будет архивировать, если только это количество или несколько разделов не нуждаются в архивировании.
minkeepthreads
Тип : целое число без знака
По умолчанию : 0
Описание : бот не будет архивировать, если на странице останется столько или меньше разделов.
n Generateindex
Тип : целое число без знака (логическое)
По умолчанию : 0
Описание : Если установлено значение 1, бот не будет генерировать индекс в User: ClueBot III / Indices / . Есть очень мало раз этот вариант следует использовать. Если используется этот параметр, параметр индекса больше не будет работать правильно.
numberstart
Тип : целое число без знака
По умолчанию : 1
Описание : Значение по умолчанию для %% i в формате .
transformheader Внимание! Недопустимая опция здесь может испортить ваши архивы!
Тип : строка,поиск === заменить пары, разделенные &&&
По умолчанию : ""
Описание : Преобразование заархивированных заголовков потоков. Для каждой парыпоиск должно быть действительным регулярным выражением и заменятьэто строка замены. См. Это для получения дополнительной информации,поиск соответствует $ шаблон, заменять соответствует $ замена, а заголовок потока соответствует $ тема. Если вы не понимаете, что это значит, не пытайтесь его использовать. Вместо этого попросите помощи у Коби .
Косметические параметры
Эти параметры формируют окно архива, отображаемое на странице, где активно архивирование.
![]() Архивы |
Архивов пока нет. |
Эта страница находится в архиве ClueBot III . |
archivebox
Тип : строка ("да" или "нет")
По умолчанию : "no"
Описание : вызывает отображение окна архива, как {{ архивы }}.
В примере окна архива значение, отличное от значения по умолчанию, равно archivebox=yes
.
box-width Тип : строка
По умолчанию : "238px"
Описание : ширина окна архива. Этот параметр действителен только в том случае, еслиarchivebox=yes.
![]() Архивы |
Архивов пока нет. |
Эта страница находится в архиве ClueBot III . |
box-Advert
Тип : строка («да» или «нет»)
По умолчанию : «нет»
Описание : отображает строку «Эта страница заархивирована ClueBot III ». внизу коробки архива. Этот параметр действителен, только если archivebox=yes
.
В примере окна архива установлено значение, отличное от значения по умолчанию box-advert=yes
. Сравните этот пример с примером рядом с параметром archivebox .
![]() Архивы |
Архивов пока нет. |
Эта страница находится в архиве ClueBot III . |
box-separator Тип : строка («да» или «нет»)
По умолчанию : «да»
Описание : отображение разделительных линий в поле архива. Этот параметр действителен, только если archivebox=yes
.
В примере окна архива установлено значение, отличное от значения по умолчанию box-separator=no
. Сравните этот пример с примером рядом с параметром archivebox .
![]() Архивы |
Архивов пока нет. |
Эта страница находится в архиве ClueBot III . |
image
Тип : строка
По умолчанию : "[[Файл: Crystal Clear app file-manager.png]]"
Описание : Если установлено, это альтернативный файл изображения, который будет использоваться в качестве значка архива в окне архива. Этот параметр действителен, только если archivebox=yes
.
В примере окна архива установлено значение, отличное от значения по умолчанию image=[[File:Exquisite-folder font.png|40px]]
. Обратите внимание, что размер изображения должен быть указан как часть аргумента этого параметра, а не в параметре image -width . Сравните этот пример с примером рядом с параметром archivebox .
image-width Тип : string
По умолчанию : "40px"
Описание : Ширина изображения в поле архива. Этот параметр действителен только в том случае , archivebox=yes
и вы используете изображение по умолчанию.
![]() Архивы |
Архивов пока нет. |
Эта страница находится в архиве ClueBot III . |
Тип поиска : строка («да» или «нет»)
По умолчанию : «да»
Описание : отображение поля поиска в поле архива. Этот параметр действителен только в том случае, если archivebox=yes
. Пример окна архива имеет значение, отличное от значения по умолчанию search=no
. Сравните этот пример с примером рядом с параметром archivebox .
talkcolor /talkcolour Тип : string
По умолчанию : ""
Описание : Этот параметр действителен только в том случае, если archivebox=yes
страница, на которой отображается окно архива, находится вОбсуждение пользователейпространство имен. Если не установлено или установлено любое другое значение, кроме « Да» , цветовая схема окна архива наОбсуждение пользователейстраница не будет стандартной цветовой схемой страницы обсуждения. В таком случае ящик архива будет использовать ту же цветовую схему, что и ящик архива на страницах без обсуждения. Если для этого параметра установлено значение « Да» и страница, на которой отображается окно архива, находится вОбсуждение пользователейпространство имен, окно архива будет использовать стандартную цветовую схему страницы обсуждения.
Эти два параметра эквивалентны и предоставляются только во избежание войны на истощение в стиле MOS.
index
Тип : string
По умолчанию : ""
Описание : Все значения этого параметра эквивалентны, кроме yes . Для этого параметра не следует устанавливать значение « да», если вы не обернули шаблон ClueBot III в {{ архивы }}. Использование index=yes
результатов в ClueBot III автоматически генерирует индекс, содержащийся на страницеПользователь: ClueBot III / Индексы / Обсуждение: YourPageбудучи включены через наОбсуждение: YourPageвместо шаблона {{ User: ClueBot III / ArchiveThis }} наОбсуждение: YourPage.
Этот параметр действителен, только если archivebox=no
. Если archivebox=yes
этот параметр не влияет на включение индекса в поле архива и не вызывает копиюПользователь: ClueBot III / Индексы / Обсуждение: YourPageбыть включенным вОбсуждение: YourPage.
как в {{archives|{{User:ClueBot III/ArchiveThis}}}}
![]() Архивы |
---|
Пользователь: ClueBot III / Индексы / Пользователь: ClueBot III / ArchiveThis |
Примеры
Следующие ниже примеры можно вырезать и вставить в верхнюю часть страницы, которую вы хотите заархивировать. {{ subst: FULLPAGENAME }} будет заменено именем страницы, которую вы редактируете при сохранении страницы.
В тексте, поясняющем следующие примеры, предполагается, что {{ subst: FULLPAGENAME }} оценивается какОбсуждение: YourPage. Другими словами, этоОбсуждение: YourPageэто страница, которую вы архивируете.
Возраст во всех этих примерах установлен на 2160 часов, что составляет 90 дней. Если вам нужно другое количество времени, измените аргумент возраста.
Пример: архивы по дате (без поля архива)
{{Пользователь: ClueBot III / ArchiveThis| archiveprefix = {{subst: FULLPAGENAME}} / Архивы /| формат = Y / F| возраст = 2160}}
Подстраницы архива, созданные в этом примере, будут иметь следующий формат:
Обсуждение: YourPage / Archives / 2013 / июнь
Обсуждение: YourPage / Archives / 2013 / июль
...
Пример: архивы по дате (с ящиком архива)
{{Пользователь: ClueBot III / ArchiveThis| archiveprefix = {{subst: FULLPAGENAME}} / Архивы /| формат = Y / F| возраст = 2160| archivebox = да| box-Advert = да}}
Подстраницы, созданные при необходимости для ваших архивов в этом примере, будут называться примерно так:
Обсуждение: YourPage / Archives / 2013 / июнь
Обсуждение: YourPage / Archives / 2013 / июль
...
Пример: пронумерованные архивы (без архивного ящика)
{{Пользователь: ClueBot III / ArchiveThis| archiveprefix = {{subst: FULLPAGENAME}} / Архив| формат = %% i| возраст = 2160| maxarchsize = 150000| numberstart = 1}}
Подстраницы, созданные при необходимости для ваших архивов в этом примере, будут называться примерно так:
Обсуждение: YourPage / Archive 1
Обсуждение: YourPage / Archive 2
...
Пример: пронумерованные архивы (с архивным ящиком)
{{Пользователь: ClueBot III / ArchiveThis| archiveprefix = {{subst: FULLPAGENAME}} / Архив| формат = %% i| возраст = 2160| maxarchsize = 150000| numberstart = 1| archivebox = да| box-Advert = да}}
Подстраницы, созданные при необходимости для ваших архивов в этом примере, будут называться примерно так:
Обсуждение: YourPage / Archive 1
Обсуждение: YourPage / Archive 2
...
Пример: по году и пронумерованный (с архивным ящиком)
{{Пользователь: ClueBot III / ArchiveThis| archiveprefix = {{subst: FULLPAGENAME}} / Архивы /| формат = Y %% i| возраст = 2160| minarchthreads = 0| minkeepthreads = 0| archivenow ={{Пользователь: ClueBot III / ArchiveNow}}, {{разрешено |, {{Решено |, {{сделано}}, {{Done}} )| header ={{Автоматический навигатор архивов}} | headerlevel = 2| nogenrateindex = 0| maxkeepthreads = 0| maxkeepbytes = 0| maxarchsize = 150000| numberstart = 1| archivebox = да| box-Advert = да}}
Подстраницы, созданные при необходимости для ваших архивов в этом примере, будут называться примерно так:
Обсуждение: YourPage / Archives / 2012 1
Обсуждение: YourPage / Archives / 2012 2
...
Обсуждение: YourPage / Archives / 2013 1
Обсуждение: YourPage / Archives / 2013 2
...
Пример: переход с MiszaBot на ClueBot III
MiszaBot | ClueBot III |
---|---|
{{Пользователь: MiszaBot / config | archive = {{subst: FULLPAGENAME}} / Архив% (счетчик) d| algo = старый (90d)| archiveheader = {{aan}}| maxarchivesize = 100 КБ| minthreadsleft = 2| counter = 20}} | {{Пользователь: ClueBot III / ArchiveThis| archiveprefix = {{subst: FULLPAGENAME}} / Архив| возраст = 2160| header = {{aan}}| maxarchsize = 100000| minkeepthreads = 2| numberstart = 21| формат = %% i}} |
Подстраницы, созданные при необходимости для ваших архивов в этом примере, будут называться примерно так:
Обсуждение: YourPage / Archive 21
Обсуждение: YourPage / Archive 22
...
Номер начала на один больше, чем последний, использованный MiszaBot, потому что при первом запуске ClueBot III может архивироваться большое количество разделов. Увеличение на единицу предотвратит добавление текущего архива. В случае, из которого взят этот пример, к странице архива 90 КБ были добавлены дополнительные 100 КБ, оставив страницу 190 КБ, для которой должен был быть максимум 100 КБ. Об этом сообщалось как об ошибке.
Возраст указывается в часах, а не в днях. 90 дней - это 2160 часов.
Если вы используете шаблон {{ Archives }} или другой шаблон, показывающий, какой архиватор вы используете, не забудьте изменить: на:{{Archives |auto= short |index= /Archive index |search= yes |bot= MiszaBot I |age= 90}}
{{Archives |auto= short |index= /Archive index |search= yes |bot= ClueBot III |age= 90}}