home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 1995 June / pcw-0695.iso / share / utils / edithelp / read.me < prev    next >
Encoding:
Text File  |  1995-03-10  |  3.9 KB  |  107 lines
  1. The EditHelp program creates Help Files for use with the Windows
  2. help system. 
  3.  
  4. It is a stand-alone program which does NOT require Microsoft Word
  5. for Windows.
  6.  
  7. Help Files are full hypertext files with links, popup-links, bitmaps,
  8. different fonts and keywords. You can use Help files not just for providing
  9. "help" but wherever hypertext is appropriate, such as, public information
  10. systems and computer-based training.
  11.  
  12. Windows Help files can execute DLLs and EXEs and can have embedded panes
  13. containing animation or user-editable data.
  14.  
  15. EditHelp can produce HTML files for use on the World Wide Web. You can use 
  16. the same source to provide hypertext information in both HLP and HTML 
  17. formats.
  18.  
  19. As you develop your Help File, EditHelp helps you keep track of the
  20. status of each topic.
  21.  
  22. To get started, open the EditHelp.EDH file - it is the source file for
  23. the EditHelp.HLP file. Press F1 for help to display EditHelp.HLP and
  24. compare the source with what WinHelp displays. Select the 'Examples'
  25. hotspot in the first topic of EditHelp.HLP to see samples of what
  26. EditHelp can do.
  27.  
  28. To create a skeleton help file for an existing program, use the 
  29. File|OpenExe command. To convert an existing Help file you have written 
  30. into Edithelp format, use the File|OpenHlp command. 
  31.  
  32. EditHelp consists of the following files
  33.  
  34.        edithelp.exe     - the help editor
  35.        edithelp.hlp     - help for the program
  36.        editwww.hlp      - help for the program in WWW mode
  37.        sample.dll       - sample DLL used by edithelp.hlp
  38.  
  39. The following sample sources are provided:
  40.  
  41.        edithelp.edh     - source for the edithelp.hlp 
  42.        editwww.edh      - source for the editwww.hlp 
  43.        sample.pas       - source of sample.dll
  44.  
  45.        sample.ico       - sample icon used by edithelp.edh
  46.        sample.shg       - sample SHG used by edithelp.edh
  47.        *.bmp            - 28 sample bitmap files
  48.  
  49. It is recommended that you use EditHelp with a Help Compiler such as 
  50. Microsoft's HC31. You may already have HC31.EXE (or HC30) on your 
  51. computer. EditHelp has a built-in Help Compiler but the compiler is 
  52. still under development. Microsoft do not publish the specification 
  53. of HLP files so the built-in compiler is "experimental".
  54.  
  55. To create bitmaps with multiple hotspots, you will need a Segmented 
  56. Graphics File editor such as Microsoft's SHED. You may already have 
  57. SHED on your computer. A freeware Segmented Graphics File editor 
  58. is under development and may be ready when you read this.
  59.  
  60. EditHelp is shareware. The registered version has the following features not
  61. available in the unregistered version:
  62.  
  63.   bitmap links
  64.   bitmaps with multiple hotspot links
  65.   links can execute DLLs and EXEs
  66.   layout commands:
  67.     indented lists
  68.     lines
  69.     boxed text
  70.     centred text
  71.   text commands:
  72.     different fonts
  73.     different character sizes
  74.     coloured text
  75.     bold and italic text
  76.   browse lists
  77.  
  78. You can still obtain these features in the unregistered version via
  79. the {literal} command - but it's far less convenient.
  80.  
  81. New Edithelp features are being developed even as you read this. Future
  82. versions should include
  83.  
  84.   - a WYSIWYG editor
  85.   - multimedia DLLs: play sounds and animation in an embedded window
  86.   - data entry DLLs: issue questionaires or write your SETUP program
  87.     as a HLP file
  88.   - an animation authoring tool
  89.   - a segmented graphics editor
  90.  
  91. The more people who register, the more features that will be added.
  92.  
  93. Registered users will receive animation and sound DLLs and demonstration
  94. multimedia Help files.
  95.  
  96. EditHelp is shareware. You can give it away so long as it has not been
  97. modified. You may not sell it but you may charge reasonable copying
  98. and distribution fees. 
  99.  
  100. Send a formatted floppy and a stamped addressed envelope to the author
  101. for the latest version and other shareware and freeware.
  102.  
  103.  
  104. Copyright Peter Balch, 1994-1995.
  105.  
  106.  
  107.