home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / faq2html.zip / faq2html.cfg next >
Text File  |  1995-07-21  |  12KB  |  282 lines
  1. #
  2. #  Default configuration data for faq2html v1.0.  This file is will be used
  3. #  to translate the ASCII version of your FAQ to HTML unless you specify an
  4. #  alternate configuration file on the command line.  You may create a new
  5. #  and different configuration file for each FAQ you maintain if you wish,
  6. #  giving each them a slightly different look.  Any line begining with a '#'
  7. #  character is considered a comment and ignored.
  8. #
  9. #  While this program was designed to work with FAQs in the minimal digest
  10. #  format and RFC 1153 format, it can be made to work fairly well with any
  11. #  ASCII text file at least to the extent of replacing bullets, ruled lines,
  12. #  creating HREFs for URLs, etc.
  13. #
  14. #  The Digest format header is expected to follow roughly this layout:
  15. #
  16. #  Usenet headers
  17. #  <blank line>
  18. #  *.answers headers
  19. #  <blank line>
  20. #  Digest Preamble & Table of Contents
  21. #  Divider composed of exactly 70 hyphens
  22. #          |FAQ section delimited by string "SUBJECT:"
  23. #  Sub 1 - |<blank line>
  24. #          |Divider composed of exactly 30 hyphens
  25. #  Sub 2
  26. #  <...>
  27. #  Sub n
  28. #  Digest Trailer
  29. #  
  30. #
  31. ##############################################################################
  32. #
  33. #
  34. #  Use the FAQ_TITLE to specify the title of the FAQ page.  If this flag is
  35. #  commented out, the generic title "Frequently Asked Questions" will be used.
  36. #  The title string should be on the line immediately following the flag and
  37. #  must be one line only.
  38. #  NOTES: the title of an HTML document normally appears as the window title
  39. #  on windowed operating systems such as OS/2 and X-Windows.  Some text-mode
  40. #  web browsers may not display the document title.  Try to keep the title
  41. #  as short as possible so that it will all fit on the users windows and
  42. #  menus (hotlists/quicklists, etc.).  Some programs will truncate titles
  43. #  longer than 64 characters.
  44. #
  45. FAQ_TITLE
  46. Frequently Asked Questions about blah blah blah...
  47. #
  48. #-----------------------------------------------------------------------------
  49. #
  50. #  USENET HEADER handling options.  One of the three following flags MUST be
  51. #  selected.  Uncomment the one that applies to your FAQ and make sure the 
  52. #  other two are commented out.  The meaning of each flag is as follows:
  53. #
  54. #  USENET_HEADERS_NOT_PRESENT  -  This FAQ has NO usenet news headers
  55. #  INCLUDE_USENET_HEADERS      -  This FAQ has usenet headers and they should
  56. #                                 be include in the HTML version of the FAQ.
  57. #  IGNORE_USENET_HEADERS       -  This FAQ has usenet headers but they should
  58. #                                 not be included in the HTML version.
  59. #
  60. #  NOTE: If usenet new headers are present, they must be followed by a blank
  61. #        line as per RFC guidelines.
  62. #
  63. #USENET_HEADERS_NOT_PRESENT
  64. #INCLUDE_USENET_HEADERS
  65. IGNORE_USENET_HEADERS
  66. #
  67. #-----------------------------------------------------------------------------
  68. #
  69. #  The USENET_HEADER_HTML flag allows you to specify up to one line of HTML
  70. #  code that will precede and follow the usenet news headers.  This flag is
  71. #  ignored unless the INCLUDE_USENET_HEADERS flag is specified.
  72. #
  73. USENET_HEADER_HTML
  74. <PRE>
  75. </PRE>
  76. #
  77. #-----------------------------------------------------------------------------
  78. #
  79. #  *.ANSWERS HEADER handling options.  One of the three following flags MUST
  80. #  be selected.  Uncomment the one that applies to your FAQ and make sure the
  81. #  other two are commented out.  The meaning of each flag is as follows:
  82. #
  83. #  ANSWER_HEADERS_NOT_PRESENT  -  This FAQ has NO *.answer headers
  84. #  INCLUDE_ANSWER_HEADERS      -  This FAQ has *.answer headers and they can
  85. #                                 be include in the HTML version of the FAQ.
  86. #  IGNORE_ANSWER_HEADERS       -  This FAQ has *.answer headers but they
  87. #                                 should not be included in the HTML version.
  88. #
  89. #  NOTE: If *.answers new headers are present, they must be followed by at
  90. #        least one blank line.
  91. #
  92. #ANSWER_HEADERS_NOT_PRESENT
  93. #INCLUDE_ANSWER_HEADERS
  94. IGNORE_ANSWER_HEADERS
  95. #
  96. #-----------------------------------------------------------------------------
  97. #
  98. #  The ANSWER_HEADER_HTML flag allows you to specify up to one line of HTML
  99. #  code that will precede and follow the *.answers headers.  This flag is
  100. #  ignored unless the INCLUDE_ANSWER_HEADERS flag is specified.
  101. #
  102. ANSWER_HEADER_HTML
  103. <PRE>
  104. </PRE>
  105. #
  106. #-----------------------------------------------------------------------------
  107. #
  108. #  This flag indicates what to do with an RFC 1153 Digest format Preamble
  109. #  section.  If your FAQ is in RFC 1153 or the Minimal Digest Format, you
  110. #  can choose whether or not to include it this section in the HTML version
  111. #  of your FAQ.  The meaning of the flags is as follows:
  112. #
  113. #  PREAMBLE_NOT_PRESENT  -  This FAQ is not in RFC 1153 or Minimal Digest
  114. #                           format and does not have a preamble section.
  115. #  INCLUDE_PREAMBLE      -  This FAQ has a preamble section and it should be
  116. #                           include in the HTML version of the FAQ.
  117. #  IGNORE_PREAMBLE       -  This FAQ has a preamble section but it should NOT
  118. #                           be included in the HTML version of the FAQ.
  119. #
  120. #  NOTE: If the preamble section is present, it must be followed by a blank
  121. #        line and a line of exactly 70 hyphens as per RFC 1153
  122. #
  123. #PREAMBLE_NOT_PRESENT
  124. INCLUDE_PREAMBLE
  125. #IGNORE_PREAMBLE
  126. #
  127. #-----------------------------------------------------------------------------
  128. #
  129. #  The PREAMBLE_HTML flag allows you to specify up to one line of HTML
  130. #  code that will precede and follow the preamble section.  This flag is
  131. #  ignored unless the INCLUDE_PREAMBLE flag is specified.
  132. #
  133. PREAMBLE_HTML
  134. <PRE>
  135. </PRE>
  136. #
  137. #-----------------------------------------------------------------------------
  138. #
  139. #  The LINK_TOC flag will cause FAQ2HTML to create internal hypertext links
  140. #  between items in the table of contents and the corresponding SUBJECT:
  141. #  headers within the FAQ.  This function will only work if the FAQ is in
  142. #  RFC 1153 or Minimal Digest format AND if the preamble section (which
  143. #  contains the TOC) has been included by use of INCLUDE_PREAMBLE flag.
  144. #
  145. LINK_TOC
  146. #
  147. #-----------------------------------------------------------------------------
  148. #
  149. #  The PRE_BULLET flag allows you to define a string of text which is used in
  150. #  the preamble section of your FAQ as a bullet.  Bullets may be replaced by
  151. #  up to one line of HTML code.  This flag will be ignored unless you have
  152. #  used the INCLUDE_PREAMBLE flag.  If used, the text on the line following
  153. #  the flag is the string used in the ASCII version of your FAQ as a bullet
  154. #  and the following line is the HTML code you wish to replace it with.
  155. #
  156. PRE_BULLET
  157. *
  158. <IMG SRC="/icons/bullet_small_red_sphere.gif" ALT="*">
  159. #
  160. #-----------------------------------------------------------------------------
  161. #
  162. #  The PRE_RULE flag defines a text string that is used as a horizontal rule
  163. #  or divider within the Preamble of the FAQ.  Up to one line of HTML code
  164. #  may be defined to replace the string.  This flag is ignored if the
  165. #  INCLUDE_PREABLE flag is not used.
  166. #
  167. PRE_RULE
  168. =============================================================================
  169. <HR>
  170. #
  171. #-----------------------------------------------------------------------------
  172. #
  173. #  The USE_DIGEST flag indicates that the body of your FAQ follows the Minimal
  174. #  Digest Format and has sections delimited by a blank line, a line of exactly
  175. #  30 hyphens, and a line starting with the string "SUBJECT:".
  176. #
  177. USE_DIGEST
  178. #
  179. #-----------------------------------------------------------------------------
  180. #
  181. #  The DIGEST_ICON flag allows you to specify up to one line of HTML code
  182. #  that will be included after each section of a Minimal Digest Format FAQ.
  183. #  This may be used to include an icon of your choice.  If you prefer to use
  184. #  standard <HR> tags between sections, just comment this tag out and they
  185. #  will be added automatically if the USE_DIGEST flag is set.
  186. #
  187. DIGEST_ICON
  188. <IMG SRC="/icons/bar_spectrum.gif" ALT="------------------------------">
  189. #
  190. #-----------------------------------------------------------------------------
  191. #
  192. #  The DIGEST_SUBJECT_HTML flag allows you to specify up to one line of
  193. #  HTML code to precede and follow the text of each "SUBJECT:" line. Normally
  194. #  this should be used to make the subject line stand out in some way from the
  195. #  other text.  
  196. #  NOTE: be sure to consider the implications of the BODY_HTML flag (below)
  197. #  when adding HTML code here.  The HTML code in BODY_HTML wraps the entire
  198. #  body section of the FAQ while the DIGEST_SUBJECT_HTML code will wrap each
  199. #  "SUBJECT:" line within the body.
  200. #
  201. DIGEST_SUBJECT_HTML
  202. </PRE><H2>
  203. </H2><PRE>
  204. #
  205. #-----------------------------------------------------------------------------
  206. #
  207. #  The BODY_HTML flag allows you to specify up to one line of HTML
  208. #  code that will precede and follow the main FAQ body.  Since your FAQ was
  209. #  originally written as an ASCII format document and most likely relies on
  210. #  the use of a non-proportional font, this should almost always include a
  211. #  <PRE></PRE> tag combination.
  212. #
  213. BODY_HTML
  214. <PRE>
  215. </PRE>
  216. #
  217. #-----------------------------------------------------------------------------
  218. #
  219. #  The BULLET flag allows you to define a text string which is used for bullets
  220. #  within the body of your FAQ (e.g. "*" or "=>") that will be matched and
  221. #  replaced with the specified line of HTML code.  In order to be identified
  222. #  as a bullet, the text string must be the first non-whitespace character on a
  223. #  line of text.
  224. #
  225. BULLET
  226. *
  227. <IMG SRC="/icons/bullet_small_red_sphere.gif" ALT="*">
  228. #
  229. #-----------------------------------------------------------------------------
  230. #
  231. #  The RULE flag allows you to define a text string which is used as a horizontal
  232. #  rule or divider between the sections of your FAQ (e.g. lines of "========" or
  233. #  "********", etc) that will be matched and replaced with the specified line of
  234. #  HTML code.  The string used to match the rule must have EXACTLY the same
  235. #  number of characters as the actual lines in your FAQ!
  236. #
  237. RULE
  238. =============================================================================
  239. <CENTER><IMG SRC="/icons/bar_spectrum.gif" ALT="------------------------------"></CENTER>
  240. #
  241. #-----------------------------------------------------------------------------
  242. #
  243. #  RFC 1153 TRAILER handling options.  One of the three following flags MUST
  244. #  be selected.  Uncomment the one that applies to your FAQ and make sure the
  245. #  other two are commented out.  The meaning of each flag is as follows:
  246. #
  247. #  TRAILER_NOT_PRESENT  -  This FAQ has NO RFC 1153 Trailer section
  248. #  INCLUDE_TRAILER      -  This FAQ has a Trailer and it should be included in
  249. #                          the HTML version of the FAQ.
  250. #  IGNORE_TRAILER       -  This FAQ has a Trailer but it should not be included
  251. #                          in the HTML version.
  252. #
  253. #  NOTE: If a trailer is present it should follow the RFC 1153 guidelines.
  254. #
  255. #TRAILER_NOT_PRESENT
  256. #INCLUDE_TRAILER
  257. IGNORE_TRAILER
  258. #
  259. #-----------------------------------------------------------------------------
  260. #
  261. #  If the MAILTO flag is set, any email addresses found in document will be
  262. #  converted to HTML MAILTO tags.  Identifying email address embedded in other
  263. #  text is tricky at best - you can make things easier by making sure that the
  264. #  address has spaces on either side of it (i.e. "blah blah info@ncc.com blah"
  265. #  is best, "yaddayadda(info@ncc.com)." might not be found or parsed correctly).
  266. #  Compuserve, Fidonet, and other non-Internet address should be written in
  267. #  Internet-style if you wish them linked (e.g., 12345.1234@compuserve.com).
  268. #
  269. LINK_MAILTO
  270. #
  271. #-----------------------------------------------------------------------------
  272. #
  273. #  If the URL flag is set, any detected URLs will be anchored as HREFs. Right
  274. #  now this works for: http:// and ftp:// tags.  The same disclaimers as used
  275. #  for the LINK_MAILTO flag apply here.  The program will do it's best to find
  276. #  URLs but it will help if they follow RFC guidelines and have whitespace at
  277. #  both ends.
  278. #
  279. LINK_URL
  280. #
  281. #-----------------------------------------------------------------------------
  282.