Tidybot


Original: http://www.kronto.org/tidybot/

Tidybot Logo

Introduction
Tidybot est un lot de multi-plateforme (X) HTML-vérificateur de syntaxe et générateur de rapport. Il traverse une arborescence de répertoires des (fichiers HTML sur votre disque dur X) et génère une page web répertoriant toutes les erreurs et les avertissements qu’il rencontre.
Tidybot peut être utilisé de deux façons : de la ligne de commande, ou via une application GUI facile à utiliser. La sortie sera identique dans les deux cas.

Téléchargement Tidybot

UNIX
tidybot-1.6.1.tar.gz (5 novembre 2005, 58 Ko)

Microsoft Windows
Installateur Tidybot 1.6.1 (5 novembre 2005, 4 Mb)
Vous pouvez jeter un oeil à la notice de montage, à l’historique des versions de changements visibles par l’utilisateur ou à quelques captures d’écran.

À l’aide de Tidybot

À l’aide de la version de ligne de commande
La version de ligne de commande de Tidybot est (sur toutes les plates-formes), un programme exécutable appelé tidybot.
Vous pouvez exécuter la commande tidybot–Aidez depuis un terminal adapté invite à voir un résumé des options disponibles.

À l’aide de la version de GUI
Sur les plates-formes Unix, la version GUI de Tidybot est installée dans le tidybot_gui et peut être exécutée directement à partir de la ligne de commande.
Sous MS Windows, le programme d’installation sera ont installé la version GUI comme le programme GUI de Tidybot, qui peut être exécuté à partir du Menu Démarrer : Démarrer > programmes > Tidybot > Tidybot GUI.
De plus (en fonction de ce qui vous a chargé le programme d’installation à faire) vous pouvez avoir également une icône Tidybot GUI sur votre bureau, ou dans la zone „Lancement rapide“ de votre barre des tâches, que vous pouvez utiliser pour démarrer le programme.
La version GUI de Tidybot vous permet de spécifier exactement les mêmes options que la version de ligne de commande, juste dans un mode plus pratique de pointer-cliquer. La version de GUI a également certaines fonctionnalités de que la version de ligne de commande n’a pas :
  • Les options utilisées moins souvent sont cachées au départ. Ils peuvent être rendus visibles en choisissant l’option de menu Afficher les Options avancées dans le menu Options.
  • Si les résultats de l’affichage dans navigateur case est cochée, Tidybot envoie les résultats de le Tidybot courir vers votre navigateur par défaut.
  • Paramètres et valeurs sont enregistrées lorsque vous quittez l’application et restauré la prochaine fois que vous démarrez il. Certains champs de conserver un historique des valeurs précédemment saisies, ce qui peut être sélectionné dans un menu déroulant.

Options de Tidybot

Utilisation de ligne de commande :
tidybot OPTION… < répertoire source >…
Autrement dit, zéro ou plus d’options suivie d’un ou plusieurs répertoires source.

Utilisation de GUI :
Toutes les options de Tidybot ont étiqueté corrélativement les versions sous forme de champs dans l’écran de GUI (sauf pour la version–et–help, qui sont des éléments de menu au lieu de cela, et–verbose, qui figure sur la liste TODO).

Options:
–version
Afficher le numéro de version du programme et de la sortie.
(GUI: sur Tidybot élément de menu dans le menu aide.)

–aider, -h
Afficher un message d’aide court et la sortie.
(GUI: élément de menu de Documentation de Tidybot dans le menu aide.)

–verbose
Activer le mode verbeux. (GUI: ne pas encore implémenté.)
–xml-pass
Ont Tidybot effectuer deux passes au cours de chaque fichier. En dehors de la vérification de syntaxe XHTML normale, Tidy vérifiera également le fichier de code XML. Les résultats de chaque passage sont fusionnées dans le rapport final. Le col XML est identique à celle effectuée lorsque l’option-tidy entrée-xml:true est donné. L’option–xml-pass est un raccourci pratique pour avoir les deux types de vérifier tout en une seule course et obtenir les résultats sur une seule page.

–sortie-directory = DIR
Les fichiers de rapports HTML générés par Tidybot seront placés en DIR. Le fichier principal sera nommé « tidybot.html ». DIR doit être un répertoire existant.

–inclure = liste, -i liste
Inclure certains fichiers dans les répertoires < source > pour traitement par Tidybot. LISTE est une liste séparée par des virgules de nom de fichier. Si un nom de fichier correspond à l’un de ces modèles, le fichier sera vérifié par Tidybot. Nom de fichier est de style shell Unix :
* correspond à tout
? fait correspondre tout caractère unique
Seq correspond à tout caractère dans seq
! seq correspond à n’importe quel char pas en seq
La valeur par défaut comprennent la liste est „* .html, *.htm“, c’est-à-dire tous les fichiers avec l’extension « .html » ou « .htm ».

–inclure-de = fichier
Similaire à–comprennent, mais les motifs d’inscription sont désormais en lecture de fichier texte, qui doit contenir un seul modèle par ligne.

–exclure = liste, e – liste
Exclure certains fichiers dans les répertoires < source > d’être traité par Tidybot. LISTE est une liste séparée par des virgules de chaînes. Si un nom de fichier correspond ou contenant l’une de ces chaînes, le fichier est ignoré et non vérifié. Chaînes exclure, contrairement aux chaînes include, ne sont pas nom de fichier, mais les sous-chaînes littérales. Caractères génériques comme * ne sont pas interprétés. La correspondance est contre le chemin d’accès complet du fichier, si p. ex. ensemble sous-répertoires peuvent être ignorées simplement par–exclude’ing le nom du sous-répertoire. Consultez la section suivante pour obtenir des exemples.

–exclude-de = fichier
Semblable à–exclure, mais l’exclusion de chaînes sont désormais en lecture de fichier texte, qui doit contenir une chaîne d’exclusion par ligne.

–Supprimer = liste, s – liste
Supprimer certains messages Tidybot de figurant sur les pages de résultat HTML générés. LISTE est une liste séparée par des virgules de chaînes. Si un message Tidybot matches ou contenant l’une de ces chaînes le message ne s’affiche pas. La chaîne mise en correspondance respecte la casse. Chaînes de répression sont littérales, comme–exclure les chaînes. Cette option peut servir à obtenir Tidybot se taire sur certains avertissements XML/XHTML, que vous n’êtes pas intéressé à avoir encombrer les rapports. Consultez la section suivante pour obtenir des exemples.

–supprimer-de = fichier
Similaire à–réprimer, mais les chaînes de la répression sont désormais en lecture de fichier texte, qui doit contenir une chaîne de répression par ligne.

–options-tidy = LIST, t – liste
Passer des options directement sur le moteur sous-jacent de la bibliothèque Tidy. LISTE est une liste de chaînes, séparées par des virgules, chacune de la forme clé : valeur, où la « clé » est une option de Tidy spécifiques. Cette option est généralement utilisée pour affiner le comportement de la bibliothèque Tidy que Tidybot est construit au-dessus de. Une liste des options valides se trouvent dans la documentation bien rangée. Consultez la section suivante pour obtenir des exemples.

–tidy-options-from = fichier
Similaire à–les options-tidy, mais les options Tidy sont désormais en lecture de fichier texte, qui doit contenir une chaîne de clé : valeur par ligne.

-stylesheet = URL
Avoir les fichiers HTML générés à la feuille de style CSS à l’URL de référence. Cette option peut être utilisée pour changer le look-and-feel des pages de résultats généré par Tidybot.

–mailto = adresse
Poster un résumé succinct de la Tidybot à exécuter à l’adresse adresse quand fait email. Cette option repose sur l’existence d’un exécutable dans votre chemin de recherche (ou dans la variable d’environnement SENDMAIL) de sendmail pour envoyer l’email. C’est donc une option Unix uniquement. À tout hasard qu’il existe des systèmes MS Windows qui ont de sendmail installé, cette option n’est pas désactivée pour la version Windows de Tidybot.

–note = NOTE, – n NOTE
Inclure chaîne NOTE dans le rapport envoyé par l’option–mailto.
Si les versions de la liste et le fichier d’une option sont spécifiées sur la ligne de commande, les valeurs d’option seront fusionnées. Plusieurs options de la liste (ou plusieurs options de fichier) sont autorisées, mais la valeur de cette dernière spécifié remplace toutes les valeurs précédentes.

Exemples
Les répertoire « exemple-sources » distribués avec Tidybot contient trois exemples de fichiers XHTML: « good.html », ‚ bad-1.html‘, et ‚ bad-2.html ‚. Le premier fichier contient XHTML correct, les deux derniers contiennent plusieurs erreurs.
La version GUI de Tidybot démarre avec les « exemple-sources » comme la valeur par défaut pour le champ « Source répertoires ».
Les exemples suivants sont exprimés par des appels de ligne de commande de Tidybot. Ils sont tous suppose que l’utilisateur ait des cd dans le répertoire qui contient le sous-répertoire « exemple-sources ».
Ces exemples peuvent facilement être répliqués dans la version de GUI en plaçant les valeurs dans les champs correspondants. (En fait, Tidybot GUI rend beaucoup plus facile d’expérimenter avec les options et voir quel genre d’effet qu’ils ont.)
Par défaut le comportement : vérifier tous les fichiers dans « exemple-sources » et placer les fichiers de rapport html dans le répertoire courant :
tidybot exemple-sources
Comme avant, mais place le rapport fichiers dans/tmp :
tidybot–sortie-directory = / tmp exemple-sources
Ne pas traiter de mauvais-1.html et mauvais-2.html (les deux appels ont cet effet) :
tidybot–exclure = exemple-sources de bad-1.html,bad-2.html
tidybot–exclure = mauvais exemple-sources
Ne comprennent pas tout bien rangés messages contenant le mot « Avertissement » dans les rapports :
tidybot–supprimer = AVERTISSEMENT exemple-sources
En outre, supprimer un type de message d’erreur très spécifique :
tidybot–supprimer = „avertissement, erreur : <spanstyle>n’est pas reconnu“ exemple-sources
(Cela montre également pourquoi les divers – options existent — spécifiant des options trop directement sur la ligne de commande peut obtenir très vite lourd.)
Charger la bibliothèque Tidy sous-jacente d’utiliser un analyseur XML plutôt qu’un analyseur HTML :
tidybot–tidy-options = „entrée-xml:yes « exemple-sources
Ont Tidybot à envoyer des messages après qu’il a fini (Unix uniquement) :
tidybot–[email protected] \
–Remarque „à un rapport: < http://foo.bar/tidybot.html > « exemple-sources
L’option–mailto est généralement utilisée lorsque Tidybot s’exécute en mode de ligne de commande comme une application automatiquement planifiée (par exemple via la crontab Unix).

Mises en garde
Tidybot, écrit dans le langage de script Python, haut niveau est un programme typique de « colle » qui crée une interface utilisateur plus facile et plus agréable sortie autour de composants déjà existants, de niveau inférieur.
Tidybot a été écrit parce que j’avais besoin de ses fonctionnalités spécifiques et c’est plus facile (et plus amusant) de combiner mon propre utilitaire qu’afin d’essayer d’adapter quelque chose d’autre. Une fois qu’elle a existé, j’ai senti que je pourrais aussi bien rendre disponible à d’autres.
Par sa conception, Tidybot offre un accès à seulement un petit sous-ensemble de ce que la bibliothèque Tidy sous-jacente est capable de. Point fort de l’original Tidy est en fait la fixation de vos anciens fichiers HTML, les convertissant en fichiers XHTML valides brillants. En revanche, Tidybot purement existe pour vérifier les fichiers existants — il ne convertit pas n’importe quoi.
Une autre limitation est que Tidy n’est pas un validateur XHTML ou XML formel. Sa vérification de la syntaxe, si vaste, ne garantit pas 100 % correct. De même, il y a certaines utilisations exotiques de XML/XHTML (espaces de noms sont un exemple) qui, bien que valides, ne sont pas pris en charge par la bibliothèque Tidy et peut donc être incorrectement signalée comme des erreurs. Tidybot est bon pour garder un oeil sur les choses et de repérer rapidement les problèmes. Il devrait jamais être utilisé en remplacement pour les contrôles de validation réelle.
Il y a un certain autre freeware des wrappers et des interfaces graphiques pour TidyLib disponible qui pourrait convenir à vos besoins beaucoup mieux que Tidybot. Un bon point de départ est la bibliothèque TidyLib page du projet binaires bien rangé.
Alors, pourquoi voudriez-vous utiliser Tidybot ? Eh bien, je l’ai écrit pour un site de taille moyenne (environ 3200 pages XHTML statiques), qui a des sections maintenues par une douzaine de personnes différentes, qui peuvent chaque téléchargement leurs propres fichiers au référentiel central. Nous courons Tidybot automatiquement tous les soirs et faire les pages de rapport disponibles dans le cadre de la section de nos développeurs. De cette façon, il y a toujours un rapport de validation actuellement disponibles, et tout le monde peut vérifier leurs téléchargements et assurez-vous que toutes les erreurs qui ont rampé dans sont rapidement corrigés.

Crédits

Code source
Tidybot utilise les composants suivants :
Langage de script : Python, par la Python Software Foundation
Vérification XHTML/XML : bibliothèque de la Tidylib C, par le projet de bibliothèque de HTML Tidy
Interface C-Python : le module ctypes, par Thomas Heller
TidyLib Python wrapper : µTidylib, par Cory Dodt
Génération de rapports HTML: HTMLTemplate, par Hamish Sanderson
En outre, la version GUI de Tidybot utilise :
GUI toolkit : wxPython, par Robin Dunn
Le rapport d’erreurs : Mongoose, par Philip Lindsay
Sous MS Windows, Tidybot utilise également :
Création de stand-alone.Fichier EXE : py2exe, par Thomas Heller
Python Win32 Extensions : win32api, par Mark Hammond
Programme d’installation : Inno Setup, par Jordan Russell
Enfin, de Tidybot nom, design et fonctionnalité se sont beaucoup inspirés de (mais ont maintenant également largement dévié de) Checkbot de Hans de Graaff, un vérificateur de liens pour les pages web.

Infrastructure
Le code source de Tidybot est stocké dans un dépôt Subversion. Regarde un dépôt public est fourni par le navigateur FishEye, avec des statistiques supplémentaires avec la permission de mpy svn stats. Suivi des problèmes s’effectue avec le logiciel de gestion de projet FogBugz.

Bugs
Si vous rencontrez un problème avec Tidybot (n’importe quel problème–même quelque chose aussi banal comme dire une faute de frappe dans la documentation!) ou si vous avez une demande, s’il vous plaît envisager de déposer un rapport de bogue. Tout simplement [email protected] est bien sûr aussi toujours la bienvenue, comme est poster un message sur le Forum des utilisateurs Tidybot.

Développement
N’importe qui peut parcourir le référenciel de Tidybot.
Vous pouvez également faire un checkout subversion approprié des dernières sources Tidybot en utilisant la commande :
% svn checkout https://svn.kronto.org/tidybot/trunk/ tidybot-svn
Une fois que vous l’avez fait, vous pouvez rester actuelle par cd’ing dans le sous-répertoire créé tidybot-svn et en disant :
% svn update

Licence
Tidybot est un logiciel libre. Il et son code source sont distribués sous la licence MIT, ce qui signifie qu’ils peuvent être librement utilisés, copiés, modifiées et distribuées. Consulter la licence pour plus de détails.

 

Comments are closed.