projects / packages / clips.git / blame
| Commit | Line | Data |
|---|---|---|
| 671c1327 MM |
1 | |
| 2 | 0MBEGIN-ENTRY-MAIN | |
| 3 | ||
| 4 | HELP_USAGE FUNCTION_SUMMARY | |
| 5 | RELEASE_NOTES COMMAND_SUMMARY | |
| 6 | CONSTRUCT_SUMMARY INTEGRATED_EDITOR | |
| 7 | ||
| 8 | END-ENTRY | |
| 9 | ||
| 10 | 1IBEGIN-ENTRY-HELP_USAGE | |
| 11 | ||
| 12 | HELP_USAGE | |
| 13 | ||
| 14 | H.2 Using the Help Facility | |
| 15 | The help facility displays menus of topics and prompts the user for a choice. | |
| 16 | It then references the help file for that information. The help facility can | |
| 17 | be called with or without a command-line topic. | |
| 18 | ||
| 19 | Syntax: | |
| 20 | (help [<path>]) | |
| 21 | ||
| 22 | where <path> is the full path leading to a topic in the help tree. For | |
| 23 | example, for information on defrule syntax, the user would type: | |
| 24 | (help construct_summary defrule). | |
| 25 | The help function has no return value. | |
| 26 | ||
| 27 | Each element or field in the path is delimited by white space, and the help | |
| 28 | facility is not case sensitive. In addition, the entire name of a field does | |
| 29 | not need to be specified. Only enough characters to distinguish the field | |
| 30 | from other choices in the menu are necessary (if there is a conflict, the help | |
| 31 | facility will pick the first one in the list). For instance, (help con def) | |
| 32 | would be sufficient for the above example. | |
| 33 | ||
| 34 | A few special fields can be used while in the help facility. | |
| 35 | ||
| 36 | ^ Branch up one level. | |
| 37 | ? When specified at the end of a path, this forces a display of the | |
| 38 | current menu, even on branch-ups. | |
| 39 | <nil> Giving no topic field will branch up one level. | |
| 40 | ||
| 41 | A branch-up from the MAIN topic root node implies an exit from help. | |
| 42 | ||
| 43 | By default, the help facility comes up in the MAIN topic root menu and the | |
| 44 | user may make a choice as described above. The prompt line always displays | |
| 45 | the name of the current menu. The help facility will branch through the help- | |
| 46 | tree until instructed to exit by a branch-up from the top level. The level | |
| 47 | always is reset to the MAIN topic upon exit from the help facility. | |
| 48 | ||
| 49 | The first call to the help facility will take longer than successive calls | |
| 50 | while the system loads help information into an internal lookup table. All | |
| 51 | other calls to the help facility are very fast. | |
| 52 | ||
| 53 | The help facility reads help information from a file during execution. Users | |
| 54 | may wish to change the location of the help file to meet the configuration of | |
| 55 | their system. The help-path function was provided to allow this. | |
| 56 | ||
| 57 | Syntax: | |
| 58 | (help-path [<help-file-name>]) | |
| 59 | ||
| 60 | If no argument is specified, the function displays the name of the current | |
| 61 | help file. If an argument is specified, the help facility will use the new | |
| 62 | file name for future help references during this CLIPS session. To change the | |
| 63 | location of the help file permanently, a change must be made in the setup.h | |
| 64 | file, then CLIPS must be recompiled. The help-path function has no return | |
| 65 | value. | |
| 66 | ||
| 67 | END-ENTRY | |
| 68 | ||
| 69 | 1MBEGIN-ENTRY-RELEASE_NOTES | |
| 70 | ||
| 71 | RELEASE_NOTES | |
| 72 | ||
| 73 | The release notes help section contains information about new features | |
| 74 | and where to get technical support. | |
| 75 | ||
| 76 | Subtopics: | |
| 77 | NEW_FEATURES SUPPORT_INFORMATION | |
| 78 | ||
| 79 | END-ENTRY | |
| 80 | ||
| 81 | 2IBEGIN-ENTRY-NEW_FEATURES | |
| 82 | ||
| 83 | RELEASE_NOTES | |
| 84 | NEW_FEATURES | |
| 85 | ||
| 86 | Version 6.2 of CLIPS contains two major enhancements. First, CLIPS now | |
| 87 | provides a mechanism which allows an embedded application to create | |
| 88 | multiple environments into which programs can be loaded. Second, an | |
| 89 | improved Windows 95/98/NT CLIPS interface is now available and the | |
| 90 | Macintosh CLIPS interface has been enhanced to support MacOS X. For a | |
| 91 | detailed listing of differences between the 6.x releases of CLIPS, | |
| 92 | refer to appendix B of the Basic Programming Guide and appendix C of | |
| 93 | the Advanced Programming Guide. | |
| 94 | ||
| 95 | END-ENTRY | |
| 96 | ||
| 97 | 2IBEGIN-ENTRY-SUPPORT_INFORMATION | |
| 98 | ||
| 99 | RELEASE_NOTES | |
| 100 | SUPPORT_INFORMATION | |
| 101 | ||
| 102 | CLIPS executables, documentation, and source code are available for | |
| 103 | download from http://www.ghg.net/clips/download/. | |
| 104 | ||
| 105 | Questions regarding CLIPS can be sent via electronic mail to | |
| 106 | clips@ghg.net. | |
| 107 | ||
| 108 | An electronic conferencing facility, sponsored by Distributed Computing | |
| 109 | Systems (http://www.discomsys.com), is also available to CLIPS users. | |
| 110 | Subscribers to this facility may send questions, observations, answers, | |
| 111 | editorials, etc., in the form of electronic mail to the conference. All | |
| 112 | subscribers will have a copy of these messages reflected back to them at | |
| 113 | their respective electronic mail addresses. To subscribe, send a single | |
| 114 | line message to clips-request@discomsys.com containing the word | |
| 115 | "subscribe". The subject field is ignored but the address found in the | |
| 116 |