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 Feature set.

This is a deliverable that focuses on the Feature set for the context sensitive Wiki help for Yioop. The following are the features that our Context-sensitive wiki help will poses from the front-end user's perspective.

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". Help points will be used for Procedural help.
  • Contextual help will be invoked using a question mark beside the element for which help will be displayed.
  • 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, while its hidden while help content is being edited.
  • 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 tooltips can be displayed as a list, which could be easily edited by the users.
  • There will be a preview button for previewing the changes made to the help content. The preview is applicable to both procedural as well as contextual help.

Wiki/Editor features

  • The primary portion of the Wiki system is the Wiki-editor.The wiki editor will support all the basic functionalities leveraging the Mediawiki Markup.
  • The editor will permit users to upload Images/files that can be used to attach to the help articles. The insertion of files/images will be according to markup specified by Mediawiki markup where Filenames will be utilized to track/insert files into help articles.
  • If the editor is being by a user and if there is inactivity for n (configurable) seconds, the wiki-editor page will timeout.
  • Wiki system will be able to save help content revisions with other metadata that includes a time stamp at which the content was saved and the name of the author of the content.
  • The wiki system will feature a diff engine that displays the diff between two revisions line-by-line.