From owner-freebsd-arch@FreeBSD.ORG  Mon Mar 29 03:12:28 2004
Return-Path: <owner-freebsd-arch@FreeBSD.ORG>
Delivered-To: freebsd-arch@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP
	id 9EC7C16A4CE; Mon, 29 Mar 2004 03:12:28 -0800 (PST)
Received: from dire.bris.ac.uk (dire.bris.ac.uk [137.222.10.60])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id 128EC43D3F; Mon, 29 Mar 2004 03:12:28 -0800 (PST)
	(envelope-from Jan.Grant@bristol.ac.uk)
Received: from mail.ilrt.bris.ac.uk by dire.bris.ac.uk with SMTP-PRIV 
          with ESMTP; Mon, 29 Mar 2004 12:10:33 +0100
Received: from cmjg (helo=localhost)	by mail.ilrt.bris.ac.uk 
          with local-esmtp (Exim 3.16 #1)	id 1B7ucq-00026r-00;
          Mon, 29 Mar 2004 12:08:16 +0100
Date: Mon, 29 Mar 2004 12:08:16 +0100 (BST)
From: Jan Grant <Jan.Grant@bristol.ac.uk>
X-X-Sender: cmjg@mail.ilrt.bris.ac.uk
To: Alexey Zelkin <phantom@FreeBSD.org>
In-Reply-To: <20040328094048.GA40406@phantom.cris.net>
Message-ID: <Pine.GSO.4.58.0403291205070.25730@mail.ilrt.bris.ac.uk>
References: <20040328094048.GA40406@phantom.cris.net>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Sender: Jan Grant <Jan.Grant@bristol.ac.uk>
cc: arch@FreeBSD.org
Subject: Re: CFD: XMLification of NOTES
X-BeenThere: freebsd-arch@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Discussion related to FreeBSD architecture
	<freebsd-arch.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-arch>,
	<mailto:freebsd-arch-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-arch>
List-Post: <mailto:freebsd-arch@freebsd.org>
List-Help: <mailto:freebsd-arch-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-arch>,
	<mailto:freebsd-arch-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 29 Mar 2004 11:12:28 -0000

On Sun, 28 Mar 2004, Alexey Zelkin wrote:

> At this point I would like to start some kind of discussion and listen for
> your ideas which features you'd like to see in application which will be
> handling these XMLs.

> According XML structure.  It should look like:
>
> <notes>
>   <section id="ID">
>     <title>Section Title</title>
>     <desc>Multiline section description</desc>
>
>     <entry type="(options|device|etc)" id="ID2">
>       <conflicts options="ID3"/>
>       <depends device="ID4"/>
>       <lint value="1"/>
>       <lint exclude="yes"/>
>       <title>Entry title</title>
>       <desc>Entry description</desc>
>     </entry>
>   </section>
> </notes>

Please strongly consider adding an XML namespace to this; it gives some
measure of version control and you can use XSLT (where possible) to
migrate cleanly from one version to the next.

I know this might seem less useful for a hand-maintained NOTES but
getting practice in addressing some of the complaints levelled against
the adoption of XML by picking the useful bits of the technology is (I
think) a good idea.

Cheers,

-- 
jan grant, ILRT, University of Bristol. http://www.ilrt.bris.ac.uk/
Tel +44(0)117 9287088 Fax +44 (0)117 9287112 http://ioctl.org/jan/
Generalisation is never appropriate.