1. What is FAQ Builder?

• 1.1 Intro
• 1.2 Layout
• 1.3 Features

2. How do I use faq_builder?

• 2.1 Write ASCII text
• 2.2 Process ASCII stuff

3. Where can I get faq_builder?

4. Where can I see a FAQ formatted with faq_builder?

1. What is FAQ Builder?

1.1 Intro

FAQ Builder is a simple Perl script faq_builder.pl which transforms ASCII input into nicely formatted FAQ (Frequently Asked Questions) layout.

1.2 Layout

You'll first get a collection of title lines which usually are the questions. These title lines are numbered automagically and are linked to the main section of the FAQ. The main section holds the title lines (questions) and below each title line the content (answer).

1.3 Features

• Simply input, high quality output.
• Faq_builder can create as many indentation levels as needed.
• You can include HTML code into the ASCII text, like lists, line breaks, fonts.
• When regrouping questions, blocks are renumbered automagically.
• Changing indendatation levels is as easy as adding/removing a line of text.
• You can add comments into your text which will not shine up later. Comments are lines beginning with '#'.

2. How do I use faq_builder?

2.1 Write ASCII text

You use a char as indicator that a line is a title line (default '�'). So you can easily build complex setups like
� Title1
�� Sub title1.1
Here comes text for sub title1.1
Here comes text for sub title1.1
Here comes text for sub title1.1
�� Sub title1.2
Here comes text for sub title1.2
� Title2
Here comes text for title2

2.2 Process ASCII stuff

Simply do a

 faq_builder.pl my_ASCII.txt  >my_HTML.html

3. Where can I get faq_builder?

You can download faq_builder.pl from the Blinux file archive (BTW: Blinux deals with support for the Linux user who is blind) as http://www.leb.net/pub/blinux/hacks/faq_builder.pl

4. Where can I see a FAQ formatted with faq_builder?

Check out http://leb.net/blinux/blinux-faq.html
PS: This description was formatted using faq_builder

Enjoy!
Hans <hzo@goldfish.cube.net>