Login | Register
My pages Projects Community openCollabNet

xlsdoc
Project home

On Friday, May 18, the normal maintenance window (17:00 Pacific time) will be extended for data center maintenance until 23:00 Pacific. No extended down-time is planned, but brief delays and interruptions are possible throughout the period.

If you were registered and logged in, you could join this project.

Summary an universal embeded (or not) documentation language
Categories None
License GNU General Public License
Owner(s) deveaux
XLSDocLogo

Francais | English

XLSDoc : Goal and context

The goal of the XLSDoc project (XML Language of Structured Document) is to develop an environnement for managing and generating the documentation of a software project. XLSDoc proceeds from university research which is done at the VALORIA (computing research center of south britain university), in the Composants team. This project is currently developped by students during the course of their study. One of our current goals is turn this project into an Open Source project.

Software development and document writing likeness

Research works of M. Deveaux (Composants team of VALORIA) have shown that software developpement and document writing can be seen as similar activities. Developpment cycles of a class or a document are rather close (cf research works of M. Deveaux). From these observations, a unique tool for generating all sorts of documents (textual documentation as well as source code documentation) suited for any kind of media (screen, projection, paper, ...) would be convenient.

XLSDoc : a unique documentation tool

The goal of XLSDoc is to generate documents suited for any kind of media from different sources (source code written in an object oriented language, structured texte documents, structured model documents). XLSDoc succeeds to LSDoc, a documentation tool which had been developped by VALORIA with the same goals but which is lacks ease of use. XLSDoc must be easier to use and is based on current technology and standards.

On the document writing side, XLSDoc must be able to process XHTML documents. On the source code side, XLSDoc must be able to extract documentation from different object oriented language.

To complete this objectif, XLSdoc use XML technology (DTD, DOM, XSL) and also uses O2CM which is an object language abstraction and proceeds from other researches (cf research works of VALORIA). In addition, XLSDoc is developped in Python to maximize its portability.