home *** CD-ROM | disk | FTP | other *** search
/ Software Recommendations - 1998 Season 1 / DNBCD4.iso / internet / htmledit / auhtml72 / AUTOHTML.DOC next >
Encoding:
Text File  |  1997-05-12  |  8.6 KB  |  229 lines
  1.                                AUTOHTML
  2.  
  3.                               Version 7.2
  4.  
  5.  
  6.  
  7. Overview:
  8.  
  9. AUTOHTML creates a multi-page web site from text source files in the 
  10. current directory. The first page is always called TOC.HTML and is a 
  11. table of contents linking to the other pages. 
  12.  
  13. A page is created for each source file. If the defaults are selected, 
  14. a separate table of contents file will be created for each page, with 
  15. the name tocxxxxx.htm where xxxxx is the last five characters of the 
  16. source file name.
  17.  
  18. The title for the first page is received from the command line as a 
  19. parameter supplied to AUTOHTML.EXE. Enclose this text within speech 
  20. marks, or only the first word will be picked up! Each entry in the 
  21. first page (TOC.HTML) is derived from a single text line in a file 
  22. with the same name as the source file, but with the extension .TIT 
  23. (short for title). If a TIT file can not be located in the current 
  24. directory, the source file name is used. This title is also used to 
  25. head the source web page and any table of contents page for that 
  26. source file. 
  27.  
  28. Links are automaticaly created whenever a word refers to another item 
  29. heading in any of the source pages. Multiple links to the same topic 
  30. within a section can be supressed with the "duplicate links=no" 
  31. setting in autohtml.ini.
  32.  
  33. An alphabetical global index (gi.htm) is created providing links to 
  34. all topics in all files processed. 
  35.  
  36. Source Files:
  37.  
  38. Source files follow the KNB format; Simply these are comprised of an 
  39. item heading line prefixed by an asterisk, thus: 
  40.  
  41. *This is an item heading
  42.  
  43. followed by any number of lines of text which comprise that item's 
  44. data.
  45.  
  46. To force a link to a multiple word heading, replace spaces with under 
  47. bars (_) within the item data, for example:
  48.  
  49. This example will link with Greater_London.
  50.  
  51. A collection of KNB text files relating to mythology are supplied as 
  52. an example.
  53.  
  54. Autohtml can also create formatted tables of columnar data 
  55. automaticaly from lines of text with columns separated by tab 
  56. characters. For example, to create a table: 
  57.  
  58. Name    Age     Height  Weight
  59. John    12      1.0     9
  60. Alan    13      1.4     12
  61.  
  62. Put the data in your text file and separate each column with a single 
  63. tab character, terminating each line with a carriage return as usual.
  64.  
  65.  
  66. Command Line:
  67.  
  68.         AUTOHTML "Title For First Page"
  69.  
  70.  
  71. Automatic Links:
  72.  
  73. Automatic links will only ever be made to the current page or to the 
  74. first source file, in alphabetical order, containing a reference to 
  75. the item. You can force other files to be linked first by so naming 
  76. them as to be alphabetically earlier. Eg; a file 'AAA.TXT' will be 
  77. scanned before a file called 'BAA.TXT'. For example. If the title 
  78. PARIS occurs in the current page and in another page, a link will be 
  79. made to the current page reference for PARIS. If however, the title 
  80. PARIS occurs in three pages, but not in the current page, then a link 
  81. will be made to the reference PARIS in the page named first.
  82.  
  83. Table Of Contents:
  84.  
  85. The format of each table of contents is either a list, or a table. 
  86. Defined by toc table=yes or toc table=no in autohtml.ini. If a tabular 
  87. format table of contents is required, the number of columns, border 
  88. and cell spacing information is read from the autohtml.ini file. 
  89. Otherwise these parameters are ignored.
  90.  
  91.  
  92. Limitations:
  93.  
  94. AUTOHTML will not create graphical systems. It is designed to carry 
  95. out the donkey work of linking multiple machine-readable text files 
  96. into a fully linked web site. If you want in-line graphics, forms, 
  97. links to other URLs and so on then you will have to add these your 
  98. self.
  99.  
  100.  
  101. AUTOHTML.INI:
  102.  
  103. AUTOHTML acceses a configuration file (autohtml.ini) in the directory 
  104. where autohtml.exe resides. This configuration file may be amended to 
  105. change the format of the created web site.
  106.  
  107. NB: 
  108. Under Windows 95, autohtml may have trouble locating the required 
  109. autohtml.ini file unless it is present in the current directory.
  110.  
  111. [preferences]
  112. case sensitive=no               (Should links match on case)
  113. separate table of contents=yes  (Table of contents separate to main 
  114.                                  data)
  115. main title font=1               (Font 1-6 for main title)
  116. sub title font=2                (Font 1-6 for subsequent title lines)
  117. toc font=3                      (Font to display table of contents 
  118.                                  entries)
  119. source=knb                      (Source file extension)
  120. toc table=yes                   (Use table format for each table of 
  121.                                  contents) 
  122. columns=3                       (Number of table columns) 
  123. width=100                       (Table width as a % of screen width) 
  124. cellspacing=2                   (Table cell spacing) 
  125. border=10                       (Table border) 
  126. align=left                      (Table cell alignment, left, center or 
  127.                                  right)
  128.  
  129. [item]
  130. title font=2                    (Font 1-6 for item titles)
  131. data font=4                     (Font 1-6 to display item data)
  132. title italic=yes                (Item titles Italic yes or no)
  133. title bold=yes                  (Item titles Bold yes or no)
  134. duplicate links=no              (Whether subsequent links to the same
  135.                                  topic should be made within a 
  136.                                  paragraph)
  137. no recurse=no                   (If no recurse=yes, links to items 
  138.                                  which point straight back to the
  139.                                  calling item are supressed. This
  140.                                  slows processing down a lot, and
  141.                                  is not normally required)
  142.  
  143. advanced=yes                    (Use advanced options) 
  144. background="space.gif"          (Backgound image)
  145. bg colour="#000000"             (Background colour)
  146. text colour="#FFFFFF"           (Text colour)
  147. link colour="#FFFF00"           (Link colour)
  148. alink colour="#000000"          (ALink colour)
  149. vlink colour="#FFFF00"          (Visited link colour)
  150.  
  151. msie=no                          (Use Microsoft Internet Explorer
  152.                                   Extensions. These options
  153.                                  override the title font and data 
  154.                                  font settings above if msie=yes)
  155. title size=5                    (Item title size)
  156. title colour="FF0000"           (Item title colour)
  157. title face=Times New Roman      (Item title font)
  158. data size=3                     (Item data size)
  159. data colour="F0F0F0"            (Item data colour)
  160. data face=Times New Roman       (Item data font)
  161.  
  162. [ignore]
  163. ; Any words in this section will not be linked
  164. ; This section may include a maximum of 500 words
  165. A
  166. IN
  167. OF
  168. THE
  169.  
  170. Compatability:
  171.  
  172. AUTOHTML has been tested with NCSA Mosaic, Microsoft Internet Explorer 
  173. and Netscape. 
  174.  
  175.  
  176. Frequently Asked Questions:
  177.  
  178. Q. I only have one source file, autohtml creates four HTML files. How do 
  179.    I get around this?
  180.  
  181. A. Autohtml always creates a primary table of contents HTML file 
  182.    called TOC.HTM and a global index file called GI.HTM. This provides 
  183.    a link to all the source files. If you only have one source file, 
  184.    then you can delete the TOC.HTM file. If you have separate table of 
  185.    contents=yes set in the autohtml.ini configuration file, then two HTML 
  186.    files will be created for each source file. The name of one file will 
  187.    commence TOC and this is the table of contents for the other data file. 
  188.    Rename this table of contents file to TOC.HTM and your web site is 
  189.    done.
  190.  
  191. Q. Autohtml doesn't create any HTML files. What's wrong?
  192.  
  193. A. Autohtml searches the current directory for files with an extension 
  194.    matching the source= setting in the configuration file 
  195.    autohtml.ini. Probably you have an incorrect extension set in the 
  196.    configuration file. Remember, the extension in the source= line 
  197.    does not include a period, eg:
  198.  
  199.                 source=knb
  200.  
  201.  
  202.  
  203. Q. When I try to view the HTML files in Mosaic, Mosaic crashes. Help!
  204.  
  205. A. Mosaic is a rather fragile HTML viewer. Try splitting the source 
  206.    files down into more smaller files. 
  207.  
  208. Q. When I try to run autohtml under Windows, it crashes. What's wrong?
  209.  
  210. A. Windows (and especially Windows 95) has a very poor memory manager. 
  211.    The shareware version of autohtml is best run in DOS mode. The 
  212.    registered version will generally run under Windows with out any 
  213.    problems.
  214.  
  215.  
  216.  
  217.  
  218. (c)1996 Servile Software
  219.  
  220. Servile Software
  221. 5 Longcroft Close
  222. Basingstoke
  223. Hampshire
  224. RG21 8XG
  225.  
  226. WWW     http://www.pins.co.uk/upages/probertm
  227. EMAIL   probertm@pins.co.uk
  228.  
  229.