Invisible Worlds, Inc.

660 York Street San Francisco CA 94110 US +1 415 695 3975 mrose@not.invisible.net http://invisible.net/

General RFC Request for Comments I-D Internet-Draft XML Extensible Markup Language Aquí se presenta una técnica para usar XML ('Extensible Markup Language') como formato fuente para los documentos de las series Borradores-Internet ('Internet-Drafts', I-D) y Petición de Comentarios ('Request For Comments', RFC).

Este documento describe cómo escribir un documento para las series I-D y RFC usando el Lenguaje de Marcado Extensible (XML, Extensible Markup Language). Este documento tiene tres objetivos: Describir una Definición de tipo de documento XML (DTD) que sea adecuada para expresar los sencillos requerimientos de formato de los documentos RFC y que al mismo tiempo permita un marcado comprensible con cualidades descriptivas. Describir el software que procesa los archivos fuente XML, incluida una herramienta que produce documentos conformes al RFC 2223, formato HTML, etc... Proporcionar un ejemplo para los dos primeros objetivos (este documento fue escrito usando dicha DTD y producido con el software mencionado). La discusión sobre las ramificaciones políticas derivadas del uso de XML como formato fuente para documentos RFC queda fuera del alcance de este documento. Simplemente se hace destacar que la adición de un mínimo de marcado al texto plano: permite la producción tradicional de documentos de texto RFC usando editores conocidos. requiere mínimas modificaciones en los entornos de software existentes y permite organizar, buscar y obtener la información tanto con mecanismos estructurados como no estructurados.

No vamos a proporcionar aquí una descripción formal o comprensiva de XML. En esta sección trataremos de lo mínimo imprescindible de XML para poder usar una Definición de tipo de documento (DTD) para escribir documentos RFC. Si ya conoce XML, pase al para examinar la DTD.

Existen muy pocas reglas a la hora de escribir en XML, ya que la sintaxis es simple. Hay cinco términos que necesitará conocer: Un "elemento" se refiere normalmente a una etiqueta inicial, una etiqueta de final y a todos los caracteres entre ambas, p. ej., "<ejemplo>texto y/o elementos anidados</ejemplo>" Un "elemento vacío" combina la etiqueta inicial y la final, p. ej., "<vacio/>". Este tipo de elementos no existe en HTML. Un "atributo" es parte de un elemento. Si está presente, aparece en la etiqueta inicial, p. ej., "<ejemplo nombre='valor'>". Por supuesto también pueden aparecer en elementos vacíos, p. ej., "<vacio nombre='valor'/>". Una "entidad" es una macro textual que comienza con "&". No se preocupe por ellas, pues sólo las usará cuando tenga que escribir un símbolo "&" o "<" en su texto. Un "símbolo" es una cadena de caracteres. El primer carácter es una letra o un guión bajo ("_"). Los demás caracteres pueden ser letras, números, un guión bajo o un punto (".").

Lo primero es comenzar el archivo fuente con una declaración XML, una referencia a la DTD y el elemento "rfc": &rfc.number; ... ]]> Ignore las dos primeras líneas (la declaración y la referencia) y trátelas como si fueran incomprensibles. No debe aparecer nada a continuación de la etiqueta "</rfc>".

En segundo lugar, asegúrese de que todos los elementos están correctamente emparejados y anidados. Un elemento correctamente emparejado que comience con "<ejemplo>" aparecerá eventualmente seguido de "</ejemplo>" (los elementos vacíos siempre están emparejados). Los elementos están correctamente anidados cuando no se solapan.

Por ejemplo, ... ... ... ]]> está correctamente anidado.

Sin embargo, ... ... ... ]]> se solapa y por tanto los elementos no están correctamente anidados.

En tercer lugar, nunca utilice "<" o "&" en su texto. En su lugar, use "<" o "&amp;", respectivamente. En cuarto lugar, existen dos caracteres de entrecomillado en XML: 'apóstrofe' y "comilla". Asegúrese de que todos los valores de atributo están entrecomillados, p. ej., "<ejemplo nombre='valor'>". Si el valor contiene alguno de los caracteres de entrecomillado, use el otro carácter para entrecomillarlo, p. ej., "<ejemplo nombre='"'>". Si contiene ambos caracteres, utilice uno de ellos para entrecomillar el valor y sustituya todas las ocurrencias de dicho carácter en el valor del atributo con '&apos;' para el apóstrofe o "&quot;" para las comillas, p. ej., "<ejemplo nombre='"&apos;"'>".

Si desea poner un comentario en su archivo fuente, esta es la sintaxis: ]]>

Y por último, comentar que XML distingue entre mayúsculas y minúsculas.

A continuación de la etiqueta "<rfc>" aparece el elemento "front": &rfc.number; ]]>

Cada elemento 'author' representa a uno de los autores del documento. Como puede existir más de un autor, puede aparecer más de un elemento "author". Si el autor es una persona deberán aparecer tres atributos en la etiqueta "<author>": "initials", "surname" y "fullname", p. ej., ]]>

El elemento 'author' contiene un elemento 'organization' y un elemento 'adress' opcional.

El elemento "organization" es parecido al elemento "title", ya que se puede incluir una abreviatura junto al nombre completo de la organización usando el atributo "abbrev", p. ej., USC/Information Sciences Institute ]]>

El elemento "adress" está formado a su vez por un elemento "postal" opcional, un elemento "phone" opcional, un elemento "facsimile" opcional, un elemento "email" opcional y un elemento "uri" opcional.

El elemento "postal" contiene uno o más elementos "street", seguidos de cualquier combinación de los elementos "city", "region" (estado o provincia), "code" (codigo postal o 'zipcode') y "country", p. ej., 660 York Street M/S 40 San Francisco CA 94110 US ]]> Esta flexibilidad permite distintos formatos nacionales para las direcciones postales. Nótese sin embargo que aunque no se especifica el orden de los elementos "city", "region", "code" y "country", como máximo puede aparecer uno de cada uno. Además de ésto, los elementos no deben ser reordenados durante el procesamiento mediante una aplicación XML (es decir, las aplicaciones de presentación deben preservar el orden de la información contenida en estos elementos). Finalmente, el valor del elemento "country" debe ser un código de dos letras ISO 3166.

Los elementos "phone", "facsimile", "email y "uri" son sencillos, p. ej., +1 415 695 3975 mrose@not.invisible.net http://invisible.net/ ]]>

El elemento "date" indica la fecha de publicación del documento. Está formado por un mes y un año, p. ej., ]]> El elemento "date" también incluye un atributo opcional "day".

El elemento "front" puede contener metadatos (cuyo contenido no aparece en las versiones impresas del documento).

Un documento tiene uno o más elementos opcionales "area", "workgroup" y "keyword", p. ej., General Grupo de trabajo de embellecimiento de RFC RFC Request for Comments Petición de Comentarios I-D Internet-Draft Borrador de Internet XML Lenguaje de marcado extensible ]]> El elemento "area" indica una categoría general para el documento (p. ej. una de las siguientes: "Aplicaciones", "General", "Internet", "Gestión", "operaciones", "Encaminamiento", "Seguridad", "Transporte" o "Usuario"), mientras que los elementos "workgroup" representan los grupos de trabajo del IETF que han producido el documento y los elementos "keyword" indican términos de búsqueda útiles.

Un documento puede tener un elemento "abstract", el cual contiene uno o más elementos "t". Normalmente aparece un único elemento "t", p. ej., Este memorándum presenta una técnica para utilizar XML (Lenguaje de marcado extensible) como formato fuente para documentos de las series Borradores de Internet (I-D) y Petición de comentarios (RFC). ]]>

Un documento puede tener uno o más elementos "note", cada uno de los cuales contiene uno o más elementos "t". Hay un atributo "title" obligatorio . Normalmente, el elemento "note" contiene texto del IESG, p. ej., El IESG tiene algo que decir. ]]>

Nótese que el texto relacionado con el estado del memorándum, la nota de copyright y el índice no está incluido en el marcado del documento: es automáticamente insertado por la aplicación XML cuando produce una versión HTML o de texto plano del documento.

Si se quiere producir un Borrador de Internet ('Internet-Draft'), el atributo "ipr" debe aparecer en la etiqueta "<rfc>", al principio del documento. El valor del atributo debe ser uno de los siguientes: Indica que el documento es completamente conforme a todas las disposiciones de la Sección 10 del RFC 2026. Indica que el documento es completamente conforme a todas las disposiciones de la Sección 10 del RFC 2026, excepto que no se concede el derecho a producir trabajos derivados. Indica que el documento NO cumple las disposiciones de la Sección 10 del RFC 2026 y el autor no cede ningún derecho al IETF, excepto el de publicarlo como Borrador de Internet. En el último caso no se insertará automáticamente ninguna nota de copyright durante el procesamiento por medio de una aplicación XML. Consulte para más detalles.

Por último, si el Borrador de Internet se está sometiendo a un proceso automatizado, el atributo "docName" debe aparecer en la etiqueta "<rfc>" al principio del archivo. El valor de este atributo contiene el nombre del documento (no del archivo) asociado con este Borrador de Internet, p. ej., ... ]]>

Juntándolo todo obtenemos, p. ej., Invisible Worlds, Inc.

660 York Street M/S 40 San Francisco CA 94110 US +1 415 695 3975 mrose@not.invisible.net http://invisible.net/

General Grupo de trabajo de embellecimiento de RFC RFC Petición de Comentarios Request for Comments I-D Borrador de Internet Internet-Draft XML Extensible Markup Language Este memorándum presenta una técnica para utilizar XML (Lenguaje de marcado extensible) como formato fuente para documentos de las series Borradores de Internet (I-D) y Petición de comentarios (RFC). ]]>

El elemento "middle" contiene todas las secciones del documento excepto la bibliografía y los apéndices:

... ]]> El elemento "middle" está formado por uno o más elementos "section".

Cada elemento "section" contiene una sección del documento. Tiene un atributo obligatorio, "title", que indica el título de la sección. Existe también un atributo opcional, "anchor", usado para las referencias cruzadas con el elemento "xref", p. ej., ...

]]>

El elemento "section" es recursivo: puede contener cualquier número y combinación de elementos "t", "figure" y "section", p. ej., ...

...

...

...

...

...

...

...

]]>

El elemento "t" contiene cualquier número y combinación de párrafos, listas y figuras. Si se necesita una referencia cruzada a una sección, figura o referencia, se utiliza el elemento "xref". De forma similar, si se necesita una referencia externa, se usa el elemento "eref". La indexación de texto se realiza mediante el elemento "iref".

El elemento "list" contiene uno o más ítems. Cada ítem es un ele- mento "t", estando permitida la recurrencia, p. ej., El primer item. El segundo item, que contiene dos sub-items con viñetas El primer sub-item. El segundo sub-item. ]]> El elemento "list" tiene un atributo opcional, "style", que puede tomar los valores "numbers" (para listas numeradas), "symbols" (para listas con viñetas), "hanging" (para listas con sangría francesa) o "empty" (para texto tabulado). Si un elemento "list" está anidado, se toma el valor por defecto del elemento padre; en caso contrario el valor por defecto es "empty".

El elemento "t", cuando está dentro de un elemento de tipo "lista con sangría francesa", tiene un atributo opcional, "hangText", que indica el texto a insertar, p. ej., Indica que el documento es completamente conforme a todas las disposiciones de la Sección 10 del RFC 2026; Indica que el documento es completamente conforme a todas las disposiciones de la Sección 10 del RFC 2026, excepto que no se concede el derecho a producir trabajos derivados. Indica que el documento NO cumple las disposiciones de la Sección 10 del RFC 2026 y el autor no cede ningún derecho al IETF, excepto el de publicarlo como Borrador de Internet. ]]>

El elemento "figure" está formado a un elemento "preamble" opcional, un elemento "artwork" y un elemento "postamble" opcional. El elemento "figure" también tiene un atributo "anchor" opcional, que se utiliza para hacer referencias cruzadas con el elemento el elemento "xref". También existe el atributo opcional "title", que indica el título de la figura. Los elementos "preamble" y "postamble", si aparecen, son simple- mente texto. Si se necesita poner una referencia cruzada a una sección, figura o referencia, se usa el elemento "xref". De igual manera, si es necesario indicar una referencia externa se utiliza el elemento "eref". La indexación de texto se efectúa mediante el elemento "iref". El elemento "artwork", que debe aparecer, contiene "arte ASCII". A diferencia del texto contenido en los elementos "t", "preamble" o "postamble", en el elemento "artwork" no se ignoran los espacios en blanco horizontales o verticales.

Por tanto, juntándolo todo tenemos, p. ej., Por tanto, juntándolo todo tenemos, p. ej., Escriba aquí su arte ASCII... ¡asegúrese de utilizar "<" o "&" en lugar de "<" y "&" respectivamente! que es un ejemplo muy simple.

]]> que es un ejemplo muy simple.

Si sus figuras ASCII contienen muchos caracteres "<", hay un truco de XML que puede utilizar: <figure> <preamble>Si sus figuras ASCII contienen muchos caracteres "&lt;", hay un truco de XML que puede utilizar:</preamble> <artwork><![CDATA[ Escriba aquí su arte ASCII... ¡Asegúrese de no utilizar "]]"! ]]></artwork> <postamble>A la construcción "&lt;![CDATA[ ... ]]>" se la denomina bloque CDATA: Las aplicaciones XML ignorarán todo lo que aparezca dentro de los corchetes más internos.</postamble> </figure> A la construcción "<![CDATA[ ... ]]>" se la denomina bloque CDATA: Las aplicaciones XML ignorarán todo lo que aparezca dentro de los corchetes más internos.

Como el elemento "figure" representa un agrupamiento lógico de texto y figuras, una aplicación XML que produzca una versión en texto plano del documento deberá intentar mantener estos elementos en la misma página. Debido a que el RFC 2223 no permite más de 69 caracteres por 49 líneas de contenido en cada página, las apli- caciones XML deberán estar preparadas para introducir saltos de página anticipadamente para permitir un mejor agrupamiento visual. Por último, el elemento "artwork" tiene dos atributos opcionales: "name" y "type". El primero se utiliza para sugerir un nombre de archivo al almacenar el contenido del elemento "artwork", mientras el segundo especifica un tipo orientativo para el contenido.

El elemento "xref" se utiliza para indicar referencias cruzadas a secciones, figuras y referencias. El atributo obligatorio "target" sirve para enlazar con el atributo "anchor" del elemento "section", "figure" y "reference". El valor de los atributos "anchor" y "tar- get" debe cumplir el formato indicado en la sintaxis de símbolo de la .

Si se utiliza como un elemento vacío, p. ej., . ]]> la aplicación XML inserta una frase apropiada durante el proce- samiento, como "Sección 2.1" o XML Basics"]]>.

Si se usa con contenido, p. ej., RFC 2223. ]]> la aplicación XML inserta una indicación apropiada durante el proce- samiento, como "RFC 2223 [2]" o RFC 2223"]]>. Aunque es la aplicación XML la que decide qué es una "indicación apropiada", dicha elección es consistente a lo largo del procesamiento de todo el documento.

El elemento "eref" se utiliza para indicar referencias a documentos externos. El atributo obligatorio "target" es un URI, p. ej, Café con Leche ]]>

Nótese que, aunque el atributo "target" está siempre presente, el elemento "eref" puede estar vacío, p. ej., ]]> y la aplicación XML inserta una indicación apropiada durante el procesamiento, como "[9]" o http://invisible.net/"]]>.

El elemento "iref" se utiliza para añadir información a un índice analítico. El atributo obligatorio "item" indica la clave principal bajo la cual aparece la información, mientras que el atributo opcional "subitem" es la clave secundaria; p. ej., ]]>

Por último, nótese que el elemento "iref" es siempre vacío: nunca contiene texto.

El autor utiliza el elemento "vspace", que sólo puede aparecer dentro del elemento "t", para instruir a la aplicación XML sobre cuestiones de formato. El atributo "blankLines" indica el número de líneas en blanco que se deben insertar. Un salto de línea físico se especifica usando el valor por defecto, "0".

Además, el elemento "vspace" puede utilizarse para forzar un nuevo párrafo dentro de un ítem de una lista, p. ej., Esto es un item de una lista. Esto es parte del mismo ítem de la lista, pero al ser mostrado aparece como un párrafo separado. ]]>

Una aplicación XML que produzca una versión texto del documento debe tener cuidado al encontrar un valor de "blankLines" que ocasiona un salto de página: en particular, si un elemento "vspace" provoca un salto de página no se deben añadir más saltos de línea después. Esto permite a los autores "forzar" un salto de página usando un valor arbitrariamente largo, p. ej., "blankLines='100'". Por último, nótese que el elemento "vspace" siempre es vacío: nunca contiene texto.

Por último, el elemento "back" se utiliza para incluir referencias y apéndices:

]]> El elemento "back" está formado por un elemento "references" opcional y uno o más elementos "section" opcionales. El elemento "back" propiamente dicho es opcional, es decir, si su documento no necesita de referencias o apéndices no es necesario incluirlo.

El elemento "references" contiene la bibliografía del documento. Contiene uno o más elementos "reference". Cada elemento "reference" contiene un elemento "front" y uno o más elementos "seriesInfo" opcionales. Ya hemos hablado del elemento "front" en la . El elemento "seriesInfo" tiene dos atributos, "name" y "value" que identifican las series de documentos y la entrada en la serie, respectivamente.

El elemento "reference" tiene un atributo opcional "anchor" que se utiliza con el elemento "xref" para las referencias cruzadas, p. ej., USC/Information Sciences Institute ]]>

El elemento "reference" tiene también un atributo "target" opcional que se utiliza para las referencias externas (véase la ). La aplicación XML, si produce una versión HTML del docu- mento, usará el atributo "target" de la forma apropiada. Sin embargo, si el atributo "name" del elemento "seriesInfo" tiene el valor "RFC", entonces la aplicación XML deberá proporcionar automáticamente un valor por defecto para el atributo "target" (p. ej. ).

Para incluir apéndices tras la bibliografía se añaden simplemente más elementos "section". (Ver el ejemplo al principio de la .)

El estado del copyright del documento no está incluido en el marcado del documento: es insertado automáticamente por la aplicación XML encargada de producir la versión texto o HTML del documento.

Esta sección trata sobre aplicaciones que trabajan con un archivo fuente XML. Hay muchas herramientas XML disponibles, así como muchas listas de recursos XML, p. ej., Cafe con Leche. Hay dos tipos de herramientas XML: certificadoras y no certificado- ras. Ambos tipos comprueban que el archivo fuente cumpla las reglas dadas en la . Sin embargo, además de asegurarse de que el archivo fuente está bien formado, una herramienta certificadora lee también la DTD referenciada por el archivo fuente para asegurarse de que concuerdan. Existen varias herramientas disponibles, tanto certi- ficadoras como no certificadoras.

Existen varios editores XML disponibles. En un caso ideal, se deseará disponer de un editor que certifique. Esto tiene dos ventajas: proporciona ayuda a la hora de desarrollar la estructura del documento, y comprueba que el archivo fuente concuerda con las reglas de la DTD.

Existen dos modos principales en Emacs que soportan XML: tdtd and psgml. El último permite validar el archivo fuente (llamando a un programa externo). Si se edita el archivo fuente con Emacs y el modo principal no es "SGML" o "XML", normalmente sólo hay que añadir estas líneas al archivo ".emacs": y reiniciar Emacs. Si no funciona, pruebe con alguno de los recursos vistos más arriba.

Para editar los archivos fuente, el autor utiliza el modo sgml de Emacs y un editor certificador comercial, llamado Clip! version 1.5

Si su editor no valida, deberá utilizar un programa que valide el archivo fuente. Para este propósito el autor utiliza el analizador AlphaWorks XML. Este requiere que el sistema tenga una máquina virtual Java. Además de en Java, existen analizadores escritos en C, Perl, Python y Tcl.

El autor ha escrito la herramienta xml2rfc, que lee el archivo fuente y produce una versión en texto y otra HTML del documento. (Este documento fue creado usando la herramienta xml2rfc). Tenga en cuenta que xml2rfc no es una herramienta certificadora, así que es una buena idea usar un editor certificador o ejecutar un analizador certificador aparte antes de usar la herramienta.

El Lenguaje de Estilo XML (XML Style Language, XSL) se utiliza para describir transformaciones desde un archivo fuente a algún otro docu- mento estructurado. Así que lo ideal sería utilizar un formateador XSL para convertir el archivo fuente XML a HTML. Sin embargo, en el momento de escribir esto XSL está aún en un estado de considerable incertidumbre (por tanto no se ha incluido ninguna referencia en este documento, ya que para cuando lea este documento las referencias serán obsoletas). Así que, entretanto, el autor uti- liza la herramienta xml2rfc para esta tarea, aún cuando no propor- ciona demasiada flexibilidad en su diseño HTML.

Los navegadores que soportan XSL u Hojas de estilo en cascada (Cas- cading Style Sheets, CSS) son capaces de mostrar el archivo fuente directamente. A fecha de hoy el autor no utiliza ninguno de estos navegadores, sino que realiza la conversión de los archivos fuente a texto o a HTML.

Al igual que los editores de texto, se puede utilizar cualquier herramienta de búsqueda orientada a texto (p. ej. grep) con el archivo fuente. Sin embargo, existen herramientas de búsqueda que entienden la información estructurada.

El autor utiliza la sgrep version 1.9 para ello, p. ej., sgrep -g xml 'ELEMENTS("title") not in ELEMENTS("back")' \ writing-rfcs.xml que extrae el elemento "title" del archivo fuente.

Este documento no plantea cuestiones de seguridad. Sin embargo, de acuerdo con , su documento debe contener una sección cerca del final que trate las consideraciones de seguridad del protocolo o pro- cedimientos que constituyen el asunto principal del documento, p. ej., ...

Este documento no plantea cuestiones de seguridad. Sin embargo, de acuerdo con , su documento debe contener una sección cerca del final que trate las consideraciones de seguridad del protocolo o procedimientos que constituyen el asunto principal del documento.

]]>

World Wide Web Consortium

MIT Laboratory for Computer Science 545 Technology Square Cambridge MA 02139 US + 1 617 253 2613 + 1 617 258 5999 timbl@w3.org http://www.w3c.org

USC/Information Sciences Institute

4676 Admiralty Way Marina del Rey CA 90292 US +1 310 822 1511 +1 310 823 6714 Postel@ISI.EDU

USC/Information Sciences Institute

4676 Admiralty Way Marina del Rey CA 90292 US +1 310 822 1511 +1 310 823 6714 jkrey@isi.edu

(N.T. existe versión en español) Harvard University

Holyoke Center, Room 813 1350 Massachusettes Avenue Cambridge MA 02138 US +1 617 495 3864 sob@harvard.edu

World Wide Web Consortium

MIT Laboratory for Computer Science 545 Technology Square Cambridge MA 02139 US +1 617 253 5702 +1 617 258 8682 timbl@w3.org

University of California, Irvine

Department of Information and Computer Science University of California, Irvine Irvine CA 92697-3425 US +1 949 824 7403 +1 949 824 1715 fielding@ics.uci.edu

Xerox PARC

3333 Coyote Hill Road Palo Alto CA 94304 US +1 650 812 4365 +1 650 812 4333 masinter@parc.xerox.com

Cuando la etiqueta "<rfc>", presente al principio del archivo, con- tiene únicamente un atributo "ipr", se produce un Borrador de Internet. Sin embargo, cuando el editor RFC añade otros atributos a esta etiqueta, se produce un RFC, p. ej., ]]> Como mínimo debe aparecer el atributo "number".

Los otros atributos son: "obsoletes", que contiene una lista de números de RFC que el documento deja obsoletos, separados por comas. "updates", que contiene una lista de números de RFC que el documento actualiza, separados por comas. "category", que puede tomar uno de estos valores: "std", para un documento de Seguimiento de estándar (Standards-Track); "bcp", para un documento de Mejores prácticas actuales (Best Current Practices); "exp", para un documento de Protocolo Experimental; "historic", para un documento histórico, o "info", el valor por defecto, para un documento Informativo; "seriesNo", que contiene el número correspondiente en la serie STD (std), BCP (bcp) o FYI (info). Por último, existe una entidad especial, "&rfc.number". Los autores que preparen un RFC deben utilizar esta entidad siempre que quieran hacer referencia al número del RFC dentro del propio documento. En las versiones impresas del documento, aparecerá la sustitución apropiada (o "XXXX").

&rfc.number; ]]>

El autor agradece sinceramente las contribuciones de: Alan Barrett, Brad Burdick, Brian Carpenter, Steve Deering, Patrik Faltstrom, Jim Gettys, Carl Malamud, Chris Newman, Kurt Starsinic, and, Frank Strauss.