Chris Pollett > Students > Pinapala

    Print View



    [CS 297 Proposal]

    [Deliverable 1]

       [Madcap Flare Configuration]

       [Madcap Flare Demo]

       [AdobeRobohelp Configuration]

       [Adobe Robohelp Demo 1]

       [Adobe Robohelp Demo 2]



    [Research on Wiki systems]

    [Deliverable 3 :A Basic Wiki editor]

    [Deliverable 4: Feature set for CSH Wiki]

    [CS297 Report - PDF]

    [CS 298 Proposal]

    [Deliverable 1: Design Document]

    [Deliverable 2: UI mocks for Help panes]

       [Left Aligned]


       [Right Aligned]

    [Deliverable 3: Help Display From web service & Wiki Parser]

       [Wiki Parser]

       [Help Display & WebService sample]

    [Deliverable 4: Integrating CSH into Yioop.]

    [CS298 Presentation - PDF]

    [CS298 Report - PDF]

    [Graduation Pic with Dr.Pollett]


Context-Sensitive Wiki Help for Yioop

Design document for User Interface used for viewing and editing help content.



This will be a concise overview of the context-sensitive help UI design, Which I will implement as a part of CS298. This will be the same UI design implemented for all ‘help’ pages on “Yioop”.


Statement of Purpose:

A Context-Sensitive Wiki Help System combines the aspects of context-sensitive help with the collaborative nature of a wiki. Users get the targeted help based on their context, but they also have ability to edit and contribute to the help content.

This  system will be an integral part of the “Yioop” system, will be extensible and will enable community to add more and more help content.


Content Outline:

Invoking Help

* Users can invoke help with a dedicated “Help” button along the top right box. Clicking on

the help button takes the user into the help mode.

* There are two ways help will be displayed to the user. Contextual help (using tooltips) &

procedural help (displayed windowpane). Procedural help will be task-oriented explaining

a possible task to be performed and how to perform it.

* There will be predefined areas on the page, to which Help can be provided to; these areas

are called “Help points." For invoking procedural-help, help-points will be used.

* A question mark beside an element will be used to allow the users invoke contextual help.

* For procedural help, help content will be exposed on the right pane. The help panel opens

up when the user clicks on any “Help point” (procedural help) on the page.

* If the user clicks on a help tip that was specified to provide contextual help, help will be

pictured in a tooltip.


Editing Help content

* For procedural help, Users will be able to edit the help content right in the help window

pane itself. An edit button pops up when help content is being displayed. When the help

content is being edited, edit button will be hidden.

* For contextual help, the help window will be leveraged to edit the tooltip help content for

all the tooltips at the same place. It might be hard to get the tooltips editable directly, so

the tooltip's list can be displayed, which could easily be edited by the users.