component manager

Content in the technical world is rarely static. Changes are made, versions and revisions are created and procedures have to be followed. Not to mention the ever-growing need for more languages for new and emerging markets.

The Darwin Information Typing Architecture (DITA) is an international standard, developed to meet these challenges.
 

Modulux, Koala’s DITA component management system, helps organisations to place the control of their DITA content in the hands of the people who know it best – the authors. Developed to work seamlessly within XMetaL, Modulux gives authors access to content management functionalitywithout leaving XMetaL®. Added to this, DITA promotes the creation of content as close to manufacture as possible.
 
 

Features and Benefits

 
Procedure control

Modulux enforces that whilst performing any document operation the user must be recognised by the system and each recognised user has a set of permissions granted by the Administrator. For example, some users may be able to make new versions of documents whilst others may simply be granted read only access. Additionally, a full audit trail is produced by the system capturing each update/edit made by the identifiable user.

Content Creation

Users can create new DITA topics from within XMetaL and suitably authorised users can check out documents already existing in Modulux for editing within XMetaL.

Version control

Using Modulux, making a new version of the document is highly controlled. Users cannot make an unauthorised version simply by using “Save as ...” but have to follow a formal process to issue a new version. Of course the system will record who made the new version, why and when.

Authorised users can check-in a new or modified topic. The system then automatically assigns a new revision number to the revised topic and archives the previous version of the topic.

The following screen shots illustrate Modulux’s check-out and check-in cycle using the XMetaL® user interface. First a DITA map is opened from the repository, then one of its Topics is opened which automatically retrieves it from the repository (the user has to select whether they want to view or edit it) and finally the document is checked back in once alterations have been made.

The entire cycle is seamlessly integrated with standard menus and processes within XMetaL.

Illustration control

All images in DITA documents are also saved into the repository. Images can be altered in other applications and the changes checked-in using the XMetaL interface. So, versioning illustrations is controlled in the same way as other documents.

Modulux has been developed to appeal at both a technical and business level to create maximum efficiencies and benefits to an organisation whilst creating as little disruption to the content life-cycle as possible.

Low cost of ownership

After an initial short analysis and a resulting specification, deployment is typically complete in a few days and not several months.

ROI

Return on Investment from the use of Modulux starts almost immediately because the user is in a familiar authoring environment and so becomes productive very quickly.

Low training requirement

Experienced XMetaL users will take to Modulux very easily, and those without XMetaL experience will soon get used to the intuitive wordprocessor- like environment and the simple integrated content control.

Embraces DITA

Modulux fundamentally embraces DITA. From the user interface to the way new content is created, the principles behind DITA are part of the fabric of the system.

Audit trails

All user actions are logged so that those responsible for edits and updates are clearly recognised and recorded.

Content re-use and re-purposing

DITA has re-use at the heart of its philosophy and so does Modulux. However, because this re-use is exposed at the point of authoring - it is positively encouraged.

Due to the structured and modular nature of DITA based content, the re-purposing of that content is easily achieved when using Modulux. For example, DITA based content can be used by both the marketing and technical parts of a company in a data sheet for example where a mixture of “marketing-speak” and factual technical data is needed. This is often referred to as single-source publishing.

Topic and item re-use

Any data component in the Modulux repository can be re-used using the usual XMetaL referencing procedure. When the user selects Search or Browse from the XMetaL dialogue, the Modulux explorer appears instead of the normal file explorer and the user can select the required component as they would normally.

Out of the box Publishing

Modulux’s integration into XMetaL means that publishing whole DITA maps is a simple two step procedure:

  1. Load the DITA map into XMetaL.
  2. Click on deploy.

XMetaL then runs through its usual deployment procedure and the entire DITA map and its contents are published. Simple!

De-duplication and improved consistency of content

Re-using content means that fewer errors occur due to the fact that correct content is re-used and changes to that content are also, by definition, propagated within the system.

Configuration and Customisation

Deploying Modulux is a straight forward and simple procedure. As Modulux uses DITA, configuration of the system is also kept to a minimum. Customisation can easily be achieved around both the author interface (XMetaL) and the underlying content structure (DITA specialisations or other content models).

Click here to download this information about Modulux, formatted for print as a two-page A4 PDF file

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

moduluxFlow.jpg