Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?


Failed to load latest commit information.
Latest commit message
Commit time
This is the source code for the C++ FQA published at
You're very welcome to edit the FQA; in particular, it's not up to date with C++11/14/etc., nor with the new FAQ structure (I mean the new, erm, they call it "Super-FAQ" at

software: - *.fqa -> *.html. master script doing it all. - converts .fqa files to .html files. does most of the work, but not all. - module generating TOC from <h2> headings and a <!-- h2toc --> comment. modifies files inplace. follows fqa2html - makes the html w3c-compliant, and runs tidy to make sure it really is. - uploads all *.html files generated from *.fqa files to slow, but automatic. - manual. generates html code for link faces (for linking.html).


*.fqa - FQA sources.
*.html - final generated FQA web pages.
images are stored at the server.

syntax of *.fqa pages:

A paragraph is text between two blank lines:

 This is a paragraph.

 This is another

Currently for say 2 blank lines the program barfs, sigh.

A FAQ entry looks like this:

 Question-paragraph (single line)

 FAQ: rest of paragraph

 maybe more paragraphs

 FQA: rest of paragraph

 maybe more paragraphs


The program creates a link to the C++ FAQ question at "FAQ:". In the original C++ FAQ, questions are linked to by number.
In the FAQ, questions have named links so if we switch to linking to we'd need to handle that difference.

Special syntax inside paragraph text:

 /whatever/ becomes <i>whatever</i> (italics)
 \/ becomes /, escaping the syntax above
 |whatever| becomes <tt>whatever</tt> ("teletype" font - used for code)
 [18.2 whatever] becomes a hyperlink to FQA answer 18.2.
 /[corr.3 (correction)]/ becomes a hyperlink to correction 3, in italics, with (correction) as the link text.
 [ whatever] becomes a hyperlink to
 `whatever` becomes whatever, unescaped - for instance `<` becomes <, unlike < which becomes &lt;.
   this is used for <ul>, <li>, <b> and <h2>.
   ...becomes <pre>paragraph</pre>. /whatever/ inside @...@ still becomes <i>whatever</i> so \/ must be used to spell /.

Now to the general page structure: there are two kinds of pages, FAQ-section-mirroring pages and "general" pages.
A FAQ-section-mirroring page has as its first paragraph something like this:

 Title sentence
 {'section': 40, 'faq-page': 'whatever.html'}
 Description sentences

The dictionary is used for question numbering and hyperlink generation.

A "general" page looks like this:

 Title sentence
 Description sentences

 Possibly more paragraphs

 `<!-- h2toc -->



 `<h2>`another heading`</h2>`

 More paragraphs


Here the "table of contents" - links at the top of the page - is generated from hand-coded <h2> headings
(unlike FAQ-section-mirroring pages where it's generated from question titles.)