FAQ PLAIN Readme ---------------- Program Name ... : FAQ PLAIN Current Version : 1.0 Date ........... : 10/07/1999 Author ......... : Cyrille Artho (cartho@mordor.ch) What is FAQ PLAIN? FAQ PLAIN is a simple FAQ preprocessor. It generates a single FAQ output page which can be used for HTML PLAIN, or as an include page. It offers a few very useful options such as a hierarchical structure of the FAQ with automatic numbering. For more information, read http://artho.com/webtools/faq/ How do I install it? You only need to adjust the first line (it has to be the path to your Perl interpreter) to use the script. For customizing its output HTML code, modify the section "settings". How do I use it? Run ./faq.pl to get the following help text: FAQ generator v1.0 ---------------------------------------- Usage: faq.pl [ < inputfile ] outputfile ---------------------------------------- The script expects the input from stdin. Options needed to be configured: see top of file faq.pl, section "settings". All settings are explained with a Perl comment. Format of input file: short definition see top of file faq.pl. It is important that the numbers do no give the final section number, but the level of the section (like tags in HTML). Example: 1: First topic, will become

1. First topic

Q: How do I configure this script? A: By editing the Perl source (only the top few lines). 1: Second topic ->

2. Second topic

Q: Why? A: Because. 2: This is going to be... ->

2.1 This is going to be...

Q: But why? A: Just because.