Documentation

Balancing Architecture and Documentation Needs of the Eclipse Community

Session Type: 
Extended [55 minutes]
Presenter: 

As software projects evolve and grow their success often results in them being less adaptable to the needs of both the development and the user communities. For a variety of subtle reasons many projects make it hard for developers to contribute.

Even agile projects, known for responding to user needs, have rapidly evolving architectures, and therefore result in any useful documentation to get out-of-date.

The reality in software development is that having accurate and useful documentation is a pain.

Xdoc -- a DSL for Eclipse Plugin Documentation

Session Type: 
Standard [25 minutes]

Schedule info

Room: 
Silchersaal
Presenter: 

Creating an Eclipse Plugin help can be a tedious task. Often Mylyn Wikitext is used but unfortunately, it is not well suited for code centric documentation. That is where Xdoc comes in. Xdoc is a markup language especially designed for Eclipse Plugin documentation. The tooling that comes with Xdoc features generators for Eclipse Help plugins, Eclipse Phoenix framework based websites and printable PDF documents.

The Xdoc language was designed having several goals in mind:

Introducing the Visual Editor for XML

Session Type: 
Standard [25 minutes]

Schedule info

The Visual Editor for XML (aka Vex) is a WYSIWYM editor for XML documents with a long history as sleeping beauty - but it is slowly awakening. Using XML as your document format allows you to concentrate on the content and on the semantics. Vex eases the burden of the angel brackets by hiding them and showing your content in a more readable way.

Syndicate content