Wikivoyage : règles concernant les scripts

De Wikivoyage
Sauter à la navigation Sauter à la recherche

Règle officielle

Cette page expose une règle de Wikivoyage en français, une norme largement acceptée par les wikivoyageurs qui doit normalement être suivie par tous les rédacteurs. Toutes les modifications de cette page doivent refléter le consensus. Dans le doute, exposez au préalable les modifications en page de discussion.


Wikivoyage Bots.png

Certains robots sont spécialisés dans la gestion des liens d'interlangue ou encore les opérations sur les catégories. Des robots bien conçus peuvent apporter un bénéfice concret à Wikivoyage. Cependant, parce que le système n'a pas été conçu pour supporter des robots, même un bon robot peut avoir des effets secondaires non souhaitables.

  • Fairytale right blue.png Si vous avez besoin de l'aide d'un robot, cliquez ici...
  • Si vous remarquez une faute d'orthographe récurrente, n'hésitez pas à l'ajouter à Wikivoyage:Requêtes aux robots
  • Pour demander l'autorisation d'utiliser un robot sur Wikivoyage ou pour vous prononcer sur les demandes en cours, cliquez ici

Comme la plupart des taches informatiques, Wikivoyage peut profiter de l'utilisation de programmes en script pour lire et écrire des pages. Cette page décrit les règles concernant l'utilisation de tels scripts sur Wikivoyage : ce que nous aimons, ce qui nous dérange et comment faire un script qui fonctionne sur Wikivoyage.

Pour et contre[modifier]

Les scripts sont pratiques pour les raisons suivantes :

  • Travail répétitif. Créer un script pour faire des taches répétitives peut faciliter la vie. Le script fait le travail à la place d'une personne qui aurait dû le faire à la main.
  • Travail soigné. Les scripts bien écrits ne font pas de fautes de frappes ou d'orthographes, etc. Un script fera le même travail mais sûrement mieux.
  • Ils fournissent un bon modèle de données préformatées pour les contributeurs.
  • Ils fournissent potentiellement une unique ressource qui n'est pas directement accessible sur le web.
  • Ils permettent de mettre à jour automatiquement des informations comme les articles récents ou d'effectuer des tâches répétitives comme par exemple importer un grand nombre d'images.

Mais les scripts génèrent aussi les problèmes suivants :

  • Conséquences désastreuses. Si le script contient un bogue, cela risque de toucher un grand nombre de pages. Et il faudra soit corriger tous les problèmes à la main sur chacune des pages ou bien faire un nouveau script pour corriger ça.
  • Unilatéral. L'auteur du script peut faire en sorte que tout un tas de pages correspondent exactement à ce qu'il voulait mais si une autre personne veut que ces pages soient autrement, il faut alors écrire un autre script.
  • Gourmand en ressources. Les robots (ou bots) consomment de la bande passante et d'autres ressources sur le serveur qui peuvent aussi servir aux utilisateurs qui éditent des pages.
  • Superflu. Les gens font souvent des scripts qui ne sont pas nécessaires. Le temps et l'énergie consacré à la conception et mise en place des scripts peut être réparties sur un grand nombre de personnes qui feront la même chose à la main.
  • Aucun apport. En général, les scripts servent à réajuster la mise en forme ou le format de Wikivoyage. À moins que ces scripts importent des données d'une autre base de données, ils n'apportent pas de contenu nouveau. C'est pourquoi, il est préférable de passer du temps à ajouter des informations ou compléter les articles de Wikivoyage.
  • Danger d'abus par des « robots vandales » ou simplement des robots errants. Un robot incontrôlable peut potentiellement causer une charge serveur importante ou même une attaque DOS.

Règles[modifier]

Pour toutes ces raisons, tous les scripts tournant sur Wikivoyage doivent respecter les règles suivantes :

  1. Les scripts doivent être tout d'abord approuvés par les administrateurs. Pour qu'un script puisse tourner sur Wikivoyage, postez le nom et le motif du script sur la page des nominations. Expliquez l'utilité, le fonctionnement précis du script et pourquoi cela n'est pas faisable manuellement. Si 2 administrateurs donnent leur voix dans les 7 jours et que personne ne s'oppose, le script pourra être mis en place sur Wikivoyage.
  2. Les scripts doivent respecter nos règles et recommandations et le manuel de style. Par exemple, un script qui remet en forme toutes les listes de restaurants doit le faire de la même manière que celle décrite dans la liste des restaurants. Si vous pensez que nous devons utiliser une autre mise en forme, faites que la règle soit changé d'abord.
  3. Chaque script doit avoir son propre identifiant utilisateur. Tous les changements seront marqués avec cet utilisateur.
  4. La page utilisateur du script doit comporter la description et le fonctionnement du script.
  5. Les scripts doivent vérifier deux pages. [[Wikivoyage:Règles concernant les scripts/Run]] and [[Utilisateur:(WT-fr) nom du script/Run]], avant de faire chaque modification. Chacune de ses pages doivent contenir exactement le mot "yes" avant que chaque modification soit sauvée. Cela permet à n'importe Wikivoyageurs d'interrompre le fonctionnement de tous les scripts ou d'un seul script.
  6. Les scripts doivent faire moins d'un changement par minute. Cela permet de ne pas saturer le serveur Web.
  7. Si possible, les scripts doivent d'abord être lancés dans une version de test de Wikivoyage avant d'être lancé réellement sur le site.

On distingue deux types de robots :

  • le robot utilisé de façon temporaire et à petite échelle. Ce type de robot peut être utilisé directement sous le compte de l'utilisateur. Il est recommandé à l'utilisateur de faire *très* attention. En cas de problème (dérapage du robot), le compte utilisateur pourra être bloqué par un administrateur ;
  • le robot à usage fréquent et grande échelle. Ce qui suit concerne ce type de robot.

Il est demandé de créer un compte utilisateur indépendant, et de faire enregistrer ce compte utilisateur sous un statut de robot avec un pseudonyme qui contient le terme Bot dans le nom. Depuis que les bureaucrates ont la possibilité de changer le statut des robots, c'est aux bureaucrates qu'il faut faire la demande.

Le statut de bot[modifier]

Validation d'un nouveau bot[modifier]

Une demande doit être faite sur la page Wikivoyage:Nominations des scripts. Si la requête est acceptée, le propriétaire du robot peut demander le bot flag sur Wikivoyage:Requêtes aux bureaucrates.

Recommandations[modifier]

Ajout du suffixe "bot" à la fin du nom[modifier]

Pour permettre aux utilisateurs de mieux distinguer les robots des simples utilisateurs, il est souhaitable de choisir un nom se terminant par la syllabe "bot". Réciproquement, dans Comment créer un compte utilisateur, on demande aux simples utilisateurs d'éviter cette syllabe.

Apparition du robot dans les outils de surveillance[modifier]

  • Apparition avec b dans la liste de suivi personnelle
  • Apparition avec b dans la liste de suivi des liens de chaque page
  • Apparition avec b dans les modifications récentes
  • Mais : apparition sans le b dans l'historique de la page : il faudra donc se fier à la terminaison en "bot" du nom d'utilisateur, en prenant garde au fait que certains robots ont un nom banalisé.

Avec le statut de robot, les contributions du robot n'apparaîtront pas automatiquement dans les modifications récentes. Il est toutefois possible de voir leurs contributions en activant l'option « afficher les robots ».

Il est cependant déconseillé d'enlever les fonctions de temporisation des robots comme les sleep présents dans PyWikipedia. Même si les modifications récentes n'apparaissent pas dans la liste habituelle, il est toujours possible d'observer le comportement des robots (via I.R.C.) et les bloquer en cas de modifications en rafale. Une diminution des temps d'attente peut être envisagée jusqu'à une période raisonnable (ie. toutes les 15 à 45 secondes). PyWikipedia par exemple propose un tel paramètre (voir minthrottle et maxthrottle dans config.py)

Accueil des nouveaux arrivants[modifier]

L'utilisation d'un robot est à proscrire pour ce travail. Il est préférable de conserver un ajout manuel des bandeaux pour privilégier les contributeurs sérieux.

Liste des bots sur la Wikivoyage francophone[modifier]

Robots autorisés et utilisés actuellement[modifier]

  • Remplacement de texte avec l'utilisation des règles de corrections typographiques de AutoWokiBrowser
  • Interwikis avec en:, de:, it: et es:
  • wikifaction de la syntaxe HTML
  • correction de type cosmétique
  • et autre fonctions disponibles avec les scripts de pywikipedia
Nom du bot Contributions Responsable Fonction
(WV-fr) ImportBot contributions Importation de contenu de Wikitravel
Crochet.david.bot contributions Crochet.david Remplacement des liens interwikis, correction typographique et orthographique
Sumone's bot contributions Sumone10154
Stefan2bot contributions Stefan2 Remplacement des images par ceux de Commons
RomaineBot contributions Romaine Remplacement des liens interwikis

La liste ci-dessus est mise à jour manuellement. Pour une liste à jour des robots validés, consulter la liste des robots.

Robots non autorisés ou en phase de test et utilisés actuellement[modifier]

Nom du robot Contributions Responsable Fonction

Logiciels de robots[modifier]

Requêtes[modifier]

Vous ne possédez pas de robot, mais vous voudriez qu'un robot réalise certains travaux pour vous : allez adresser une requête sur la page : Wikivoyage:Requêtes aux robots.

Scripts inadaptés[modifier]

Le robot doit faire ses changements comme un utilisateur connecté qui peut être contacté en cas de problème. Un robot doit pouvoir être arrêté à tout moment par n'importe quel administrateur, et s'il ne se conforme pas aux règles, un administrateur pourra le bloquer temporairement afin que les modifications cessent, même s'il fonctionne correctement.

Voir aussi[modifier]

Liens externes[modifier]