aide utags

Aide utags

Retour à l'accueil du site

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

1.Aide utags

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

2.Commandes et macro commandes de navigation dans l'hypertexte: et présentation de la forme de l'hypertexte

l'éditeur vim possède une fonction de navigation hypertexte qui se décline en commandes :

  • en mode ligne de commande on peut accéder à une étiquette (tag) "sommaire" par exemple par la commande:

    :ta sommaire

  • une variante est :

    :sta sommaire

    qui fait un split de la fenêtre avant d'effectuer la navigation.

  • il existe une commande de retour : :po qui vous ramène à la position initiale.

  • la commande ta sans argument vous fait avancer dans l'arbre de navigation :ta vous pouvez ainsi parcourir l'arbre de navigation par des séquences de ces deux commandes.

  • l'arbre de navigation peut être visualisé par la commande:

    :tags

  • une navigation entre buffer de texte qui n'est pas une navigation hypertexte est la commmande: :e#

    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.

  • afin de faciliter la navigation ces commandes ont été mappés (commande :map) sur les touches de fonction allant de F5 à F8 : (la commande ":map" permet de mapper une séquences de caractéres de commande en une autre... plus simple l'approche mentor utilise des mappage commençant par le caractère "&" e-commercial.)

    2.1.Tableau des touches de fonction de navigation

    TFligne_de_commandeaction  
    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  

  • en mode commande vi le curseur doit être sur la référence hypertexte par exemple: sommaire (référence hypertexte pour le langage de balisage leger mentor).

  • la touche pour la navigation est "ctrl-]" sur un clavier qwerty et ctrl-altgr-] sur un azerty ce qui est plus compliqué et que l'on a donc émulé sur altgr-$ (le $ se trouvant en azerty au même endroit que le ] en qwerty et altgr-$ est en fait le caractère "¤") cette commande va à l'étiquette dont il est fait référence, ceci dans la même fenêtre.
    c'est donc l'équivalent de la commande ":ta etiquette" mais sans avoir à taper l'étiquette au clavier.
    altgr-$ lance la macro ggt (en mode commande tapez "&ggt")

  • la touche "µ" opére la recherche de l'étiquette en faisant un split horizontal de la fenêtre elle est donc l'équivalent de la commande ":sta etiquette". µ lance la macro ght (en mode commande tapez "&ght" la macro gvt fait un spit vertical de la fenêtre elle est mappé sur la touche "§" qui n'est pas utilisé par vi.

  • la touche shift-$ correspondant au caractère "£" la navigation hypertexte mais en ouvrant un nouvel onglet.
    £ lance la macro gnt (en mode commande tapez "&ght")
  • le déplacement entre onglets s'effectue par les commandes suivantes:

  • les 3 touches altgr-$, £ (shif-$) , µ et § ont été choisies car elles ne sont pas utilisées par le mode commande vi et elles se trouvent être voisines. * et § sont choisi par leur position relative au shift droit pour indiquer le sens du split de la fenêtre.
  • on remarquera que les lettres utilisées pour les macros se trouvent aussi être voisines, la lettre "g" signifiant un déplacement (go) dans la nomenclature des macros.
    (le franglais dans les nomenclatures est clairement assumé - pragmatisme anglo-saxon oblige)

    2.2.Tableau des touches des commandes de navigation

    touchemacros  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 [ ]

  • une étiquette hypertexte ou tag mise entre les délimiteurs "<" et ">", dite étiquette mentor .
    qui ne peut contenir que des caractères alphanumériques avec comme séparateur le caractère underscore "_"
  • un éventuel Résumé de bloc ou Commentaire mentor mis entre parenthèses "( )",
  • le texte proprement dit mis entre accolades "{}" qui est le bloc de texte proprement dit.
  • les références hypertextes de la forme aux étiquettes de textes qui émaillent le texte contenu dans les blocs de texte

    3.1.Bloc structurel

    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:

  • l'étiquette du nom du fichier
  • le titre du fichier
  • une référence vers le sommaire du fichier. La forme de l'étiquette du fichier est donc ).
  • par exemple pour un fichier nommé nomfichier.ext on a :
    <nomfichier_extension>(titre fichier)[nomfichier_extension_som]

    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.

  • des macros commandes pour faciliter l'édition de la forme de l'hypertexte sont fournies :

    1.Tableau des macro commandes d'edition: pour le langage de balisage léger mentor

    macromnemonique  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

    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.

  • Le libellé de menu SaisieNomDomaine permet de saisir la valeur de la variable d'environnement $DOMAIN.
  • Le libellé AfficheDomaineCourant affiche la valeur de cette variable.

  • On trouve ensuite le libellé Domaine.Exporter qui appelle la macro fdex qui appelle à son tour le script archive domaine sh qui constitue un fichier archive avec la commande "tar" et le recopie sur le support de sauvegarde définie par la variable ARCHISUPP dans un répertoire reprenant le nom de la base mentor ARCHIDIR.

  • Le libellé Option.IncrementArchiveDomaine indique à archive domaine sh que le nom de l'archive doit inclure un numéro incrémental de façon à réaliser des archives successives. exemple "utags_000.ar", "utags_001.ar"

  • Vient ensuite un sous-menu Fichier qui comporte les libellés suivants:

    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