<< uman .. @ uman uman .. wb >>

uman >> uman > uman .. w

uman .. w

affiche la page web documentant un item

Syntaxe

uman item w
uman item wx..
uman item wr..
uman item wL
uman item wL##
uman item1|item2|.. wL##
uman "item1 | item2 | .. " wL##

Arguments

w

Le mode "w" (web) de uman cible la documentation structurée disponible sur internet pour un item donné.

item, item1|item2|,...

Mots ou expressions (texte) dont la documentation est recherchée :

  • Lorsque le libellé est tout en minuscules, la recherche est effectuée sans tenir compte de la casse typographique.
  • Sinon (le libellé comporte au moins un caractère en majuscule), la recherche est effectuée en tenant compte de la casse.

Plusieurs items séparés par des "|" peuvent être spécifiés. Le moteur de recherche de l'aide Scilab en ligne est alors utilisé et alimenté par les items concernés afin de rechercher toutes les pages contenant au moins l'un d'eux.

Les pages trouvées sont classées par nombre décroissant d'occurrences des items trouvées. L'utilisation des conjonctions AND ou NOT entre items pour restreindre la sélection n'est pas permise.

Pour inclure un ou plusieurs espaces dans l'item ou la liste d'items, tout le motif (excepté l'option "w") doit être spécifié entre guillemets ou apostrophes.

Comme avec uman en console, lorsqu'un seul item est recherché et n'est pas reconnu comme élément littéral de Scilab, il est alors recherché dans les tables d'alias disponibles. S'il y est trouvé, l'élément correspondant est ciblé à la place (redirection).

options
Elles sont indépendantes les unes des autres. Elles peuvent être utilisées seules ou se cumuler.
x : Références eXternes prioritaires : lorsque l'item existe à la fois dans Scilab et dans une ressource externe (par exemple un module externe), utiliser cette option pour en cibler prioritairement la version externe.
r : rafraichir le registre de uman : après avoir installé ou désinstallé des ressources (modules externes ATOMS ou autre, chemins dans déclarés dans umanUserPaths, etc), cette option déclare ces changements à uman avant d'exécuter la requête et les suivantes.
L## :

Cette option Linguistique est utilisée uniquement lorsque l'item donné est documenté sur http://help.scilab.org. Sinon l'option est ignorée.

Les codes linguistiques ## disponibles sont en (par défaut), fr, ja, pt, ou ru.

Voir uman pour plus d'information.

Des exemples utilisant ces options sont fournis ci-dessous.

L'option "s" (sommaire de la section de l'aide de l'item) n'est pas utilisable en mode "w".

Description

uman .. w lance le navigateur internet défini dans les préférences Scilab et ouvre la page web de l'aide Scilab en ligne ou toute autre page web de référence de l'item externe donné. Si l'item n'est pas trouvé parmi les mots réservés de Scilab ou parmi les modules Scilab externes installés, chargés, ou parmi les autres ressources simplement déclarées dans uman, le moteur de recherche de l'aide en ligne de Scilab est ciblé.

Les pages web ciblées sont celles de la dernière version de Scilab officiellement publiée, qui peut être ultérieure à la version de Scilab utilisée sur l'ordinateur si l'utilisateur n'a pas actualisée celle-ci.

uman .. w requiert une connection internet active.

uman .. w n'affiche rien dans la console.

Exemples

// ====== CONNEXION INTERNET ACTIVE REQUISE ======
//
// Documentation web de Scilab : l'option "w"
// ------------------------------------------
uman ode w        // dans la langue de la session (si reconnue, sinon en anglais)
uman ode wlpt     // en Portugais
uman ode wl       // Page de référence en anglais (code par défaut = "en")

uman type w       // pourrait afficher les pages de "type" ou "Type". "type" est ciblé
uman Type w       // affiche la page d'aide de "Type" (typographie mixte prise en compte)
uman linespec w   // tout en minuscule => requête insensible à la typographie: "LineSpec" trouvé

uman sort wlru    // non trouvé : l'option "w" recherche aussi une redirection interne
                  // La correspondance "sort => gsort" est trouvée et utilisée

uman cholesky w   // Tout item inconnu est passé au moteur de recherche de l'aide en ligne

uman scimax w     // Pas sur ATOMS mais a une forge Scilab : celle-ci est ciblée

uman contour3d w  // Pour une fonction uniquement disponible et déclarée sur
                  //  FileExchange, la page FileExchange afférente est ouverte.

uman gpib w       // Ni sur ATOMS ni sur la Forge Scilab. Son site web référencé est ciblé

// Exemples avec un module ATOMS externe installé
// ----------------------------------------------
uman uman w       // La page ATOMS du module "uman" est ciblée et ouverte

yn = atomsIsInstalled("plotlib");
atomsInstall plotlib ; // installons "Plotlib"
atomsIsLoaded plotlib  // => %F : le module n'a pas besoin d'être chargé

uman quiver xw    // quiver() est une fonction de Plotlib.
                  //  L'aide des modules ATOMS n'est pas (encore) publiée en ligne.
                  //  => la page d'aide trouvée est affichée dans la console
                  //  à la place (avec une indication spécifique)

if ~yn, atomsRemove("plotlib"), end   // (ménage après l'exemple)

Voir aussi

Historique

VersionDescription
2.1

Traduction de cette page en français

2.0

Création de cette page dédiée documentant "uman .. w"

1.0

Première publication de uman


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