Help Viewer

From Openmoko

Contents 1 Overview 2 Use Cases 3 Layout Components 3.1 Application Area 3.1.1 Application Menu 3.1.2 Filter Menu 3.2 Navigation Area 3.3 Toolbar 3.3.1 Search 3.3.2 Action Buttons 3.4 Details Area 3.5 Footer Area 3.5.1 Status Bar 4 Constraints 5 Sessions 6 Architectural Details 7 Implementation Recommendations 8 Icons 9 Interactions 10 Unresolved Issues 11 Questions and Answers

Overview

This article defines the Help Viewer Application, an application designed for getting answers to common questions and problems for the OpenMoko platform. The Help Viewer Application is common to all Native Stylus-Based application.

Use Cases

Here are some possible use cases:

• I want to learn how to store a search result
• I want to learn how to contact the developer of an application

Layout Components

https://wiki.openmoko.org/images/3/35/Screen_help_viewer.png

• 1) Application Menu -- Additional options related to article objects.
• 2) Filter_Menu -- Filtering options for the list of articles.
• 3) Navigation Area -- List of articles based on current filter.
• 4) Toolbar -- Search reindexes, after every keypress, the help item membership of the Search Results Category.
• 5) Details Area -- Detailed view of current selected article.

Application Area

Application Menu

Item	Action	Constraints
Help	Opens Help Viewer Application with help for this application

Filter Menu

Item	Action	Constraints
All	Displays all help items
<category>	Displays all help items from this category
Search Results	Displays all help items matching current search string

Navigation Area

Displays list of help items from current Category using the Navigation Widget. Has the following structure:

Item	Action	Constraints
Column 1	Displays subject of help item

Tap selecting a row, will display correspoding help information in the Details Area.

Toolbar

Search

Search reindexes, after every keypress, the help item membership of the Search Results Category.

Action Buttons

(TBD)

Details Area

https://wiki.openmoko.org/images/d/d5/Screen_help_viewer_full.png

• 1) Article Body -- The current article's full contents in a Message Body.

Footer Area

Status Bar

Displays the total number of help items in the current category.

Constraints

(TBD)

Sessions

• The current help item selection and Details Area mode is persistant.

Architectural Details

(TBD)

Implementation Recommendations

(TBD)

Icons

• Help icon size is 21 x 21 pixels

Interactions

(TBD)

Unresolved Issues

(TBD)

Questions and Answers

(TBD)