[platform-help-dev] Eclipse help system requirements

[khalsted@xxxxxxxxxx]

For Eclipse 2.0, the IBM ID community has put forward the
following help system affordance requirements.

1. Require at least the affordances used in Eclipse V1.0
   - TOC rendering:
     - Level 1 nodes affordance (v1 called them infosets,
       and showed them in a drop-down list)
     - Level 2 nodes affordance (v1 called them infoviews,
       and showed them as tabs on the nav frame) *** NOTE:
       The ability to display different views of the navigation
       is critical.
     - Level 3+ nodes in nav tree (topics, shown in tree;
       Level 3 nodes served as search filters)

   - Printing:
     - individual topics
     - topic trees
   - Synchronization
   - Show/Hide navigation
   - Forward/Back
   - Search advanced options (search headings; search filtering)

2. Additional new requirements
   - TOC rendering:
     - Expand/collapse all for nav tree
     - Bookmarking topics
   - Search:
     - Ability to specify case sensitivity
     - Search hits return <h1> from content file, not
       navigation label
   - Infopops:
     - A visual cue on UIs that there is context-sensitive
       help available
     - higher/lower context sensitivity on infopops
       (e.g., an arrow on an infopop for a field that will
       take you to the wizard's infopop)

Kari Halsted
User Assistance PDT
IBM Canada - Toronto Software Lab
(905) 413-3331 / tl 969-3331 / D3-238

The more I want to get something done, the less I call it work.
                   - Richard Bach