Manuel:Pywikibot/archivebot.py/configuration
archivebot.py est un script d'archivage des pages de discussion. Ce document explique comment mettre en place des pages de discussion sur le wiki pour l'archivage automatique effectué par ce robot. Pour une documentation sur le fonctionnement du robot, veuillez consulter Manuel:Pywikibot/archivebot.py.
Comment configurer une page de discussion
Ce robot ne traite que les pages qui sont explicitement marquées à l'aide de la transclusion d'un modèle de marqueur, ainsi que les sections archivées pour cause d'inactivité durant une période spécifiée.
Un marqueur de modèle couramment utilisé est {{User:MiszaBot/config|...}}.
Le modèle peut avoir les paramètres décrits ci-dessous.
La plupart sont optionnels.
{{TEMPLATE_PAGE
|archive =
|algo =
|counter =
|maxarchivesize =
|minthreadsleft =
|minthreadstoarchive =
|archiveheader =
|key =
}}
Pour une section à archiver, elle doit être de niveau 2, marquée avec ==. Il est possible de désactiver certaines sections, voir l'explication ci-dessous.
Paramètres du modèle
Signification des paramètres :
| Paramètre de modèle | Description |
|---|---|
archive |
nom de la page qui contiendra tous les fils à archiver. C'est obligatoirement une sous-page de la page courante. Les Variables sont utilisables. |
algo |
indique l'âge maximum des threads actifs. Doit être sous la forme old(délai), avec délai égal au nombre d'heures ou de jours comme 24h (24 heures) ou 5d (5 jours). Par défaut, old(24h).
|
counter |
La valeur actuelle du compteur affecté à la variable. Sera actualisée par le robot. Initialement la valeur est 1.
|
maxarchivesize |
La taille maximale de l'archive avant l'incrémentation du compteur. L'unité peut être donnée après en concaténant les lettres K et M (respectivement Ko et Mo). Par défaut la valeur est 1000M (1000 Mo).
|
minthreadsleft |
Le nombre minimal de fils qui doivent être laissés sur la page. La valeur par défaut est 5.
|
minthreadstoarchive |
Le nombre minimal de fils à archiver à la fois. Par défaut 2.
|
archiveheader |
Contenu qui sera placé en entête sur les nouvelles pages d'archives. On peut y placer des variables. Par défaut la valeur est {{talkarchive}}.
|
key |
Une clé secrète qui (si elle est valide) permet l'archivage de pages qui ne sont pas des sous-pages de la page à archiver. |
Variables pour les motifs des noms de page
Dans le paramètre archive du modèle, les variables suivantes peuvent être utilisées.
| Variable | Substituée comme ... |
|---|---|
%(counter)d |
la valeur actuelle du counter
|
%(year)d |
année du fil de discussion à archiver |
%(quarter)d |
trimestre de l'année du fil à archiver (1-4) |
%(month)d |
numéro du mois du fil à archiver (de 1 à 12) |
%(month)02d |
mois sur deux chiffres (01-12) |
%(monthname)s |
nom du mois en anglais |
%(monthnameshort)s |
trois premières lettres du nom du mois |
Comment empêcher l'archivage
Pour empêcher un fil ou une section d'être archivée pour un temps fini, vous pouvez modifier la section et insérer une signature avec un horodatage dans le futur. Le robot ne l'archivera pas avant cette date. Assurez vous de bien former la signature, avec le nom de l'utilisateur et la date, exactement comme une vraie signature, pour que le robot la reconnaisse.
Le blocage infini de l'archivage d'un fil peut s'effectuer effectivement en utilisant une date dans un futur très lointain, comme par exemple « 17:27, 4 juin 2045 (UTC) ».
Pour ne pas perturber les lecteurs, la signature vide peut être écrite en tant que commentaire uniquement avec le nom vide d'utilisateur « DoNotArchiveUntil ». Les autres commentaires seront ignorés par le robot.
Vous pourriez vouloir avoir sur votre wiki un modèle substituable pour cet usage particulier. Voir par exemple le modèle suivant sur la Wikipedia anglophone : w:Template:DNAU.
Voir aussi
- w:Help:Archiving a talk page#Automated_archival - la plupart de ce qui y est indiqué n'est pas spécifique à la Wikipedia anglophone.
- w:User:MiszaBot/config