10 people following this project (follow)

For step-by-step instructions on how to modify this project see http://www.ef-faq.org/introduction.html#1.7.

The FAQ source is written in an extended dialect of the markdown syntax. See http://daringfireball.net/projects/markdown/syntax for more info. On top of markdown, we have added the following:

? section name
?? question name

The faqbldr program finds all .faq files in the current directory, producing a single static HTML file for each one. These files contain both the HTML from the markdown syntax plus a wrapper around it that includes a header, a footer, and a generated navigation menu on the left. The contents of this wrapping HTML comes from the template.html file which is mostly plain HTML but also contains lines with a replacement token from this list

###DATE###
###MENU###
###CONTENT###

These tokens are replaced with the appropriate generated HTML to make the final output file.

Once all the files have been processed, they are written to the "output" directory which also contains a few checked-in support files. After faqbldr is run, the output directory (& its subdirectory) contains all the files needed to publish to the EF-FAQ hosting account.

To add new questions and answers or to update existing answers in the FAQ. Just edit the appropriate .faq text file and run faqbldr. You can test the FAQ by launching default.html from the output directory since all of the internal URLs are relative and the FAQ contents are all static.

Similarly, if you would like to adjust the formatting / clean up the current HTML/CSS mess, you can probably accomplish everything you need just by editting template.html.

Once everything looks the way you like, make a fork of the source project here on codeplex and post a request for the project maintainers to pull your changes. The maintainers can then integrate your changes and push the final results up to the ef-faq.org site.

Last edited Nov 29 2010 at 5:18 PM by simmdan, version 2

Comments

No comments yet.