TBD: incomplete
This document describes a basic structure of Maemo help file. Help file conform to XML version 1.0.
File must consist of the following elements:
ossohelpsource
Root element.
Required.
folder
Element to contain topics. Only one instance of this element is allowed. Must have a name.
Required.
title
Name of the folder. Only one instance of this element is allowed.
Required.
change_history
Element to keep document change entries history. Used by and for content authors only.
Not visible. Optional.
change
Element to contain change entry. Contains text only.
Optional.
topic
Element to contain a topic. There can be a lot instances of the element. Recommended that each topic must be self-contained. Each topic:
- Must have a title
- Must have an associated context ID
topictitle
Topic title.
Required.
context
Element to hold ID of the associated context ID. ID is stored in contextUID attribute.
synonims
Element to contain topic’s synonyms. Used by Maemo Help Search engine only. Each topic synonym must be wrapped to a single synonym element.
Not visible. Optional.
synonym
Element to keep topic synonym.
Optional.
(content represeting elements itself)