Manual del Usuario de XMLEye

Antonio García Domínguez

Universidad de Cádiz


    
  

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.


Tabla de contenidos

1. Instalación del programa
Instalación desde paquetes Debian
Instalación manual para un único usuario
Instalación manual a nivel del sistema
2. Instalación de extensiones de XMLEye
Instalación de hojas de usuario
Instalación de nuevos tipos de documento
Instrucciones específicas para las hojas y tipo de documento de ACL2
Instalación mediante paquetes Debian
Instalación manual a partir de fuentes
3. Uso y configuración
Apertura y edición de documentos
Navegación por los documentos
Personalización de la presentación
Personalización de los tipos de documento
A. GNU Free Documentation License

Capítulo 1. Instalación del programa

En este capítulo cubriré la instalación del programa en sus diferentes formas, tanto a nivel de usuario como a nivel de sistema. Para instalar hojas de usuario para nuevos tipos de documento, referirse al capítulo Capítulo 2, Instalación de extensiones de XMLEye.

Instalación desde paquetes Debian

Esta es la opción a seguir siempre que sea posible, ya que además de ser más sencilla, permitirá recibir actualizaciones de forma automática.

Los paquetes han sido desarrollados para Ubuntu Gutsy, pero deberían funcionar en cualquier distribución basada en Debian reciente. Si lo conseguís, enviadme un correo y lo añadiré aquí.

Los pasos a seguir son:

  1. Descargaremos la firma digital de los paquetes disponible bajo http://www.shoyusauce.org/packages/claveDebian.asc.

  2. Añadiremos la firma al anillo de confianza de Apt. En primer lugar lanzaremos la opción SistemaAdministraciónOrígenes de software bajo el menú principal de GNOME.

    Hecho esto, seleccionaremos la pestaña Autentificación y pulsaremos en el botón Importar clave..., tras lo cual seleccionaremos la firma que antes descargamos.

    Aún no cerraremos la ventana: nos queda una cosa por hacer.

  3. Ahora añadiremos los repositorios de paquetes binarios y paquetes de fuentes de XMLEye y sus hojas de estilos. Esta vez iremos a la pestaña Software de terceros.

    Pulsaremos en Añadir e introduciremos esta línea tal y como está:

    deb http://www.shoyusauce.org/packages/ubuntu/ gutsy main

    Volvemos a pulsar en Añadir, pero esta vez introducimos esta línea:

    deb-src http://www.shoyusauce.org/packages/ubuntu/ gutsy main

    Ya podemos pulsar en Cerrar para cerrar este diálogo, y solicitar la actualización de nuestras listas de paquetes en el diálogo subsecuente pulsando en Recargar. Una vez haya terminado, estaremos listos para instalar XMLEye y otros paquetes de apoyo, como pprocACL2.

  4. Lanzaremos SistemaAdministraciónGestor de paquetes Synaptic y pulsaremos en el botón Buscar de la barra de herramientas.

    Introduciendo "xmleye" en el campo de búsqueda obtendremos un único resultado en el que podremos hacer doble clic para marcar para su instalación. También podríamos seleccionar otros paquetes con hojas de estilos definidas por el usuario, como "libacl2-procesador-perl", de la misma forma.

    Una vez todos los paquetes que deseamos instalar se hallen marcados, pulsaremos en Aplicar de la barra de herramientas para confirmar los cambios.

  5. ¡Listo! Ya podemos lanzar XMLEye a través de AplicacionesAccesoriosXMLEye del menú principal de GNOME.

    Sólo un detalle: todas las opciones que establezcamos irán a parar al subdirectorio .xmleye bajo nuestro directorio personal, es decir, /home/nombredeusuario.

La ruta bajo la cual tendremos que instalar las hojas de usuario será /usr/share/xmleye/xslt, y en /usr/share/xmleye/types se hallarán los descriptores de tipo.

Instalación manual para un único usuario

Antes de seguir, tendremos que instalar por nuestra cuenta un entorno de Java compatible con J2SE 6.0 o superior. La opción más sencilla es usar IcedTea (el JRE de Sun también funciona, pero nos obliga a firmar la licencia DLJ primero):

sudo aptitude install icedtea-java7-jre

Supongamos que no podemos usar los paquetes Debian. ¿Qué podemos hacer? En el caso de un único usuario no es complejo en absoluto: sólo hay que descargar el último tar.bz2 de distribución de https://forja.rediris.es/frs/?group_id=233 y descomprimirlo bajo nuestro directorio personal.

Para ejecutar XMLEye, basta con ejecutar el guión /home/tunombredeusuario/xmleye/xmleye tras pulsar la combinación ALT+F2. Una opción más cómoda para los habituales de la línea de órdenes es añadir la siguiente línea a ~/.bashrc:

export PATH=$PATH:~/xmleye

Haciendo esto, se puede abrir cualquier documento compatible desde la línea de órdenes mediante:

xmleye (ruta absoluta o relativa)

Según este procedimiento, las hojas de usuario se instalarán en /home/tunombredeusuario/xmleye/xslt, y los descriptores de tipo en /home/tunombredeusuario/xmleye/types. Las opciones se guardarán en /home/tunombredeusuario/xmleye.

Instalación manual a nivel del sistema

Un caso más complejo es cuando queremos instalarlo para varios usuarios, pero queremos tener ajustes distintos para cada usuario (las hojas son comunes a todos). Al igual que en el caso anterior, tendremos que tener un JRE compatible con J2SE 6.0 o superior antes que nada, pero después usaremos una distribución diferente de los ficheros.

La distribución "ideal" sería la del paquete Debian, pero como es un poco más compleja de lo que necesitamos, nos limitaremos a un término medio. Primero descomprimiremos la última distribución de XMLEye (el enlace de descarga está en la sección anterior) a /opt, que crearemos si no existe ya:

sudo mkdir /opt
cd /opt
sudo tar xjf (ruta a distribución)

Tendremos que retocar el guión de lanzamiento un poco. XMLEye cuenta con dos variables de entorno, XMLEYE_PREF_DIR y XMLEYE_TYPES_DIR, que indican la ruta en la que se guardarán las preferencias y los tipos personalizados por el usuario.

Además, XMLEye supone que los ficheros de datos se hallan bajo la ruta sobre la cual es lanzado. La ruta en la que se halla el .jar no es realmente de importancia.

Con toda esta información, basta con sustituir las líneas que afectan a PROGRAM_DIR y PROGRAM_JAR por:

PROGRAM_DIR=/opt/xmleye
PROGRAM_JAR=xmleye.jar
export XMLEYE_PREF_DIR=${HOME}/.xmleye
export XMLEYE_TYPES_DIR=${HOME}/.xmleye
mkdir -p ${XMLEYE_PREF_DIR}

De forma similar a la sección anterior, los usuarios podrían directamente ejecutar XMLEye a través de la ruta completa. Para que todos los usuarios puedan ejecutar XMLEye por nombre, se puede añadir esta línea a /etc/environment:

export PATH=$PATH:/opt/xmleye

Si queremos que aparezca una entrada de menú y que se asocien los ficheros XML con XMLEye, entonces tendremos que, además de seguir el paso anterior, crear el fichero /usr/share/applications/xmleye.desktop con este contenido:

[Desktop Entry]
Encoding=UTF-8
Version=1.0
Type=Application
Terminal=false
Exec=xmleye %U
Comment[es]=Visor genérico de XML dirigido por datos
Name=XMLEye
Comment=Generic data-driven XML Viewer
GenericName=Generic XML viewer
GenericName[es]=Visor genérico de XML
Icon=accessories-text-editor
Categories=Utility;TextEditor;
MimeType=application/xml;

Actualizaremos las bases de datos y reiniciaremos los menús de GNOME con:

sudo update-desktop-database
sudo update-menus
sudo killall gnome-panel nautilus

Ya debería de aparecer la entrada de XMLEye en el menú principal de GNOME.

Las hojas de usuario estarán bajo /opt/xmleye/xslt, y los descriptores de tipo en /opt/xmleye/types.

Capítulo 2. Instalación de extensiones de XMLEye

Instalación de hojas de usuario

Una hoja de usuario nos permite mejorar XMLEye en una de las siguientes formas:

  • Ver la estructura de un documento XML de otra forma. Un ejemplo sería ver sólo un resumen del documento, cambiar el orden para su preprocesamiento, o decorar los nodos del árbol con nuevas etiquetas e iconos.

  • Ver el contenido de un nodo del documento de otra forma. Podemos hacer cualquier cosa que se nos ocurra con HTML 4.0 y CSS (no hay soporte para Javascript), y establecer vínculos entre nodos del árbol y nodos de otros documentos.

Realmente, no son más que conjuntos de hojas XSLT que siguen una determinada estructura para permitir su localización y su integración con otras hojas, ya que una hoja de usuario puede ser una especialización de otra hoja.

La ruta donde se guardan las hojas de usuario variará dependiendo del método de instalación que hayamos seguido. Para más detalles, referirse al capítulo Capítulo 1, Instalación del programa. Nos encontraremos bajo dicha ruta una serie de ficheros (sólo de interés para desarrolladores) y dos subdirectorios, preproc y view, en cuyo interior habrá un subdirectorio por hoja de usuario de preprocesado o visualización, respectivamente.

Instalar una hoja de usuario no es más entonces que asegurarnos que su subdirectorio se halle en el lugar correcto, y reiniciar XMLEye. Encontraremos entradas con los mismo nombre que los subdirectorio correspondientes en las entradas PreferenciasPreprocesamiento y PreferenciasVisualización de XMLEye. Por defecto siempre tendremos instalado como mínimo las hojas de usuario de preprocesado y visualización xml.

Instalación de nuevos tipos de documento

A pesar del nombre, XMLEye puede visualizar cualquier tipo de documento, usando un preprocesador si no se trata de un documento XML originalmente, e integrarse con su editor (monitorizando el fichero en busca de cambios) siempre que se le dé la información correspondiente. Esa información viene integrada en un descriptor de tipo de documento.

Dichos descriptores se nombran usando la extensión y siguen un formato XML sencillo, en cuyos detalles no entraremos aquí (véase el Manual del Desarrollador). Lo único que nos importa es su instalación, que es tan sencilla como copiar el fichero correspondiente a la ruta de tipos que le corresponde según el tipo de instalación que hayamos realizado.

Una vez instalado y reiniciado XMLEye, podremos abrir cualquier documento que tenga las extensiones especificadas en el tipo de documento instalado sin más problemas, siempre que su editor y preprocesador (si tiene alguno) se hallen debidamente instalados en una ruta que forme parte de la variable de entorno PATH.

Instrucciones específicas para las hojas y tipo de documento de ACL2

Como muestra de las capacidades de XMLEye, desarrollé en paralelo un conjunto de hojas de usuario de preprocesado y visualización, junto con un tipo de documento para ACL2. Esto nos permite demostraciones para dicho sistema en formato .lisp siguiendo una estructura arbórea donde cada nodo se muestra como un hipertexto con enlaces a otras partes de la demostración.

La subcarpeta t/testInputs del fichero de fuentes con nombre de la forma ACL2-Procesador-*.tar.gz más reciente contiene algunos ejemplos de interés, extraídos de tutoriales reales de aprendizaje del uso de ACL2.

Hay básicamente dos formas de instalar este conjunto de ejemplo:

Instalación mediante paquetes Debian

Si instalamos XMLEye mediante el paquete Debian, sólo tendremos que instalar el paquete libacl2-procesador-perl. La próxima vez que iniciemos XMLEye tendremos todo lo necesario a nuestra disposición.

Instalación manual a partir de fuentes

Los pasos son los siguientes:

  1. Descomprimimos el fichero de fuentes bajo /tmp, y nos introducimos en sus contenidos:

    cd /tmp
    tar xzf (ruta a las fuentes)
    cd ACL2-Procesador-*
  2. Instalamos el preprocesador tal y como instalaríamos cualquier paquete Perl. Este proceso resultará muy familiar a cualquier usuario de las autotools:

    sudo perl Makefile.PL
    sudo chown -R `id -un`.`id -gn` *
    make
    make test
    sudo make install

    Es muy probable que Perl nos solicite en la primera orden instalar algunas dependencias. Siempre le diremos que sí. La segunda orden se emplea para poder compilar y realizar pruebas de regresión sin necesitar permisos de superusuario. Por último, se podría emplear sudo checkinstall en vez de la última orden si deseamos poder desinstalarlo fácilmente, si instalamos el paquete del mismo nombre.

    Es posible que debido a ligeros cambios en la salida de ACL2 en el futuro se produzcan cambios (deseables o no) de la salida del preprocesador respecto de lo esperado. Si alguien se encuentra con dicho problema, que no dude en contactarme, por favor.

  3. Lo siguiente es instalar las hojas de usuario, que es tan fácil (suponiendo que la ruta de hojas de usuario es /home/tunombredeuaurio/xmleye/xslt como:

    cp -r xslt/* $HOME/xmleye/xslt
  4. Terminaremos instalando el descriptor de tipo a su sitio:

    cp types/* $HOME/xmleye/types

Comprobaremos que todo va bien ejecutando:

$ pprocACL2Usage:
    pprocACL2 [opciones] [entrada Lisp ACL2]

Options:
    --help, -h, -?
                Se limita a mostrar un mensaje corto de ayuda.

    --man, -m
                Muestra un mensaje detallado de ayuda en formato man.

Capítulo 3. Uso y configuración

Este capítulo de la guía trata acerca del empleo de XMLEye y de su configuración. Para cuestiones relacionadas con la instalación o con detalles de implementación, referirse a los capítulos anteriores o al Manual del Desarrollador, respectivamente.

A lo largo de esta guía nos referiremos exclusivamente a las opciones de los menús, pero prácticamente toda acción tiene una combinación equivalente en el teclado,indicada en la parte derecha del elemento del menú correspondiente (y si no, es un fallo del que se agradecería una notificación ;-) ). Además, las opciones más comunes poseen un botón en la barra de herramientas, cuyo icono es una versión ampliada del icono de la entrada de menú correspondiente.

Podemos cambiar entre los botones de la barra de herramientas, el árbol y el navegador mediante CTRL+TAB en de izquierda a derecha y de arriba abajo, o mediante SHIFT+CTRL+TAB en dirección inversa.TAB y SHIFT+TAB siguen funcionando también de la forma usual, pero se hallan redefinidos en el navegador para navegar por los hipervínculos.

La forma de lanzar el programa se detalla en la guía de instalación, y variará según el método seguido.

Apertura y edición de documentos

Bajo el menú Fichero, disponemos de Abrir..., en donde podremos seleccionar un fichero de cualquier tipo, o uno de los tipos de ficheros que tengamos instalados.

Una vez hayamos seleccionado el fichero, se pasará por el preprocesador si se reconoce el tipo de fichero por su extensión y es necesario, y se mostrará su árbol en pantalla, junto con la visualización de su nodo raíz.

Para editar el fichero fuente con el editor definido en el descriptor de tipo, usaremos Editar fuente. Si Preferencias+Actualización automática se halla activo, XMLEye monitorizará el fichero en segundo plano y actualizará el árbol XML cada vez que se produzcan cambios en él, indpendientemente de si estuviera o no el editor abierto.

Por último, podemos acceder a los 5 últimos documentos abiertos con éxito, o Salir del programa.

Para cerrar un documento, actualmente no hay ninguna entrada en el menú Fichero (ver petición de funcionalidad #156), pero puede hacerse pulsando la cruz de su pestaña correspondiente. Para cerrar todos los documentos, podemos pulsar en el botón de cierre general en el extremo derecho del componente de pestañas.

Navegación por los documentos

El documento XML tras ser preprocesado sigue una estructura arbórea normal y corriente, por lo que podemos realizar las acciones usuales mediante las entradas del menú Navegar. En particular:

Buscar...

Abre un diálogo de búsqueda en el que podemos buscar siguiendo diversos parámetros. Además de las opciones usuales de búsqueda por palabras completas o por concordancia de mayúsculas, se puede marcar el ámbito de la búsqueda.

Buscar siguiente

Repite la última búsqueda realizada, mostrando un error en caso de que no se halla realizado una anteriormente. Si hemos llegado al último resultado de la última búsqueda, volveremos al primero después.

La repetición de una búsqueda es muy rápida, ya que XMLEye se ocupa de almacenar los resultados tras la primera petición y va dando directamente los resultados que le siguen dispués.

Padre

Sube un nivel en la jerarquía del árbol, o no hace nada si estamos en la raíz.

Hijo

Baja un nivel en la jerarquía del árbol, o no hace nada si estamos en un nodo hoja.

Hermano anterior

Se desplaza al anterior nodo hijo del padre del nodo actual, o no hace nada si estamos en su primer hijo.

Hermano siguiente

Se desplaza al siguiente nodo hijo del padre del nodo actual, o no hace nada si estamos en su último hijo.

Expandir todo

Expande el contenido de todos los nodos del árbol, de tal forma que todo nodo quede directamente visible, a menos que haya sido ocultado explícitamente por la hoja de visualización.

Contraer todo

Contrae el contenido de todos los nodos del árbol, de tal forma que únicamente el nodo raíz quede visible.

Aunque casi toda acción es accesible mediante ratón, se recomienda aprender los accesos directos mediante teclado, ya que agilizan enormemente los desplazamientos.

Podemos cambiar entre los documentos haciendo clic en sus pestañas correspondientes, o pulsando en la flecha hacia abajo justo a la izquierda de la cruz en el extremo derecho de la barra de pestañas: se desplegará una lista con los nombres de los documentos abiertos, pudiendo saltar directamente al documento que deseemos.

Personalización de la presentación

Podemos cambiar en cualquier momento la hoja de usuario empleada para el preprocesado del documento, ocupada de generar la estructura arbórea que vemos en el panel izquierdo, seleccionando una opción distinta del submenú PreferenciasPreprocesado. Se regenerará el árbol XML del documento y se nos mostrará el nodo raíz.

Podemos hacer lo mismo con la visualización de cada nodo bajo el submenú PreferenciasPreprocesado. Se actualizará el nodo actual de forma automática.

Nota

Los dos tipos de hojas de usuario son independientes, pero a veces conseguirá muchos mejores resultados si usa una hoja de visualización que esté diseñada de forma acorde a la hoja de preprocesado utilizada. Tal es el caso de la hoja de visualización ppACL2, por ejemplo.

Personalización de los tipos de documento

Cualquier usuario puede personalizar los tipos de documentos instalados, cambiando su nombre mostrado en el diálogo de selección, la orden de preprocesamiento, la orden de edición y las extensiones correspondientes a su libre albedrío. Esto se hace en el diálogo disponible bajo PreferenciasTipos admitidos....

La copia global del sistema siempre se mantiene intacta, por lo que podemos volver a ella siempre que queramos pulsando el botón Aceptar.

Apéndice A. GNU Free Documentation License

Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other functional and useful document “free” in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

  1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
  2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
  3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
  4. Preserve all the copyright notices of the Document.
  5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
  6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
  7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
  8. Include an unaltered copy of this License.
  9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
  10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
  11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
  12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
  13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
  14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
  15. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.

You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements”.

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.