background preloader

DocBook

LyX - The Document Processor Jaxe, votre éditeur XML Authoring with Eclipse Summary The topic of technical publishing is relatively new to the world of Eclipse. One can make the argument that technical publishing is just another collaborative development process involving several people with different backgrounds and skills. This article will show that the Eclipse platform is a viable platform for technical publishing by discussing how to write documents such as an article or a book within Eclipse. In fact, this article was written using Eclipse. By Chris Aniszczyk, IBM CorporationLawrence Mandel, IBM Corporation Copyright © 2005 International Business Machines Corporation. December 14, 2005 The authors of this document view technical documentation as another development process that shares the same characteristics as a software process. In the open source world, technical documentation is primarily accomplished using two popular formats: DocBook and the Darwin Information Typing Architecture (DITA). Advantages of an XML format Modularity Version Control Figure 1.

DocBook Element Reference The description of each element in this reference is divided into the following sections: Each element synopsis begins with a concise description of the elements it can contain. This description is in DTD "content model" syntax, with all parameter entities expanded. Content models are the way that DTDs describe the name, number, and order of other elements that may be used inside an element. The primary feature of content model syntax is that it is concise, but this conciseness comes at the cost of legibility until you are familiar with the syntax. There are six components to content model syntax: element names, keywords, repetitions, sequences, alternatives, and groups. Element names An element name in a content model indicates that an element of that type may (or must) occur at that position. A content model of Para indicates that the element must contain a single paragraph. Keywords There are two keywords that occur in the content models of DocBook elements: EMPTY, and #PCDATA. Repetitions

Editix Lite - Free XML Editor DocBook XML Resources at CERN DocBook is primarily an XML vocabulary (defined by a DTD, Docoment Type Definition) which maintained by the DocBook Technical Committee of OASIS. It is particularly well suited to books and papers about computer hardware and software (though it is by no means limited to such application areas). Using DocBook I have combined various documents describing DocBook and adapted them to CERN. Why using DocBook is an optimal solution for single-source publishing is explained by Dan York in his nice tutorial. Michael Smith wrote an introductory article about why one should consider using DocBook. Jirka Kosek gave three presentations about DocBook Best Practices at the O'Reilly Open Source Convention (July 23-27, 2001, Sheraton San Diego Hotel, San Diego, CA): One can also learn quite a bit on how to use DocBook for professional HTML applications by reading Dan York's Summary of the e-smith Documentation Process. DocBook reference Documentation The DocBook DTD DocBook XSLT stylesheets

Date: 30 juin 2005, Mise à jour: 30 juin 2005SilviaCADILLO, {cadillo4@etu.unige.ch} MOTS CLES: - [Resumé] [Preface] [Introduction] [Discussion du travail] [Conclusions] [Bibliographie] [Annexe] [Remerciements] Ce document a pour but de présenter les problématiques courantes de l'édition des documents pédagogiques (le cas d'étude de l'édition d'un livre), de montrer quelles sont les méthodes permettant de les résoudre, ainsi que d'effectuer un bref tour d'horizon des logiciels pour la création des documents électroniques. Ces dernières années, Internet est devenu la plate-forme universelle de diffusion d'informations, avec un essor de la communication, de la collaboration et de la diffusion de documents numériques. Notre vue sur l'enseignement prend un nouveau visage, nous assistons à un nouveau besoin de l'enseignement traditionnel dispensé dans des salles de cours. Il faut organiser les ressources pédagogiques nécessaires à la diffusion. Le concept du document Cycle de vie du document

DocBook Cascading Stylesheet (CSS2) About DocBook is an XML dialect for writing documentation. The Cascading Stylesheet provided here allows you to directly view a styled XML document in software that supports XML styled with CSS2 (e.g. a recent Mozilla or Opera browser) Status There are currently many Docbook elements that haven't had CSS written to style them yet. Examples (To view the XML versions, you need a capable browser) Author Guide (from The Linux Documentation Project) Documentation for CVSspam Some docbook test cases. Usage To use, alter your XML file to include a stylesheet directive, <? Download Current 2004-11-21 docbook-css-0.4.tar.gz ~8kB Licencing change: since it wasn't prevously clear under what terms these files were made available (the only indication being "this file placed in the public domain" in one of them), I've set out the terms of use explicitly in the file COPYING Added styling for various sgmltag classes Support valign=top and valign=bottom attributes for table entrys Previous Limitations XML parsing Source

O'Reilly -- Take My Advice: Don't Learn XML Take My Advice: Don't Learn XML by Michael(tm) Smith 07/18/2001 Contents If you're a developer interested only in the data-oriented side of XML, and if you don't care about document authoring (writing books, articles, manuals, love poems, Web pages, whatever), feel free to ignore this article. If, on the other hand, document authoring is important to you (you're a technical writer, an HTML markup author, manager of a documentation group, an anonymous pamphleteer) and you're trying to decide whether it would be worthwhile for you to learn XML and use it for authoring documents, stick around. What you learn might save you a lot of time and spare you from some unnecessary frustration. An Alternate Course of Study It's likely you've heard a lot of hype about the advantages that XML-based document authoring is supposed to provide: the capability to create "self-describing data", for example, or to "separate content from presentation" or to do "single-sourcing". Don't Learn XML? Why not learn XML?

Related: