1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
<!-- $Id: faq_builder.pl,v 1.6 2000/02/10 05:53:47 hzo Exp hzo 0->
<!-- FAQ, created with faq_builder -->
<!-- faq_builder is available at http://leb.net/pub/blinux/hacks -->
<!-- faq_builder is released under the GNU Public License (GPL) -->
<!-- Send improvements to me, that's Hans Zoebelein hzo@goldfish.cube.net hzo@gmx.de -->
<!-- Enjoy! -->
<h4><a href="#toc1.">1. What is FAQ Builder?</a></h4>
<ul>
<li><a href="#toc1.1">1.1 Intro</a></li>
<li><a href="#toc1.2">1.2 Layout</a></li>
<li><a href="#toc1.3">1.3 Features</a></li>
</ul>
<h4><a href="#toc2.">2. How do I use faq_builder?</a></h4>
<ul>
<li><a href="#toc2.1">2.1 Write ASCII text</a></li>
<li><a href="#toc2.2">2.2 Process ASCII stuff</a></li>
</ul>
<h4><a href="#toc3.">3. Where can I get faq_builder?</a></h4>
<h4><a href="#toc4.">4. Where can I see a FAQ formatted with <b>faq_builder</b>?</a></h4>
</ul>
<br><br><h3><a name="toc1.">1. What is FAQ Builder?</a></h3>
<h3><a name="toc1.1">1.1 Intro</a></h3>
<p>
FAQ Builder is a simple Perl script <b>faq_builder.pl</b> which transforms ASCII input into nicely formatted FAQ (Frequently Asked Questions) layout.
</p>
<h3><a name="toc1.2">1.2 Layout</a></h3>
<p>
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).
</p>
<h3><a name="toc1.3">1.3 Features</a></h3>
<p>
<ul>
<li> Simply input, high quality output.
<li> Faq_builder can create as many indentation levels as needed.
<li> You can include HTML code into the ASCII text, like lists, line breaks, fonts.
<li> When regrouping questions, blocks are renumbered automagically.
<li> Changing indendatation levels is as easy as adding/removing a line of text.
<li> You can add comments into your text which will not shine up later. Comments are lines beginning with '#'.
</ul>
</p>
<br><br><h3><a name="toc2.">2. How do I use faq_builder?</a></h3>
<h3><a name="toc2.1">2.1 Write ASCII text</a></h3>
<p>
You use a char as indicator that a line is a title line (default '').
So you can easily build complex setups like<br>
Title1<br>
Sub title1.1<br>
Here comes text for sub title1.1<br>
Here comes text for sub title1.1<br>
Here comes text for sub title1.1<br>
Sub title1.2<br>
Here comes text for sub title1.2<br>
Title2<br>
Here comes text for title2<br>
<br><br>
</p>
<h3><a name="toc2.2">2.2 Process ASCII stuff</a></h3>
<p>
Simply do a <br>
<pre> faq_builder.pl my_ASCII.txt >my_HTML.html</pre>
and you get ready formatted HTML text. Using our input sample will
give you <br><br>
1. Title1<br>
1.1 Sub title1.1<br>
1.2 Sub title1.2<br>
2. Title2<br>
<br>
1. Title1<br>
1.1 Sub title1.1<br>
Here comes text for sub title1.1<br>
Here comes text for sub title1.1<br>
Here comes text for sub title1.1<br>
<br>
1.2 Sub title1.2<br>
Here comes text for sub title1.2<br><br>
2. Title2<br>
Here comes text for title2<br>
</p>
<br><br><h3><a name="toc3.">3. Where can I get faq_builder?</a></h3>
<p>
You can download faq_builder.pl from the Blinux file archive
(BTW: Blinux deals with support for the Linux user who is blind) as
<a href="http://www.leb.net/pub/blinux/hacks/faq_builder.pl">http://www.leb.net/pub/blinux/hacks/faq_builder.pl</a><br>
</p>
<br><br><h3><a name="toc4.">4. Where can I see a FAQ formatted with <b>faq_builder</b>?</a></h3>
<p>
Check out <a href="http://leb.net/blinux/blinux-faq.html">http://leb.net/blinux/blinux-faq.html</a>
<br>
PS: This description was formatted using <b>faq_builder</b>
<br><br>
Enjoy!<br>
Hans <a href="mailto:hzo@goldfish.cube.net"><hzo@goldfish.cube.net></a>
|
