What is FAQtor? FAQtor is short for "Frequently Asked Questions generaTOR". 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. Can you show me a webpage that uses FAQtor? The page you are viewing was generated by FAQtor 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 Who developed FAQtor? Phil Schwartz 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).
What do I need in order to use FAQtor? Python 2.3 (or greater) is required. How do I run FAQtor? python faqtor.py yourfaq.xml [yourconfig.cfg] What does the xml input file look like? The FAQtor FAQ was generated with this XML file. 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. 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.

What is the structure of the XML input file in? Please refer to the README.xml in the FAQtor source distribution 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:

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.