<< disp_usage uman uman .. @ >>

uman >> uman > uman

uman

Manuel d'utilisation en console, documentation multimodale multilingue avancée

Syntaxes

uman
uman pattern
uman pattern options
uman -options pattern
uman -options pattern options

uman item g
uman item gx..
uman item gL
uman item gL<lang>

uman item w
uman item wx..
uman item wr..
uman item wL
uman item wL<lang>
uman item1|item2|.. wL<lang>
uman "item1 | item2 | .. " wL<lang>

uman bugNumber wb
uman item wb
uman item1|item2.. wb
uman author>item.. wb
uman author1|author2|..>item.. wb
uman author><Ndays wb
uman section/>item.. wb
uman section/><Ndays wb
uman section1|section2|../author1|author2|..>item1|item2|..<Ndays wb
uman "section1|section2|.. / author1|author2|.. > item1 | item2 |..<Ndays" wb

uman topic! @
uman topic @
uman author>topic! @
uman author1|author2>(topic1|topic2)&topic3&~(topic4|topic5)! @
uman author><Ndays @
uman author>topic<Ndays! @
uman "author > topic1 | topic2 < Ndays!" @

Sommaire

Arguments

pattern

Texte unique: nom d'une fonction, symbole ($, [, etc ), expression, numéro d'un bug documenté sur bugzilla, terme quelconque... à propos de quoi des informations sont demandées. La requête sera traitée de manière indifférente à la casse typographique si le pattern est libellé tout en minuscules. Sinon la différence entre minuscules et majuscules sera prise en compte (hors modes "wb" et "@").

Lorsqu'il inclut des espaces, virgules ",", point-virgules ";", deux-points ":", "=", slashs "//", parenthèses, ou des accolades, le pattern doit obligatoirement figurer entre guillemets ou entre apostrophes.

Variables de configuration

Le comportement par défaut de uman peut être modifié en utilisant diverse variables de configuration dont la valeur sera fixée dans votre fichier personnel de démarrage de session SCIHOME\scilab.ini ou SCIHOME\.scilab.

Ces variables doivent être déclarées en global afin de les protéger contre d'éventuelles instructions clear (très prisées des matlabeurs mais dévastatrices en Scilab).

Variables disponibles :

  • umanMaxLineWidth : entier décimal sur l'intervalle [50, 110]. Les valeurs hors de cet intervalle sont ignorées. La valeur par défaut est 90. Lorsque la console est très large, cette variable permet de restreindre la largeur d'affichage des pages d'aide à une largeur choisie inférieure à celle de la console. Pour rester aisément lisible, chaque ligne doit comporter en moyenne entre 10 et 12 mots. Au delà, le déchiffrage visuel devient pénible. Si la console est plus étroite que umanMaxLineWidth caractères, sa largeur effective est prise en compte et la valeur de umanMaxLineWidth est ignorée.

  • umanDefaultOptions : Mot sans espace = série d'options de uman à utiliser par défaut. Voir plus loin la liste complète des options.

    • Les options "w", "wb" et "@" ne sont pas utilisables par défaut.
    • Si elle est utilisée par défaut, l'option "s" (sommaire) est annulée par les options d | e | h | b | a | u utilisées à l'appel de uman.
    • De même, "u" (usages) déclarée par défaut sera annulée par les options d | e | h | b | a | s utilisées à l'appel de uman.

  • umanUserPaths : vecteur de textes. Chaque élément du vecteur indique le chemin d'un répertoire dans lequel -- au delà des dossiers standard SCI\contrib et SCIHOME\contrib de résidence des modules externes -- uman doit chercher d'autres modules et leur documentation. Pour être visibles par uman, ces modules doivent être conditionnés selon les règles minimales décrites dans la section Aspects techniques.

  • umanAlignSyntaxes = "" | "l" | "r" (par défaut) : indique le mode d'alignement des syntaxes affichées en console pour une fonction :

    • "" : Supprime l'alignement utilisé par défaut.
    • "l" : le bloc gauche LHS des arguments de sortie est justifié à gauche ("Left"). Les "=" des expressions "LHS = fun(RHS)" et autres "fun(RHS)" sont alignés entre eux.
    • "r" : le bloc gauche LHS des arguments de sortie est justifié à droite ("Right"). Les "=" des expressions "LHS = fun(RHS)" et autres "fun(RHS)" sont alignés entre eux.

    Le mode "r" est le plus lisible. Il est utilisé lorsque umanAlignSyntaxes n'est pas explicitement définie.

  • umanNoStyle = %T | %F : valeur booléenne (par défaut = %F). À fixer à %T si l'on souhaite annuler l'affichage des styles en équivalents ASCII : "/.../" pour les parties en italique, mise en majuscules pour les "PARTIES EN GRAS", etc. En effet, "/" peut parfois devenir ambigu et être confondu avec une division ; si un mot en minuscule mis en gras désigne le nom d'une variable, sa mise en majuscules pose alors problème car désigne une variable distincte ; etc.

Exemple : nous souhaitons fixer par défaut umanNoStyle = %t, umanDefaultOptions = "d", et umanMaxLineWidth = 100. Nous ferons :

edit SCIHOME\scilab.ini. Dans ce fichier, ajoutons les lignes de code suivantes :

global umanNoStyle umanDefaultOptions umanMaxLineWidth
umanNoStyle = %T
umanDefaultOptions = "d"
umanMaxLineWidth = 100
Noter que sur la ligne global, le nom des variables ne doivent pas être séparés par des virgules mais par des espaces.

options

texte simple sans espace indiquant une ou plusieurs options. Chaque caractère (ordre et typographie indifférents) active une fonctionnalité spécifique. Les options disponibles sont décrites ci-après.

Par défaut, les options sont indiquées after le pattern. Sinon, le mot des options doit être préfixé par "-".

Les options

  • définies comme celles par défaut via la variable de configuration umanDefaultOptions,
  • indiquées avant le pattern et préfixées avec -, en appelant uman,
  • indiquées après le pattern, en appelant uman,

se cumulent selon les priorités décroissantes suivantes :

après le pattern > avant le pattern > via umanDefaultOptions > valeurs par défaut implicites.

le contenu doit être affiché.

Par défaut, la sortie texte est affichée dans la console Scilab. C'est le mode normal d'utilisation de uman. D'autres types d'affichage sont cependant possibles.

Priorités entre les différents modes d'utilisation de uman : wb > w, g > @

g : Navigateur d'aide = interface Graphique. En plus de l'affichage de la page d'aide dans la console, uman appelle le navigateur d'aide pour la même requête pattern.

Si le navigateur help n'est pas déjà ouvert, il est appelé dans la langue d'usage de la session ou celle fixée par l'option "L##".

Si le pattern fait référence à un module externe installé mais non chargé en session, les pages d'aide afférentes ne peuvent pas être affichées dans le navigateur. Une alerte est alors affichée dans la console en fin de page.
Lorsque l'option "g" est accompagnée de l'option "x" (modules eXternes prioritaires), la page affichée dans le navigateur est toujours prioritairement celle de la version Scilab du pattern (s'il y en a une), non la version externe. Pour plusieurs versions homonymes des pages d'aide, il est en effet impossible de forcer l'affichage de l'une d'entre elles plutôt qu'une autre.
w : page Web : affiche dans votre navigateur internet la page d'aide internet officielle, ou la page web des bugs documentés. L'affichage de la page d'aide dans la console est supprimé. Voir uman .. w.
wb : Web Bugs : affiche dans votre navigateur internet la page web des bugs documentés concernant le pattern indiqué. Aucun affichage n'est effectué en console. Voir uman .. wb.
@ : Listes de messagerie @listes.scilab.org (archives internet) : le pattern permet de réaliser des recherches par sujets, auteurs, et âge maximal des messages archivés. Aucune des autres options n'est utilisable en mode "@". Voir uman .. @.
j : Journaliser : autorise l'enregistrement de tous les affichages produits par uman dans tous les journaux actuellement ouverts (s'il y en a).

Par défaut, tous les journaux ouverts sont suspendus par uman avant tout affichage en console, afin de ne pas être alimentés par uman, puis sont réactivés à l'issue de la commande uman. Si aucun journal n'est préalablement actif, cette option n'en ouvre pas et aucune journalisation n'est déclenchée.

COMMENT la requête doit être traitée :

c :

Clear : effacer la console avant d'y afficher la page.

L## :

Langue d'usage : visualiser la version de la page dans la langue ##, où ## est un des codes linguistiques en | fr | ja | pt | ru. D'autres codes tels que de | zh | fa sont admis, sous réserve que de la documentation dans ces langues soit disponible (la documentation de certains modules externes est traduite dans ces langues). Sans l'option L##, la langue d'usage de la session est utilisée. Si L est indiquée en dernière option et sans code ##, ou si le code donné n'est pas reconnu, la version de référence en anglais est considérée.

Depuis uman 2.0, les corpus partiels / sous-ensembles de pages d'aide traduits hors des langues en,fr,ja,pt,ru sont admis et peuvent être exploités. Il suffit de déposer le fichier .jar correspondant sur l'ordinateur, comme pour un module standard. uman y cherchera et extraira les pages dés que l'item désigné dans le pattern est disponible dans la langue. Sinon, comme d'habitude, uman retourne la version par défaut, en anglais.

x : Priorité aux modules et références eXternes. Cette option est utilisable de deux manières :
  • Lorsque deux fonctions ayant le même nom sont proposées d'une part au sein de Scilab ET d'autre part dans un module ou d'une autre ressource externe (ATOMS, autres modules, fichier distribué dans FileExchange), par défaut uman considère la version Scilab. L'option "x" permet de cibler prioritairement les versions externes. Lorsque "x" est utilisée alors qu'aucune version externe correspondant au pattern n'existe, la version Scilab est toujours ciblée.

  • L'option "x" permet également de traiter les "faux-amis" : lorsque le même pattern désigne à la fois un terme propre à Scilab et un terme d'un autre langage de programmation scientifique (Octave, etc) MAIS correspondant à deux fonctionnalités clairement distinctes, par défaut l'acception propre à Scilab est considérée. Pour cibler plutôt l'acception externe, l'option "x" sera utilisée : uman redirigera alors automatiquement la requête initiale vers la page Scilab de la fonctionnalité equivalente.

    Exemples de termes faux-amis : type, end, load, home, range, null, etc. Ces termes utilisés à la fois en Scilab et par exemple en Octave ont cependant des significations différentes dans ces 2 langages.

r : Rafraichit / Recharge le registre de tous les modules externes installés, et supprime toutes les pages précédemment extraites des modules externes.

"r" doit être utilisée lors du 1er appel à uman après l'installation, mise à jour ou désinstallation d'un ou plusieurs modules externes.

Le registre des ressources JAR est initialement créé lors de la 1ère utilisation de uman. Chaque appel à uman recherche si une des ressources indexées correspond à la demande, et si en l'occurence la page correspondante (pour la langue demandée) est déjà extraite et disponible. Si ce n'est pas le cas, la page est extraite de l'archive JAR et est stockée sur le disque : un dossier est réservé aux pages Scilab, un autre pour toutes les pages de l'ensemble des modules externes, avec dans les deux cas autant de sous-dossiers que de versions linguistiques concernées. Tout appel ultérieur de uman pour la même page dans la même langue utilise la version déjà extraite et stockée. Après avoir installé, actualisé ou retiré des modules, autant le registre des JAR que le stock des pages externes déjà extraites peuvent se retrouver obsolètes ou non à jour. Toutes ces références doivent alors être raffraichies ou supprimées pour être ré-extraites si besoin. L'option "r" s'en chargera.

QUEL CONTENU doit être affiché.

Par défaut, la page d'aide correspondant à la requête est affichée, et l'affichage est restreint aux sections suivantes :

  • Chemin dans l'arborescence de l'aide
  • Désignation réelle de la page (après possible redirection)
  • Liste des syntaxes admises
  • Liste des paramètres d'entrée & de réponse
  • Références connexes Voir aussi.
Les informations d'autres sections peuvent être affichées en options à la demande (voir ci-dessous).

Les options de contenus sont classées selon les priorités suivantes : u > s > a > d,e,h,b
u : usages : affiche uniquement la liste des syntaxes admises, précédée du chemin dans l'aide. Cette option a la priorité la plus forte. En particulier elle annule les options "s" (sommaire) ou "w" (page web).
s : affiche le sommaire de la section de l'aide documentant l'item choisi, au lieu d'afficher sa page d'aide.
Cette option est cumulable avec l'option "g", pour afficher le sommaire dans le navigateur d'aide.
"s" annule ou ignore les options "w", "a", "b", "d", "e", "h".
a : All : affiche toutes les sections. Cette option équivaut aux options cumulées "deh".
d : Description : affiche les sections Description, Bibliographie, Références, Auteurs sections, ainsi que toutes les autres sections de types non identifiés.
Lorsqu'une page n'a pas de section "Arguments" | "Paramètres", sa section "Description" est toujours affichée.
e : Exemples : affiche les sections "Exemples"

Les exemples présentés dans d'autres sections sont affichés au sein et avec celles-ci. L'option "e" n'a aucun effet sur leur affichage.

h : Historique de l'implémentation du pattern.
b : Bugs : URL de la page internet listant les rapports de bugs concernant le pattern. Lorsque l'option "w" est simultanément utilisée, la page correspondante est ouverte dans le navigateur internet.

Description

You need human help? Just call uman

uman.. est une fonction avancée très compacte et paramétrable permettant d'accéder depuis la console et de manière unifiée à diverses ressources documentaires, en premier lieu aux manuels d'utilisation de Scilab. Les pages d'aide de Scilab, des modules ATOMS, des autres modules externes, ressources documentées sur le FileExchange Scilab ou externes, documentation des fonctions locales en commentaires d'en-tête, archives des listes de messagerie officielles, registres des rapports de bugs.. sont notamment couverts. uman permet en particulier d'afficher les pages d'aide directement dans la console ou dans votre navigateur internet, dans la langue choisie.

Systèmes d'exploitation

uman peut être utilisée sous Windows, Linux et Mac OS, avec Scilab 5.4, 5.5, et Scilab 6.

Principales fonctionnalités
  1. "uman" permet facilement de trouver, extraire, et afficher des informations issues

    • des pages d'aide incluses dans Scilab,
    • des pages d'aide des modules ATOMS installés,
    • des commentaires d'en-tête dans les macros des fonctions locales,
    • des pages d'aide d'autres modules externes conditionnés de manière standard,
    • des pages et du moteur de recherche de l'aide en ligne officielle,
    • des pages web des modules ATOMS (200 entrées) et des commentaires associés,
    • des forges publiques Scilab en ligne,
    • des pages du FileExchange Scilab (60 entrées),
    • du registre des bugs de Scilab sur bugzilla.scilab.org,
    • des archives en ligne des listes de diffusion officielles de Scilab,
    • et d'autres sites web externes présentant des ressources en code Scilab.

    Où l'information requise se trouve-t-elle ? uman recherche l'information parmi de nombreuses ressources dispersées, la met en forme et l'affiche pour vous : dans la console, dans le navigateur d'aide, ou dans votre navigateur internet : à vous de choisir avec une option compacte d'un seul caractère.

  2. Le comportement par défaut de uman ne vous convient pas ? uman est facilement paramétrable, dans votre fichier de démarrage personnel. Toutes les options d'appel de uman restent à tout moment utilisables pour s'adapter à vos besoins documentaires ponctuels.

  3. Seule une partie de la page d'aide vous intéresse ? Les syntaxes admises, les exemples, la description des paramètres, les fonctions dans le même chapitre, etc ? uman vous permet d'afficher uniquement la section souhaitée.. Si toute la page d'aide vous intéresse réellement, l'option "a" l'affichera en entier.

  4. Vous êtes habitué-e au langage Octave ? Indiquez le terme Octave que vous avez à l'esprit : près de 200 redirections vous mèneront directement à la page Scilab équivalente. D'autres racourcis pratiques sont également définis pour tous les utilisateurs.

  5. Inutile de charger les modules externes en session pour en consulter la documentation avec uman. Même les pages des modules qui ne fonctionnent pas avec votre ordinateur peuvent ainsi être affichées en console.

  6. Indiquez juste en option le code linguistique en | de | fr | ja | pt | ru | zh souhaité, et la version correspondante de la page demandée s'affiche en console ou en ligne. Inutile de changer la langue de la session. Vous avez un doute sur la version traduite d'une page ? Consulter la version de référence en anglais est immédiat.

  7. Un bug dans votre code vous résiste ? L'option "wb" de uman recherche et affiche la liste des bugs documentés concernant la fonction indiquée qui semble défaillante. Les rapports de bugs peuvent également être sélectionnés selon leur auteur ou commentateur, la catégorie, ou la période de publication, pour Scilab et pour de nombreux modules ATOMS.

  8. Vous souhaitez sonder les archives des listes de diffusion à propos d'un item, d'un auteur de messages, d'une période donnée ? uman le fait aisément pour vous depuis la console.

  9. Sans conclure.. uman affiche le texte de manière intelligible. Listes d'items imbriquées, tableaux simples avec ou sans bordures, extraits de code, notes et alertes, styles de texte.. sont supportés. Le style du code des syntaxes admises ou des exemples est également amélioré.

Raccourcis

Les termes suivants (en minuscules) ne sont pas des fonctions Scilab, mais sont définis pour uman afin de cibler certains contenus importants de manière directe :
apifun : Liste des fonctions du module externe apifun (s'il est installé).
colors : Fonctions de gestion des couleurs
datatypes : Liste des types de données
files : Principale liste des fonctions de gestion des fichiers
gui : Graphical User Interfaces : interfaces interactives. Composants graphiques interactifs (menus, uicontrols)
hdf5 : Liste des fonctionnalités HDF5 (fichiers et format)
history : Fonctionnalités d'historisation des commandes Scilab
ipd : Fonctions du module externe de traitement d'images IPD (s'il est installé).
keys : Liste des raccourcis clavier de Scilab
metanet : Fonctions du module externe Metanet (s'il est installé)
plotting : Liste des fonctions graphiques
signal : Fonctions de traitement du signal (liste principale)
stats : Fonctions statistiques (liste principale)
trigo : Fonctions trigonométriques normales et hyperboliques, directes et inverses
variables : Sommaire de la section Scilab => Variables
windows : Fonctions Scilab spécifiques à MS Windows
xml : Fonctions de traitement des fichiers et contenus XML

Ressources et références utilisées

Nous ne donnerons pas ici l'algorithme détaillé de recherche documentaire suivi par uman en fonction du patterndonné. Nous listerons juste les différents critères et sources utilisés. L'algorithme est consultable directement dans le code, dans la partie "SEARCHING FOR THE RIGHT HELP TARGET". La manière de prendre en compte les possibles redirections de tous types, l'option "x", la version linguistique choisie, et la casse typographique du pattern est directement considérée dans le code.

Ressources exploitées en mode console :

Les sources documentaires suivantes sont considérées :

  • Listes des alias / redirections Scilab->Scilab (raccourcis), externe->Scilab, et de faux-amis (si l'option "x" est utilisée).
  • Pages d'aide Scilab officielles, dans les 5 langues principalement supportées et distribuées (en, fr, ja, pt, ru).
  • Pages d'aide des modules ATOMS installés en modes "all users" (par l'administrateur) et "user" (par l'utilisateur).
  • Pages d'aide des autres modules externes installés dans les dossiers SCI\contrib ou SCIHOME\contrib directories ou dans leurs sous-dossiers.
  • Pages d'aide d'autres modules externes installés dans un des dossiers déclarés dans la variable globale umanUserPaths déclarée dans le fichier de démarrage de l'utilisateur.
  • Commentaires d'en-tête des fonctions locales écrites en langage Scilab et ne disposant pas de page d'aide dédiée standard.

Si aucune de ces ressources ne correspond à l'item du pattern ou à ses possibles alias, d'autres ressources externes indexées mais non installées sont scrutées, à savoir :

  • La table uman des alias / redirections externe->externe.
  • Les modules ATOMS indexés mais non installés.
  • Des modules hors ATOMS disponibles sur une forge Scilab publique.
  • Des ressources originales et correctement conditionnées disponibles sur le FileExchange Scilab.
  • D'autres références externes hors ATOMS, hors FileExchange et sans forge Scilab.

Si une de ces ressources correspond au pattern, un message invitant à utiliser l'option "w" -- voire précisant le libellé effectif du pattern -- est affiché dans la console.

Ressources exploitées en mode web "w" :

  • Pages d'aide Scilab officielles, pour les 5 langues standard supportées (en,fr,ja,pt,ru).
  • Nom et pages d'aide de chaque module ATOMS installé en modes "all users" et "user".
  • Noms des autres modules ATOMS indexés dans uman.
  • Noms des modules hors ATOMS ayant une forge Scilab publique.
  • Ressources distribuées sur le FileExchange, correctement conditionnées, et indexées dans uman.
  • Autres ressources externes indexées dans uman.
  • Moteur de recherche sur http://help.scilab.org
Les raccourcis Scilab->Scilab, équivalences externe->Scilab, et équivalences externe->externe peuvent être exploités afin d'identifier l'item correspondant au pattern donné.

Ressources exploitées en mode "wb" :

  • Fonctions Scilab : site bugzilla.scilab.org
  • Fonctions des modules ATOMS installés :
    • Si le module a une Forge Scilab : page des tickets de la forge
    • Sinon : page ATOMS.scilab.org du module, section des commentaires.
  • Pour tous les items issus de FileExchange : page FileExchange.scilab.org correspondante, section des commentaires.
  • Autres items externes indexés dans uman avec un site web référent : la page portail du site.
  • Autres items non reconnus, items multiples séparés par "|" : moteur de recherche sur http://bugzilla.scilab.org

Les alias / redirections définis dans uman ne sont pas utilisés en mode "wb".

Ressources exploitées en mode "@" listes de diffusion :

Archives de l'ensemble des listes de diffusion, sur mailinglists.scilab.org

Aspects techniques

  • uman extrait les pages d'aide de Scilab et des modules ATOMS ou autres modules Contrib et les stocke dans SCIHOME\uman et ses sous-dossiers.
  • Modules dans SCI\contrib (ATOMS ou autres) :
    • Tout module externe peut et doit résider n'importe où dans les dossiers SCI\contrib ou SCIHOME\contrib, pas nécessairement à leur racine.

    • Chaque module doit avoir un sous-dossier ~\jar\* contenant un ou plusieurs fichiers standard scilab_##_##_help.jar tels que produits par xmltojar(..), où ##_## désigne le code linguistique de la version du fichier (un seul fichier .jar par langue).

    • Le dossier du module doit également avoir un sous-dossier et un fichier ~\etc\<package_name>.start. Le fichier .start peut éventuellement être vide. Seul son nom <package_name> est utilisé par uman : il indique le nom = identifiant technique du module.

Limitations connues

  1. Changer la langue utilisée dans le navigateur d'aide nécessite de préalablement fermer celui-ci s'il est déjà ouvert, avant et de le relancer avec "uman .. gl##".. Voir le bug n° 12889
  2. Options "sw" : il n'est pas possible de cibler une page de sommaire sur https://help.scilab.org.
  3. Tableaux :
    • Le contenu des cellules doit être simple, non structuré : les tableaux imbriqués ou les listes à puces ou numérotées incluses dans des cellules sont traités comme du contenu linéaire.
    • Les cellules fusionnées avec colspan ou/et rowspan ne sont pas correctement traitées.
  4. Si plusieurs versions d'un module sont installées (dans SCI\contrib\* ou SCIHOME\contrib\*, etc), seules les pages de la dernière version répertoriée seront accessibles, laquelle n'est pas nécessairement la version la plus récente.
  5. Pour toute fonction locale, si les commentaires d'en-tête figurent dans un bloc multiligne /*...*/, ils sont ignorés. Voir le bug n° 14353.
  6. Les expressions LaTeXées affichées sous forme d'imagettes ne peuvent être affichées en console en texte. Néanmoins, leur existence est indiquée au fil du texte là où elles devraient apparaitre.
  7. Dans les pages en chinois, les lignes longues sans espaces ne sont pas césurées.
  8. uman n'est pas automatiquement extensible à toutes les langues. Si vous souhaitez ajouter une langue (par exemple lue de droite à gauche), merci de prendre contact avec l'auteur.
  9. Appeler le navigateur d'aide avec l'option "g" n'amène pas celui-ci au 1er plan (s'il est amarré au bureau Scilab) : voir le bug n° 13756
  10. uman ne peut pas être utilisée en mode console sans menus pour Scilab sous Windows : l'affichage UTF8 est défaillant. Voir le bug n° #10748.

Exemples

uman               // affiche cette page d'aide (Paramètres, "Voir aussi")

uman .*. cd        // Les opérateurs et les symboles sont admis (raccourci vers kron())
uman  $  cde       // Autre symbole. Description et Exemples inclus, après clc()

uman linespec a    // tout en minuscules => casse typographique indifférente => "LineSpec" trouvé
uman type a        // Les 2 pages "type" ou "Type" existent. Page "type" choisie
uman Type a        // Affiche la page "Type"
uman typE a        // L'item "typE" n'existe pas => "Aucune page trouvée pour 'typE'"

uman linspace Lrua // version russe de la page entière 'linspace'
uman linspace aL   // version de référence en anglais (par défaut)

uman uint16  ce    // Cette page présente plusieurs fonctions (int8, int16, etc)
                   // Elle est correctement ciblée et traitée.

// Les listes à puces ou numérotées imbriquées sont correctement affichées :
uman daskr cd
//     Réduisons la largeur de la console. Puis relançons
uman daskr cd     // Les lignes sont correctement césurées (mais jamais les lignes de code)

// Les tableaux simples avec ou sans bordures sont correctement affichés :
uman plotsparse c      // 2 tableaux sans bordures
uman atomsSetConfig ac // tableaux avec bordures. Les lignes longues sont césurées

// Redirections internes vers des pages ou le sommaire du chapitre :
uman keys        // raccourcis clavier => redirection vers la page "console"
uman files       // Sommaire des principales fonctions de gestion des fichiers
                 // D'autres raccourcis sont proposés. Essayer "stats"

// Equivalences Scilab d'items externes non reconnus en Scilab
uman polyval d   // polyval() n'existe pas en Scilab mais est la fonction Octave
                 // correspondant à horner() => la page Scilab horner() est affichée

// Equivalences Scilab de termes faux-amis
uman end a       // la page Scilab "end" est affichée = controls (if.. end / for.. end / while..end)
uman end ax      // "x" reconnait en priorité les acceptions externes.
                 // En langage Octave, "end" désigne le "numéro du dernier élément",
                 // => la page Scilab "$" est maintenant affichée.

// L'option "s" affiche le Sommaire de la section de l'item, au lieu de sa page :
uman strstr s    // toutes les fonctions de traitement du texte sont listées

// L'option "g" appelle simultanément le navigateur d'aide (amarrable au dessus de l'éditeur)
uman strstr deg
uman cholesky g  // = "help cholesky". Aucune page dédiée => Liste les pages contenant "cholesky"
uman who gs      // Le sommaire de la section de l'item peut aussi être ciblé
                 //  et affiché dans le navigateur d'aide.
                 // Pour changer la langue du navigateur, il doit être
                 //  préalablement fermé. Puis :
uman who gslru   // version russe demandée affichée en console.

// Pour toute fonction locale chargée en session telle que celle-ci :
function r=test(p, q)
   //
   // CALLING SEQUENCES
   // r = test(p)
   // r = test(p, q)
   //
   // PARAMETERS
   // p: 1st param (describe it here)
   // q: optional 2nd param (describe it here)
   // r: result (describe it here)
   //
   // DESCRIPTION
   // This function and its comments must be executed. It is designed to
   //  illustrate uman's acting as head_comments().
   //
   // Go on with other help sections. The block of comments must be continuous.
   //
   r = p*q.^2
endfunction
uman test   //  affiche le 1er bloc continu de commentaires en en-tête dans test()

// Avec un module ATOMS installé
// =============================
uman atoms d           // Liste des fonctions du gestionnaire ATOMS
yn = atomsIsInstalled("plotlib");
atomsInstall plotlib ; // Installons le module "Plotlib"
atomsIsLoaded plotlib  // => %F
uman plot cde          // La fonction Scilab plot() est prioritaire. Sa page est affichée.
uman plot cdex         // Avec "x", la fonction plot() du module eXterne "Plotlib"
                       //  devient prioritaire. La page Plotlib de plot() est affichée.
uman linspace cax      // Aucune version externe de linspace() n'est trouvée
                       //  => la version Scilab est affichée.
uman plot cdexg        // Le navigateur d'aide appelé par l'option "g" n'affiche
                       //  rien, car "Plotlib" est INSTALLÉ mais n'est pas CHARGÉ

if ~yn, atomsRemove("plotlib"), end    // (ménage après ces exemples)

Voir aussi

Auteur

Samuel GOUGEON

Historique

VersionDescription
2.1, 2016-10-30

  • 14 bugs corrigés. 19 références ajoutées.
  • Le bloc des syntaxes est désormais aligné. Nouvelle variable de configuration "umanAlignSyntaxes".
  • Pour toute page sans section "Paramètres", la partie "Description" est désormais toujours affichée.
  • Pages d'aide traduites en français.

2.0, 2016-04-06

Version majeure. uman reformulée. Nombreuses nouvelles fonctionnalités, améliorations, et bugs corrigés. uman est maintenant utilisable avec Sclab 6.

1.4, 2015-07-31

Première version binaire pour Scilab 6. 3 bugs corrigés. 10 références ajoutées.

1.3, 2015-07-12

20 bugs corrigés. 20 références ajoutées. Voir les détails dans changelog.txt

1.2, 2015-06-06

Près de 40 améliorations et bugs corrigés. Code prêt pour Scilab 6.

1.1, 2015-04-02

Version technique intermédiaire créée par l'administrateur ATOMS (après correction de bugs ATOMS)

1.0, 2015-03-22

Première version publiée


Report an issue
<< disp_usage uman uman .. @ >>