home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1 / Nebula One.iso / Internet / WWW / Perl_WWW_Utilities / perlMIF_beta2 / README < prev    next >
Encoding:
Text File  |  1994-07-02  |  4.3 KB  |  112 lines
  1. README
  2.  
  3. This is the distribution of Perl program(s) and library(s) dealing with
  4. Frame MIF.
  5.  
  6. ---------------------------------------------------------------------------
  7.     Copyright (C) 1994  Earl Hood, ehood@convex.com
  8.  
  9.     This program is free software; you can redistribute it and/or modify
  10.     it under the terms of the GNU General Public License as published by
  11.     the Free Software Foundation; either version 2 of the License, or
  12.     (at your option) any later version.
  13.  
  14.     This program is distributed in the hope that it will be useful,
  15.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.     GNU General Public License for more details.
  18.  
  19.     You should have received a copy of the GNU General Public License
  20.     along with this program; if not, write to the Free Software
  21.     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22. ---------------------------------------------------------------------------
  23.  
  24. CONTENTS of distribution:
  25.  
  26. CHANGES.edc2html  Revision history of edc2html
  27. CHANGES.mif.pl      Revision history of mif.pl
  28. COPYING          GNU General Public License
  29. HPTagEDC/      Directory containing example output of edc2html
  30. README          The file you are reading
  31. doc/          Documentation
  32. mif/          Location of Perl libraries
  33. edc2html*      Perl program to create HTML files to navigate an FrameBuilder
  34.           Element Catalog
  35. files/          MIF files and other input/output files to programs
  36. install_mif*      Installation (csh) script
  37. xrgb2mif*      Program to convert an rgb.txt style file to a Color Catalog
  38.  
  39.  
  40. ---------------------------------------------------------------------------
  41. INSTALLATION
  42.  
  43. For installation, do the following:
  44.  
  45.     1. Read and edit the csh script, install_mif.
  46.     2. Run install_mif.
  47.  
  48. You might have to run the script as root.
  49.  
  50.     Note:
  51.     The Perl programs might need the first line editted to point
  52.     to the location of the Perl interpreter at your site.  By 
  53.     default, the programs assume /usr/local/bin/perl.
  54.  
  55. See NOTES below for further information.
  56.     
  57. ---------------------------------------------------------------------------
  58. DOCUMENTATION
  59.  
  60. Documentation is located in the directory doc/.  The documentation is in
  61. FrameMaker 4.0 and HTML.  Reading the files in doc/ should get you
  62. started on how to the programs.
  63.  
  64. ** All the mif.pl extension libraries still need to be documented. **
  65.  
  66. Files with just the ".doc" extension are in Frame 4.0.  The ".doc.html"
  67. files are the Frame files converted to HTML.
  68.  
  69. I put considerable time in documenting the tools, so pleeeease read
  70. them :-)
  71.  
  72. If you have a Web client like Mosaic, you can load the HTML files into
  73. the viewer for reading.  The HTML files contain cross-references (that
  74. hopefully help in describing things) to each other.
  75.  
  76. ---------------------------------------------------------------------------
  77. NOTES
  78.  
  79.  o  The Perl programs make use of the file "mif.pl" and other libraries
  80.     in the mif/ directory.  The installation script trys to install the
  81.     files in a standard Perl library location in a sub-directory called
  82.     "mif".  However, if you install it in a location that Perl does not
  83.     look for when requiring files, then make sure you set the PERLLIB
  84.     environment variable.
  85.  
  86.  o  The HPTagEDC/ directory contains the HTML conversion of the HPTag
  87.     Element Catalog.  This is the Frame quivalent to the OpenBook DTD.
  88.     The file "files/HPTagEDC.desc" is the element description file used
  89.     for the HPTag Element Catalog.  See documentation on edc2html for
  90.     more information on element description files.
  91.  
  92.  o  mif.pl is the guts of everything.  I tried to write it so it can be
  93.     used in any Perl program dealing with Frame MIF.  All the other
  94.     mif_*.pl libraries just hook in callbacks into mif.pl to do their
  95.     job.
  96.     
  97.     If you come up with a nifty program that uses mif.pl, please drop
  98.     me a message.  I'd like to see if others are making any use of it.
  99.  
  100. ---------------------------------------------------------------------------
  101. BUGS/COMMENTS/SUGGESTIONS?
  102.  
  103.     If you have any bugs/comments/suggestions, feel free to drop me
  104.     an e-mail message at ehood@convex.com.
  105.  
  106.     If you have questions on what the tools can, or cannot do, please
  107.     read the documnetation first.  If the docs do not answer your
  108.     question(s), feel free to e-mail me.
  109.  
  110. ---------------------------------------------------------------------------
  111. Earl Hood, ehood@convex.com
  112.