[Scilab-users] uman : help in the console, with language switch, automatic redirections, related online pages.

[Antoine Monmayrant]

I just started to play with it and it looks good!
It provides a feature that scilab is lacking: a decent command line 
documentation.
Thanks,

Antoine


Le 06/08/2015 09:45 PM, Samuel Gougeon a écrit :
> Hello,
>
> *uman* is a *U*nified display command of the Scilab User *MAN*ual. It 
> is a general purpose
> function that might be useful for every Scilab user and developer.
> *uman* 1.2 is just released on ATOMS (web and Scilab 
> interface).Install it and enjoy!
>
> *Pointers* :
>    * ATOMS page : http://atoms.scilab.org/toolboxes/uman
>    * Help (en): 
> http://sgougeon.free.fr/scilab/help/uman/scilab_en_US_help/uman.html
>    * Help (fr)  : 
> http://sgougeon.free.fr/scilab/help/uman/scilab_fr_FR_help/uman.html
>
> *Main features* :
>
>  * A single function to see help pages from Scilab, from installed 
> ATOMS modules (no need
>    to load them), from other external modules, and heading comments in 
> functions. Around
>    50 external references available on the Scilab FileExchange can 
> also be addressed.
>
>  * A single function to target and display contents in text mode in 
> the console, or as usual
>    in the help browser, or as well online (help, bugzilla, atoms, 
> forge, or even external websites).
> *uman* aims to embrace as many Scilab ressources as possible.
>
>  * Just give a language code en | de | fr | ja | pt | ru | zh in 
> option, and you get the
>    right version of the page in the console or online. No need to 
> change the session's
>    language. Watching the reference en_US version of the page is now 
> straightforward,
>    without leaving your locales.
>
>  * Just display main infos in brief: path in help, calling sequences, 
> parameters, See
>    also. And be free to display more on request: description, 
> examples, history, parent
>    ToC... Or finally display the whole page with the "a" option. It is 
> so easy to copy/past
>    pieces of examples from the console... to the console!
>
>  * Are you used to use another scientific language? Almost 200 
> automatic redirections will
>    target the right or nearest Scilab equivalence for you. Other handy 
> shortcuts are also
>    defined for all users.
>
>  * Stucked with a bug? The "wb" option lets you list documented ones 
> related to the
>    faulty entry, for Scilab and many ATOMS packages. Online users 
> comments have
>    never been so easily reachable.
>
>  * Last but not least: get a smart text layout in console. Nested 
> lists of items, tables,
>    pieces of codes, notes and warnings, text styles.. are supported. 
> The code style of
>    calling sequences and examples is also improved.
>
> *Supported OS* : Windows, Linux and Mac OS, with Scilab 5.5 and Scilab 6.
>
> *uman* has been extensively tested for Windows, a few tested for 
> Linux, and is
>   almost untested for Mac OS. Issues may be reported in comments on 
> the ATOMS
>   page. Please have a look to the list of known limitations before 
> posting.
>
> Try *uman*, and adopt it ;)
>
> Best regards
> Samuel Gougeon
>
>
>
> _______________________________________________
> users mailing list
> users at lists.scilab.org
> http://lists.scilab.org/mailman/listinfo/users
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.scilab.org/pipermail/users/attachments/20150609/0b5c735e/attachment.htm>