Menu

#3 Find better documentation format

not scheduled
open
nobody
Research (5)
5
2007-02-02
2007-02-02
Hanno Braun
No

All documentation is currently organized in plain-text files. While this is enough for many purposes, it would be nice to have a more advanced format that fulfills the following requirements:
* Line-based, human-readable file format that can be edited with a standard text editor.
* Ability to create links between different documents.
* Only logical information embedded in the document, no information about how the final document should look.
* Ability to generate several document types (html, pdf, etc.) by using some kind of style sheet file (e.g. css).

A possible candidate would be DocBook[1].

[1] http://docbook.sourceforge.net/

Discussion

  • Hanno Braun

    Hanno Braun - 2007-02-03

    Logged In: YES
    user_id=1090331
    Originator: YES

    Another good candidate seems to be DITA[1].

    [1] DITA Open Toolkit: http://dita-ot.sourceforge.net/

     
  • Hanno Braun

    Hanno Braun - 2007-03-27

    Logged In: YES
    user_id=1090331
    Originator: YES

    First research indicates that DITA, as a format, seems to be better suited than DocBook:
    * DITA is based on topics that can be assembled into documents, while DocBook is much more monolitic (better suited for books and articles).
    * DITA is less complicated then DocBook, which has a huger number of tags and seems to be quite bloated.

    However, DocBook's tool support is vastly better. For DITA, only one open source solution seems to exist (DITA Open Toolkit[1]) which is cumbersome to install (I couldn't get it to work so far, clearly more effort is required for this than I'd like to put in), while DocBook is supported by a broad range of tools and can be easily transformed into any output format.

    As it looks right now, DocBook seems to be the better solution.

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.