From 4e056bc4d41ba7a1bb75a860eaa3be1c26ccd0ff Mon Sep 17 00:00:00 2001
From: Jacques Garrigue <garrigue at math.nagoya-u.ac.jp>
Date: Thu, 27 Sep 2001 07:31:55 +0000
Subject: ameliore ocamlbrowser
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@3800 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
---
otherlibs/labltk/browser/help.ml | 102 ++++++++++++++++++++++-----------------
1 file changed, 58 insertions(+), 44 deletions(-)
(limited to 'otherlibs/labltk/browser/help.ml')
diff --git a/otherlibs/labltk/browser/help.ml b/otherlibs/labltk/browser/help.ml
index 696e1d85b..d21fd1261 100644
--- a/otherlibs/labltk/browser/help.ml
+++ b/otherlibs/labltk/browser/help.ml
@@ -1,81 +1,92 @@
let text = " OCamlBrowser Help
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).
-1) 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.
-
- (*) 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.
-
-2) Module walking
- Each module is displayed in its own window.
-
- 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.
+ 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.
+
+ 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.
+
+ 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.
C-s opens a text search dialog for the displayed signature.
-3) File editor
+2) Editor
You can edit files with it, but there is no auto-save nor undo at
the moment. Otherwise you can use it as a browser, making
occasional corrections.
@@ -104,7 +115,7 @@ USE
Signature shows the signature of the current file.
-4) Shell
+3) Shell
When you create a shell, a dialog is presented to you, letting you
choose which command you want to run, and the title of the shell
(to choose it in the Editor).
@@ -120,6 +131,9 @@ USE
BUGS
+* This not really a bug, but OCamlBrowser is a huge memory consumer.
+ Go and buy some.
+
* When you quit the editor and some file was modified, a dialogue is
displayed asking wether you want to really quit or not. But 1) if
you quit directly from the viewer, there is no dialogue at all, and
--
cgit v1.2.3-70-g09d2