fbpx
Wikipedia

DocBook

Agosto 03, 2021

DocBook es una aplicación del estándar SGML/XML e incluye una DTD propia y que se utiliza de manera más destacada en el área de la documentación técnica, especialmente para documentar todo tipo de material y programas informáticos. Existe un Comité Técnico de DocBook en OASIS (originalmente SGML Open) que mantiene y actualiza este estándar. DocBook inicialmente comenzó como una DTD de SGML, pero a partir de la versión 4 existe un equivalente para XML.

Como lenguaje semántico que es, DocBook nos permite crear documentos en un formato neutro, independiente de la presentación. En este formato neutro se recogen tanto el contenido como la estructura lógica del mismo, permitiendo así que pueda ser publicado (presentado) automáticamente en multitud de formatos: HTML, XHTML, EPUB, PDF, man pages , HTML Help, etc., simplemente aplicando "plantillas" de presentación, sin que sea necesario ningún cambio sobre el documento original.

Introducción

DocBook es un lenguaje XML. En su versión actual (5.0), está formalmente definido por un esquema RELAX NG con reglas Schematron integradas. (Existen también un XML Schema+Schematron y un DTD, pero actualmente se consideran no estándares.)

Los documentos DocBook no describen ni la apariencia ni la presentación de sus contenidos, sino únicamente el sentido de dichos contenidos. Por ejemplo, en lugar de indicar exactamente cómo ha de visualizarse una determinada frase que es el título de un capítulo, DocBook simplemente indica que dicha frase es un título de capítulo. Posteriormente, el decidir dónde y cómo se ha de mostrar dicho título dentro de la página será tarea de una herramienta procesadora externa o de la aplicación visualizadora que estemos manejando.

DocBook dispone de un gran número de etiquetas para describir elementos semánticos, englobándose estas en tres grandes categorías: estructurales, de bloque y de línea.

Las etiquetas estructurales especifican características generales de sus contenidos. Por ejemplo, el elemento book especifica que sus elementos hijo serán partes de un libro: títulos, capítulos, glosarios, apéndices, etc. Algunas etiquetas estructurales son:

  • set:
  • book:
  • part:
  • article:
  • chapter:
  • appendix:
  • dedication:

Los elementos estructurales pueden contener a otros elementos estructurales, pero han de ser siempre elementos de primer nivel dentro de un documento DocBook.

Las etiquetas de bloque representan elementos tales como párrafos, listas, etc., y no todos ellos han de contener necesariamente texto en su interior. Estos elementos de bloque suelen ir distribuidos secuencialmente, y serán visualizados uno "debajo" de otro. (Aunque "debajo" puede variar dependiendo del entorno cultural: en la mayoría de lenguajes occidentales "debajo" significará un sentido descendente en la página; pero en algunos lenguajes orientales, "debajo" significará un sentido en columnas de derecha a izquierda. La especificación DocBook es completamente neutral a ese tipo de conceptos intrínsecos de cada cultura.)

Las etiquetas de línea representan elementos tales como letras enfatizadas, hyper-enlaces, etc, y se suelen aplicar a porciones de texto en el interior de un elemento de bloque, provocando habitualmente que la herramienta procesadora de presentación aplique algún tipo de tratamiento tipográfico especial a dichas porciones. (La especificación de DocBook indica que se espera un tratamiento tipográfico especial, pero no indica exactamente qué tratamiento específico se debe aplicar. Por ejemplo, "letras enfatizadas" no implica necesariamente "letras en cursiva"; la herramienta de presentación puede optar por aumentarles el tamaño de letra o por cambiarles el color de fondo.)

Ejemplos

Artículo en DocBook SGML/XML

<?xml version="1.0" standalone="no"?> <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> <article lang="es"> <title>Creando Documentación Técnica con DocBook</title> <articleinfo> <author> <firstname>Leonardo</firstname> <surname>Caballero</surname> </author> </articleinfo> <section id="art-intro"> <title>Introducción</title> <para>DocBook es un aplicación del estándar SGML/XML e incluye una DTD propia y que se utiliza de manera más destacada el área de la documentación técnica, especialmente para documentar todo tipo de material y programas informáticos, para mayor información consultar aquí <ulink url="http://www.oasis-open.org/docbook/"/>.</para> </section> </article>

Desde un punto de vista semántico, este documento es un "artículo" (article), con su respectivo "título" (title). Se identifica claramente al "autor" (author), y se podría haber incluido también otro tipo de "información" adicional (articleinfo). Este artículo de ejemplo consta de una sola "sección", también con su respectivo "título"; y con "párrafos" (paragraph) de texto.

Libro en DocBook SGML/XML

 <?xml version="1.0" standalone="no"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> <book lang="es" id="simple_libro"> <title>Un libro muy simple</title> <chapter id="capitulo_1"> <title>Capitulo 1</title> <para>Hola mundo!</para> <para>¡Yo espero que tu día sea bueno!</para> </chapter> <chapter id="capitulo_2"> <title>Capitulo 2</title> <para>Hola otra vez, mundo!</para> </chapter> </book>

Desde un punto de vista semántico, este documento es un "libro" (book), con un "título" (title); consta de dos "capítulos" (chapter), cada uno de ellos con sus propio "título", y estos "capítulos" tienen "párrafos" (paragraph) de texto. Todo ello expresado en un formato fácilmente comprensible por humanos.

Esquemas y validación

Tanto los distintos elementos que forman un DocBook, como las reglas para combinarlos (por ejemplo, que todo elemento "libro" ha de contener un elemento "título", previo a cualquier otro elemento estructural tal como "capítulo"), se definen formalmente en un esquema (schema), de tal forma que los programas informáticos pueden validar el documento contra dicho esquema, y determinar así, en todo momento, si el documento está bien formado.

Escritura

Como documentos XML que son, los documentos DocBook pueden ser escritos con cualquier editor de texto, aunque siempre será más sencillo escribirlos con un editor XML, o, mejor aún, con un editor XML que lleve integrados los esquemas específicos de DocBook. Por ejemplo Emacs, trabajando en modo nXML, o XML Copy Editor.

También existen editores más "visuales" (WYSIWYG), tales como XMLmind Editor ("XXE"), Oxygen XML Editor, capaz de representar los documentos DocBook formateándolos con CSS; o Syntext Serna, que realiza transformaciones XSL en tiempo real.

Postproceso

Asimismo, como documentos XML que son, los documentos DocBook pueden ser validados y procesados automáticamente por cualquier herramienta o lenguaje de programación que soporte XML.

Estas herramientas se suelen utilizar para crear documentos de salida en un amplio abanico de formatos, habitualmente haciendo uso de "hojas de estilo" DocBook XLS, un tipo de hojas XSLT que nos permiten transformar documentos DocBook a otros formatos tales como HTML, PDF, etc., permitiendo conversiones tan sofisticadas como para que contemplen la generación automática de tablas de contenido, de glosarios y/o de índices, o que permitan incluso filtrados previos de contenidos, extractando solo ciertas partes del DocBook original.

Usos

DocBook es muy utilizado en algunos contextos, entre los que destacan Linux Documentation Project (Proyecto de documentación Linux), las referencias de las APIs de GNOME y GTK+, así como la documentación del núcleo Linux. Las páginas man del Entorno Operativo Solaris se generan también a partir de documentos que utilizan las DTDs o los esquemas de DocBook.

Historia

DocBook nació en 1991, de un proyecto conjunto de HAL Computer Systems y O'Reilly & Associates, evolucionando posteriormente hasta tener su propia organización (el Grupo Davenport), para acabar, en 1998, siendo gestionado por el consorcio SGML Open, que más tarde se convertiría en la organización OASIS, en cuyo seno existe actualmente el DocBook Technical Committee, encargado del mantenimiento del estándar DocBook.

La especificación DocBook está disponible tanto en el formato SGML como en el formato XML, estando definida tanto por un documento DTD, como por un esquema RELAX NG - W3C XML Schema. A partir de la versión 5, el esquema RELAX NG es el "normativo", siendo el resto de formatos meras adaptaciones del mismo.

DocBook nació como una aplicación de SGML, pero actualmente su adaptación XML la ha sustituido en la mayoría de usos. (A partir de la versión 4 del DTD SGML, la versión DTD XML ha tomado su propio camino y su propio esquema de numeración.)

En un principio, el uso del formato DocBook estaba prácticamente reducido al grupo de compañías participantes en su diseño, pero en estos momentos ha sido ampliamente adoptado por toda la comunidad de software libre y por un amplio espectro de compañías, existiendo en el mercado multitud de herramientas que hacen uso de él.

Norman Walsh y el equipo de desarrollo del DocBook Open Repository mantienen un conjunto de hojas de estilo DSSSL y XSL para generar versiones PDF y HTML de documentos DocBook (así como para desarrollar otros formatos, incluyendo páginas de referencia man y de ayuda en HTML). Walsh es también el principal autor del libro DocBook: The Definitive Guide (DocBook: La Guía Definitiva), la documentación oficial de DocBook. Este libro se puede obtener bajo licencia GFDL o en su versión impresa (ISBN 1565925807), editada por O'Reilly & Associates."

Referencias

Enlaces externos

  • DocBook en OASIS (Organization for the Advancement of Structured Information Standards)
  • DocBook Open Repository Project en SourceForge
  • DocBook Validator + Transformer en SourceForge
  • DocBook's Live-DTD
  • DocBook: The Definitive Guide
  • DocBook Filters - Read and write DocBook xml using OpenOffice.org
  • Getting Started With DocBook on OpenOffice, para aquellos que deseen editar DocBook con el OpenOffice.org.
  • <oXygen/> DocBook Editor (commercial)
  • Writing and producing documentation (HTML Help) with DocBook
  •   Datos: Q796483

Agosto 03, 2021
docbook, aplicación, estándar, sgml, incluye, propia, utiliza, manera, más, destacada, área, documentación, técnica, especialmente, para, documentar, todo, tipo, material, programas, informáticos, existe, comité, técnico, oasis, originalmente, sgml, open, mant. DocBook es una aplicacion del estandar SGML XML e incluye una DTD propia y que se utiliza de manera mas destacada en el area de la documentacion tecnica especialmente para documentar todo tipo de material y programas informaticos Existe un Comite Tecnico de DocBook en OASIS originalmente SGML Open que mantiene y actualiza este estandar DocBook inicialmente comenzo como una DTD de SGML pero a partir de la version 4 existe un equivalente para XML Como lenguaje semantico que es DocBook nos permite crear documentos en un formato neutro independiente de la presentacion En este formato neutro se recogen tanto el contenido como la estructura logica del mismo permitiendo asi que pueda ser publicado presentado automaticamente en multitud de formatos HTML XHTML EPUB PDF man pages HTML Help etc simplemente aplicando plantillas de presentacion sin que sea necesario ningun cambio sobre el documento original Indice 1 Introduccion 2 Ejemplos 2 1 Articulo en DocBook SGML XML 2 2 Libro en DocBook SGML XML 3 Esquemas y validacion 4 Escritura 5 Postproceso 6 Usos 7 Historia 8 Referencias 9 Enlaces externosIntroduccion EditarDocBook es un lenguaje XML En su version actual 5 0 esta formalmente definido por un esquema RELAX NG con reglas Schematron integradas Existen tambien un XML Schema Schematron y un DTD pero actualmente se consideran no estandares Los documentos DocBook no describen ni la apariencia ni la presentacion de sus contenidos sino unicamente el sentido de dichos contenidos Por ejemplo en lugar de indicar exactamente como ha de visualizarse una determinada frase que es el titulo de un capitulo DocBook simplemente indica que dicha frase es un titulo de capitulo Posteriormente el decidir donde y como se ha de mostrar dicho titulo dentro de la pagina sera tarea de una herramienta procesadora externa o de la aplicacion visualizadora que estemos manejando DocBook dispone de un gran numero de etiquetas para describir elementos semanticos englobandose estas en tres grandes categorias estructurales de bloque y de linea Las etiquetas estructurales especifican caracteristicas generales de sus contenidos Por ejemplo el elemento book especifica que sus elementos hijo seran partes de un libro titulos capitulos glosarios apendices etc Algunas etiquetas estructurales son set book part article chapter appendix dedication Los elementos estructurales pueden contener a otros elementos estructurales pero han de ser siempre elementos de primer nivel dentro de un documento DocBook Las etiquetas de bloque representan elementos tales como parrafos listas etc y no todos ellos han de contener necesariamente texto en su interior Estos elementos de bloque suelen ir distribuidos secuencialmente y seran visualizados uno debajo de otro Aunque debajo puede variar dependiendo del entorno cultural en la mayoria de lenguajes occidentales debajo significara un sentido descendente en la pagina pero en algunos lenguajes orientales debajo significara un sentido en columnas de derecha a izquierda La especificacion DocBook es completamente neutral a ese tipo de conceptos intrinsecos de cada cultura Las etiquetas de linea representan elementos tales como letras enfatizadas hyper enlaces etc y se suelen aplicar a porciones de texto en el interior de un elemento de bloque provocando habitualmente que la herramienta procesadora de presentacion aplique algun tipo de tratamiento tipografico especial a dichas porciones La especificacion de DocBook indica que se espera un tratamiento tipografico especial pero no indica exactamente que tratamiento especifico se debe aplicar Por ejemplo letras enfatizadas no implica necesariamente letras en cursiva la herramienta de presentacion puede optar por aumentarles el tamano de letra o por cambiarles el color de fondo Ejemplos EditarArticulo en DocBook SGML XML Editar lt xml version 1 0 standalone no gt lt DOCTYPE article PUBLIC OASIS DTD DocBook XML V4 2 EN http www oasis open org docbook xml 4 2 docbookx dtd gt lt article lang es gt lt title gt Creando Documentacion Tecnica con DocBook lt title gt lt articleinfo gt lt author gt lt firstname gt Leonardo lt firstname gt lt surname gt Caballero lt surname gt lt author gt lt articleinfo gt lt section id art intro gt lt title gt Introduccion lt title gt lt para gt DocBook es un aplicacion del estandar SGML XML e incluye una DTD propia y que se utiliza de manera mas destacada el area de la documentacion tecnica especialmente para documentar todo tipo de material y programas informaticos para mayor informacion consultar aqui lt ulink url http www oasis open org docbook gt lt para gt lt section gt lt article gt Desde un punto de vista semantico este documento es un articulo article con su respectivo titulo title Se identifica claramente al autor author y se podria haber incluido tambien otro tipo de informacion adicional articleinfo Este articulo de ejemplo consta de una sola seccion tambien con su respectivo titulo y con parrafos paragraph de texto Libro en DocBook SGML XML Editar lt xml version 1 0 standalone no gt lt DOCTYPE book PUBLIC OASIS DTD DocBook XML V4 2 EN http www oasis open org docbook xml 4 2 docbookx dtd gt lt book lang es id simple libro gt lt title gt Un libro muy simple lt title gt lt chapter id capitulo 1 gt lt title gt Capitulo 1 lt title gt lt para gt Hola mundo lt para gt lt para gt Yo espero que tu dia sea bueno lt para gt lt chapter gt lt chapter id capitulo 2 gt lt title gt Capitulo 2 lt title gt lt para gt Hola otra vez mundo lt para gt lt chapter gt lt book gt Desde un punto de vista semantico este documento es un libro book con un titulo title consta de dos capitulos chapter cada uno de ellos con sus propio titulo y estos capitulos tienen parrafos paragraph de texto Todo ello expresado en un formato facilmente comprensible por humanos Esquemas y validacion EditarTanto los distintos elementos que forman un DocBook como las reglas para combinarlos por ejemplo que todo elemento libro ha de contener un elemento titulo previo a cualquier otro elemento estructural tal como capitulo se definen formalmente en un esquema schema de tal forma que los programas informaticos pueden validar el documento contra dicho esquema y determinar asi en todo momento si el documento esta bien formado Escritura EditarComo documentos XML que son los documentos DocBook pueden ser escritos con cualquier editor de texto aunque siempre sera mas sencillo escribirlos con un editor XML o mejor aun con un editor XML que lleve integrados los esquemas especificos de DocBook Por ejemplo Emacs trabajando en modo nXML o XML Copy Editor Tambien existen editores mas visuales WYSIWYG tales como XMLmind Editor XXE Oxygen XML Editor capaz de representar los documentos DocBook formateandolos con CSS o Syntext Serna que realiza transformaciones XSL en tiempo real Postproceso EditarAsimismo como documentos XML que son los documentos DocBook pueden ser validados y procesados automaticamente por cualquier herramienta o lenguaje de programacion que soporte XML Estas herramientas se suelen utilizar para crear documentos de salida en un amplio abanico de formatos habitualmente haciendo uso de hojas de estilo DocBook XLS un tipo de hojas XSLT que nos permiten transformar documentos DocBook a otros formatos tales como HTML PDF etc permitiendo conversiones tan sofisticadas como para que contemplen la generacion automatica de tablas de contenido de glosarios y o de indices o que permitan incluso filtrados previos de contenidos extractando solo ciertas partes del DocBook original Usos EditarDocBook es muy utilizado en algunos contextos entre los que destacan Linux Documentation Project Proyecto de documentacion Linux las referencias de las APIs de GNOME y GTK asi como la documentacion del nucleo Linux Las paginas man del Entorno Operativo Solaris se generan tambien a partir de documentos que utilizan las DTDs o los esquemas de DocBook Historia EditarDocBook nacio en 1991 de un proyecto conjunto de HAL Computer Systems y O Reilly amp Associates evolucionando posteriormente hasta tener su propia organizacion el Grupo Davenport para acabar en 1998 siendo gestionado por el consorcio SGML Open que mas tarde se convertiria en la organizacion OASIS en cuyo seno existe actualmente el DocBook Technical Committee encargado del mantenimiento del estandar DocBook La especificacion DocBook esta disponible tanto en el formato SGML como en el formato XML estando definida tanto por un documento DTD como por un esquema RELAX NG W3C XML Schema A partir de la version 5 el esquema RELAX NG es el normativo siendo el resto de formatos meras adaptaciones del mismo DocBook nacio como una aplicacion de SGML pero actualmente su adaptacion XML la ha sustituido en la mayoria de usos A partir de la version 4 del DTD SGML la version DTD XML ha tomado su propio camino y su propio esquema de numeracion En un principio el uso del formato DocBook estaba practicamente reducido al grupo de companias participantes en su diseno pero en estos momentos ha sido ampliamente adoptado por toda la comunidad de software libre y por un amplio espectro de companias existiendo en el mercado multitud de herramientas que hacen uso de el Norman Walsh y el equipo de desarrollo del DocBook Open Repository mantienen un conjunto de hojas de estilo DSSSL y XSL para generar versiones PDF y HTML de documentos DocBook asi como para desarrollar otros formatos incluyendo paginas de referencia man y de ayuda en HTML Walsh es tambien el principal autor del libro DocBook The Definitive Guide DocBook La Guia Definitiva la documentacion oficial de DocBook Este libro se puede obtener bajo licencia GFDL o en su version impresa ISBN 1565925807 editada por O Reilly amp Associates Referencias EditarEnlaces externos EditarDocBook wiki DocBook en OASIS Organization for the Advancement of Structured Information Standards DocBook Open Repository Project en SourceForge DocBook Validator Transformer en SourceForge DocBook s Live DTD DocBook The Definitive Guide DocBook Filters Read and write DocBook xml using OpenOffice org Getting Started With DocBook on OpenOffice para aquellos que deseen editar DocBook con el OpenOffice org lt oXygen gt DocBook Editor commercial Writing and producing documentation HTML Help with DocBookEsta obra contiene una traduccion derivada de DocBook de la Wikipedia en ingles publicada por sus editores bajo la Licencia de documentacion libre de GNU y la Licencia Creative Commons Atribucion CompartirIgual 3 0 Unported Datos Q796483Obtenido de https es wikipedia org w index php title DocBook amp oldid 125248651, wikipedia, wiki, leyendo, leer, libro, biblioteca,

español

, española, descargar, gratis, descargar gratis, mp3, video, mp4, 3gp, jpg, jpeg, gif, png, imagen, música, canción, película, libro, juego, juegos