"DITAworks is an Eclipse based solution which is built on DITA architecture and supports collaborative modeling, maintaining, publishing of complex documentation arrays."

*instinctools GmbH

Posts Tagged ‘DITA’

Recorded webinar on “DITA Specialization: Tools for Visual Support” available

Friday, July 9th, 2010 by Amit Tejpaul

On June 10, 2010, we had organized a webinar on the topic “DITA Specialization: Tools for Visual Support”. We would like to thank all the participants for their enthusiasm in attending the webinar.

In this webinar, Alexej Spas talked about how the otherwise complicated activity of DITA specialization can be handled comfortably in a visual way. The benefits of having infrastructure support for DITA specialization in terms of model validation, import, export and integration with version control and documentation environment were also talked about. The webinar was structured as follows:

  • Traditional approach to doing DITA Specializations
  • Main challenges in doing DITA Specializations
  • Traditional vs. Visual Specialization/Benefits of visual over traditional Specializations
  • Demo by doing an example Specialization using visual tools

For those who had missed the webinar or those who want to go through it again, we have uploaded the webinar at:

Webinar: Tools for Visual support for Doing DITA Specializations

The presentation slides for the webinar are separately available at:

http://www.slideshare.net/instinctools/dita-specialization-tools-for-visual-support


*instinctools to provide DITA Visual Specialization Manager free-of-charge

Friday, November 6th, 2009 by Alexej Spas

*instinctools GmbH has decided to provide free-of-cost licenses for its DITA Visual Specialization Manager, an application designed to make complex DITA specialization tasks easier to work with. These free licenses will be valid for unlimited time period but limited to the development and maintenance of open DITA Specializations e.g. specializations under OASIS for different industries such as Machine, Pharmaceutical etc. This offer is aimed at lowering the barriers to DITA usage and adoption. (more…)

Networked Teams - Intelligent Content

Tuesday, June 9th, 2009 by Alexej Spas

…is the motto of this year’s Single Source Forum.

On June 22, 2009 *instinctools will present released DITAworks 1.1 as an important innovation on the 9th Single Source Forum in Munich.

This event is an ideal opportunity for visitors from all kinds of business areas to get information on challenges and innovations in the documentation world.

This year, emphasis is placed on new developments in the provision of information. How suitable are Web 2.0 technologies for the documentation environment? How can clients be directly involved in the creation process? And how do collaboration platforms promote the exchange of information?

Answers to these questions are given by acclaimed field experts in the form of lectures and practice examples on themes such as virtual team work, collaborative tools and user involvement.

Professor Dr. Volker Markl from the Technical University of Berlin opens the program with an exciting insight into the intelligent search machines of tomorrow. To round off the day, a panel of experts from science and business will discuss the latest trends in technical documentation.

In the accompanying exhibition, renowned software manufacturers present their proven tools and interesting new developments.

Visit our booth on Single Source forum..

More about Single Source Forum

DITA Eclipse Editor: Using DITA for publishing documentation in Eclipse Help format. Functionality preview

Monday, April 27th, 2009 by Alexej Spas

This article discusses the main challenges that a documentation team faces when it decides to use DITA as a source format for Eclipse Help documentation. It also explains how DITAworks documentation tool plans to address these challenges.

About Eclipse Help

The Eclipse Platform includes its own help system based on an XML table of contents referencing HTML files.  This is a standard way to document Eclipse-based software products.

But eclipse help format is not reduced to usages only inside of Eclipse platform. It is available as standalone server solution and can be used for providing ANY help content via Web server. Eclipse help system provides such important functions like navigation through TOCs, search, indexing, bookmarking and s.o.

When Eclipse help is used for documentation of Eclipse-based software, it allows much more sophisticated mechanisms for context-dependent help definitions like: search expressions, contexts, so called cheat sheets and s.o.

Additionally, due to component-oriented architecture of Eclipse, Eclipse help is structured in form of plugins that can be independently deployed and interlinked. This enables creation of scalable documentation that fits to complex product configurations.

Eclipse Help and DITA

DITA as single-source architecture opens a promising approach for maintaining all your documentation in single format. Eclipse help as one of the publishing formats can address needs of context dependent application help as well as generic online help.

DITA Open Toolkit provides a way to transform DITA maps and topics into Eclipse help plugins, but these possibilities are quite limited. Namely DITA OT will generate a TOC file and set of HTML topics linked to source map, but it does not address following important specifics of Eclipse Help:

  • Definition of contexts (used for context-dependent help)
  • Interlinking topics between several Eclipse help plugins
  • Definition of search phrases
  • Definition of cheat sheets
  • Tuning of plug-in contents (Manifest properties, amount of TOCs, indexes, contexts and s.o.)
  • Some other advanced features of eclipse help.

These limitations are hindering adoption of Eclipse help as publishing output format for DITA content.  They need to be addressed if we want to use the full capability of Eclipse help system and this issue can be seen as a current challenge for DITA-oriented tooling.

(more…)

Common errors in DITA specializations

Saturday, March 28th, 2009 by Alexej Spas

DITA as information architecture can be seen as a set of best practices for topic-oriented authoring. Besides providing a set of DTDs and rules for authoring, DITA also defines a way to design new information structures customized through custom semantics. This is achieved by process of specialization.

Specialization opens a new dimension for customizing DITA to needs of different enterprises. But doing a valid specialization is not a trivial process. It requires rather deep understanding of DITA internals and command in technologies like DTD, XML Schema and s.o.

But even with sufficient knowledge of DTD (or XML Schema) coding, doing a valid specialization requires knowledge of certain DITA principles and rules. Just designing a valid DTD will not necessarily mean that you have a valid DITA model. More on Specializations can be read here: http://docs.oasis-open.org/dita/v1.0/archspec/ditaspecialization.html

This article discusses some common problems and pitfalls people face when they do DITA 1.1 specializations . (more…)

DITA Models single-sourcing: Why not?

Wednesday, February 18th, 2009 by Alexej Spas

It is a well known fact that DITA is a great information architecture that enables single source publishing of content into different formats. “Write once and use everywhere” is a motto of it. But when it comes to DITA definition itself and DITA specializations, we have to make decisions about format we want to maintain our models in. We need to choose between DTD or XML Schema. Once this decision is made and the model is developed, it is quite a time consuming operation to change chosen format and in most cases, people would stay with originally selected format because of the effort and time involved.

DITA itself has to be supported in both formats in parallel.

But why not consider single-sourcing of DITA models? I think this would be logical step following the single-sourcing philosophy of DITA.

(more…)

 

Copyright © 2008-2010 * instinctools GmbH