Browse Prior Art Database

Generating DITA based help that is aware of which step within a task it is associated with as defined in an activity model

IP.com Disclosure Number: IPCOM000183919D
Original Publication Date: 2009-Jun-05
Included in the Prior Art Database: 2009-Jun-05
Document File: 4 page(s) / 184K

Publishing Venue

IBM

Abstract

This article describes a mechanism for generating a help system from a User Model. This help system includes information on Tasks that a User may carry out. As the User performs the tasks, their progress is monitored; when they bring up the Help System, it is aware of their current task and displays the pertinent Help information.

This text was extracted from a PDF file.
At least one non-text object (such as an image or picture) has been suppressed.
This is the abbreviated version, containing approximately 54% of the total text.

Page 1 of 4

Generating DITA based help that is aware of which step within a task it is associated with as defined in an activity model

DITA provides a way of generating help formats (e.g. InfoCenter) from XML files. These generated files can be used to provide a context-sensitive help system for an application.

    DITA provides a

tag with

sub-tags, allowing structured documentation to be created. When used in a task based user interface there is currently no mechanism available to tie each modelled task to a DITA

element, and each modelled Step within a task to the relevant DITA

element. Having such a mechanism would allow fully context sensitive help to be displayed on an interface.

    This disclosure aims to protect a mechanism whereby having generated a Java* Server Pages(JSP) implementation from DITA. The DITA elements can be mapped to a user's state in the application (with respect to the Activity Diagram),providing context sensitive help within a generated application environment. This disclosure provides another piece to the Model Driven Architecture approach for matching help with user's state.

    Existing art allows an application to be generated from a UML model. This disclosure provides an extension to this behaviour allowing nodesin the Activity Diagramwithin this model to correspond to steps defined in the generated Help. These can be used to correspond to Activity Diagrams (

) and their nodes (

).

    This mechanism is an advance over existing techniques as currently to provide context-sensitive help, the transformed help system would need to display the relevant

content based on where in t...