Welcome to FAQGen

FAQGen is a Java command-line tool that generates an HTML FAQ page from an XML file.

Actually, FAQGen requires three input files:

  • Configuration File - Tells the application how and where to generate the FAQ page.
    Example Config File
  • FAQ File - Stores your question/answer pairs, grouped into sections.
    Example FAQ File

If you like, you can view the Rendered HTML file from running the three samples files through FAQGen.

Downloading FAQGen

If I've peaked your interest, and if you happen to already have Java installed, why not download FAQGen and take it for a spin?

Download FAQGen v0.50.0

On the download page, you'll find zip and tar.gz versions of both the binary and source distributions.

The FAQGen distributions (currently) contain all required .jar files necessary to run, so it should be relatively simple to try it out.

Running FAQGen

Being Java, FAQGen can't just be run like a standard app. The classpath needs to be configured.

The distribution contains a couple of scripts to help get you started.

The scripts are relatively simple and may need to be modified in order to work on your system, but they do attempt to auto-configure the classpath and launch the FAQGen app.

Comments, Problems, Bug Reports

If you have any comments, or need help using FAQGen, feel free to Email Me.

Any feedback would be appreciated.

You are also invited to register a FAQGen Trac account. Registration is free and registered users can contribute to Trac tickets as well as create new tickets.

To Do

  • Make better launching scripts
  • Add "Generated by FAQGen" footer to bottom of generated pages. Inclusion is optional, of course, as the user has full control of the template.
  • Use FAQGen to create an actual FAQ for the FAQGen application. This could also become the example FAQ included with the distribution.

Looking for the original Trac Welcome Page?