home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / x / volume10 / infow / part01 / README < prev    next >
Encoding:
Text File  |  1993-04-28  |  4.1 KB  |  107 lines
  1. This is the latest, and hopefully last, major release of the Info widget
  2. posted on two other occasions to comp.sources.x. I will continute to
  3. provide fixes and small functionality updates as necessary, of course,
  4. but feel that this is now as featureful as it needs to be, given its
  5. intended use.
  6.  
  7. The following changes have been made since the last release:
  8.  
  9. o    More bugs fixed; memory no longer leaks like water through a sieve.
  10.     Whoops. Code was also cleaned up a bit more.
  11.  
  12. o    Widget now subclassed from composite, not paned, making it more
  13.     portable to other widget sets. Also handles geometry management
  14.     much more effectively.
  15.  
  16. o    Mouse selections in the text now supported. If something looks
  17.     interesting and you click on it, regardless of where it is,
  18.     something will happen. Maybe even what you wanted.
  19.  
  20. o    Any resource that could be user specified without changing the basic
  21.     functionality of the widget has been put into the resource database.
  22.     Resources in general are now used much more effectively. This doesn't
  23.     mean that you actually need to know how to set them (keine angst, RMS),
  24.     since a reasonable set of defaults are available (and will be
  25.     automatically installed).
  26.  
  27. o    The HELPFILE is gone; the help text is now a resource string. This
  28.     means you can now give your users xinfo help in Pashto or Finnish,
  29.     if you want, simply by editing the database.
  30.  
  31. o    Better support for color. I.E. I thought up some reasonable defaults
  32.     that you can enable if you've got a color system.
  33.  
  34. o    Various accelerators for making life easier have been added.
  35.  
  36. o    A popup dialog for getting required arguments. XInfo no longer just
  37.     beeps at you and gives you a whiny message about what you should have
  38.     done, it jumps up and asks you for it.
  39.  
  40. o    The following text was added (finally):
  41.  
  42. When creating the info widget, the following resources are retrieved from
  43. the resource database:
  44.  
  45. -------------------------------------------------------------------------------
  46. Name        Class        Type        Notes    Default
  47. -------------------------------------------------------------------------------
  48. bellVolume    BellVolume    Int        CSG    50%
  49. callback    Callback    XtCallbackList    CSG    NULL
  50. infoFile    InfoFile    String        CSG    XpDefaultInfoFile
  51. infoNode    InfoNode    String        CSG    XpDefaultInfoNode
  52. infoPath    InfoPath    String        CSG    XpDefaultInfoPath
  53. printCommand    PrintCommand    String        CSG    XpDefaultPrintCommand
  54. retainArg    RetainArg    Boolean        CSG    FALSE
  55. -------------------------------------------------------------------------------
  56.  
  57. bellVolume    Determines how loud to ring the bell when something wants
  58.         to complain.
  59.  
  60. callback    If specified, is called when the info widget wants to "quit"
  61.         it is left up to the caller to decide what "quitting" means.
  62.  
  63. infoFile    Which info file to read from. Generally defaults to "dir".
  64.  
  65. infoNode    Which info node to try and find. Generally defaults to "top".
  66.  
  67. infoPath    Colon separated path to follow when looking for info files.
  68.  
  69. printCommand    Which unix command to run when the user asks to print the
  70.         current node. This command will be run on a temporary file
  71.         containing the node's text and header information.
  72.  
  73. retainArg    Determine whether or not to leave text (if any) in the
  74.         argument area around after selecting a node.
  75.  
  76.  
  77. CONTENTS
  78. -------------------------------------------------------
  79.  
  80. This directory contains the sources for an "Emacs Info" browsing widget,
  81. subclassed from the Composite widget.
  82.  
  83. The following files are important:
  84.  
  85. Info.c, Info.h, InfoP.h  - Comprise the Info widget (as is normal)
  86.  
  87. xinfo.c    - A simple application of the info widget (also demonstrates
  88.       usage of the quit callback).
  89.  
  90. XInfo.ad - Application defaults.
  91.  
  92. Compiling should be fairly straigtforward. You may want to edit some
  93. of the defaults in Info.h to match the configuration at your site, though
  94. this really should be changed in the resource database if at all possible.
  95.  
  96. Those wishing for an more elaborate view of the twisty mechanations
  97. of my mind (regarding this code, at least) should read the NOTES file.
  98.  
  99. Questions, suggestions, bug fixes or large anonymous cash donations
  100. (all currencies accepted) should be sent to:
  101.  
  102.                 Jordan Hubbard
  103.  
  104.             ARPA:    jkh@meepmeep.pcs.com
  105.             (OR):    jkh@meepmeep.pcs.de   (europe)
  106.             
  107.