From owner-freebsd-doc  Fri Jul 17 00:45:25 1998
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Received: (from majordom@localhost)
          by hub.freebsd.org (8.8.8/8.8.8) id AAA01591
          for freebsd-doc-outgoing; Fri, 17 Jul 1998 00:45:25 -0700 (PDT)
          (envelope-from owner-freebsd-doc@FreeBSD.ORG)
Received: from tyree.iii.co.uk (tyree.iii.co.uk [195.89.149.230])
          by hub.freebsd.org (8.8.8/8.8.8) with ESMTP id AAA01582;
          Fri, 17 Jul 1998 00:45:23 -0700 (PDT)
          (envelope-from nik@iii.co.uk)
From: nik@iii.co.uk
Received: from carrig.strand.iii.co.uk (carrig.strand.iii.co.uk [192.168.7.25])
	by tyree.iii.co.uk (8.8.8/8.8.8) with ESMTP id IAA13739;
	Fri, 17 Jul 1998 08:45:12 +0100 (BST)
Received: (from nik@localhost)
	by carrig.strand.iii.co.uk (8.8.8/8.8.7) id IAA04692;
	Fri, 17 Jul 1998 08:44:24 +0100 (BST)
Message-ID: <19980717084424.50539@iii.co.uk>
Date: Fri, 17 Jul 1998 08:44:24 +0100
To: Joseph Koshy <jkoshy@FreeBSD.ORG>
Cc: freebsd-doc@FreeBSD.ORG
Subject: Re: Comments on FAQ DTD?
References: <199807170117.SAA00144@hub.freebsd.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
X-Mailer: Mutt 0.85e
In-Reply-To: <199807170117.SAA00144@hub.freebsd.org>; from Joseph Koshy on Thu, Jul 16, 1998 at 06:17:34PM -0700
Organization: interactive investor
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org

On Thu, Jul 16, 1998 at 06:17:34PM -0700, Joseph Koshy wrote:
> I found a DTD for FAQs on the Web recently which seemed /much/ lighter
> than the current LinuxDoc or DocBook DTDs which we use.
> 
> 	http://www.faq.org/qaml/qaml.dtd
> 
> I liked the simplicity of the DTD but it also seemed to lack a way to
> markup a computer/user dialogue, something which I guess is important
> for the FreeBSD FAQ.

Very quickly (I'm off for 3 days in about 2 minutes)

If you look at doc/sgml/freebsd.dtd you'll see my extensions to DocBook
to handle this.

In essence, you would write

    <FAQList>
      <FAQListItem>
         <FAQQuestion>
           <para>...</para>

           <para>...</para>
         </FAQQuestion>
 
         <FAQAnswer>
           <para>...</para>

           <informalexample>
             <screen><prompt/#/ <userinput>...</userinput></screen>
           </informalexample>
         </FAQAnswer>
      </FAQListItem>

      ...
    </FAQList>

and so on. Wordy, but in keeping with DocBook. I just need to document it
before it gets used.

Comments appreciated.

N
-- 
Work: nik@iii.co.uk                       | FreeBSD + Perl + Apache
Rest: nik@nothing-going-on.demon.co.uk    | Remind me again why we need
Play: nik@freebsd.org                     | Microsoft?

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message