Re: XML2RFC template for MIB modules

["Randy Presuhn" <randy_presuhn@mindspring.com>]

Hi -

> From: "Wijnen, Bert (Bert)" <bwijnen@lucent.com>
> To: <dbharrington@comcast.net>; "'Mreview (E-mail)'" <mreview@ops.ietf.org>
> Sent: Tuesday, September 27, 2005 1:16 PM
> Subject: RE: XML2RFC template for MIB modules
>

> Instead of this:
>
>       <reference anchor="RFC2863">
>         <front>
>           <title>
>             The Interfaces Group MIB
>           </title>
>           <author initials="K." surname="McCloghrie" fullname="Keith McCloghrie>
>             <organization>Cisco Systems</organization>
>           </author>
>           <author initials="F." surname="Kastenholz" fullname="Frank Kastenholz>
>             <organization>FTP Software</organization>
>           </author>
>           <date month="June" year="2000"/>
>         </front>
>         <seriesInfo name="RFC" value="2863"/>
>       </reference>
>
> I would rather do (and in fact I always do it that way):
>
>   <back>
>     <references title="Normative References">
>       <?rfc include='./reference.RFC.2863.xml'?>
>     </references>
>
> For an internet-draft you can do:
>
>    <?rfc include='reference.I-D.rfc-editor-rfc2223bis'?>
>
> If done thsi way, it always pick up the current draft and it also
> picks up a consistent set of attributes about the RFC or I-D.
>
> I see that in your TEXT, you have for example:
>
>     For example, some modules are always implemented in conjunction with the IF-MIB
>     [RFC2863] and are REQUIRED to document how certain objects in the
>
> Which is better done as follows:
>
>     For example, some modules are always implemented in conjunction with the IF-MIB
>     <xref target="RFC2863"/> and are REQUIRED to document how certain objects in the
>
> which will in fact generate [RFC2863] citation, with the added advantage, that
> if you generate an HTML file instead of a .TXT file, that the citation
> will be clickable.
...

Yet another way to do references is like this:


upfront:

<!DOCTYPE rfc SYSTEM "rfcXXXX.dtd" [

    <!ENTITY udp PUBLIC ''
      'http://xml.resource.org/public/rfc/bibxml/reference.RFC.0768.xml'>
    <!ENTITY tcp PUBLIC ''
      'http://xml.resource.org/public/rfc/bibxml/reference.RFC.0793.xml'>

when used:
User Datagram Protocol (UDP) <xref target="RFC0768"/>

references section:
<back>
  <references title='Informative References'>
   &udp;
   &tcp;

- - - - - - -
Now, what would *really* be nice, for those cases where RFC numbers change,
would be a way to also say something like <ENTITY Udp '<xref target="RFC0768"/>'>
so that the in-line citations would just be something simple like
User Datagram Protocol (UDP) &Udp
Nroff lets me do something very much like this.

Randy