Docbook Vs DITA

Total Page:16

File Type:pdf, Size:1020Kb

Docbook Vs DITA DocBook vs DITA Radu Coravu [email protected] @radu_coravu DITA for Software Documentation About the Author I’m a Hub: Feedback (questions, Open Source Projects End users problems, improvement requests) Help, Blogs/Presentations workarounds Technical Support (Me) Improve Oxygen XML Editor Improve product documentation Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation DocBook vs DITA “Comparing DocBook and DITA is like comparing two different types of birds” Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation DocBook 5 vs DITA 1.3 ● Compare standards/vocabularies ● Compare publishing systems ● Compare documentation/communities Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Short History DocBook DITA ● 1991 – First DTD ● 2001 – First DTD HAL Computer IBM Systems and O'Reilly ● 1998 – OASIS ● June 2005 - OASIS ● Current version: 5.1 ● Current version: 1.3 ● Extensive XML ● Extensive XML vocabulary (366) vocabulary (461) Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Main Purpose DocBook DITA ● Books, articles in web or ● Topic-oriented PDF format information “DocBook is a general “The Darwin Information purpose [XML] schema Typing Architecture (DITA) specification defines a set of particularly well suited to document types for books and papers about authoring and organizing computer hardware and topic-oriented information, as well as a set of software (though it is by mechanisms for combining, no means limited to these extending, and constraining applications).” document types.” Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Versioning DocBook DITA ● Three major versions ● 4 minor versions (1.0, (3, 4 and 5). 1.1, 1.2 and 1.3) ● Numerous minor ● Latest Version is DITA (maintenance) 1.3 releases. ● Latest version is DocBook 5.1. Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation DocBook Specs Versioning Rules ● Minor versions (“point releases,” such as V2.2) could add to the markup model, but could not change it in a backwards-incompatible way. ● Major versions (such as V3.0) could both add to the markup model and make backwards- incompatible changes. ● Major-version introductions must be separated by at least a year. Problems updating from DocBook to DocBook 5 (DocBook 4 for was in 2006). Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Schema DocBook DITA ● Initially: DTD ● Initially: DTD ● Now: Normative - ● Now: Normative - Relax NG, available Relax NG, available also as DTD and XML also as DTD and XML Schema Schema Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Content Reuse DocBook DITA ● xi:include ● Conrefs Problems: Harder to ● Keyrefs validate, duplicate IDs ● Conkeyrefs ● Entity references Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Linking DocBook DITA ● Internal links based on ● Direct/indirect ID/IDREF constraints ● Related links ● Links based on ID/IDRef and ● Relationship tables. XLink standard. Neat stuff: ● You can add links on all DocBook elements ● You can define xreflabel on any element ● Olink (linking across publications) Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Media resources (images, audio, video) DocBook DITA ● Support for ● Only image referencing images, references (direct or videos and audio indirect) resources ● Scale, scalefit, width, ● Scale, scalefit, width, height depth ● Align ● Content area width, depth ● Align ● Valign Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Block Elements Trivia DocBook DITA ● Article ● Topics ● Books ● Div’s – Chapters ● Sections (non- ● Topic (new in 5.1) nesting) ● Sections – Numbered – Recursive – Simple Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Tables DocBook DITA ● CALS table ● CALS table ● HTML table ● Simple table ● Informal table ● Internal table Table related info: Table related info: ● Support for table footer ● Table Orientation attribute ● Table Orientation attribute ● Table page wide scale ● Table page wide scale (pgwide) (pgwide) ● Profiling on any table cell Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Inline Elements Trivia DocBook DITA ● Emphasis with roles ● Bold, italic, instead of underline bold/italic/underline ● Inline equations ● Inline equations ● Inline SVG ● Inline SVG ● UI element refs like ● UI element refs “guibutton, guilabel, “uicontrol” guimenu, guisubmenu” Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Other Common Vocabulary Features ● Keywords ● Index terms ● Footnotes ● Image maps ● Embed SVG and MathML. Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Profiling/Filtering DocBook DITA ● 14 pre-configured ● 7 pre-configured profiling attributes attributes ● Values are semi-colon ● Values are space separated separated ● Filter using transformation ● Filter using DITAVAL parameters file ● You can filter based on any attribute Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Extending/Restricting the vocabulary DocBook DITA ● Once you extend ● Specialize, restrict, vocabulary it's no extend vocabulary longer DocBook Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Mainstream Publishing Engines DocBook DITA ● DocBook XSLTs: ● DITA Open Toolkit HTML, XHTML, (open source): WebHelp, EPUB, HTML5, XHTML, PDF, PDF, Eclipse Help, Eclipse Help Java Help – Based on mixture of – Based mostly on XSLT ANT build files, Java 1.0 and a couple of code and XSLT 2.0 Java extensions stylesheets Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation DocBook Publishing Diagram Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation DITA OT Publishing Diagram Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation PDF Publishing Customizations DocBook DITA ● PDF font, paper size, ● You need XSLT columns can be knowledge and to customized with build customization parameters folder or plugin for any customization ● Special support for FOP, XEP ● Special support for FOP, XEP, Antenna ● Anything else configurable via XSLT House Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation HTML-based Publishing DocBook DITA ● HTML (old), XHTML ● HTML5, XHTML ● Chunked ● Eclipse Help HTML/XHTML ● Eclipse Help ● WebHelp output ● EPUB Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation HTML Publishing Customizations DocBook DITA ● CSS ● CSS ● Lots of parameters ● XSLT customization ● XSLT customization Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Extra DocBook Publishing Features ● Custom Processing instructions ● Some parameter XSLTs generate documentation. ● Java Extensions to: – Add line numbers to program listings – Determine the intrinsic size of an image – Provide syntax highlight in program listing Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Communities DocBook DITA ● DocBook Users List ● DITA Users List (general questions) (Yahoo Group, Google Group) ● DocBook Apps Users List (publishing- ● DITA-OT Users List related) (Google Group) Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Online Help Resources DocBook DITA ● Vocabulary ● Vocabulary – DocBook Definitive Guide – DITA Specification ● Publishing: ● Publishing: – DocBook Complete Guide – DITA Open Toolkit documentation Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Trends DocBook DITA Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Questions ● Why is DocBook getting replaced by DITA? ● Do we have anything to learn from the DocBook specification? ● Do we have anything to learn from the DocBook publishing system? Copyright @ Syncro Soft, 2014. All rights reserved. DITA for Software Documentation Thank You! Questions? Radu Coravu [email protected] @radu_coravu Copyright @ Syncro Soft, 2014. All rights reserved..
Recommended publications
  • OASIS Response to NSTC Request for Feedback on Standard Practices
    OASIS RESPONSE TO NSTC REQUEST FOR FEEDBACK ON STANDARDS PRACTICES OASIS (Organization for the Advancement of Structured Information Standards) is pleased to respond to the request from the National Science and Technology Council's Sub-Committee on Standards published at 75 FR 76397 (2010), and extended by 76 FR 3877 (2011), for feedback and observations regarding the effectiveness of Federal agencies' participation in the development and implementation of standards and conformity assessment activities and programs. We have advised our own members about the Federal Register inquiry, in case they wish to respond. Of course, their opinions are their own, and this response does not represent the views of any members, but only the observations of OASIS professional staff. I. RESPONDENT'S BACKGROUND OASIS is one of the largest and oldest global open data standards consortia, founded in 1993 as SGML Open. OASIS has over 5000 active participants representing about 600 member organizations and individual members in over 80 countries. We host widely-used standards in multiple fields including • cybersecurity & access control (such as WS-Security, SAML, XACML, KMIP, DSS & XSPA) [/1], • office documents and smart semantic documents (such as OpenDocument, DITA, DocBook & CMIS) [/2], and • electronic commerce (including SOA and web services, such as BPEL, ebXML, WS-ReliableMessaging & the WS-Transaction standards) [/3] among other areas. Various specific vertical industries also fulfill their open standards requirements by initiating OASIS projects, resulting in mission-specific standards such as • UBL and Business Document Exchange (for e-procurement) [/4], • CAP and EDML (for emergency first-responder notifications) [/5], and • LegalXML (for electronic court filing data)[/6].
    [Show full text]
  • Automated Software System for Checking the Structure and Format of Acm Sig Documents
    AUTOMATED SOFTWARE SYSTEM FOR CHECKING THE STRUCTURE AND FORMAT OF ACM SIG DOCUMENTS A THESIS SUBMITTED TO THE GRADUATE SCHOOL OF APPLIED SCIENCES OF NEAR EAST UNIVERSITY By ARSALAN RAHMAN MIRZA In Partial Fulfillment of the Requirements for The Degree of Master of Science in Software Engineering NICOSIA, 2015 ACKNOWLEDGEMENTS This thesis would not have been possible without the help, support and patience of my principal supervisor, my deepest gratitude goes to Assist. Prof. Dr. Melike Şah Direkoglu, for her constant encouragement and guidance. She has walked me through all the stages of my research and writing thesis. Without her consistent and illuminating instruction, this thesis could not have reached its present from. Above all, my unlimited thanks and heartfelt love would be dedicated to my dearest family for their loyalty and their great confidence in me. I would like to thank my parents for giving me a support, encouragement and constant love have sustained me throughout my life. I would also like to thank the lecturers in software/computer engineering department for giving me the opportunity to be a member in such university and such department. Their help and supervision concerning taking courses were unlimited. Eventually, I would like to thank a man who showed me a document with wrong format, and told me “it will be very good if we have a program for checking the documents”, however I don’t know his name, but he hired me to start my thesis based on this idea. ii To Alan Kurdi To my Nephews Sina & Nima iii ABSTRACT Microsoft office (MS) word is one of the most commonly used software tools for creating documents.
    [Show full text]
  • Schematron Overview Excerpted from Leigh Dodds’ 2001 XSLT UK Paper, “Schematron: Validating XML Using XSLT”
    Schematron: validating XML using XSLT Schematron Overview excerpted from Leigh Dodds’ 2001 XSLT UK paper, “Schematron: validating XML using XSLT” Leigh Dodds, ingenta ltd, xmlhack.com April 2001 Abstract Schematron [Schematron] is a structural based validation language, defined by Rick Jelliffe, as an alternative to existing grammar based approaches. Tree patterns, defined as XPath expressions, are used to make assertions, and provide user-centred reports about XML documents. Expressing validation rules using patterns is often easier than defining the same rule using a content model. Tree patterns are collected together to form a Schematron schema. Schematron is a useful and accessible supplement to other schema languages. The open-source XSLT implementation is based around a core framework which is open for extension and customisation. Overview This paper provides an introduction to Schematron; an innovative XML validation language developed by Rick Jelliffe. This innovation stems from selecting an alternative approach to validation than existing schema languages: Schematron uses a tree pattern based paradigm, rather than the regular grammars used in DTDs and XML schemas. As an extensible, easy to use, open source tool Schematron is an extremely useful addition to the XML developers toolkit. The initial section of this paper conducts a brief overview of tree pattern validation, and some of the advantages it has in comparison to a regular grammar approach. This is followed by an outline of Schematron and the intended uses which have guided its design. The Schematron language is then discussed, covering all major elements in the language with examples of their 1 of 14 Schematron: validating XML using XSLT usage.
    [Show full text]
  • Schema Declaration in Xml Document
    Schema Declaration In Xml Document Is Darin varying or propellant when cluck some suffusion motive melodically? When Anton interdepend his titters reap not gyrally enough, is Parsifal malnourished? Styled Winnie scollop confoundedly, he reincreasing his stopple very refreshfully. When a uri that they come back into account only applies when sales orders that document in order to the design Must understand attribute Should I define a global attribute that will indicate to implementation the criticality of extension elements? Create a DOM parser to use for the validation of an instance document. As such, the XML Schema namespace, and provides a mapping between NIEM concepts and the RDF model. It is a convention to use XSD or XS as a prefix for the XML Schema namespace, et al. XML documents have sufficient structure to guarantee that they can be represented as a hierarchical tree. Are expanded names universally unique? DOC format for easy reading. This site uses cookies. This schema fragment shows the definition of an association type that defines a relationship between a person and a telephone number. Furthermore, such as Adobe Acrobat Reader. In some cases, if any. The idea behind using URIs for namespace names are that URIs are designed to be unique and persistent. Note: The material discussed in this section also applies to validating when using the SAX parser. Finally, Relax NG Schema, even when the elements and attributes defined by Microsoft are present. The XML representation for assertions. Developers of domain schemas and other schemas that build on and extend the NIEM release schemas need to be able to define additional characteristics of common types.
    [Show full text]
  • JSON Application Programming Interface for Discrete Event Simulation Data Exchange
    JSON Application Programming Interface for Discrete Event Simulation data exchange Ioannis Papagiannopoulos Enterprise Research Centre Faculty of Science and Engineering Design and Manufacturing Technology University of Limerick Submitted to the University of Limerick for the degree of Master of Engineering 2015 1. Supervisor: Prof. Cathal Heavey Enterprise Research Centre University of Limerick Ireland ii Abstract This research is conducted as part of a project that has the overall aim to develop an open source discrete event simulation (DES) platform that is expandable, and modular aiming to support the use of DES at multi-levels of manufacturing com- panies. The current work focuses on DES data exchange within this platform. The goal of this thesis is to develop a DES exchange interface between three different modules: (i) ManPy an open source discrete event simulation engine developed in Python on the SimPy library; (ii) A Knowledge Extraction (KE) tool used to populate the ManPy simulation engine from shop-floor data stored within an Enterprise Requirements Planning (ERP) or a Manufacturing Execution System (MES) to allow the potential for real-time simulation. The development of the tool is based on R scripting language, and different Python libraries; (iii) A Graphical User Interface (GUI) developed in JavaScript used to provide an interface in a similar manner to Commercial off-the-shelf (COTS) DES tools. In the literature review the main standards that could be used are reviewed. Based on this review and the requirements above, the data exchange format standard JavaScript Object Notation (JSON) was selected. The proposed solution accom- plishes interoperability between different modules using an open source, expand- able, and easy to adopt and maintain, in an all inclusive JSON file.
    [Show full text]
  • Release Notes for the Docbook XSL Stylesheets I
    Release Notes for the DocBook XSL Stylesheets i Release Notes for the DocBook XSL Stylesheets Release Notes for the DocBook XSL Stylesheets ii Contents 1 Release Notes: snapshot 1 2 Release Notes: 1.79.2 1 3 Release Notes: 1.79.1 1 3.1 Gentext . .1 3.2 Common . .2 3.3 FO...........................................................4 3.4 HTML.........................................................9 3.5 Manpages . 13 3.6 Epub.......................................................... 14 3.7 HTMLHelp . 16 3.8 Eclipse . 16 3.9 JavaHelp . 16 3.10 Slides . 17 3.11 Website . 17 3.12 Webhelp . 18 3.13 Params . 18 3.14 Profiling . 20 3.15Lib........................................................... 20 3.16 Tools . 20 3.17 Template . 21 3.18 Extensions . 21 4 Release Notes: 1.79.0 21 4.1 Gentext . 22 4.2 Common . 23 4.3 FO........................................................... 24 4.4 HTML......................................................... 29 4.5 Manpages . 34 4.6 Epub.......................................................... 35 4.7 HTMLHelp . 36 4.8 Eclipse . 36 4.9 JavaHelp . 37 4.10 Slides . 37 4.11 Website . 38 4.12 Webhelp . 38 4.13 Params . 39 Release Notes for the DocBook XSL Stylesheets iii 4.14 Profiling . 40 4.15Lib........................................................... 40 4.16 Tools . 40 4.17 Template . 41 4.18 Extensions . 42 5 Release Notes: 1.78.1 42 5.1 Common . 42 5.2 FO........................................................... 43 5.3 HTML......................................................... 43 5.4 Manpages . 44 5.5 Webhelp . 44 5.6 Params . 44 5.7 Highlighting . 44 6 Release Notes: 1.78.0 44 6.1 Gentext . 45 6.2 Common . 45 6.3 FO........................................................... 46 6.4 HTML......................................................... 47 6.5 Manpages .
    [Show full text]
  • Determining the Output Schema of an XSLT Stylesheet
    Determining the Output Schema of an XSLT Stylesheet Sven Groppe and Jinghua Groppe University of Innsbruck, Technikerstrasse 21a, A-6020 Innsbruck, Austria {Sven.Groppe, Jinghua Groppe}@uibk.ac.at Abstract. The XSLT language is used to describe transformations of XML documents into other formats. The transformed XML documents conform to output schemas of the used XSLT stylesheet. Output schemas of XSLT stylesheets can be used for a static analysis of the used XSLT stylesheet, to automatically detect the XSLT stylesheet, which has been used for the trans- formation, of target XML documents or to reason on the output schema without access to the target XML documents. In this paper, we describe how to auto- matically determine such an output schema of a given XSLT stylesheet, where we only consider XML to XML transformations. The input of our proposed output schema generator is the XSLT stylesheet and the schema of the input XML documents. The experimental evaluation shows that our prototype can de- termine the output schemas of nearly all typical XSLT stylesheets. 1 Introduction Among other usages of XML, XML is the most widely used data model for exchang- ing data on the web and elsewhere. For the exchange of data, we have to transform the data from one format into another format whenever the two exchange partners use different formats. The exchange partners can use different formats, which might be a proprietary company standard, a proprietary application format or other standard for- mats, for historical, political or other reasons. We focus on XSLT [23] as transforma- tion language for the XML data.
    [Show full text]
  • Mulberry Classes Guide to Using the Oxygen XML Editor (V19.0)
    Mulberry Classes Guide to Using the Oxygen XML Editor (v19.0) Mulberry Technologies, Inc. 17 West Jefferson Street, Suite 207 Rockville, MD 20850 Phone: 301/315-9631 Fax: 301/315-8285 [email protected] http://www.mulberrytech.com Version 1.6 (April 21, 2017) ©Copyright 2015, 2017 Mulberry Technologies, Inc. Mulberry Classes Guide to Using the Oxygen XML Editor (v19.0) Exercise 1 Exercise 1. Guide to Using Oxygen XML Editor (v19.0) NOTE: This is a reference, not a list of instructions! Oxygen is both an XML editor and a development tool. We will be using it to run XML transforms using XSLT, to validate documents according to a DTD or schema, and to run Schematron, XQuery, XSLT-FO, and other pro- cesses. Key Oxygen Icons check well-formedness (blue checkmark) validate document (red checkmark) associate schema (red push pin) apply transformation scenario (triangle in circle) configure transformation scenario (wrench) XPath 2.0 search window Open Oxygen XML Editor • Double click the icon Naming Files When you create a file, it is considered best practice to name your files using the following file extensions: • XML filenames end in “.xml” • XSLT filenames end in “.xsl” Exercises page 1 Mulberry Classes Guide to Using the Oxygen XML Editor (v19.0) • XML Schema filenames end in “.xsd” • DTD filenames end in “.dtd” • DTD modules (DTD fragments) end in “.ent” or “.mod” • Schematron filenames end in “.sch” • PDF files end in “.pdf” • HTML an XHTML files end in “.html” or “.htm” • RELAXNG files end in “.rng” Create a New XML Document 1. First Time Opening Oxygen • If a “Welcome to Oxygen” screen appears, under Create New • Choose New Document • Choose XML Document • Then finish as explained below • If there is no “Welcome to Oxygen” screen, on the top bar choose File • Choose New • Under New Document, choose XML Document • Then finish as explained below 2.
    [Show full text]
  • Docbook to XHTML I
    DocBook to XHTML i DocBook to XHTML DocBook to XHTML ii COLLABORATORS TITLE : DocBook to XHTML ACTION NAME DATE SIGNATURE WRITTEN BY Jordi Fita February 6, 2018 REVISION HISTORY NUMBER DATE DESCRIPTION NAME 29081e152caf 2011-05-31 Added the ’notranslate’ class to the code’s div jfita output in db2html. 34b7522b4f97 2011-03-28 atangle is now using a new style for directives jfita which don’t collide with XML tags. I had to update all games and programs as well in order to use the new directive syntax. 6cc909c0b61d 2011-03-07 Added the comments section. jfita a43774cb5c70 2011-01-25 db2html now takes into account XML jfita idiosyncrasies. 3afa2eb8824f 2010-11-12 Fixed missing tokens from lexer in db2html. jfita 2d89308d5f16 2010-11-10 Fixed a problem with double end of line values in jfita db2html’s literate programming filter. d1e8f7703f36 2010-11-10 Corrected the literate programming directive’s jfita regexp to include the dot character. 8c7d8f36c874 2010-10-30 Fixed a typo. jfita a643bad18ca3 2010-10-28 Fixed a typo in db2html. jfita ec13c85db550 2010-10-27 Added a missing source style to db2html.txt jfita DocBook to XHTML iii REVISION HISTORY NUMBER DATE DESCRIPTION NAME 30b4b6244050 2010-10-27 Added the filter for atangle’s directive to db2html. jfita e3241d8e1dc9 2010-10-25 Added the AsciiDoc’s homepage’s link to jfita db2html. 05a1b32f8b4a 2010-10-22 The appendix sections now aren’t actual jfita appendix when making a book. 0ab76df46149 2010-10-20 Added the download links. jfita 9efbebdaa6ab 2010-10-19 Fixed an unused ’tmp’ variable in db2html’s jfita print_error function.
    [Show full text]
  • Markup Languages and TEI XML Encoding
    Methods and tools for Digital Philology: markup languages and TEI XML encoding Digital Tools for Humanists Summer School 2019 Pisa, 10-14 June 2019 Roberto Rosselli Del Turco Dipartimento di Studi Umanistici Università di Torino [email protected] XML encoding Markup languages there are many markup languages, which differ greatly fundamental distinction: procedural markup vs. descriptive markup procedural markup is typical of word processors: instructions for specifying where the characters should appear on the page, their appearance, etc. WYSIWYG approach, but also see LaTeX the user doesn’t see or modify the markup directly (but again see LaTeX) descriptive markup describes text this distinction isn’t as neat as one would love to think, see for instance the structural aspect of text 2 XML encoding Descriptive markup allows the scholar to do a semantic annotation of text the current standard is the XML language (← SGML) in spite of the multiple hierarchies problem XML has been used to produce many different encoding schemas: TEI schemas for all types of texts TEI-derived schemas: EpiDoc, MEI, CEI, etc. other schemas: DOCBOOK, MML – Music Markup Language, MathML, SVG, etc. it is also possible to create a personal encoding schema, but you would need a very good reason not to use TEI XML 3 Il linguaggio XML Markup languages: XML SGML is the “father” of XML (eXtensible Markup Language) XML was created to replace both SGML, offering similar characteristics but a much lower complexity, and also HTML, going beyond the intrinsic
    [Show full text]
  • Using XML for Long-Term Preservation Subtitle: Experiences from the Diva Project
    Title: Using XML for Long-term Preservation Subtitle: Experiences from the DiVA Project Authors: Müller, Eva; Klosa, Uwe; Hansson, Peter; Andersson, Stefan; Siira, Erik Organization: Uppsala University Library, Electronic Publishing Centre Email: [email protected]; [email protected]; [email protected]; [email protected]; [email protected] Address: Box 510, 75 120 Uppsala, Sweden Url: http://publications.uu.se Keyword: long-term preservation, XML, XML Schema, DiVA, DiVA Document Format, DiVA Archive, URN, URN:NBN Abstract One of the objectives of the DiVA project is to explore the possibility of using XML as a format for long-term preservation. For this reason, the practical use of XML in different parts of the system was evaluated before deciding on the design. The DiVA Document Format - defined by an XML schema - has been developed to describe the inter-relationships amongst the various data elements and processes, and to support long-term preservation of the actual documents. XML Schema provides a means for defining the structure, content and semantics of XML documents. It is an XML based alternative to the XML Document Type Definition (DTD). Because one of the primary reasons for using XML was to support long-term preservation, the most popular DTDs for documents: DocBook and TEI were evaluated. Limitations regarding metadata descriptions were found in both of these DTDs, so the decision to develop a new structure for DiVA, using XML schema, was made. This schema combines the DocBook Schema (derived from the DocBook DTD) for the textual parts of the document with the internal schema for all metadata (bibliographic and administrative data).
    [Show full text]
  • The Docbook Schema Working Draft V5.0B9, 26 October 2006
    The DocBook Schema Working Draft V5.0b9, 26 October 2006 Document identifier: docbook-5.0b9-spec-wd-01 Location: http://www.oasis-open.org/docbook/specs Editor: Norman Walsh, Sun Microsystems, Inc. <[email protected]> Abstract: DocBook is a general purpose [XML] schema particularly well suited to books and papers about computer hardware and software (though it is by no means limited to these applications). The Version 5.0 release is a complete rewrite of DocBook in RELAX NG. The intent of this rewrite is to produce a schema that is true to the spirit of DocBook while simultaneously removing inconsistencies that have arisen as a natural consequence of DocBook's long, slow evolution.The Technical Committee has taken this opportunity to simplify a number of content models and tighten constraints where RELAX NG makes that possible. The Technical Committee provides the DocBook 5.0 schema in other schema languages, including W3C XML Schema and an XML DTD, but the RELAX NG Schema is now the normative schema. Status: This is a Working Draft. It does not necessarily represent the consensus of the committee. Please send comments on this specification to the <[email protected]> list. To subscribe, please use the OASIS Subscription Manager. The errata page for this specification is at http://www.oasis-open.org/docbook/specs/docbook5-er- rata.html. Copyright © 2001, 2002, 2003, 2004, 2005, 2006 The Organization for the Advancement of Structured In- formation Standards [OASIS]. All Rights Reserved. Table of Contents 1. Introduction .................................................................................................................................... 2 2. Terminology .................................................................................................................................... 2 3. The DocBook RELAX NG Schema V5.0 .............................................................................................
    [Show full text]