home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast.iso / dv_x / dvxhlp10.zip / READ.ME < prev   
Text File  |  1992-06-03  |  3KB  |  87 lines
  1. MDVXHELP 1.0 - 6 Jun 1992
  2.  
  3. Included in this archive are
  4.  
  5.         READ.ME         This file
  6.         DVXHELP.DOC     The specification of the DV/X help file format,
  7.                         as far as I have been able to reverse-engineer.
  8.         MDVXHELP.EXE    A program for creating DV/X help files
  9.         MDVXHELP.C      Source code for MDVXHELP.EXE
  10.         MDVXHELP.H      Header file for MDVXHELP.EXE
  11.         MAKEFILE        A Turbo C Make makefile to build MDVXHELP.EXE
  12.         EXAMPLE.ZIP     The DESQview FAQ list, an example of how to use
  13.                         MDVXHELP
  14.  
  15. MDVXHELP was a quick hack and probably could use some improvements.  If you
  16. make any improvements to the source code, document your changes in the header
  17. of the source file and also in this READ.ME.  Let me know if you make
  18. changes, and I'll include them in the official distribution.
  19.  
  20. COPYRIGHT
  21. ---------
  22.  
  23. MDVXHELP and DVXHELP.DOC are copyright 1992 by Daniel J. Bodoh. Permission is
  24. granted to copy this document free of charge in whole or in part, as long as
  25. the copyright notice is included.
  26.  
  27.  
  28. HOW TO USE MDVXHELP
  29. -------------------
  30.  
  31. MDVXHELP concatenates the section and icon files that make up the help file,
  32. and builds the header and directory.  At the minimum, you must read
  33. DVXHELP.DOC to learn about the Front Cover, the Body, and the Tags.
  34.  
  35. The MDVXHELP command line is
  36.  
  37. mdvxhelp <out-file> <front-cover> <section> [<section> [...]]
  38.          [<icon> [<icon> [...]]]
  39.  
  40. or
  41.  
  42. mdvxhelp <out-file> @<list-file>
  43.  
  44.  
  45. Where
  46.  <out-file> is the name of the DV/X help file that will be created
  47.  <front-cover> is the filename containing the front cover in the format
  48.      described in DVXHELP.DOC
  49.  <section> is a file containing one section.
  50.  <icon> is a .XPM file from the Icon Editor
  51.  <list-file> is a list of the input files in the order.  Each filename
  52.      must be terminated by a NL.
  53.  
  54. The END terminator is not required in any of the files; it is added
  55. automatically by MDVXHELP.
  56.  
  57. Each section of the body should be in a separate file.  This file should be
  58. standard text format, but you may include any '/' codes into the file that
  59. you wish.  In order to make the file readable, you may terminate lines in a
  60. paragraph with a NL (see DVXHELP.DOC), but paragraphs must be terminated with
  61. two NLs.  MDVXHELP replaces single NL's with a space, and double NL's with a
  62. single NL.
  63.  
  64. MDVXHELP uses the filename as the section name, EXCEPT FOR THE FIRST SECTION
  65. IN THE BODY.  Regardless of the name of this file, it is given the section
  66. name 'CONTENTS'.
  67.  
  68.  
  69. If the first character of a section file is a '$', then that section has a
  70. tag attached to it and the first two lines of the file (except the '$') are
  71. interpreted as a tag as described in DVXHELP.DOC.
  72.  
  73. The icon files MUST have the .XPM extension.
  74.  
  75. You can use the icon files directly from the Icon Editor without any
  76. modification.
  77.  
  78. The DESQview/QEMM FAQ list is included as an example of what MDVXHELP can do.
  79. To build it, extract EXAMPLE.ZIP and type:
  80.  
  81.           BUILD
  82.           COPY DVFAQ.HLP \DVX\HELP\DVFAQ.HLP
  83.           DISPHELP -f DVFAQ.HLP
  84.  
  85. Good luck!  My address is listed in DVXHELP.DOC if you have questions or
  86. comments.
  87.