uman .. w

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.

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.
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.

Consulter la page uman pour plus d'information.

Description

uman .. w requiert une connection internet active.

uman .. w lance le navigateur internet défini dans vos 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 des 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é.

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.

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).

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

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é celle-ci).

Options "sw" : il n'est pas possible de cibler une page de sommaire sur https://help.scilab.org.

Requête concernant une fonctionnalité supprimée:

Lorsque l'item est une ancienne fonctionnalité de Scilab supprimée...

• avant Scilab 5.3.1 :
  • Si un substitut existe :
    • un message est affiché dans la console. Il indique la dernière version de Scilab ayant inclus la fonctionnalité, et le nom de son substitut.
    • La page d'aide du substitut est affichée en ligne.
  • Sinon : la page https://atoms.scilab.org/toolboxes/removed est affichée.

  En outre, si le module atomsInstall("removed") est installé, l'ancienne page concernant l'item est affichée dans la console.

• après Scilab 5.3.0 : sa page d'aide archivée est affichée en ligne.

Exemples

// ====== CONNEXION INTERNET ACTIVE REQUISE ======

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 CUMSUM w     // page d'aide du bloc CUMSUM de Xcos
uman cumsum w     // page d'aide de la fonction cumsum() de Scilab

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   // Item inconnu => le moteur de recherche de l'aide en ligne est utilisé

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é

uman end wx       // "x" (priorité eXterne) peut être utilisée avec "w". Ici => page Dollar $.

Avec un module externe ATOMS installé :

uman uman w       // La page ATOMS du module "uman" est ciblée et ouverte

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

uman openserial w  // 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("serial"), end   // (ménage après l'exemple)

Documentation de fonctionnalités Scilab supprimées :

// atomsInstall removed ;
// atomsAutoloadDel removed ;  // Puis redémarrer la session

// Case 1) Fonctionnalité supprimée avant Scilab 5.3.1 (sans page en ligne)
 uman lgfft w   // sans substitut
 uman getf w    // avec un substitut

// Case 2) Fonctionnalité supprimée avant Scilab 5.3.0
 uman xbasr w   // sans substitut
 uman MSDOS w   // avec un substitut

Voir aussi

• uman — Manuel d'utilisation en console, documentation multimodale multilingue avancée
• uman .. @ — Sélectionne des messages des archives des forums Scilab
• uman .. b — affiche la liste des bugs documentés concernant un motif donné
• http://help.scilab.org

Historique