Scilab Home Page | Wiki | Bug Tracker | Forge | Mailing List Archives | Scilab Online Help | File Exchange
ATOMS : uman - User manual in console + advanced features details
Please login or create an account

uman - User manual in console + advanced features

User MANual in console + online + browser, easy languages switch, related bugs, comb mailing lists...
(2100 downloads for this version - 11399 downloads for all versions)
Details
Version
2.1
Author
Samuel GOUGEON
Owner Organization
private individual
Maintainer
Samuel Gougeon
Categories
License
Creation Date
October 30, 2016
Source created on
Scilab 6.0.x
Binaries available on
Scilab 5.5.x:
Windows 64-bit Windows 32-bit Linux 64-bit Linux 32-bit MacOSX
Scilab 6.0.x:
Windows 64-bit Windows 32-bit Linux 64-bit Linux 32-bit MacOSX
Install command
--> atomsInstall("uman")
Description
            HELP pages (english & french):
http://sgougeon.free.fr/scilab/help/uman/scilab_en_US_help
-------
uman.. displays help pages in console, and other online documentation about
online help pages, reported bugs, messages on mailing lists related to the
query. It manages aliases, language switching, and has other advanced features.

FUNCTIONS
---------
 disp_usage — Displays allowed syntaxes to call a given function.
 uman       — User manual in console, online, or browser, with 
               language switch and related bugs & messages.
 uman .. @  — Selects informations from Scilab mailing lists
 uman .. w  — Shows the online help page or the reference web page 
               of an item
 uman .. wb — Shows bugs reported on Scilab bugzilla or forge bugs 
               trackers, or as ATOMS comments


MAIN FEATURES
-------------
       "uman" allows to easily select, grab and display informations
from embedded Scilab help pages, from pages of installed ATOMS modules, from
heading comments in local user-defined functions, from pages of other external
modules, from the online Scilab help pages and search engine, from ATOMS web
pages (200 entries) and their comments, from online Scilab forges, from Scilab
FileExchange pages (60 entries), from Scilab's bug trackers, from archives of
all official Scilab mailing lists, and from other external web sites presenting
Scilab resources.

        You don't have to think about where is the required information:
"uman" gets it from the right place and displays it for you. You can
get it in the console, in the help browser, or in your internet browser for
online resources.

        No need to load modules in the Scilab session. Even the documentation of
packages that do not run under your Operating System can be viewed and displayed
in the console.

        No need to view the whole help page. Choose informations that you want
to display: only usages (syntaxes), parameters, See also. Or more: description,
examples, history, table of contents of the item's help section.. If really the
whole page must be displayed, the "a" option will do it.

        Are you used to use another scientific language? Almost 200 automatic
redirections will target the right Scilab equivalences for you. Other handy
shortcuts are also defined for all users.

        Just give a language code en | de | fr | ja | pt | ru | zh in option,
and you get the right version of the help page in the console or online. No need
to change the session language. Watching the reference en_US english version of
the page is now straightforward, without leaving your locales.

        Set your default "uman" parameters in your startup file, and
enjoy. You will always be able to easily override them in compact command-line
options.

        Stucked with a bug? The "wb" option let's you either view the
page of a specific bug, or nicely list documented bugs related to a chosen item,
or list bugs related to a given category/section, or from some chosen reporters
or commenters, or within a chosen period, for Scilab and many ATOMS packages.
Online users comments are as well directly reachable..

        Want to efficiently probe mailing lists, for some items, or some
authors, on some given period? "uman" does it easily for you.

        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.

             =============================================


CHANGES 2.0 => 2.1 (2016-10-30)
-------------------------------
NEW FEATURES
 * New configuration variable umanAlignSyntaxes = '' | 'l' | 'r' (default)

IMPROVEMENTS
 * Help pages are now available in french.
 * Console mode: 
   - For a better readability, syntaxes of a function are now aligned. 
     Their justifying is tunable. Examples: who, unwrap, ss2tf, strsplit...
   - When a page has no parameters section, its description section(s) is
     now automatically displayed, even without using the 'd' option

REFERENCES ADDED
 * Redirections
   - internal: stat=>stats
   - to Scilab: bicg, bicgstab, cgs, class, iscell, iscellstr, isinteger,
     isjava, numel, pcg, spdiags, square => squarewave(faux-ami)
   - to external: print_usage
 * FileExchange: GnuSciPlot, Ishikawa, STL
 * ATOMS: forge cglab=>cgal, Dynpeak, FOT, sopi, wgserialxcosio

BUG FIXED
 * 'uman close u' displayed only 'close(H)', forgetting 'close'
 * Changing csvDefault('separator',..) made 'uman' failing.
 * uman ignored any <term> of a <variablelist> having an id.
 * '& ' in a <screen> area yielded an error. 
   Example: 'uman _atomsGettingStarted dc'
 * When a table's row had a single cell, '<td>' was sometimes displayed
 * 'uman bitget lru' did not display the parameters section
 * 'uman author> wb' without section and item yielded an error.
 * 'uman figure_size wb' did not select '... Fig.figure_size=sizes ...' 
 * 'uman [ wb' missed '[a b c ..]' and other entries
 * 'uman ? wb' or 'uman # wb' yielded a Bugzilla error
 * 'uman 12 wb' was accepted while Scilab bugs are numbered starting from 77.
 * 'uman doc/>plot2d wb' did not target the 'Documentation pages' component
 * 'uman doc/><100 wb' yielded an error (no topic)
 * 'uman author> @' used '>' as part of the author name
            
Files (3)
[118.97 kB]
Source code archive

[243.33 kB]
OS-independent binary for Scilab 5.5.x
2.1 binary for Scilab 5.5
[320.83 kB]
OS-independent binary for Scilab 6.0.x
2.1 binary for Scilab 6.0
News (0)
Comments (0)
Leave a comment
You must register and log in before leaving a comment.
Email notifications
Send me email when this toolbox has changes, new files or a new release.
You must register and log in before setting up notifications.