Project

General

Profile

Bug #495

create FAQ for EML

Added by Matt Jones about 18 years ago. Updated over 17 years ago.

Status:
Resolved
Priority:
Immediate
Assignee:
Category:
eml - general bugs
Target version:
Start date:
05/01/2002
Due date:
% Done:

0%

Estimated time:
Bugzilla-Id:
495

Description

Changes as decided upon at the Sevilleta EML meeting, April 24-25, 2002:

1) James agreed to create a FAQ. We may want this to be in a simple XML format
so that we can transform it into HTML and other formats like PDF. Something
like this might work if you can't find something on the web for FAQs already:

<faq version="1.1">
<faq-item id="1">
<question>Why does it rain?</question>
<answer>Because it is wet.</answer>
</faq-item>
</faq>

Although we might also wat the ability to group faq-items into sections. My
element names leave some room for improvement :)

EML FAQ.doc (23 KB) EML FAQ.doc James Brunt, 08/26/2002 09:12 AM
EML FAQ.doc (31.5 KB) EML FAQ.doc James Brunt, 08/26/2002 10:27 AM
eml-faq.xml (17.7 KB) eml-faq.xml James Brunt, 08/30/2002 10:55 AM

History

#1 Updated by Matt Jones almost 18 years ago

Moving milestone. James still needs to complete this for the 2.0.0 release.

#2 Updated by James Brunt almost 18 years ago

I've been working on this and should have a draft ready in a couple of weeks -
I'll call for additional favorite FAQ's soon.

James

#3 Updated by Matt Jones almost 18 years ago

Excellent. And thanks. Can you attach what you already have to this bug so that
we can provide feedback? Also, we decided today on the EML conference call to
aim for Sep 6 as the deadline for the next EML release contributions, with the
actual release going out on Spetember 13. Any chance you could have it ready by
Sep 6?

#4 Updated by James Brunt almost 18 years ago

OK, but remember you asked for it - I'm still working from my yellow pad notes
and I haven't formatted it in XML yet but here it is. I'll try to have a
formatted version with a little polish by Friday 30 Aug. I'll take any
favorites you have - answers which I'll wordsmith are also most welcom.

#5 Updated by James Brunt almost 18 years ago

I've added another page of questions from my yellow pad and some more answers.
Still unedited for the most part. Since I don't know if my previous comments
will be deprecated I will repeat them - I'm shooting for an XML formatted
version that is somewhat polished by Friday 30 Aug - send any favorite
questions and any favorite answers. TNX

#6 Updated by Matt Jones almost 18 years ago

James -- excellent start. I read it over and all of the questions are great.
The answers are good too :) Some of the answers are trivially out-of-date -- we
can make those technical corrections once you submit the initial text XML
document into CVS as a draft. What XML format are you going to use? I think
Docbook has some suggested tags for FAQ entries.

#7 Updated by James Brunt almost 18 years ago

I would appreciate suggestions on the formatting. I have this homegrown one that
Matt did that I can modify to have section identifiers but if someone has
something more standard I'd appreciate it.

<faq version="1.1">
<faq-item id="1">
<question>Why does it rain?</question>
<answer>Because it is wet.</answer>
</faq-item>
</faq>

#8 Updated by James Brunt almost 18 years ago

I've added some more text and formatted the document. I've got a lot of editing
and polishing and some more answers to make up but I wanted to get this up
before I head out for the long weekend.

#9 Updated by James Brunt over 17 years ago

I've checked the first real draft into cvs for comments, formatting, additions,
etc. I'm hoping someone will take on the formatting and provide a template for
the further development and maintenance. There needs to be provisions for
subsectioning I think because I can see questions developing along several
lines. I won't close out this bug until we have a real working version that the
group feels is acceptable for publication. - James

#10 Updated by Matt Jones over 17 years ago

James -- I'll develop an XSLT stylesheet to produce XML from your faq that can
be linked into the EML docs. I agree sections are probably in order. I added
eml-dev to the cc list for this bug so that people would know to review the new
FAQ that you created. I think there are still some minor inaccuracies we'll
want to clean up, but its looking great! Thanks.

#11 Updated by Chad Berkley over 17 years ago

I changed the format of the xml in the faq to docbook, then I changed the
build.xml file to use the docbook xsl stylesheets. I also added a couple more
questions to the faq. the faq can no be formatted to html using the command
'ant faqhtml'.

#12 Updated by James Brunt over 17 years ago

Chad, this looks great. Being not familiar with Docbook can you tell me how to
insert sectioning into the QandA feature?

#13 Updated by Chad Berkley over 17 years ago

you can put any docbook inline elements into those question and answers. See
http://www.docbook.org/tdg/en/html/docbook.html for a complete reference on the
docbook elements. I think you would just use <para> and lists to section the
questions and answers how you want. It depends on where you want to put the
sectioning though.

#14 Updated by Matt Jones over 17 years ago

Completed for RC1 release. Reviewed and revised by jones and berkley. Ready to
ship. Thanks James. FIXED.

#15 Updated by Redmine Admin about 7 years ago

Original Bugzilla ID was 495

Also available in: Atom PDF