#
# $Id: faq_builder.pl,v 1.4 2000/02/10 02:30:19 hzo Exp hzo $
# 

# Syntax faq_builder your_FAQ_ASCII_file.txt > your_FAQ.html 

# Build a HTML formatted FAQ with index and content out of simple
# ASCII text. Created an index and the main FAQ section which is
# linked to the index section.

 
# Written to make things easier for those who are writing FAQs
# I didn't check whether similar tools exist (I'm pretty sure) 
# Writing some Perl stuff is too much fun to not use the oppotunity :)


# Formatting of ASCII:
# Levels of indentation are determined by the number of $LEVEL_CHARs 
# in front of the headers.
# You'll get a menu section and an output section which are numbered.
# The menu section has a link to the output section.
# If you choose '§' as $LEVEL_CHAR then

# 	§ This is a main title
# 	§§ This is subtitle A
# 	§§§ This is question no 1
# 	This is the answer to question 1
# 	§§§ This is question 2
# 	This is answer to question no 2
# 	This is still answer to question 2
#	§§ This is subtitle B

# will give you

# 	1. This is a main title
#	   1.1 This is subtitle A
#	      1.1.1 This is question no 1
#	      1.1.2 This is question no 2
#	   1.2 This is subtitle B
#
#
#       1. This is a main title
#       1.1 This is subtitle A
#       1.1.1 This is question no 1
#       This is the answer to question 1 
#
#       1.1.2 This is question no 2
#       This is answer to question no 2
#       This is still answer to question 2
#
#	1.2 This is subtitle B

# You can put comments into your input file which will be ignored by the
# formatter. A comment line begins with '#'. You'll eventually have to
# change '%' signs into '%%' to make them shine up, if I recall right.
# Simply check it out.

# Please send comments and suggestions. 
# My email:  Hans Zoebelein <hzo@gmx.de> or <hzo@goldfish.cube.net>
# 
# Enjoy!
# Hans