[rfc-i] Graphics and XML

dhc at dcrocker.net (Dave Crocker) Tue, 10 July 2012 15:17 UTC

From: "dhc at dcrocker.net"
Date: Tue, 10 Jul 2012 08:17:27 -0700
Subject: [rfc-i] Graphics and XML
In-Reply-To: <4FFC454C.5050204@gmx.de>
References: <4FF74695.2060701@gmx.de> <CC1D097E.15D49%jhildebr@cisco.com> <CAMm+Lwi1NR+Sq4gkaSLKHJpeEqPPHxCyindC4m52ZuF+Q+fZQQ@mail.gmail.com> <4FFBAFBF.8010104@it.aoyama.ac.jp> <CAMm+LwguQL4HRqFUB3T8QVK_LnnRmrWSrxpPrJDSC+0KD4QStQ@mail.gmail.com> <4FFC2247.3040008@gmx.de> <F85C55DF-AECC-4E9E-ABE9-CC1B96768B94@checkpoint.com> <F33933E2-D14C-4F0C-AFFC-2025D73EDE5A@vpnc.org> <4FFC454C.5050204@gmx.de>
Message-ID: <4FFC4787.5060308@dcrocker.net>

On 7/10/2012 8:07 AM, Julian Reschke wrote:
> On 2012-07-10 16:57, Paul Hoffman wrote:
>> On Jul 10, 2012, at 6:39 AM, Yoav Nir wrote:
>>
>>> The other problem that keeps coming up is people wanting to add
>>> images, graphs and formulas to documents. XML2RFC as it currently
>>> stands is just as ill-suited for this as nroff.
>>
>> Adding an image to an XML document is trivial: you use a stable URL.
>> See draft-hoffman-rfcformat-canon-others for more detail.
>> ...
>
> That's a *bit* misleading; it's sufficient to specify the location
> relative to the source text file (or even to inline it as data: URI).
>
> Example:
> <http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#rfc.section.12.2>
>
>
> But yes, a stable, absolute URI would work as well.



I've cited this before, but to provide a real-world example for an 
existing RFC, take a look at the three versions of RFC 5598:

    http://bbiw.net/recent.html#emailarch

All were generated from a single xml2rfc source, using a construct form 
that I think is pretty straightforward.  It contains a citation to a 
'local' file and then an ascii-art version of the diagram.  The pdf and 
html versions use the pretty form and the txt version uses the ascii 
art.  xml2rfc generates these automatically.

For example:

> <figure
> 					align="center"
> 					anchor="Basic"
> 					title="Basic Internet Mail Service Model">
>
> 					<?rfc needLines="28" ?>
> 					<artwork
> 						align="center"
> 						alt="[ User, MHS, User Service Model ]"
> 						name="Basic Internet Mail Service Model"
> 						src="email-arch-fig-svcmodel.png"
> 						type="image/png">
> 						<![CDATA[
>                                +--------+
>             ++================>|  User  |
>             ||                 +--------+
>             ||                      ^
> +--------+  ||          +--------+  .
> |  User  +==++=========>|  User  |  .
> +---+----+  ||          +--------+  .
>     .       ||               ^      .
>     .       ||   +--------+  .      .
>     .       ++==>|  User  |  .      .
>     .            +--------+  .      .
>     .                 ^      .      .
>     .                 .      .      .
>     V                 .      .      .
> +---+-----------------+------+------+---+
> |   .                 .      .      .   |
> |   .................>.      .      .   |
> |   .                        .      .   |
> |   ........................>.      .   |
> |   .                               .   |
> |   ...............................>.   |
> |                                       |
> |     Message Handling Service (MHS)    |
> +---------------------------------------+
>
> Legend: === lines indicate primary (possibly indirect)
>             transfers or roles
>         ... lines indicate supporting transfers or roles]]></artwork>
> 				</figure>






-- 
  Dave Crocker
  Brandenburg InternetWorking
  bbiw.net