NOTE: This wiki is provided by the OASIS standards consortium as a collaborative tool for the OASIS DITA Help Subcommittee. Members of the Subcommittee are permitted to post to these pages (SC Members Page). As this is an official workspace of the TC, the OASIS IPR Policy and other OASIS rules apply to its use. |
To learn more about the work of the Subcommittee, send a comment, or join this effort, visit the OASIS DITA Help Subcommittee homepage. Prospective members of the subcommittee must first join the OASIS DITA Technical Committee (TC Members Page). |
Wiki pages are transient documents, so intermediate edits may not be saved. SC members should move all permanent work and stable artifacts to the SC's document repository, where the archival work product of the SC also can be viewed by the public. |
Wiki home page for the OASIS DITA Help Subcommittee
Welcome! The URL for this page is: http://wiki.oasis-open.org/dita/ditahelp
The formal name of the subcommittee is "The OASIS DITA Help Subcommittee".
Purpose
The OASIS DITA Help Subcommittee has the following top-level purpose:
- develop a top-level design for authoring of Help systems and user assistance content for implementation using DITA;
- establish recommendations for the integration of DITA-authored Help systems and software applications using context-sensitivity;
- remove the obstacles to effective use of DITA for Help systems through the creation of best practice guidelines, cookbooks and worked examples, and to promote the use of DITA for creating Help systems and user assistance content;
- develop informal support for processing DITA for delivery as Help systems and user assistance;
- establish guidelines that promote best practices for applying standard DITA approaches to Help systems and user assistance content.
The deliverables of the DHSC will be:
- recommendations to the DITA TC for specification changes to better support Help systems and user assistance content;
- a high-level processing model description that defines the standard use of DITA for Help systems and user assistance content;
- explanations and guidelines for the use of DITA for Help systems and user assistance content.
The DITA Help SC wiki will support collaborative design work between and during meetings.
Definition
DITA Help, as defined by the OASIS DITA Help SC (DHSC):
- A set of recommendations for the design and implementation of commonly recognized user assistance components using the DITA architecture. These components include, but are not limited to, navigation components, context-sensitive linking, embedded Help, browse sequences, associative links, window definitions. The recommendations can be used as a foundation for the development of authoring models and tools to support solutions in a variety of formats and for a variety of platforms.
Current activities
We meet every three weeks via teleconference.
Some draft changes to the DITA standard, aimed at DITA 1.3, are being discussed. Another Wiki page provides guidelines for DTD/Schema development for sub-committees.
Status of the subcommittee representations
This information in this Wiki reflects exploratory work. It is not a reliable guide on the future direction of DITA. It should not be taken as guidance for using DITA or for developing DITA tools.
Working discussion about objectives
Moved to http://wiki.oasis-open.org/dita-adoption/ditaadoptionhelp (to be deleted from this page)
Background
TBA
Email: <tony.self AT SPAMFREE hyperwrite DOT com>
Reference Articles and Papers
In 1999, Joe Welinske of WinWriters (now WritersUA) instigated the formation of the Help for the Web Initiative, a volunteer committee under the loose auspices of the World Wide Web Consortium. The initiative had a flurry had activity for about six months, but then stagnated. The papers contributed to the initiative included:
Implementing a Web-based Help System (Tony Self)
At the WritersUA annual conference in Palm Springs in 2006, a meeting of interested parties was held to discuss a markup language for help. The outcomes of that meeting included the setting up of an OASIS user assistance discussion list, and a discussion paper by Tony Self. The OASIS assistance discussion list started with Paul Prescod devising a very useful set of goals. Unfortunately, after an initial flurry of ideas and messages, momentum was lost and the list became inactive.
Other XML for User Assistance resources include:
Bob Doyle's HATs Off to XML Help
Sarah O'Keefe's XML Architecture for Customized User Assistance
David Rose's XML - The Future of Windows Help?
Tony Self's explanation of Microsoft Vista Help (Longhorn Help)
Tony Self's article on DITA for Help (also on WritersUA Site)
Tony Self's article on modifying DITA OT build files for context-sensitive Help
Tony Self's DITA Help blog on the DITA XML site
Lee Anne Kowalski's presentation on Getting Up To Speed with Eclipse User Assistance
Su-Laine Yeo's tutorial on customising XMetaL 6 WebHelp output
Presentation by Stan Doherty and Ben Allums on DITA for Help at CTDUG Meeting
Meeting Notes
- Minutes are stored in the OASIS DITA Help Subcommittee documents area.
Dita Wiki