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

uman >> uman > uman .. w

uman .. w

Show the online help page or the reference web page of an item

Syntax

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>

Arguments

w

w is the uman's option making it working in "web query" mode.

item, item1|item2|,...

Words or text expressions that must be searched for in the title of bugs reports:

  • When it is all in lower-case, the item is searched in a case-insensitive way.
  • When it mixes upper and lower cases, the item is searched as is in a case-sensitive way.

Several items may be provided, separated with "|". Then, the Scilab online help search engine is targeted and queries any page about at least one of the items. Pages matching the maximal number of items are ranked first. There is no way no restrict the selection with AND or NOT conjunctions.
If the item or the list of items includes at least one space, the whole pattern must be delimited within quotes or double-quotes.

As with uman in console, when no multiple items are searched for and the item is not found as is, a redirection (alias) is searched for, and if any, is targeted instead.

options
They are independent from each others and may be used alone or together.
x : eXternal contents first: Use this option when the item is available in Scilab as well as in another external resource, and you want to target the external version instead of Scilab's one.
r : refresh uman's registery: After installing or uninstalling any resources (ATOMS, external modules, paths in umanUserPaths, etc), makes uman aware of these changes before processing.
L## :

The Language option is used only when http://help.scilab.org is targeted to process the given item(s). It will be ignored in all other cases.

Available language codes ## are en (default), fr, ja, pt, or ru.

See uman for more information.

Examples using these options are provided herebelow.

The s option (summary of the item's section) is not available in w mode.

Description

uman .. w runs the web browser defined in your Scilab preferences and opens an URL targeting the Scilab online help page or the reference web page of the item, or the Scilab online help search engine. Pages for the current Scilab version are considered. Scilab's version that runs "uman" is ignored (if it is not the current one).

uman .. w requires an active internet connexion.

uman .. w is console-quiet.

Examples

// ====== ALIVE INTERNET CONNEXION REQUIRED ======
//
// Online help page : The "w" option
// ---------------------------------
uman ode w        // in the session's language (if it is registered, otherwise in english)
uman ode wlpt     // in Portuguese
uman ode wl       // Reference page in english

uman type w       // could display "type" or "Type" pages. "type" is prefered
uman Type w       // displays the "Type" page (case-sensitive)
uman linespec w   // all in lowercase => the query is case-insensitive: "LineSpec" found

uman sort wlru    // Not found: The "w" option also searches inner redirections
                  // "sort => gsort" found and used.

uman cholesky w   // For any unknown pattern => online search engine &amp; results

uman uman w       // ATOMS's page of uman is targeted

uman scimax w     // not on ATOMS but has a Scilab forge: its forge is targeted

uman contour3d w  // For a function only available and registered on FileExchange,
                  //  the related online page is opened.

uman gpib w       // Neither on ATOMS nor with a Scilab forge. Its website is targeted

// Example with an external toolbox installed
// ------------------------------------------
yn = atomsIsInstalled("plotlib");
atomsInstall plotlib ; // Let's instal Plotlib
atomsIsLoaded plotlib  // => %F: no need to be loaded

uman quiver xw    // quiver() is in Plotlib. There is no (yet) online help pages
                  //  ATOMS modules => the page is displayed in the console
                  //  instead (with a specific footer)

if ~yn, atomsRemove("plotlib"), end   // cleaning after the example

See Also

History

VersionDescription
2.0, 2016-04-06

Separate help page for "uman .. w"

1.0, 2015-03-22

First uman release


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