[xml2rfc] Slides for edu presentation on xml2rfc in Dallas

[julian.reschke at gmx.de (Julian Reschke)]

Michael Tuexen wrote:
> Seems to be usable... I'm normally doing copy&paste and then change
> the number.
> 
> But I have to change the URL, if the references are moved to a different 
> location,
> this is not the case with the <?rfc ...> stuff, right?

Yes.
>From elwynd at dial.pipex.com  Tue Mar 14 12:46:29 2006
From: elwynd at dial.pipex.com (Elwyn Davies)
Date: Tue Mar 14 04:44:07 2006
Subject: [xml2rfc] Slides for edu presentation on xml2rfc in Dallas
In-Reply-To: <[e-mail]>
References: <[e-mail]> <[e-mail]>
	<[e-mail]> <[e-mail]>
	<[e-mail]> <[e-mail]>
	<[e-mail]>
Message-ID: <[e-mail]>



Michael Tuexen wrote:
> Julian,
>
> what is the alternative to
>
> <references title='Normative References'>
> <?rfc include="reference.RFC.1321" ?>
> <?rfc include="reference.RFC.2104" ?>
> <?rfc include="reference.RFC.2119" ?>
> <?rfc include="reference.RFC.2960" ?>
> <?rfc include="reference.RFC.3436" ?>
> <?rfc include="reference.FIPS.180-1.1995" ?>
> </references>
>
> which I find pretty convenient...
>
> Best regards
> Michael
>
> On Mar 14, 2006, at 1:10 PM, Julian Reschke wrote:
>
>> Pekka Savola wrote:
>>> On Tue, 14 Mar 2006, Julian Reschke wrote:
>>>> Elwyn Davies wrote:
>>>>> So.. I was just trying to think if there are any circumstances in 
>>>>> which the include PI is necessary.. should we be effectively 
>>>>> deprecating <?rfc include=..?
>>>>
>>>> I think so. It's incompatible with DTD validation.
>>> I have to disagree with that.  I like user convenience :).  Using 
>>> includes is definitely the shortest and easiest way to write 
>>> references and keep them in sync.
>>
>> Well, there's an alternative way to include references, that *is* 
>> compatible with DTD validation...
The ENTITY route is 'cleaner' from an XML perspective:
At the top of the file:
Using the online bibliography:
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY RFC2119 SYSTEM 
"http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
]>
or with local cache and a suitable setting of XML_LIBRARY:
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY RFC2119 SYSTEM "reference.RFC.2119.xml">
]>

Then later on:
<references title='Normative References'>
&RFC2119;
</references>

This does essentially the same as <?rfc include...> but will be 
understood by any XML processor, not just xml2rfc.

Obviously the online version needs you to be on the network ;-)   but 
saves you the hassle of maintaining the local cache.
Also XMLmind (for example) will not load files with network refs if they 
are not accessible - which is inconvenient when trying to edit off network.
BTW Rob Austein contributed some code to do an efficient cache update 
(see contrib directory in source archive).

Regards,
Elwyn
>From thomas.morin at rd.francetelecom.com  Tue Mar 14 14:04:30 2006
From: thomas.morin at rd.francetelecom.com (Thomas Morin)
Date: Tue Mar 14 05:04:39 2006
Subject: [xml2rfc] Slides for edu presentation on xml2rfc in Dallas
In-Reply-To: <[e-mail]>
References: <[e-mail]> <[e-mail]>
	<[e-mail]> <[e-mail]>
	<[e-mail]>
	<[e-mail]>
	<[e-mail]>
Message-ID: <1142341470.1361.26.camel@wintermute>

Elwyn Davies:
> The ENTITY route is 'cleaner' from an XML perspective:
> At the top of the file:
> Using the online bibliography:
> <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
> <!ENTITY RFC2119 SYSTEM 
> "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
> ]>
> or with local cache and a suitable setting of XML_LIBRARY:
> <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
> <!ENTITY RFC2119 SYSTEM "reference.RFC.2119.xml">
> ]>
> 
> Then later on:
> <references title='Normative References'>
> &RFC2119;
> </references>
> 
> This does essentially the same as <?rfc include...> but will be 
> understood by any XML processor, not just xml2rfc.
> 
> Obviously the online version needs you to be on the network ;-)   but 
> saves you the hassle of maintaining the local cache.
> Also XMLmind (for example) will not load files with network refs if they 
> are not accessible - which is inconvenient when trying to edit off network.
> BTW Rob Austein contributed some code to do an efficient cache update 
> (see contrib directory in source archive).

Another issue I have wrt using entities with XMLMind is that this editor
will replace an entity ("&RFC2119;") by its content
("<reference>...</reference>" block) in the saved file, which is a pain
because you lose the nice feature of having reference block updated when
new drafts version are published.

Is there a way to avoid this with XMLMind ?
Maybe an XML-clean solution would be to allow a <reference/> block to be
empty and only have one special attribute set which would designate some
draft or RFC ?

Regards,

-Thomas