Aide utags
version disponible en : en it ru zh es ja de nl pt
crée le : 20240324- mis à jour le : 20240324- généré le: 20240613_105856
Bonjour,
vous venez probablement de créer une base hypertexte du système "mentor" à la suite de l'installation du module utags.
à la fin du script de création de la base, gvim est lancé pour éditer ce fichier d'aide.
gvim est le socle sur lequel s'appuie utags pour fournir un système d'édition et de gestion hypertexte.
Si gvim ne vous est pas familier commencez par consulter aide vim.
aide vim est la référence d'une étiquette hypertexte mentor qui vous conduit au fichier d'aide de vim.
Pour y accéder soit tapez la commande ":ta aide_vim" et faire enter
soit placez le curseur de texte sur la référence aide vim tapez shift-$ ce qui ouvrira un nouvel onglet sur le fichier d'aide.
Il vous faut maintenant apprendre à manier l'outil à travers:
Par la suite un deuxième volet important sera disponible dans le système mentor : module tableur base de donnee relationnelle et applications
l'éditeur vim possède une fonction de navigation hypertexte qui se décline en commandes :
:ta sommaire
:sta sommaire
qui fait un split de la fenêtre avant d'effectuer la navigation.
:tags
qui va dans le buffer précédent (switch donc si on la répète). C'est utile si on veut switcher
entre deux fichiers sans modifier l'arbre de navigation hypertexte.
2.1.Tableau des touches de fonction de navigation
TF ligne_de_commande action
F5 tags afficher la pile des étiquettes parcourus (tags'stack)
F6 po remonter d'une étiquette dans la pile F7 ta avancer d'une étiquette dans la pile F8 e# switch entre deux buffers de texte
2.2.Tableau des touches des commandes de navigation
touche macros action
altgr-$ ggt navigation hypertexte dans le buffer vi courant
µ ght do horizontal tag navigation hypertexte en faisant un split horizontal de la fenêtre £ gnt navigation hypertexte en ouvrant un nouvel onglet § gvt navigation hypertexte en faisant un split vertical de la fenêtre autres macros liées à des fichiers spécifiques (cf ci-aprés)
gsf go sommaire fichier navigation hypertexte dans le sommaire du fichier gsr go sommaire fichier référence navigation hypertexte dans le sommaire du fichier à l'endroit de la réference de l'étiquette courant gsg go sommaire général navigation hypertexte dans le sommaire général (liste des références des fichiers de la base) gut go utags navigation hypertexte vers le fichier utags (index des étiquettes hypertexte des fichiers de la base) gag go arbre general navigation hypertexte vers le fichier contenant l'arbre des fichiers de la base) gas go arbre source navigation hypertexte vers le fichier contenant l'arbre des fichiers de la dernière exécution de utags) grc go reféference croisée navigation hypertexte vers le fichier des références croisées:recherche la référence de l'étiquette courante
3.Bloc de texte texte structuré
Le bloc de texte est la structure sous laquelle est enregistré un texte.
Il est composé de quatre type d'éléments délimités par les couples de délimiteurs < >, ( ), { } et [ ]
On a donc une forme générale:
<etiquette_de_bloc>(titre) [reference]
{
...
... [reference] ...
...
<etiquette_de_sous_bloc>()
{
...
... [reference] ...
...
... <etiquette_dans_texte> ...
...
... [reference] ...
...
etc...
}
}
qui peut donc être imbriquée: Un bloc de texte peut contenir d'autres blocs de textes.
Un bloc particulier est le bloc du fichier entier dont la ligne d'étiquette contient:
la macro pour générer cette ligne est &fnt fnt pour un fichier texte.
Il existe d'autres macros &fn pour les types de fichiers sources courant.
1.Fichiers générés par utags
REMARQUE POUR LES DEVELOPEURS : ce document contenant des liens vers les sources des fichiers de macros vim ou des scripts perl sont un exemple
de la manière de relier vos sources et vos documentations de spécifications techniques par des étiquettes mise dans les commentaires,
rendant aisée la programmation lettrée.
Egalement le sommaire du fichier (gsf) vous donnera une vision globale de votre sources et des liens pour accéder
au code qui vous intéresse. Exemple avec le programme perl de génération des pages html : sommaire mt to htm pl
( Programme largement perfectible - évolution dans des versions futures, comme l'include d'"inside html" dans le document source
afin de bénéficier des feuilles de style.)
Ces fontions donne une solution pratique à l'éternel problème de décalage entre le code et la documentation.
Avec la méthodologie mentor, la documentation est un code comme les autres.
1.Tableau des macro commandes d'edition: pour le langage de balisage léger mentor
macro mnemonique commentaire
ebia Edition Bloc Insertion Accolades insére un bloc d'accolades
ebai Edition Bloc Inversion Des Parenthèse insére des accolades de façon à scinder un bloc ebtb Edition Bloc Tag Build crée un bloc structurel complet en laissant en édition sur l'étiquette ebma Edition Bloc Mise En Accolades met en accolade un bloc de ligne selectionné par F3-F4 ebmp Edition Bloc Mise En Parenthèse met en parenthèse un bloc de ligne selectionné par F3-F4 ebm Edition Bloc Mise En Bloc Silencieux il y a une série de macro ebm dont la dernière lettre est modifieur de bloc etft Edition Tab Fichier Texte il y a une série de macro etf macro vim etf dont la dernière lettre est le type du fichier source
2.Macro commandes de generation de l'hypertexte
2.1.Tableau des macro commandes de generation de l'hypertexte
macro mnemonique commentaire
ub UTags Base lance utags pour une analyse des fichiers modifiés depuis la dernière analyse sur toute la base (racine.dom)
ud Utags Domaine lance utags pour un analyse des fichiers modifiés du domaine courant uf Utags Fichier lance utags pour l'analyse du fichier courant F11 ub racine.dom raccourci ut M-F11 ud racine.dom général raccourci ug C-F11 uf fichier raccourci uf
REMARQUE : On retrouve les commandes décrites ici dans le menu Utags de la barre de menus de gvim.
Ce menu a été conçu pour donner un accés rapide à une aide pour remémorer les commandes.
REMARQUE : ces commandes ainsi et que le langage de balisage léger mentor sont les seules choses à connaitre
pour disposer d'un outil puissant de gestion de l'information textuelle qui si vous l'intégrez
pour servira constament et pour longtemps afin de conserver et d'utiliser pratiquement
toutes vos informations utiles.
Dans le menu Utags on trouve un sous-menu "Exploitation" qui permet de sauvegarder ou d'archiver un domaine en entier
et aussi d'archiver des versions successives de fichiers.
REMARQUE : une gestion des données structurées sera prochainement proposée.
Ce nouveau module est l'intégration des fonctions tableur et SGBDR (système de gestion de base de données relationnelles).
Il s'implémente à travers des blocs de texte du type CSV dont les étiquettes sont les noms des tables du SGBDR.
Un langage de script sera également intégré à ce module pour programmer ces données.
vous permettant de réaliser rapidement des applications de toute nature.
Exemple particulier de réalisation : génération de partition musicale de protéodie à partir du code FASTA d'une protéine :
partition_de_la_protéodie_stimulatrice_de_phenylalanine_ammonia_lyase_1_pisum_sativum
http://quantique.alwaysdata.net/phenylalanine_ammonia_lyase_1_pisum_sativum_sti_part_txh.htm