home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1998 September / PCO_0998.ISO / filesbbs / os2 / vhelp100.arj / VHELP100.ZIP / readme.txt < prev    next >
Encoding:
Text File  |  1998-07-16  |  3.5 KB  |  102 lines
  1. VyperHelp: OS/2 IPF help outliner, editor and converter
  2.  
  3. Disclaimer
  4.  
  5. Use this software at your own risk!
  6.  
  7. It is a pre-release, and has not been fully tested.  While we have made every
  8. attempt to ensure that the software is free from
  9. bugs, MekTek is not responsible for any loss of data due to use of this
  10. program.  Read the complete license for details.
  11.  
  12. Please save and backup your work often.
  13.  
  14. Introduction
  15.  
  16. VyperHelp is a visual outliner and editor for creating online help for
  17. OS/2-based systems.  It generates IPF files, which can be compiled into
  18. OS/2-based HLP and INF files.  VyperHelp has the following features:
  19.  
  20.    WYSIWYG text editing with codes revealed
  21.    Powerful outline tree controls
  22.    Keyword/index support
  23.    Full symbol support
  24.    IPF export
  25.    WinHelp (HPJ) import
  26.    ASCII text import and export
  27.    Command-line conversion program
  28.  
  29. See Usage Notes for tips, limitations, and a list of known bugs.  Help can be
  30. viewed from the command line (in Warp 4) with:
  31.  
  32.   view vyper.hlp
  33.  
  34. Conversion Program (VYX)
  35.  
  36. VyperHelp includes a conversion program (vyx.exe), which can be run from the
  37. command line to convert formats in a batch mode.  The syntax for the program is
  38. as follows:
  39.  
  40.   VYX infile outfile
  41.  
  42. where infile is the input file, and outfile is the output file.  The file type
  43. is determined by the filename extension.  Supported input file types are: TXT,
  44. HPJ, and VYD.  Supported output file types are: TXT, IPF, VYD, and VYT.  VYD is
  45. a VyperHelp document.  VYT is VyperHelp diagnostic trace output.  outfile may
  46. also include '=' to specify the same root filename as the input file (for
  47. example, "=.ipf").
  48.  
  49. When the output is an IPF file, BMP files will automatically be generated as
  50. necessary to support inline art.  They will be named IPFnnnn.BMP, where nnnn is
  51. a number starting at 1000.
  52.  
  53. Requirements
  54.  
  55. VyperHelp has the following requirements:
  56.  
  57.    OS/2 Warp version 3 or greater
  58.    Pentium or faster
  59.    4M hard drive space
  60.    32M memory recommended
  61.    IPF compiler (to create HLP or INF files)
  62.  
  63. Terms
  64.  
  65. This pre-release of VyperHelp is provided for free use and distribution until
  66. 10/31/98.  It will not work after that date.  Please read the complete license
  67. for details.
  68.  
  69. Installation
  70.  
  71. There is currently no installation program.  To install, simply unzip the
  72. contents into an empty directory; we recommend c:\vyper (we use that directory
  73. name in the remainder of this section).  Then run VyperHelp (vyper.exe) or the
  74. conversion program (vyx.exe) from this directory.
  75.  
  76. You may want to set up a program object for VyperHelp.  Set the program path to
  77. c:\vyper\vyper.exe, and set the working directory to the c:\vyper.  Set the
  78. program name to
  79. VyperHelp.  You may also want to set up a program association so that VyperHelp
  80. is automatically run when a *.VYD file is double-clicked.
  81.  
  82. If you want to run VyperHelp from a directory other than the directory where it
  83. was installed, you need to make the following changes to your CONFIG.SYS:
  84.  
  85.   1. Add c:\vyper to your LIBPATH.
  86.   2. Add a line with "SET TABPATH=c:\vyper".  This gives the location of the
  87. parsing tables (*.llr and *.dfa).
  88.  
  89. Support
  90.  
  91. Support for this pre-release is handled only by email and
  92. fax.  We would like to hear from you with any questions, comments, suggestions
  93. or bug reports for VyperHelp.
  94.  
  95. Please contact MekTek by one of the following means:
  96.  
  97.    Email: mek@compuserve.com
  98.    Fax: 1-651-649-0237
  99.  
  100. Thank you for trying VyperHelp!
  101.  
  102.