The SCOhelp system supports a flexible system of navigation,
called ``views''.
The view HTML files generated by the system
are stored in a TopicViews subdirectory under
each language directory.
About topic views
Topic views provide entry points into the documentation set
based on subject areas.
The goal is to point the user directly to the subject matter
they are looking for.
A view is a subject listing, similar to a table of contents.
Instead of chapter and section titles and pages,
it lists pointers to information.
That information can be other lists to further refine the subject,
or individual HTML files on that subject.
Views are displayed in the browser window with multiple frames:
the left-hand frame shows a view list on a particular subject,
and the right-hand frame shows an introduction to that subject area.
If an item in the view list points to another view list,
selecting that item replaces the current view and introduction
with the new view and introduction.
If the item in the view list points to an HTML node,
selecting that item displays the node in the right frame
and leaves the left frame unchanged.
Navigation buttons in a frame at the bottom of the window
assist the user in navigating through topic views.
Some characteristics of views are:
Topic views that are presented to the user reflect what is actually
installed on the system.
This ensures that all links in the topic views will work.
Views are generated from
view metadata
supplied with a set of HTML files.
A given view list can have contributions from SCO,
vendors supplying SCO with HTML files,
and other independent vendors.
Views are rebuildable in the field to accommodate updates and new
products being installed.
The top-level view is the main topic list that is provided by SCO
and is static (can only be changed by shipping a new file).
An item on a view can link to another view, a table of contents,
or an HTML file.
A view list can have an introductory page displayed in the right screen.
View items can be classified by node class and ranked by a weighting factor.
A given HTML file can participate in more than one view.
Top-level home page
When the user starts SCOhelp or selects the
Home button in the bottom left frame in
SCOhelp, the top-level view appears.
The top-level view has a fixed set of subjects.
The ViewID for the top-level view is topview.
Vendors should not use topview as a ParentView in
view stanza files;
instead, vendors should add their content to the
view pages below the home page.
The current list of view pages listed on the top-level home page are:
View ID
Title
REFhome
Manual Pages
BRhome
Backup and Restore
SHLhome
Command Line (Shells)
CPThome
Compatibility
DOShome
DOS and Windows
DSKhome
Desktops
FDhome
Files and Directories
FShome
Filesystems
HWhome
Hardware
INShome
Installation and Licensing
INThome
Internet and Intranet
MMhome
Mail and Messaging
NEThome
Networking
PRhome
Printing
SEChome
Security
SMhome
System Management
UGhome
Users and Groups
HDKhome
Hardware and Driver Development
SDKhome
Software Development
LATEST
Latest Updates
FEAhome
UnixWare 7 Features
GLhome
Glossary
View mechanism
Because views reflect what is actually installed on the system,
views must be rebuilt based on the information supplied
with the installed HTML files.
When a new set of HTML files ship, or when another product
is installed, the views are reassembled from view metadata by the
ODSSI tools
resident on the system.
If the installation scripts call the ODSSI tools,
the installation process triggers the
regeneration process.
The view metadata exists outside the HTML files for these reasons:
You can add view metadata to an existing HTML file created
from any source without modifying the HTML.
It provides the ability to restructure views and ship new views after
the HTML files ship.
New views could be swapped in without changing the HTML files.
The amount of view metadata is small relative to the number and size of
the HTML node files; regenerating views is more efficient
because all the HTML files do not have to be scanned.
HTML files from any source can participate in the view system,
including documentation that has not been built with views in mind.
Vendors generate HTML using a variety of tools,
and adding the metadata is another step that must
be performed each time the HTML is regenerated.