ameliore ocamlbrowser

git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@3800 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02

1 files changed, 51 insertions, 36 deletions

diff --git a/otherlibs/labltk/browser/README b/otherlibs/labltk/browser/README
index 21fdbd0c2..e48ba6f9c 100644
--- a/otherlibs/labltk/browser/README
+++ b/otherlibs/labltk/browser/README
@@ -9,75 +9,90 @@ INSTALLATION
    The name of the command is `ocamlbrowser'.
 
 USE
-   OCamlBrowser is composed of three tools, the Editor, which allows
-   one to edit/typecheck/analyse .mli and .ml files, the Viewer, to
-   walk around compiled modules, and the Shell, to run an OCaml
-   subshell. You may only have one instance of Editor and Viewer, but
-   you may use several subshells.
+   OCamlBrowser is composed of three tools, the Viewer, to walk around
+   compiled modules, the Editor, which allows one to
+   edit/typecheck/analyse .mli and .ml files, and the Shell, to run an
+   OCaml subshell. You may only have one instance of Editor and
+   Viewer, but you may use several subshells.
 
    As with the compiler, you may specify a different path for the
-   standard library by setting OCAMLDIR. You may also extend the
+   standard library by setting CAMLLIB. You may also extend the
    initial load path (only standard library by default) by using the
-   -I command line option.
+   -I command line option, or set various other options (see -help).
 
-a) Viewer
-   It displays the list of modules in the load path. Click on one to
-   start your trip.
+   If you prefered the old GUI, it is still available with the option
+   -oldui, otherwise you get a new Smalltalkish user interface.
 
-   The entry line at the bottom allows one to search for an identifier
-   in all modules, either by its name (? and * patterns allowed) or by
-   its type (if there is an arrow in the input). When search by type
-   is used, it is done in inclusion mode (cf. Modules - search symbol)
+1) Viewer
 
-   The Close all button is there to dismiss the windows created
-   during your trip (every click creates one...) By double-clicking on
-   it you will quit the browser.
+ Menus
 
    File - Open and File - Editor give access to the editor.
 
    File - Shell opens an OCaml shell.
 
+   View - Show all defs  displays all the interface of the currently
+        selected module
+   View - Search entry  shows/hides the search entry at the top of the
+        window
+
    Modules - Path editor changes the load path.
         Pressing [Add to path] or Insert key adds selected directories
         to the load path.
         Pressing [Remove from path] or Delete key removes selected
         paths from the load path.
    Modules - Reset cache rescans the load path and resets the module
-   cache. Do it if you recompile some interface, or change the load
-   path in a conflictual way.
+        cache. Do it if you recompile some interface, or change the load
+        path in a conflictual way.
 
    Modules - Search symbol allows to search a symbol either by its
-   name, like the bottom line of the viewer, or, more interestingly,
-   by its type. Exact type searches for a type with exactly the same
-   information as the pattern (variables match only variables),
-   included type allows to give only partial information: the actual
-   type may take more arguments and return more results, and variables
-   in the pattern match anything. In both cases, argument and tuple
-   order is irrelevant (*), and unlabeled arguments in the pattern
-   match any label.
+        name, like the bottom line of the viewer, or, more
+        interestingly, by its type. Exact type searches for a type
+        with exactly the same information as the pattern (variables
+        match only variables), included type allows to give only
+        partial information: the actual type may take more arguments
+        and return more results, and variables in the pattern match
+        anything. In both cases, argument and tuple order is
+        irrelevant (*), and unlabeled arguments in the pattern match
+        any label.
 
    (*) To avoid combinatorial explosion of the search space, optional
    arguments in the actual type are ignored if (1) there are to many
    of them, and (2) they do not appear explicitly in the pattern.
 
-b) Module walking
-   Each module is displayed in its own window.
+ Search entry
+
+   The entry line at the top allows one to search for an identifier
+   in all modules, either by its name (? and * patterns allowed) or by
+   its type. When search by type is used, it is done in inclusion mode
+   (cf. Modules - search symbol)
+
+   The Close all button at the bottom is there to dismiss the windows
+   created by the Detach button. By double-clicking on it you will
+   quit the browser.
+
+ Module browsing
+
+   You select a module in the leftmost box by either cliking on it or
+   pressing return when it is selected. Fast access is available in
+   all boxes pressing the first few letter of the desired
+   name. Double-clicking / double-return displays the whole signature
+   for the module.
 
-   At the top, a scrollable list of the defined identifiers. If you
-   click on one, this will either create a new window (if this is a
-   sub-module) or display the signature for this identifier below.
+   Defined identifiers inside the module are displayed in a box to the
+   right of the previous one. If you click on one, this will either
+   display its contents in another box (if this is a sub-module) or
+   display the signature for this identifier below.
 
    Signatures are clickable. Double clicking with the left mouse
-   button on an identifier in a signature brings you to its signature,
-   inside its module box.
+   button on an identifier in a signature brings you to its signature.
    A single click on the right button pops up a menu displaying the
    type declaration for the selected identifier. Its title, when
    selectable, also brings you to its signature.
 
    At the bottom, a series of buttons, depending on the context.
-   * Show all displays the signature of the whole module.
    * Detach copies the currently displayed signature in a new window,
-     to keep it.
+     to keep it. You can discard these windows with Close all.
    * Impl and Intf bring you to the implementation or interface of
      the currently displayed signature, if it is available.