Document utags download
version disponible en : en
crée le : 20230330- mis à jour le : 20230330- généré le: 20240613_105851
Utags, est le premier module de TextOffice.
Utags est un programme qui permet à travers l'utilisation du langage de balisage leger mentor
de gérér une base de données hypertexte, c'est à dire la gestion de vos textes de toute nature: documentation, code source, fichiers de paramètrage, etc...
Utags est un outil qui s'intégre à l'éditeur gvim(vim) cf vim_org
en produisant un fichier "tags" nommé utags (pour liste d'étiquettes universelles) qui est un index permettant la navigation hypertexte.
Aprés avoir crée cet outil, j'ai réalisé que pour en maitriser la puissance il fallait développer
une méthodologie. J'ai appelé cette méthodologie "mentor" car elle est d'une grande aide
pour un accés rapide à l'information et pour son organisation (ce qui est corrolaire).
L'approche de mentor est un alliage de principe de physique de l'information (entropie) et de l'esprit unix.
Gvim est l'IHM qui permet d'utiliser utags. Un menu vim "Utags" regroupe toutes les commandes
de gestion de l'hypertexte mentor dans gvim, ce menu est essentiellement didacticiel pour vous permettre la prise en main
mais avec le temps vous ne devrez plus utiliser le menu pour les commandes usuelles.
La premiere version d'utags est une version betatest disponible sur linux 64 bits.
Installable par l'installateur debian. Cf debian_org.
Lien de téléchargement :
La présente version est la version française, la version anglaise sera disponible prochainement.
Télécharger l'installateur debian utags version Linux 64bits
Vous trouverez les consignes d'installation dans document readme utags
Une fois intallé gvim s'ouvrira directement sur le document source mentor de l'aide utags
où vous pourrez commencer à apprendre à utiliser utags.
Souvent vous avez voulu noter une idée, voulu enregistrer quelque part une information qui vous serait utile plus tard,
ou un lien à explorer plus tard. Ou encore vous avez passé une heure à explorer un code source pour savoir où et comment faire cette modification au plus juste.
Et puis soit vous ne l'avez pas fait parce que vous ne saviez pas où enregistrer cette idée, cette information, de façon à la retrouver simplement.
Ou alors vous l'avez écrit sur un bout de papier, ou mieux un carnet ou un fichier et puis vous avez perdu le papier oublié de consulter et mettre à jour le carnet,
vous ne savez même plus bien ou il se trouve et oublié où était ce fichu fichier ou ces fichiers parce que vous avez essayer d'organiser par thème etc.
Et puis c'est long de cliquer plusieurs fois pour ouvrir le bon sous-répertoire ou se trouve ce fichier qu'il faut ensuite rechercher, etc, etc, etc.
Bref parce que ce n'était pas pratique, immédiat et efficace au bout de plusieurs tentatives vous avez renoncer à dépenser de l'énergie
et du temps inutilement pour cela. Mais vous en êtes insatisfait.
Et pour les développeurs, votre navigation dans le code source, à force de concentration, vous a permis de réaliser cette modification du code
mais après vous n'avez pas enregistré, pris des notes sur ce que vous avez appris en explorant les sources, ce qui s'appelle rétro-documentation
et dans un mois ou six vous allez de nouveau devoir refaire cette exploration parce que vous aurez oublié 90% de ce travail.
De la même façon, vous vous sentez démuni face à un code source non documenté ou avec une documentation
à laquelle vous ne pouvez pas faire confiance à cause du décalage avec le source, si vous avez la chance ou la malchance qu'elle existe.
J'ai été bien entendu confronté à toutes ces situations et c'est la raison pour laquelle j'ai construit cet outil
que j'utilise depuis 25 ans environ et que je mets aujourd'hui à votre disposition.
Utags est cet outil qui m'a permis d'enregistrer toute information utile rapidement, de pouvoir facilement réorganiser
l'information enregistrée et de retrouver en quelques secondes une information datant de plusieurs années.
Merveilleux me direz-vous !
Oui mais il y a un petit bémol : pour accéder à cet outil précieux, il y a un sésame qui sera peut-être un peu coûteux pour vous
sauf si vous l'avez déjà adopté: if faut utiliser l'éditeur de texte gvim/vim cf vim_org
Mais croyez moi : ça vaut la peine, vous n'imaginez pas votre retour sur investissement car vous allez vivre dans un autre monde.
Une aide vim est fourni pour vous faciliter la prise en main de l'éditeur.
Utags organise une base de donnée hypertexte à partir de la méthodologie mentor ( cf mentor prs 1 ) vous permettant de rentrer dans le domaine de l'édition d'hypertexte.
N'éditez pas des textes, éditez un hypertexte !
Mentor applique aux données non-structurées (textuelle) le même principe de séparation des couches données et présentation qui est appliqué généralement aux données structurées (base de données)
La couche présentation est fournie par l'utilitaire qui permet la génération des pages HTML qui a produit les pages de ce site et du site quantique_org
Les tableaux de données structurées sont néanmoins déjà présents dans utags sous la forme de bloc de texte au format CSV avec un utilitaire pour le formatage des tableaux.
A terme, Utags intégrera les fonctions attendues dans une suite bureautique en intégrant les données structurées (base de données relationnelle et tableur) à partir d'utilitaire
manipulant les tableaux CSV pour réaliser des calculs et des fonctions relationnelles entre les différents tableaux.
En réalité j'utilise ces fonctions CSV de données structurées depuis des années mais j'ai un chantier assez important pour en faire un produit diffusable.