question-answer-brainstorming

(Difference between revisions)

Jump to: navigation, search
m (Interview Questions and Answers: Validity)
m (Multi-page FAQs: Adding Syntax highlighting)
Line 10: Line 10:
Current mark-up:
Current mark-up:
-
:<nowiki><a href="/england/noappointmentneeded/walkincentres/walkincentreservices.cmsx">What services does a Walk-in Centre offer?</a></nowiki>
+
<source lang=html4strict>
 +
<a href="/england/noappointmentneeded/walkincentres/walkincentreservices.cmsx">What services does a Walk-in Centre  
 +
offer?</a>
 +
</source>
Possible solution (tentative class-names):
Possible solution (tentative class-names):
-
:<nowiki><a </nowiki>'''class="question answer-at"'''<nowiki> href="/england/noappointmentneeded/walkincentres/walkincentreservices.cmsx">What services does a Walk-in Centre offer?</a></nowiki>
+
<source lang=html4strict>
 +
<a href="/england/noappointmentneeded/walkincentres/walkincentreservices.cmsx" class="question answer-at">What services  
 +
does a Walk-in Centre offer?</a>
 +
</source>
More about this possible solution:
More about this possible solution:
(FAQ-LIST)
(FAQ-LIST)
-
:<nowiki><ul class="faq-list"></nowiki>
+
<source lang=html4strict>
-
:<nowiki><li><a class="question answer-at" href="faq1.htm">What are the microformats?</a></li></nowiki>
+
<ul class="faq-list">
-
:<nowiki><li><a class="question answer-at" href="faq2.htm">Who can use the microformats? </a></li></nowiki>
+
  <li><a class="question answer-at" href="faq1.htm">What are the microformats?</a></li>
-
:<nowiki><li><a class="question answer-at" href="faq3.htm">How can we use the microformats? </a></li></nowiki>
+
  <li><a class="question answer-at" href="faq2.htm">Who can use the microformats? </a></li>
-
:<nowiki></ul></nowiki>
+
  <li><a class="question answer-at" href="faq3.htm">How can we use the microformats? </a></li>
 +
</ul>
 +
</source>
(FAQ-PAGE)
(FAQ-PAGE)
-
:<nowiki><div class="faq"></nowiki>
+
<source lang=html4strict>
-
:<nowiki><h1 class="question">What are the microformats?</h1></nowiki>
+
<div class="faq">
-
:<nowiki><p class="answer">Microformats are an implementation...</p></nowiki>
+
  <h1 class="question">What are the microformats?</h1>
-
:<nowiki></div></nowiki>
+
  <p class="answer">Microformats are an implementation...</p>
 +
</div>
 +
</source>
(FAQ-NAVIGATION-MENU)
(FAQ-NAVIGATION-MENU)
-
:<nowiki><ul class="faq-navigation"></nowiki>
+
<source lang="html4strict">
-
:<nowiki><li><a href="faq1.htm" class="faq-previous question answer-at">What are the microformats?</a> (Previous in faq-list)</li></nowiki>
+
<ul class="faq-navigation">
-
:<nowiki><li><a href="faq3.htm" class="faq-next question answer-at">How can we use the microformats?</a> (Next in faq-list)</li></nowiki>
+
  <li><a href="faq1.htm" class="faq-previous question answer-at">What are the microformats?</a> (Previous in  
-
:<nowiki></ul></nowiki>
+
faq-list)</li>
 +
  <li><a href="faq3.htm" class="faq-next question answer-at">How can we use the microformats?</a> (Next in  
 +
faq-list)</li>
 +
</ul>
 +
</source>
==Interview Questions and Answers==
==Interview Questions and Answers==

Revision as of 11:01, 28 November 2008

Contents

Questions and Answers

Purpose

The "question-answer" microformat proposes to formalize the relationships between questions and answers (including "FAQs") published within a single HTML document (and possibly a set of documents). Such formalization should allow for reuse of questions and answers in new contexts, e.g. search engines, IM bots, etc.

Multi-page FAQs

Based on [1] (extraneous detail omitted)

Current mark-up:

<a href="/england/noappointmentneeded/walkincentres/walkincentreservices.cmsx">What services does a Walk-in Centre 
offer?</a>

Possible solution (tentative class-names):

<a href="/england/noappointmentneeded/walkincentres/walkincentreservices.cmsx" class="question answer-at">What services 
does a Walk-in Centre offer?</a>

More about this possible solution:

(FAQ-LIST)

<ul class="faq-list">
  <li><a class="question answer-at" href="faq1.htm">What are the microformats?</a></li>
  <li><a class="question answer-at" href="faq2.htm">Who can use the microformats? </a></li>
  <li><a class="question answer-at" href="faq3.htm">How can we use the microformats? </a></li>
</ul>

(FAQ-PAGE)

<div class="faq">
  <h1 class="question">What are the microformats?</h1>
  <p class="answer">Microformats are an implementation...</p>
</div>

(FAQ-NAVIGATION-MENU)

<ul class="faq-navigation">
  <li><a href="faq1.htm" class="faq-previous question answer-at">What are the microformats?</a> (Previous in 
faq-list)</li>
  <li><a href="faq3.htm" class="faq-next question answer-at">How can we use the microformats?</a> (Next in 
faq-list)</li>
</ul>

Interview Questions and Answers

A lively discussion on Quirksmode didn't resolve the issue, but the most convincing argument was made by Eric Myers at comment #7. The answer to a question is semantically a blockquote. The question itself is just text, assuming the author asked the question, so a paragraph is what's called for. Combine that with comment #13, which suggest the use of EM to provide a different voice for the question, and you're halfway there. What remains is to work in the names of the speakers. The CITE tag isn't ideal for identifying the speaker (it's not quite a reference to another source), but it's the only tag that makes sense with a blockquote. That just leaves a tag for the identity of the interviewer. But since the interviewer is also the author, the byline at the top of the page should do the trick. So to sum up, here's a proposed solution:

<p><em>What is your quest?</em></p>
<blockquote><p><cite>Sir Launcelot:</cite> To seek the Holy Grail.</p></blockquote>
<p><em>What is your favorite color?</em></p>
<blockquote><p><cite><abbr title="Sir Launcelot">SL:</abbr></cite> Blue.</p></blockquote>

If it is important that the format be portable across sites, then I would also propose adding class="question" in the P tag and class="answer" in the blockquote, although I tend to think the format is cleaner without those classes.

hFeed

FAQs could be marked up as, or using a variant of, hAtom, with the question being the entry title and the answer the content. Andy Mabbett

hfeed (hAtom) is a good candidate, however, one thing is lacking...the key concept of a q/a. The value of a q/a format is for agregating questions and answers. If hAtom can indicate that it's contents are q/a it would be perfect. Taylor Cowan

See also

question-answer-brainstorming was last modified: Wednesday, December 31st, 1969

Views