XML file format:
================
The XML input file is structured as follows:
1. An opening and closing and tag contains all of the faq data.
2. The faq contains one or more "sections" each with a required "name" parameter.
3. Each section contains one or more questions.
4. Each of the questions contains exactly one answer.
The "faq" tag:
==============
... everything else ...
The "section" tag:
==================
The "question" tag:
===================
What is this?
The "answer" tag:
=================
This is an answer
New in v0.6: the following can be used to create named anchors so that you can
refer to this answer from other documents or from within the faq:
This expanded syntax is optional and was added to accommodate linking to answers from
elsewhere. For example:
How do I use this new feature?
By adding a name="" attribute to the answer tag
After running FAQtor incorporating the above into your XML input file you can create links
within to this answer from another page, say "related.html":
New features
You can now refer to the FAQ from another page.
Click here to see how.
Putting it all together:
========================
What is this?
This is the xml input file format
Is it really this easy?
Yes, the xml file is structured in a very easy to create manner
Is there anything else I need to know?
Yes.
There are some "gotchas" that will be discussed later in this document
Additional notes:
=================
Leading and trailing whitespace is ignored by FAQtor. So each section, question and answer that
requires leading and/or trailing whitespace will need to include the HTML non-breaking space entity,
namely:
eg.
This line has two leading spaces.
As of FAQtor v0.7 you can now include html markup directly within the XML document.
Although not syntactically correct XML, FAQtor will convert the HTML specific markup (namely
the < and > brackets) to XML-compliant entities (namely, < and >). This functionality
is provided as a convenience to users because it can be quite tedious to manually replace
the start and end tag delimiters with entities.
eg.
This answer requires a
linebreak
The content of the previous XML tag will be converted by FAQtor to this:
This answer requires a <br> linebreak
The previous result will then be passed the XML parser.