Manual:Pywikibot/archivebot.py/setup
De archivebot.py is een script om overlegpagina's te archiveren. Op deze plek leggen we uit hoe overlegpagina's op wiki door deze bot automatisch worden gearchiveerd. Voor een uitleg hoe deze bot te gebruiken, lees Manual:Pywikibot/archivebot.py.
Hoe de bot gebruiken voor overlegpagina's
Deze bot archiveert enkel pagina's die zijn voorzien van het botsjabloon, en archiveert inactieve overlegkopjes na verloop van tijd.
Een veel gebruikt sjabloon om te markeren is {{User:MiszaBot/config|...}}.
Het sjabloon kan de hieronder beschreven parameters hebben.
(De meeste zijn optioneel.)
{{TEMPLATE_PAGE
|archive =
|algo =
|counter =
|maxarchivesize =
|minthreadsleft =
|minthreadstoarchive =
|archiveheader =
|key =
}}
Een overlegkopje moet van een tweede niveau zijn om te kunnen archiveren: ==. Het is mogelijk sommige overlegkopjes te excluderen: zie uitleg onderaan.
Sjabloonparameters
Betekenissen van de verschillende sjabloonparameters:
| Sjabloonparameter | Omschrijving |
|---|---|
archive |
Titel van de pagina waar gearchiveerde overlegkopjes kunnen worden geplaatst. Dit moet een subpagina zijn van een bestaande pagina.Variabelen worden ondersteund. |
algo |
specificeert de maximale leeftijd van een overlegkopje. Dit moet in de vorm old(vertraging) waar vertraging de leeftijd in uur of dagen specificeert zoals 24h (24 uur) of 5d (5 dagen). Standaard is old(24h).
|
counter |
De huidige waarde van een teller die kan worden toegewezen aan een variabele. Dit zal door de bot worden geactualiseerd. Initiële waarde is 1.
|
maxarchivesize |
De maximale grootte van het archief voordat de teller wordt verhoogd. Waardes kunnen gegeven worden door het toevoegen van K of M , wat het aantal KByte of MByte voorsteld. Standaardwaarde is 1000M (1000 megabytes).
|
minthreadsleft |
Minimumaantal overlegkopjes die op een pagina moeten behouden blijven. Standaard is dat 5.
|
minthreadstoarchive |
Het minimumaantal overlegkopjes te archiveren in één keer. Standaardwaarde is 2.
|
archiveheader |
Inhoud dat in nieuwe archiefpagina's zal worden geplaatst. Deze parameter ondersteund het gebruik van variabelen. Standaardwaarde is {{talkarchive}}.
|
key |
Een geheime sleutel dat (indien geldig) toelaat de archieven geen subpagina te laten zijn van de pagina die wordt gearchiveerd. |
Variabelen voor paginanaam model
In de archive parameter van het sjabloon, gevolgd door variabelen, kan worden gebruikt.
| Variabel | Breidt uit naar... |
|---|---|
%(counter)d |
De huidige waarde van de counter
|
%(year)d |
Jaar van het overleg dat gearchiveerd kan worden |
%(quarter)d |
Kwartaal van het jaar (1-4) van het overleg dat gearchiveerd kan worden |
%(month)d |
Numerieke maand (1-12) van het overleg dat gearchiveerd kan worden |
%(month)02d |
Tweecijferige numerieke maand (01-12) |
%(monthname)s |
Engelse naam van de maand |
%(monthnameshort)s |
De eerste drie letters van de naam van de maand |
Hoe archivering voorkomen
Om te voorkomen dat een sectie (overlegkopje) gearchiveerd wordt binnen een bepaalde termijn, kan je de sectie bewerken en je handtekening vervangen door één met een tijdstempel die in de toekomst ligt. De bot zal het overlegkopje dan niet archiveren totdat de tijd verstreken is. Zorg ervoor dat de handtekening goed is weergegeven: het moet een gebruikersnaam bevatten en een exacte datum in hetzelfde formaat als een normale handtekening, anders zal het niet herkend worden door de bot.
Het is mogelijk de archivering van een overlegkopje voor onbepaalde tijd te verhinderen, gebruik makende van een een datum die nog ver voor ons uit ligt, zoals "22:51, 23 maart 2044 (UTC)".
Om de lezers niet in verwarring te brengen, kan de handtekening als reactie worden geplaatst DoNotArchiveUntil. Andere reacties zullen door de bot worden genegeerd.
Op je wiki kan je een vergelijkbaar/vervangbaar sjabloon voor dit specifieke doel hebben. Zie de Engelse Wikipedia als voorbeeld: w:Template:DNAU.