Re: Wine FAQ - call for a volunteer

[Francois Gouget]

On Sat, 2 Nov 2002, Dimitrie O. Paun wrote:
[...]
> - Work on getting the SGML tools to do what we
> want, so we can write the FAQ in XML, like so:
>
> <faq>
>   <entry>
>     <question>What is this for?</question>
>     <answer>Nothing in particular, it's just cool.</answer>
>   </entry>
> </faq>

DocBook is the way to go there. It's already what we use for the Wine
documentation and it has tags for writing FAQs. See the URL below for
the reference of all the DocBook tags:

DocBook: The Definitive Guide
http://www.docbook.org/tdg/en/html/docbook-x.html

Here is the basic structure for FAQs. It's pretty simple. I think the
example below should be 99% of what you need to write the whole FAQ. You
can look up the tags in the above doc for more details. And you can also
ask me if needed (not that I'm a great DocBook specialist but having
worked on the CrossOver FAQs...)

<qandaset>

<qandadiv><title>Installation</>
    <!-- Put all installation related questions in this section -->

<qandaentry>
      <question id="download">
        <para>
        Where can I download Wine from?
        </para>
      </question>
      <answer>
        <para>
        You can get it from <ulink url="http://www.winehq.com">WineHQ</>
        blah, blah, ...
        </para>
      </answer>
    </qandaentry>

<qandaentry>
      <question id="will_be_an_html_a_name">
        <para>
        What is question 2?
        </para>
      </question>
      <answer>
        <para>
        This is answer 2.
        </para>
        <para>
        More paragraphs.
        </para>
      </answer>
    </qandaentry>
    ...

</qandadiv>

<qandadiv><title>Configuration</>
    <!-- Put all configuration related questions in this section -->
  ...
  </qandadiv>

<qandadiv><title>Whatever...</>
  ...
  </qandadiv>

...

</qandaset>