home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / vhelp105.zip / readme.txt < prev    next >
Text File  |  1999-06-29  |  4KB  |  104 lines
  1. VyperHelp: OS/2 IPF help outliner, editor and converter
  2.  
  3. Introduction
  4.  
  5. VyperHelp is a visual outliner and editor for creating online help for
  6. OS/2-based systems.  It generates IPF files, which can be compiled into
  7. OS/2-based HLP and INF files.  It also generates WinHelp project source,
  8. including HPJ, CNT, RTF and HH files.  VyperHelp has the following features:
  9.  
  10.    WYSIWYG text editing with codes revealed
  11.    Powerful outline tree controls
  12.    Keyword/index support
  13.    Full symbol support
  14.    IPF import and export
  15.    WinHelp (HPJ,RTF,CNT) import and export
  16.    RTF document-style export
  17.    ASCII text import and export
  18.    Command-line conversion program
  19.  
  20. See Usage Notes for tips, limitations, and a list of known bugs.  Help can be
  21. viewed from the command line (in Warp 4) with:
  22.  
  23.   view vyper.hlp
  24.  
  25. Conversion Program (VYX)
  26.  
  27. VyperHelp includes a conversion program (VYX.EXE), which can be run from the
  28. command line to convert formats in a batch mode.  VYX is faster and supports
  29. more features than the editor.  The syntax for the program is as follows:
  30.  
  31.   VYX infile outfile
  32.  
  33. where infile is the input file, and outfile is the output file.  The file type
  34. is determined by the filename extension.  Supported input file types are: TXT,
  35. IPF, HPJ, and VYD.  Supported output file types are: TXT, IPF, HPJ, RTF, H, VYD,
  36. and VYT.  VYD is a VyperHelp document.  VYT is VyperHelp diagnostic trace
  37. output.  outfile may also include '=' to specify the same root filename as the
  38. input file (for example, "=.ipf").  H is a C language header file.
  39.  
  40. When the output is an IPF or HPJ file, BMP files will automatically be generated
  41. as necessary to support inline art.  They will be named VInnnnn.BMP or
  42. VWnnnnn.BMP, where nnnn is a sequential number.
  43.  
  44. Requirements
  45.  
  46. VyperHelp has the following requirements:
  47.  
  48.    OS/2 Warp version 3 or greater
  49.    Pentium or faster
  50.    4M hard drive space
  51.    32M memory recommended
  52.    IPF compiler (to create HLP or INF files)
  53.  
  54. Terms
  55.  
  56. VyperHelp is provided for free distribution.  Thirty days after its first use,
  57. it will no longer work.  During that trial period, promotional text will be
  58. inserted at the end of each section during export or conversion.
  59.  
  60. A registration key is required for un-limited and un-hindered use.  Registration
  61. keys can be purchased from MekTek for $49 US, which includes minor upgrades and
  62. support.
  63.  
  64. Please read the complete license for details.
  65.  
  66. Installation
  67.  
  68. To install VyperHelp, run the INSTALL.EXE program which was included as part of
  69. the ZIP package.  The installation program will unpack the files into a
  70. directory you specify (default is C:\VYPER), and create a VyperHelp folder.
  71.  
  72. If you opt to update your CONFIG.SYS file, then the directory will be added to
  73. the PATH and LIBPATH, and a TABPATH setting will be added.  TABPATH gives the
  74. location of the parsing tables (*.LLR and *.DFA).  These changes allow VyperHelp
  75. and VYX to be run in directories other then the one they were installed to.
  76.  
  77. The installation program also sets up an association between VyperHelp and the
  78. *.VYD file extension, so you can double-click a VYD file to edit it.
  79.  
  80. Removal (Uninstall)
  81.  
  82. VyperHelp and all of its associated files and folders can be removed from your
  83. system using INSTALL.EXE program which was included as part of the original ZIP
  84. package.
  85.  
  86. To remove VyperHelp, run the program from the command line, using the following
  87. parameters:
  88.  
  89.   install /a:d
  90.  
  91. Contact MekTek
  92.  
  93. Please contact us with any comments, suggestions or bug reports for VyperHelp,
  94. or if you would like to join our mailing list.
  95.  
  96. Contact MekTek by one of the following means:
  97.  
  98.    Web: http://ourworld.compuserve.com/homepages/mek/vyper.htm
  99.    Email: mek@compuserve.com
  100.    Fax: 1-651-649-0237
  101.    Voice: 1-651-649-0245
  102.  
  103. Thank you for trying VyperHelp!
  104.