home *** CD-ROM | disk | FTP | other *** search
/ The Mac 13 / the-mac-13.iso / Shareware City / Utilities / setext2html / mac / readme.mac
Encoding:
Text File  |  1995-06-05  |  3.1 KB  |  83 lines  |  [TEXT/ttxt]
  1. Running the script
  2. First you must have MacPerl. You can find it at your favourite info-mac mirror in
  3. /info-mac/dev/mac-perl-418.hqx
  4.  
  5. It is recommendable to save this script as System 6 or System 7 runtime from MacPerl. There's a bug in
  6. my MacPerl version (4.1.8 PPC). When you run the script from MacPerl, it won't come up with a
  7. choosefile-dialog to open your setext document, unless you did not save it after a modication.
  8.  
  9. When you save it as System 6 or System 7 runtime, you can drop text files on it. You will then be asked to choose a name for the new output file. When the script is started without input files, you will be asked to pick one.
  10.  
  11. If you parse large files, the script can use a large amount of memory. Make sure to adjust memory
  12. requirements.
  13.  
  14. Do I need to configure it?
  15. By default the script
  16. - creates one output file for each input file it was given.
  17. - runs in verbose mode.
  18. - parses urls and mail addresses.
  19.  
  20. If you are happy with that you don't have to read further.
  21.  
  22. How do I configure it? 
  23. The script is already setup to be runned on a Mac, however there are some default settings you can change. 
  24. I'd rather do this by using an AppleScript but I couldn't find the time to do that yet. If someone else does, I'd realy like to know about it.
  25.  
  26. You can find the settings after this line in the script:
  27.     
  28.             #_______ OPTIONS _______
  29.  
  30. Translating email addresses
  31. The script can translate email addresses to the HTML 'mailto:'  tag. 
  32. This option is enabled by default. If you don't  want this, then change the line
  33.  
  34.                 $DO_MAIL = 1; 
  35. to
  36.                 $DO_MAIL = 0;
  37.  
  38. Translating url's
  39. The script can translate urls to HTML url references.
  40. This option is enabled by default. If you don't  want this, then change the line
  41.  
  42.                 $DO_URL = 1;
  43. to 
  44.                 $DO_URL = 0;
  45.  
  46. Verbose mode
  47. By default the script runs in verbose mode. If you are not generating multiple output files, there's nothing much to see, so you might want to disable it.
  48. If you are generating multiple output files,  the script shows you which chapter is being parsed.
  49. You can disable verbose mode by changing the folowing line in the script
  50.  
  51.                 $VERBOSE = 1;
  52. to
  53.  
  54.                 $VERBOSE = 0;
  55.  
  56. Generating multiple output files 
  57. If you want to generate multiple output files based on title-tt's, then change
  58. the line 
  59.  
  60.                 $SPLIT_ON_CHAPTERS=0; 
  61. to
  62.                 $SPLIT_ON_CHAPTERS=1;
  63.  
  64. title-tt's can be recognized as:
  65.  
  66. This is a title-tt
  67. ==================
  68.  
  69. Remember, if you want to be able to do this, the first 2 lines in the document must be title-tt.
  70.  
  71. Specifing the prefixes for output files
  72. When generating multiple output files, an overview file will be created in the same directory as the rest of the output files. This file holds references to these output files. The default prefix is "index", so the overview file becomes "index.html"
  73.  
  74. You can change "index" in the folowing line in the script to something more suitable for your system.
  75.  
  76.                 $INDEX_FILE_PREFIX="index";
  77.  
  78. The other output files have "ch-" as prefix by default, so output files will be named "ch-1.html", "ch-2.html" etc.
  79. You can change "ch-" in the folowing line in the script to something more suitable for your needs.
  80.  
  81.                 $CHAPTER_PREFIX="ch-";
  82.  
  83.