RE: XML2RFC template for MIB modules

["David B Harrington" <dbharrington@comcast.net>]

Hi,

Ooooh. I much prefer your reference format. I hadn't figured quite how
to do it. Changed.

Whoops. [RFC2863] was a Cut-and-paste-without-followup error.

> -----Original Message-----
> From: Wijnen, Bert (Bert) [mailto:bwijnen@lucent.com] 
> Sent: Tuesday, September 27, 2005 4:16 PM
> To: dbharrington@comcast.net; 'Mreview (E-mail)'
> 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.

 
> 
> 
> Hope this helps,
> Bert
> 
> 
> 
> > -----Original Message-----
> > From: owner-mreview@ops.ietf.org 
> [mailto:owner-mreview@ops.ietf.org]On
> > Behalf Of David B Harrington
> > Sent: Tuesday, September 27, 2005 21:58
> > To: 'Mreview (E-mail)'
> > Subject: XML2RFC template for MIB modules
> > 
> > 
> > Hi,
> > 
> > I have enclosed a text document that is the output of my xml2rfc
MIB
> > module template, so you can see roughly what will get generated,
and
> > can comment on the layout, etc.
> > 
> > I have enclosed the XML template for writing MIB modules. 
> It was used
> > to generate the text document. It is peppered with comments that
do
> > not show up in the output document. Please review those comments
as
> > well.
> > 
> > For those who do not yet have xml2rfc, you can use the web
service,
> > available on that site. Just give it an XML file in the
appropriate
> > format (like the one I have included) and it will generate 
> text, HTML,
> > nroff, or other file types.
> > 
> > To install xml2rfc on your own system, the xml2rfc tool is
available
> > from http://xml.resource.org/. It is a TCL-driven program, so
you'll
> > also need TCL. The tool is based on RFC2629. The rfc2629.dtd file
in
> > the distribution contains the DTD used to do the translations. The
> > README file link on the website and in the distribution explains
all
> > the tags.
> > 
> > The distribution also contains xslt files and some templates for
> > non-MIB documents. I haven't used these much since I don't 
> maintain a
> > website. 
> > 
> > The xml2rfc website also contains citation libraries. It is a bit
> > painful writing the references in XML. The citation libraries can
be
> > used online (cut and paste), or downloaded to your local system. 
> > 
> > There is a mailing list where you can ask questions or request
> > enhancements.
> > 
> > I personally use the free XMLSpy editor home edition, which
provides
> > checking for well-formed and valid XML.
> > 
> > Let me say that I have been doing the "final" editing of the
Bridge
> > documents in nroff, and the editing of ISMS document in 
> xml2rfc. What
> > a difference!!! You will quickly gain back the time it 
> takes to learn
> > the xml2rfc tool in the time saved editing a document.
> > 
> > Comments welcome,
> > David Harrington
> > dbharrington@comcast.net
> > 
> > 
>