uman .. w

Arguments

w

w is the uman's option making it working in "Web page" mode.

item, item1|item2|,...

Words or text expressions that must be searched for.

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

options

Available options 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 the Scilab's one.
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.

Please see the uman page for more information.

Description

uman .. w requires an active internet connexion.

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.

Several items may be provided, separated with "|". Then, the Scilab online help search engine is always called 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.

As with uman in console: when a single item is searched for and is not found as is, a redirection (alias) is searched for, and if any, it is targeted instead.

If the item or the list of items includes at least one space, the whole pattern (out of options) must be delimited within quotes or double-quotes.

Pages for the current official Scilab version are considered. Scilab's version that runs "uman" is ignored (if it is not the current official version).

"sw" options: It is not possible to target online Tables of Contents on https://help.scilab.org.

Querying a removed feature

When the item is a former Scilab feature that has been removed...

• before Scilab 5.3.1:
  • If a replacement exists:
    • A message is displayed in the console. It indicates the last Scilab version supporting the feature, and the name of its replacement.
    • The online page of the replacement is displayed.
  • Otherwise: the https://atoms.scilab.org/toolboxes/removed page is displayed.

  In addition, if the atomsInstall("removed") module is installed, the former page of the item is displayed in the console.

• after Scilab 5.3.0: Its archived page is displayed online.

Examples

// ====== ALIVE INTERNET CONNEXION REQUIRED ======

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 CUMSUM w     // page of the CUMSUM Xcos block
uman cumsum w     // page of the cumsum() Scilab function

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   // Unknown pattern => the online search engine is called

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

uman end wx       // "x" (priority to eXternal) can be used with "w". Here => Dollar page.

With an installed external ATOMS module :

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

yn = atomsIsInstalled("serial");
atomsInstall serial ; // Let's install the serial toolbox
atomsIsLoaded serial  // => %F: no need to be loaded

uman openserial w   // There is no (yet) online help pages for ATOMS packages.
                    //  => the page is displayed in the console instead
                    // (with a specific footer)

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

Documentation for Scilab removed features :

// atomsInstall removed ;
// atomsAutoloadDel removed ; // Then restart the session

// Case 1) Feature removed before Scilab 5.3.1 (no online archive)
 uman lgfft w   // without replacement
 uman getf w    // with a replacement

// Case 2) Feature removed after Scilab 5.3.0
 uman xbasr w   // without replacement
 uman MSDOS w   // with a replacement

See Also

• uman — User manual in console. Advanced multimodal and multilingual documentation.
• uman .. @ — Selects messages from Scilab mailing lists archives
• uman .. b — Lists bugs reported about a given item, in the web browser
• http://help.scilab.org

History