About
Q. 1.0 What is FAQtor?
Q. 1.1 What does FAQtor do?
Q. 1.2 Can you show me a webpage that uses FAQtor?
Q. 1.3 Can you show other pages?
Q. 1.4 Who developed FAQtor?
Q. 1.5 What other nifty programs has the author written?
Usage
Q. 2.0 What do I need in order to use FAQtor?
Q. 2.1 How do I run FAQtor?
Q. 2.2 What does the xml input file look like?
Q. 2.3 What does the config file look like?
Q. 2.4 Why would I want to use a config file if it's optional?
XML input file
Q. 3.0 What is the structure of the XML input file in?
Q. 3.1 How do I refer to answers (from other documents or
from within the faq itself)?
Configuration File (optional)
Q. 4.0 What format is the configuration file in?
About
A. 1.0 What is FAQtor?
FAQtor is short for "Frequently Asked Questions generaTOR".
Return to top
A. 1.1 What does FAQtor do?
FAQtor is a python script that enables you to easily create and maintain a list of questions
and answers in a configurable format.
Return to top
A. 1.2 Can you show me a webpage that uses FAQtor?
The page you are viewing was generated by FAQtor
Return to top
A. 1.3 Can you show other pages?
Not at this time, but if you are using it or know of somebody that is, please send
me an email. My contact info is available on Sourceforge
Return to top
A. 1.4 Who developed FAQtor?
Phil Schwartz
Return to top
A. 1.5 What other nifty programs has the author written?
Funny you should ask. Phil Schwartz is also the author of
Kodos (a Regex debugger and analyzer) and
Scratchy (an Apache log parser and report
generator).
Return to top
Usage
A. 2.0 What do I need in order to use FAQtor?
Python 2.3 (or greater) is required.
Return to top
A. 2.1 How do I run FAQtor?
python faqtor.py yourfaq.xml [yourconfig.cfg]
Return to top
A. 2.2 What does the xml input file look like?
The FAQtor FAQ was generated with this XML file.
Return to top
A. 2.3 What does the config file look like?
The FAQtor FAQ was generated with this config file.
This file is optional. If not supplied, defaults are provided.
This question may also be of interest to you.
Return to top
A. 2.4 Why would I want to use a config file if it's optional?
Although FAQtor will use defaults, it is recommended that you create a config file to
customize the layout of the FAQ.
Return to top
XML input file
A. 3.0 What is the structure of the XML input file in?
Please refer to the
README.xml in the FAQtor source distribution
Return to top
A. 3.1 How do I refer to answers (from other documents or
from within the faq itself)?
Note:This feature is available in version 0.6
or newer
In the XML input file, within each answer section that you wish to refer
to you must assign a name-value entity. Only answers that you wish to refer to require this
additional syntax, which looks like this:
Now, anywhere you wish to refer to it, you simply use the anchor with the name you just
created. In this case, "named-anchors". This name can be anything as long as it adheres
to HTML
syntax rules.
For example, this shows how to link to the current answer for demonstration purposes:
Return to top
Configuration File (optional)
A. 4.0 What format is the configuration file in?
The config file uses a standard Windows INI file format.
For more information on the config file, please refer to
README.cfg in the FAQtor source distribution.
Return to top