1Summary of commands 2=================== 3 4Browse available libraries in tree display window: double left-click to 5expand an item, single left-click to select. Selecting an expanded item 6will display information (if available) on the item on the text window. 7 8Type in a string in the entry window to find matching built-ins; 9single click on any word in the text window to put it in the entry window 10double click on any word to look for match directly. 11 12Summary of function 13=================== 14 15This tool allows the user to obtain information on the libraries of 16ECLiPSe, and also provides a search facility for information on built-in 17predicates of ECLiPSe. 18 19Layout 20====== 21 22tree display window - shows a hierarchical tree display of available 23libraries and information in their interface. 24 25selected library button - this button at the top of the tree 26display shows the currently selected library (if any) from the tree 27display. This library can be loaded by pressing the button. 28 29entry window - on typing return, the string in the entry window is looked 30up to find matches in ECLiPSe's built-ins. 31 32text window - the information found on matching the entry are displayed in 33this window. This is either a list of built-ins and a brief description of 34their function if more than one built-in matched, or a longer description 35of a built-in if a unique built-in matched the string in the entry. 36 37Close button - close this window. 38 39 40Functionality 41============= 42 43This tool provides a combined interface to two methods of providing on-line 44information for ECLiPSe: 45 461) ECLiPSe's help/1 command for built-in predicates, 47 482) Information files containing the module interface and comments 49directives from libraries. 50 51The text display window displays the longer descriptions on a topic from both 52methods. The tree display allows the browsing of available libraries. The 53information here is taken from information files that are generated by the 54icompile/1,2 predicates. Summary descriptions, if available, are shown in 55the tree display, and more detailed description can be obtained by 56selecting an item on the tree display. The items are hierarchical in that 57the library modules are shown under their directories, and the interface 58items (e.g. exported/imported predicates, operators, etc.) from a 59particular library are shown under that library. By default, the display 60shows only up to the available libraries. Open a library item to obtain its 61interface information. 62 63If an item can be opened, then its longer description will only be shown 64when it is opened. Double clicking on a closed item will open the item if 65it can be opened. The colour of the library items also show its status: blue 66if it is currently loaded in this ECLiPSe session, or green if 67unloaded. Selecting a library or any of the item under it will select the 68library, and this is shown in the selected library button. If a directory or 69the top level is selected, then there is no selected library. A selected 70library can be loaded into the current top-level module by clicking the 71button. This will also update the colour of the library items accordingly. 72 73The user can allow their own information files to be browsed by the tree 74display by adding the directory of where the information files are to the 75library_path environment flag (which can be set with the global setting 76tools or set_flag/2). Note that the tool reads in library_path when it is 77started and will not dynamically update this information while the tool is 78opened. To allow changes in library_path to be seen by the tool, close it 79and reopen it from the menu. In addition, the colour of the librarys will 80not be immediately updated if a library is not loaded via the load selected 81library button: it will only be updated when the library item is refreshed. 82 83 84The tool also provides an interface to ECLiPSe's help/1 command. In addition 85to entering the string to look up directly by typing it in the entry 86window, the user can select words from the display window by clicking on 87them. A single click will put the word in the entry, and double click will 88cause a direct lookup, thus providing a form of hypertext lookup facility. 89 90