1 LISP LIBRARY PACKAGES MANUAL 1 LISP LIBRARY PACKAGES MANUAL HELPSYS 1 ON-LINE-DOCUMENTATION TOOLS 1 HELPSYS 6 HelpSys allows on-line lookup and display of references from the Interlisp-D Reference Manual. HelpSys enables the TTYIN macro ?cr, which works much like the TTYIN macro ?=cr. The ?cr macro prints the manual entry for the function in question, whereas ?=cr just displays the argument list. One can also access this facility through the HELP LISPXMACRO (try HELP to the Interlisp Executive) and by using the Lookup button atop HelpSys's window. Note that starting the DInfo system (another Library package) significantly modifies how a manual reference is displayed (for the better, of course). (IRM.LOOKUP KEYWORD TYPE WINDOW) [Function] This is the primary function of HelpSys. If TYPE is specified, then the primary manual entry for KEYWORD of TYPE, or the first if there is no primary, will be displayed in WINDOW. If TYPE is not specified, then a pop-up menu will be raised containing all the manual entries for KEYWORD. Primary entries are marked with stars (*'s) on either end of the item. WINDOW defaults to IRMWINDOW. (IRM.SMART.LOOKUP KEYWORD WINDOW) [Function] Uses wild card matching if *'s are in KEYWORD (* matches any substring) or tries spelling correction. A pop-up menu is raised if more than one wild card match is found. Note that the first time a * appears in a KEYWORD, HelpSys will need to load the list of possible keywords for matching against, and only after this list has been loaded will spelling correction be enabled. This is the function called by the HELP LISPXMACRO, by the Lookup button atop IRMWINDOW, and by DInfo's Interlisp-D Reference Manual Lookup facility. (HELPSYS FN ÿÿï%ÿ) [Function] This is the function called by TTYIN when you type ?cr with the CAR of the current form being typed as FN. It figures out what type FN is (Function, Macro, or I.S.Operator etc. . .) and calls IRM.LOOKUP appropriately. 2 User Variables 1 IRMWINDOW [Variable] This is the default window used by HelpSys for printing manual references. IRMWINDOWREGION [Variable] HelpSys uses this when creating IRMWINDOW. Note that if IRMWINDOW has been opened you must (SETQ IRMWINDOW NIL) for this variable to take effect. IRM.FONT [Variable] This should be set to a display font descriptor and determines the font that will be used for the printing of manual entries. Initially set to the value of: (FONTCREATE 'HELVETICA 10 NIL NIL 'DISPLAY). 2 Installing Helpsys 1 Helpsys requires the text files of the Interlisp-D Reference Manual to be on a random access filing device, i.e., either {DSK} or a file server. The files it requires are Chap*.IRM and IRM.HAHSFILE on the Lisp Library floppies. To install HELPSYS you must copy all these files to one directory, and set the variable IRM.HOST&DIR to the name of this directory. IRM.HOST&DIR [Variable] This determines where HelpSys will look for the manual text files and hash file. This should be set in your site init file. As file servers can often be quite loaded down, HelpSys will work much faster if you move these files to {DSK}. IRM.HASHFILE.NAME [Variable] If this is NIL, HelpSys will look for the hash file as IRM.HASHFILE on IRM.HOST&DIR, otherwise it uses the value of this variable. To speed up HelpSys one can copy the hash file to {DSK}, set this variable to its new location, and set \IRM.HASHFILE to NIL so that HelpSys will be forced to use the new hash file. (LIST ((PAGE NIL (PAPERSIZE Letter FOLIOINFO (ARABIC ) STARTINGPAGE# 125) (0 0 612 792) ((FOLIO NIL (PARALOOKS (QUAD RIGHT) CHARLOOKS (SUPERSCRIPT 0 INVISIBLE OFF SELECTPOINT OFF PROTECTED OFF SIZE 10 FAMILY MODERN OVERLINE OFF STRIKEOUT OFF UNDERLINE OFF EXPANSION REGULAR SLOPE REGULAR WEIGHT MEDIUM INVERTED OFF USERINFO NIL STYLE NIL) FORMATINFO (ARABIC )) (270 12 288 36) NIL) (HEADING NIL (HEADINGTYPE FOOTINGR) (54 27 558 36) NIL) (HEADING NIL (HEADINGTYPE RECTOHEAD) (54 762 558 36) NIL) (TEXT NIL NIL (54 54 504 684) NIL))) (PAGE NIL (PAPERSIZE Letter FOLIOINFO (ARABIC )) (0 0 612 792) ((FOLIO NIL (PARALOOKS (QUAD LEFT) CHARLOOKS (SUPERSCRIPT 0 INVISIBLE OFF SELECTPOINT OFF PROTECTED OFF SIZE 10 FAMILY MODERN OVERLINE OFF STRIKEOUT OFF UNDERLINE OFF EXPANSION REGULAR SLOPE REGULAR WEIGHT MEDIUM INVERTED OFF USERINFO NIL STYLE NIL) FORMATINFO (ARABIC )) (54 12 288 36) NIL) (HEADING NIL (HEADINGTYPE FOOTINGV) (54 27 558 36) NIL) (HEADING NIL (HEADINGTYPE VERSOHEAD) (54 762 558 36) NIL) (TEXT NIL NIL (54 54 504 684) NIL))) (PAGE NIL (PAPERSIZE Letter FOLIOINFO (ARABIC )) (0 0 612 792) ((FOLIO NIL (PARALOOKS (QUAD RIGHT) CHARLOOKS (SUPERSCRIPT 0 INVISIBLE OFF SELECTPOINT OFF PROTECTED OFF SIZE 10 FAMILY MODERN OVERLINE OFF STRIKEOUT OFF UNDERLINE OFF EXPANSION REGULAR SLOPE REGULAR WEIGHT MEDIUM INVERTED OFF USERINFO NIL STYLE NIL) FORMATINFO (ARABIC )) (270 12 288 36) NIL) (HEADING NIL (HEADINGTYPE FOOTINGR) (54 27 558 36) NIL) (HEADING NIL (HEADINGTYPE RECTOHEAD) (54 762 558 36) NIL) (TEXT NIL NIL (54 54 504 684) NIL))))) *ø2TT(ø)ø2T,ÌÌøT,ÌÌøT.ÌÌøø.ÌÌø øBøø PAGEHEADING VERSOHEADBøø PAGEHEADING RECTOHEADAøø PAGEHEADINGFOOTINGVAøø PAGEHEADINGFOOTINGRMODERN MODERNMODERNMODERN MODERN MODERN MODERN   HRULE.GETFNMODERN    HRULE.GETFNMODERN     HRULE.GETFNMODERN  HRULE.GETFNMODERN  HRULE.GETFNMODERNA$)G_  .1;[L %¨ 51T HRULE.GETFNMODERN  HRULE.GETFNK“ž- HRULE.GETFNMODERN  HRULE.GETFN'(ò; ±‚zº