home *** CD-ROM | disk | FTP | other *** search
/ Hot Shareware 32 / hot34.iso / ficheros / DTOOL / INTER57F.ZIP / WH_ED122.ZIP / README.TXT < prev    next >
Text File  |  1997-12-14  |  6KB  |  119 lines
  1. WH_Ed122.ZIP includes
  2.  
  3.         README.TXT      1997-12-14      This file.
  4.         WH_wEdit.EXE    1997-12-14      A Windows help file editor, v. 1.22.
  5.     HISTORY.TXT    1997-12-14    Program history list.
  6.         FILE_ID.DIZ     1997-12-14      Identification file.
  7.  
  8. Windows help files can have their initial window position and size defined
  9. at compile time - secondary windows in help files even must have these
  10. properties defined. The position and size are defined as fractions of the
  11. display screen, and therefore it can give inconveniences to carry help files
  12. between different graphics platforms.
  13.  
  14. The WH_wEdit program can edit Windows help files compiled with the HC31 or
  15. HCP help file compilers. WH_wEdit will let you edit both the windows' size and
  16. position, and the background colors of the header and text sections of the
  17. windows. Help files compiled with the HC30 compiler cannot be edited as the
  18. HC30 compiler does not support a [WINDOWS] section in the Help Project File.
  19.  
  20. WH_wEdit also facilitates macro editing. Windows help file macros perform
  21. initialization when the file is loaded by WinHelp. For example, if browsing
  22. is enabled (i.e. if << and >> pushbuttons are available) the help file will
  23. include the macro
  24.     BrowseButtons()
  25. which instructs WinHelp to show the pushbuttons on the button bar. Macro
  26. editing is a delicate matter, and you should not use the macro editor unless
  27. you know what you are doing. You will get the same warning every time you
  28. enable the editor after you have loaded WH_wEdit. For professional help file
  29. authors only: If you start WH_wEdit with four positive integers as parameters,
  30. the macro editor window is opened unconditionally without any warning, with
  31. position and size defined by the four integers (20 320 550 250 is fine for
  32. 800x600+). Only professional help file authors should use this option.
  33.  
  34. Version 1.12+ of WH_wEdit accepts Windows 95 type help files. It can also open
  35. all observed kinds of .MVB (Mulitmedia Viewer Book) files, however, it cannot
  36. edit the windows properties of MVB type 27 files. It will let you know if you
  37. open such file.
  38.  
  39. The program recognizes four types of help files:
  40.     15    Windows 3.0 files (no windows to edit)
  41.     21    Windows 3.1 files and .MVB files
  42.     27    .MVB files (position/size/colors cannot be edited)
  43.     33    Windows 95 files
  44.  
  45. The size of a help file is defined in the file's header. If the physical file
  46. is longer than this size, WH_wEdit will offer to truncate the file. WH_wEdit
  47. cannot edit the file unless it is truncated. A 72 bytes appendix has been
  48. observed to files compiled with RoboHelp. No problems have been observed
  49. truncating such help files. However, truncation is irreversible, so be sure
  50. to have a copy of your help file before you let WH_wEdit truncate it.
  51.  
  52. WH_wEdit is a Windows application program. It is straightforward to use and
  53. has these few lines of online help:
  54.     Select a Help file from the "File" menu
  55.     Select a window to edit from the "Windows" list
  56.     Check appropriate "Defined" checkboxes to enable editing
  57.     Click on the "Change" pushbutton to facilitate editing
  58.     Select the "Edit" menu to enable macros editing
  59. The "WH_wEdit Sample" position and size editor window and the "Color" editor
  60. window have separate online help. The Macros Editor operates almost identical
  61. to Windows' NotePad editor. It includes copy and paste, so that you can copy
  62. macros from one help file - or other sources - to the clipboard, and paste
  63. them into other help files.
  64.  
  65. A few hints are appropriate, though. File|Save will save the current state of
  66. a file unconditionally. File|Open and File|Exit will notify the user about
  67. changes selectively to the Windows part and in the Macros editor, and a save
  68. can be accepted or refused individually; selecting Cancel in any of these two
  69. windows will return you to the current state of the editor. If any changes
  70. were refused, and opening of a file was then canceled in the Open dialog box,
  71. then the changes will remain in the editor, but they are marked as saved.
  72.  
  73. Text can be entered in the Macros editor even if no file is open; WH_wEdit
  74. will offer to copy the editor's contents to the clipboard if you attempt to
  75. save this text or to open a file.
  76.  
  77. The program can report the following errors:
  78.  
  79. Cannot open <name>                Not found, or readonly
  80. <name> has unknown format            Probably not a help file
  81. <name> was compiled with HC30, can't edit    No windows to edit
  82. Insufficient heap for windows in <name>        More local memory needed
  83. No windows were defined in <name>         *)    Compiled without definitions
  84. Cannot reopen <name> for update            Another application deleted
  85. Length of <name> has changed, can't update      or changed the help file
  86. Nothing to save                    Attempt to save unedited file
  87. Window clipped at screen edge            Parts of sample off screen
  88. <name> has MVB type 27 windows. WH_wEdit cannot
  89.   edit position, size and colors of these
  90.   windows.                     *)    Format not supported
  91. Known/Unknown appendix <n> bytes long. Truncate
  92.   after help file?                Truncate in order to edit
  93. *) These are not error messages if the Macros Editor is enabled, then the
  94.    macros can be edited.
  95.  
  96. There are 16 more possible errors concerning the help file format. I would
  97. appreciate to be informed if an error message appear not listed above, or if
  98. the "Insufficient heap" message appears.
  99.  
  100. WH_wEdit is copyright (C) 1994-1997 Bent Lynggaard. The program is freeware,
  101. thus it can be used without any registering. It may be distributed from
  102. Bulletin Board Services.
  103.  
  104. The program may not be included in any commercial software package or
  105. shareware package without my permission. It may be included in public domain
  106. and freeware software packages provided that:
  107.      1. It is included in the original WH_Ed122.ZIP package together with this
  108.         README file, and with my PKZIP authenticity code intact (KJO555).
  109.      2. It is included in the package for a specific help file editing purpose.
  110. I would appreciate to be notified if WH_wEdit is included in a public domain
  111. package.
  112.  
  113. WH_wEdit is supplied without any warranties.
  114.  
  115. Make backups of your help files before you edit them.
  116.  
  117. 1997-12-14.
  118. Bent Lynggaard <bent.lynggaard@risoe.dk> on Internet.
  119.