The ECA web manual screen is broken into a number of regions (frames), each of which provide different ways of interacting with the manual content. The regions are:
Quick Search Panel -Top/Left
Menu bar - Top
The Table of Contents -Left
Manual Item Content - Main Frame
Search Results - Main Frame (switched with Manual Item content)
This part of the ECA manual navigation allows the user to quickly search for a word or phase within the manual without having to first open the full search page. The user may specify any search text that is recognised by the system (see Search Help)
The other item in the Quick Search panel is the ability to enter a Manual Item number directly. After clicking GO (or hitting the enter key) after typing the required manual item number instructs the system to find the section in the manual and to show it in the main frame. The Table of Contents is also expanded to show that item.
Note: There is no need to enter padding 0's in the number. That is, 4.1.1 works just as well as 4.01.01
The Menu Bar running along the top of the ECA web manual allows the user to move around the various parts of the system with ease. The options are sensitive to what parts of the information you are currently looking at (for example the results page). The menus and the items contained within them are as follows:
Back Arrow - allows the user to go back to the last page viewed (same as the browsers Back button)
Forward Arrow - same as browser's forward button
Next Manual Item Arrow - moves to the next manual item in the entire ECA manual (relative to the current item being read).
Proceeding Manual Item Arrow - moves to the proceeding manual item in the ECA manual (if one exists)
Sub-Sections Menu - this menu holds a list of all topmost sub-section names within the manual item being read. It is empty and greyed when the search results, title page, or help screens are active. Selecting one of the sub-section names from the menu jumps to that sub-section in the current manual item.
Search Results Menu - this menu contains options to allow navigation through the current search results. The menu items are:
Results Page / Top of Page - the first item in the search menu is "Results Page", assuming that page is not already showing. Selecting this item makes the search page active. If that page is already active then the menu item shows "Top of Page" to allow the user to return to the top of the results list.
Next Result - if the user has performed a search, then this menu item can be used to step to the next result.
Print Menu - this menu contains a single option that allows the user to print-out the current Manual Item.
Help - contains help on:
The table of contents for the ECA web manual is the way in main which the content of the manual will most often be navigated. This "tree" shows the structure of the manual at the level of Volume, Chapter, Section, and Manual Item (plus Appendices). The tree can be collapsed or expanded by clicking on an item in the tree. If the item clicked in the TOC is a high level element (Volume, Chapter, Section) then the tree will either expand or collapse all the items below that point (depending on its current state). Clicking on a Manual Item (say 4.01.01) will open the content of that item in the main frame. The selected item is highlighted in the TOC tree to provide an indication of the current position in the manual.
The TOC pane can be expanded by dragging the edge of the pane to the right. This will reveal more of the titles in the TOC but reduces the amount of information that is displayed of the selected Manual Item content. The entire table of contents can also be expanded or collapsed to Chapter, Section of Manual Item level by clicking one of the magnifying glasses located besides the Table Of Contents heading.
Finally, the titles shown in the table of contents are often too long to show in the pane. In these cases, to see the entire title (without having to resize the pane), simply hover the mouse over the particular title and the system will show a fly-over containing the entire title.
This is where the content of a manual item is displayed when selected via the table of contents, quick search pane, or as a result of a search.
The search results are displayed in the same window as the manual content. However the system keeps a record of the results so the user can swap between manual content and further results by using the Search Results Menu described above.
The results of a search are shown as a list. The results are shown in the order they are found in the manual from its first manual item to it last. Results found in titles are shown first, followed by those only found in paragraphs , lists or.tables. Clicking on a result jumps to the manual item and area it is found within it.
Highlighting of all occurences of words found in the search string aids in location of the required information within the text.
Note: For further help on searching see the search help menu item.
|
|
End of Section 3.02.01 |
|