background preloader


Facebook Twitter


Editix Lite - Free XML Editor. Bob Stayton - Re: [docbook-apps] too many block-elements in xsl-fo ouput. DocBook. LyX - The Document Processor. DocBook. Authoring with Eclipse. Summary The topic of technical publishing is relatively new to the world of Eclipse.

Authoring with 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. Writing Documentation with DocBook. Revision 3937: / 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.

DocBook XML Resources at CERN

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. The document Writing Documentation Using DocBook - Using DocBook at CERN is available in HTML (chunked per chapter), HTML (in a single file), or in PDF. 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):

Date: 30 juin 2005, Mise à jour: 30 juin 2005SilviaCADILLO, {} 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. DocBook Cascading Stylesheet (CSS2) About DocBook is an XML dialect for writing documentation.

DocBook Cascading Stylesheet (CSS2)

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.

Writing documentation with DocBook-XML 4.3. >e-novative> DocBook Environment - DocBook XML on Windows was never easier. XML Editor: XMLmind XML Editor. Profiling DocBook documents. 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.

Take My Advice: Don't Learn XML

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".