Manual:Pywikibot/archivebot.py/setup/cs
archivebot.py je skript pro archivaci diskusních stránek. Tento dokument vysvětluje, jak nastavit diskusní stránky na wiki pro automatickou archivaci prováděnou tímto robotem. Dokumentaci k ovládání robota naleznete v sekci Příručka:Pywikibot/archivebot.py.
Jak robota nastavit pro diskusní stránku
Tento robot zpracovává pouze stránky, které jsou explicitně označeny zahrnutím šablony značek, a archivuje sekce neaktivní po stanovenou dobu.
Běžně používaná šablona značky je {{User:MiszaBot/config|...}}.
Šablona může mít parametry popsané níže.
(Většina z nich je volitelná.)
{{TEMPLATE_PAGE
|archive =
|algo =
|counter =
|maxarchivesize =
|minthreadsleft =
|minthreadstoarchive =
|archiveheader =
|key =
}}
Aby bylo možné archivovat sekci, musí se jednat o sekci úrovně 2, označenou ==.
U některých sekcí je možné se odhlásit: viz vysvětlení níže.
Parametry šablony
Významy parametrů šablony jsou:
| Parametr šablony | Popis |
|---|---|
archive |
Název stránky, na kterou budou uložena archivovaná vlákna. Musí se jednat o podstránku aktuální stránky. Proměnné jsou podporovány. |
algo |
Určuje maximální stáří vlákna. Musí být ve tvaru old(delay), kde delay určuje stáří v hodinách nebo dnech, například 24h (24 hodin) nebo 5d (5 dní). Výchozí hodnota je old(24h). |
counter |
Aktuální hodnota čítače, která může být přiřazena jako proměnná. Bude aktualizována botem. Počáteční hodnota je 1. |
maxarchivesize |
Maximální velikost archivu před zvýšením čítače. Hodnota může být zadána s připojeným písmenem, například K nebo M, které označuje KByte nebo MByte. Výchozí hodnota je 1000M (1000 megabajtů). |
minthreadsleft |
Minimální počet vláken, které by měly na stránce zůstat. Výchozí hodnota je 5. |
minthreadstoarchive |
Minimální počet vláken k archivaci najednou. Výchozí hodnota je 2. |
archiveheader |
Obsah, který bude umístěn na nové stránky archivu jako záhlaví. Tento parametr podporuje použití proměnných. Výchozí hodnota je {{talkarchive}}. |
key |
Tajný klíč, který (pokud je platný) umožňuje, aby archivy nebyly podstránkami archivované stránky. |
Proměnné pro předlohy názvů stránek
V parametru archive v šabloně lze použít následující proměnné.
| Proměnná | Rozšiřuje se na... |
|---|---|
%(counter)d |
Aktuální hodnota counter |
%(year)d |
Rok archivace vlákna |
%(quarter)d |
Čtvrtletí (1–4) archivovaného vlákna |
%(month)d |
Číslo měsíce (1–12) archivování vlákna |
%(month)02d |
Dvoumístný číselný údaj měsíce (01–12) |
%(monthname)s |
Anglický název měsíce |
%(monthnameshort)s |
První tři písmena názvu měsíce |
Jak zabránit archivaci
Chcete-li zabránit archivaci sekce (vlákna) na omezenou dobu, můžete sekci upravit a vložit podpis s budoucím časovým razítkem. Root vlákno archivuje až v tomto okamžiku. Ujistěte se, že podpis je správně naformátován. Musí obsahovat uživatelské jméno a datum přesně ve stejném formátu jako správný podpis, jinak jej robot nerozpozná.
Archivaci vlákna můžete efektivně zablokovat na dobu neurčitou pomocí časového razítka z velmi vzdálené budoucnosti, například "13:13, 14 červenec 2045 (UTC)".
Aby nedošlo k matení čtenářů, může být falešný podpis napsán jako komentář pouze s falešným uživatelským jménem "DoNotArchiveUntil". Ostatní komentáře bude robot ignorovat.
Pro tento konkrétní účel byste mohli chtít mít na své wiki šablonu substitutable. Příklad naleznete v šabloně anglické Wikipedie: w:Template:DNAU.
Související odkazy
- Nápověda:Archivace diskusní stránky#Automatizovaná archivace – většina toho, co je zde napsáno, se netýká specificky anglické Wikipedie.
- w:User:MiszaBot/config