Manuel d'utilisation en console, documentation multimodale multilingue avancée
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 b uman item b uman item1|item2.. b uman author>item.. b uman author1|author2|..>item.. b uman author/section>item.. b uman section/author>item.. b uman section>item.. b uman section1|section2|../author1|author2|..>item1|item2|.. b uman "section1|section2|.. / author1|author2|.. > item1 | item2 |..<Ndays" b uman ..<Ndays b uman <Ndays b
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!" @
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 "b" 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.
Les options décrites ici sont utilisables à l'appel de uman(). Un autre
ensemble d'options de configuration modifiant le
comportement de uman() est disponible en
préférences. |
options
est un mot sans espace indiquant une ou
plusieurs options. Chaque caractère (ordre et min/majuscules indifférents)
active une fonctionnalité spécifique.
Les options disponibles sont décrites ci-après.
Par défaut, les options
sont indiquées après le pattern
. Sinon, le mot des
options
doit être préfixé par "-"
.
Les options
umanDefaultCallOptions
,pattern
et préfixées avec
-
, en appelant uman
,pattern
, en appelant
uman
,se cumulent selon les priorités décroissantes suivantes :
après le pattern >
avant le pattern
>
préférences configurées >
valeurs par défaut implicites.
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
: b > w, g > (console) > @
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 de
Scilab 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 complémentaire
"L##" .
| ||||
w : | Page Web : affiche dans votre navigateur internet la page d'aide internet officielle. Voir uman .. w. | ||||
b : | Web Bugs : affiche dans votre navigateur internet une page
web listant les bugs documentés concernant le
pattern donné.
Voir uman .. b.
Cet usage de uman() dispose de l'option
Liste uniquement les bugs non résolus
disponible dans les préférences. | ||||
@ : | 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 dans tous les journaux actuellement
ouverts (s'il y en a) tous les affichages en console
produits par uman .
Par défaut, tous les journaux ouverts sont suspendus puis
réactivés par uman avant et après
tout affichage en console, afin de ne pas être alimentés.
Si aucun journal n'est préalablement actif, cette option
n'en ouvre pas et aucune journalisation n'est déclenchée. |
Par défaut, la page d'aide correspondant à la requête est affichée, et l'affichage est restreint aux sections minimales suivantes pour l'item :
Les options de contenus sont classées selon les priorités
suivantes : u > s > a > p,d,e,h |
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 pour les contenus : elles ignore toutes les autres options de contenus, mais est ignorée en mode b, w ou g. | ||
s : | affiche le sommaire de la
section de l'aide documentant
le pattern choisi, au lieu de sa page d'aide.
| ||
a : | All : affiche
toutes les sections de la page
d'aide. Equivaut à utiliser "pdeh" . | ||
p : | Paramètres : affiche la section
Arguments.
| ||
d : | Description : affiche les sections Description, Bibliographie, Références, Auteurs, ainsi que toutes les autres sections de type non identifié. | ||
e : | Exemples : affiche les
sections d'exemples
Les exemples inclus dans des sections d'un autre type sont
affichés au sein et avec celles-ci. L'option
"e" n'a aucun effet sur leur affichage. | ||
h : | Historique du
pattern . |
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 :
|
r : | Rafraichit /
Recharge le registre de tous
les modules externes installés, et supprime toutes les pages
précédemment extraites des modules externes et mises en cache.
Pour les modules gérés avec le système ATOMS : uman() met
automatiquement à jour son registre de ressources après chaque
installation ou désinstallation d'un module. L'usage de
l'option "r" ne fait rien de plus et est donc inutile.
L'option "r" sera utilisée une fois
|
uman..
est une fonction avancée compacte et paramétrable permettant
d'accéder depuis la console et de manière unifiée
à diverses ressources documentaires, en premier lieu aux pages du
manuel d'utilisation
de Scilab. Les pages de Scilab (fonctions actuelles ou anciennes fonctions supprimées),
des modules ATOMS, d'autres modules externes,
des ressources documentées sur le FileExchange Scilab ou externes, la documentation
des fonctions locales en commentaires d'en-tête, les archives des listes de messagerie
officielles, les registres des rapports de bugs.. sont notamment couverts.
L'affichage peut à la demande être réalisé directement dans la console, ou dans votre
navigateur internet, ou dans le navigateur d'aide de Scilab, dans la langue choisie.
Pour plus de 220 termes externes (issus d'autres langages scientifiques), uman redirige automatiquement la requête vers la référence Scilab équivalente ou la plus appropriée.
uman
peut être utilisée sous Windows, Linux et Mac OS,
avec Scilab 5.5 et Scilab 6.
"uman" permet facilement de trouver, extraire, et afficher des informations issues
Pourquoi se demander où l'information requise se trouve ?
uman
la recherche parmi de nombreuses ressources
dispersées, et l'affiche pour vous : dans la console, dans le navigateur
d'aide, ou dans votre navigateur internet : à vous de choisir.
Le comportement par défaut de uman
ne vous convient pas ?
De nombreux paramètres de configuration peuvent être réglés via
l'interface des préférences. Par ailleurs, toutes les options d'appel de
uman
restent à tout moment utilisables pour s'adapter à
vos besoins documentaires ponctuels.
Seule une partie de la page d'aide vous intéresse ? Les syntaxes admises,
les paramètres décrits, la description des usages, les exemples,
l'historique, les fonctions dans le même chapitre, etc ?
uman
vous permet d'afficher uniquement la ou les parties
souhaitées.. Si toute la page d'aide vous intéresse réellement, l'option "a" l'affichera en entier.
Vous êtes habitué-e au langage Octave ? Indiquez le terme Octave que vous avez à l'esprit : plus de 220 redirections vous mèneront directement à la page Scilab équivalente ou la plus proche. D'autres racourcis pratiques sont également définis pour tous les utilisateurs.
Indiquez juste en option le code
en | de | fr | ja | pt | ru | zh
de la langue souhaitée,
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.
Votre requête concerne une ancienne fonctionnalité retirée de Scilab ?
uman
l'identifiera, et pourra afficher l'ancienne page,
en ligne, ou dans la console ou le navigateur d'aide (si le module
complémentaire https://atoms.scilab.org/toolboxes/removed rassemblant
les pages des anciennes fonctionnalités est installé).
Vous pensez faire face à un bug dans Scilab ou dans un module ATOMS ? Utilisez l'option "b" de uman pour afficher en ligne la liste des bugs documentés concernant votre requête. Pour Scilab, la requête peut facilement être filtrée (nom du rapporteur ou d'un commentateur, catégorie, période). Les commentaires relatifs aux modules externes ATOMS sont aussi directement accessibles.
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.
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.
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 |
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 |
ipcv : | Fonctions du module externe de traitement d'images IPCV (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 |
// SVP sélectionner chaque ligne une à une, l'exécuter (CTRL+E), et voir le résultat en console uman ndgrid u // Uniquement les syntaxes admises pour ndgrid() uman eye p // Section "Paramètres" (Arguments) affichée uman eye d // Section "Description" affichée uman eye e // Section "Exemples" affichée uman linspace h // Section "Historique" affichée uman eye ph // Sections "Paramètres" et "Historique" affichées uman eye a // Page entière affichée uman ones d // "d" affiche aussi toute autre section (ici "Remarques"). uman .* cpd // Les opérateurs et les symboles sont admis. // "c" = console effacée avant l'affichage. 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" , <> "type" uman typE a // L'item "typE" n'existe pas => "Aucune page trouvée pour 'typE'" uman linspace Lruph // version russe de la page entière 'linspace' (Paramètres et Historique) uman linspace hpL // version de référence en anglais (toujours Paramètres et Historique) // ("L" au lieu de "l" (~ "1" = one), mais "l" est OK). uman uint16 ce // Cette page présente plusieurs fonctions (int8, int16, etc) // Elle est correctement ciblée et traitée. // Les listes imbriquées de termes, à puces, ou numérotées sont bien affichées : uman brackets cd // Réduisons la largeur de la console. Puis relançons uman brackets cd // Les lignes sont bien 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 | for | 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. uman flipdim x // Aucune version externe trouvée => celle de Scilab est affichée // L'option "s" affiche le Sommaire de la section de l'item, au lieu de sa page : uman clear s // toutes les fonctions dans la section de "clear" sont listées
Appeler le navigateur d'aide avec uman() et ses options :
uman strstr deg // Dans le navigateur, les options "de" sont ignorées. uman cholesky g // = "help cholesky". // Aucune page dédiée => Liste les pages contenant "cholesky" uman who gs // Affiche le sommaire de la section de "who" // Pour changer la langue du navigateur, il doit être préalablement fermé. Puis : uman who gslru
Avec une fonction utilisateur définie localement :
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 // Fin de la fonction endfunction uman test // affiche le 1er bloc continu de commentaires en en-tête dans test()
--> uman test 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.
Avec un module ATOMS installé :
uman atoms d // Liste des fonctions du gestionnaire ATOMS yn = atomsIsInstalled("serial"); atomsInstall serial ; // Installons le module externe 'serial' atomsIsLoaded serial // => %F uman openserial ca uman openserial s // Sommaire du module 'serial' uman openserial ag // Le navigateur d'aide appelé par l'option "g" n'affiche rien, // car "serial" est INSTALLÉ mais n'est pas CHARGÉ. // À la place, la page est affichée dans la console. if ~yn, atomsRemove("serial"), end // (ménage après ces exemples)
Version | Description |
3.0 | 2019-08-22
uman
porte sur un item supprimé reconnu, désormais
|
2.1 | 2016-10-30
|
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 Scilab 6. |
1.4 | 2015-07-31 : Première version binaire pour Scilab 6. 3 bugs corrigés. |
1.3 | 2015-07-12 : 20 bugs corrigés. Voir les détails dans changelog.txt |
1.2 | 2015-06-06 : près de 40 améliorations et bugs corrigés. |
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 |