WikiRobots/fr

Présentation
Les tâches répétitives peuvent être automatisées à l'aide de robots ou de bots, c'est-à-dire de programmes logiciels fonctionnant seuls sur le wiki.

Les robots classiques et les plus utilisés pour les sites wiki sont fournis par MediaWiki, sous le nom de paquet Pywikibot. Voir Manuel:Pywikibot pour des informations complètes.

En un mot, Pywikibot est une collection de scripts Python capables d'utiliser l'API wiki native pour agir sur les sites wiki. Pour voir la liste des API pour le wiki de FreeCAD, visitez http://www.freecadweb.org/wiki/api.php.

Pour utiliser Pywikibot, vous devez :


 * 1) installer le package Pywikibot
 * 2) configurez Pywikibot pour qu'il fonctionne sur le Wiki FreeCAD.
 * 3) lancez les scripts dont vous avez besoin pour la tâche à accomplir.

Il existe une multitude d'informations sur la façon d'installer, de configurer et d'utiliser Pywikibot. Cependant, soyez conscient que ces informations, bien qu'utiles, peuvent être trompeuses, car elles mélangent des instructions relatives à deux bases de code Pywikibot différentes et différentes versions de la collection de scripts Pywikibot.

Dans ce qui suit, vous trouverez les instructions de base pour configurer et utiliser Pywikibot sur le wiki FreeCAD. Cela vous permettra d'effectuer les tâches les plus courantes. Pour une utilisation avancée, référez-vous au Manuel:Pywikibot et au code source Python.

Installation
Allez sur http://tools.wmflabs.org/pywikibot/ et téléchargez. (le projet est aussi sous github, gerrit, etc... mais c'est un moyen simple d'obtenir un paquet complet et autonome).

Décompressez le contenu dans le répertoire de votre choix.

À moins que vous ne vouliez installer les bibliothèques dans vos librairies Python, vous avez terminé (si vous voulez toujours les installer, vérifiez le fichier dans le répertoire de base).

Pywikibot fonctionne avec Python 2.6 et 2.7 sans problème. Python 3 n'a pas été testé jusqu'à présent avec FreeCAD wiki fonctionne également.

Configuration
Vous devez enregistrer le code Python suivant dans un fichier portant le nom dans le répertoire de base où vous avez décompressé. (pour être clair, dans le même répertoire où vous trouvez déjà un fichier appelé ).

Dans le code ci-dessus :


 * remplacez <> par votre nom d'utilisateur Wiki
 * remplacer cp437 par votre console_encoding. Pour connaître l'encodage de votre console, pour Windows et Linux, lancez l'interpréteur Python, entrez suivi de . Python écrira votre  à l'écran.

Vous devez ensuite enregistrer le code Python suivant dans un fichier portant le nom dans le sous-répertoire. (avec les autres fichiers ).

Utilisation
Vous êtes maintenant prêt à lancer les scripts de Pywikibot. Les scripts eux-mêmes sont contenus dans le sous-répertoire, dont vous pouvez connaître les noms.

Pour lancer les scripts, ouvrez un terminal et allez dans le répertoire de base (celui de l'installation, PAS le sous-répertoire ), et écrivez

où bien sûr vous remplacez < > par le nom du script qui vous intéresse, et < > par le ou les paramètres requis pour le script donné.

Pour obtenir une description de l'utilisation et des paramètres d'un script, il suffit d'utiliser le paramètre -help. Par exemple, pour obtenir une description du script (l'un des plus utiles), tapez

Il existe un autre paramètre très utile, valable pour tous les scripts, appelé -simulate, qui vous permet de tester les commandes sans endommager le Wiki. Utilisez-le avant de passer en mode 'live'.

Exemples
Cette commande permet de se connecter au wiki

Cette commande imprimera une liste de toutes les pages contenant un lien vers SourceForge

Cette commande remplacera tous les liens vers l'ancien forum SourceForge par un lien vers le nouveau forum hébergé par freecadweb.org.

Cette commande imprimera une liste de toutes les pages contenant le mot 'PartDesign', en commençant par la page intitulée "2d Drafting Module" et en poursuivant par ordre alphabétique.

This command will replace all the secure links to the old SourceForge Forum with a link to the new freecadweb.org-hosted Forum in the translated pages

FreeCAD Wiki Related Commands
Count all pages that a specific wiki templates is used in

List all pages that a specific wiki templates is used in

Replace a string in all the pages listed in the Arch category (a/k/a )