First-Aid Help for eRules

This page contains some concise help information for your first steps with this application. The following will be treated:

top

Selecting a publication

Fig 1 - The Publications Box
Fig 1 - The Publications Box

The first step is to select the publication you would like to consult, from the list of publications. All publications are shown in the publication box in the top left corner of the screen. Initially, they are shown ordered by organisation, but the title dropdown menu allows to reorder the display by, for example, language or publication date.

To select the publication, simply click on its title. Some publications may not be available and are displayed in gray. Once selected, the publication title will be displayed differently (see figure 1, the "December 2003 edition of the Rules for Classification of steel ships"). Also, at the same time the Table of Contents will be loaded in the the Table of Contents box underneath the publications box.

top



Navigating the Table of Contents

Fig 2 - The Table of Contents Box
Fig 2 - The Table of Contents Box

The behaviour of the Table of Contents is modeled after the Windows Explorer behaviour. This means the following:

top





Tip: you can use Alt+n and Alt+p to move to the next and previous page in the publication. No need to use the mouse!

Note that in Firefox to use the access keys, you need to use Shift + Alt + shortcut key.

top



Switching from Table of Contents to List of Tables to List of Figures

Fig 7 - Changing the browse mode
Fig 7 - Changing the browse mode

The default browse mode is by Table of Contents entries. There may be times when you would like to browse all tables of a publication, or all figures. For this, there are different browse modes which can be selected by choosing another entry in the Table of Contents box (see figure 7).

Fig 8 - List of Tables in action
Fig 8 - List of Tables in action

Once selected, several elements in the user interface will change (see figure 8):

Fig 9 - The adapted Next/Previous buttons
Fig 9 - The adapted Next/Previous buttons






top



Quick Search

Fig 10 - The Quick Search form  (disabled)
Fig 10 - The Quick Search form (disabled)

In the top-right corner the quick search form is available at all times. When starting the application you will notice that the box is disabled (see Figure 10); you cannot search, because you haven't selected a publication yet. As soon as you choose one, the box will become active (see Figure 12), and you can enter a search term.

Tip: you can use Alt+q to move the cursor to the search field. No need to use the mouse!

Note that in Firefox 2.0 to use the access keys, you need to use Alt + Shift + shortcut key.

Fig 12 - The Quick Search form  (normal state)
Fig 12 - The Quick Search form (normal state)

top



Advanced Search

Currently, the Advance Search Interface offers you a number of more advanced features, in particular: Search simultaneously more than one document, and Restrict your search by some document-specific criteria.

To search several documents at once, you can use Shift and Ctrl buttons to select a range of sequential or interspersed documents (see Figures 13 and 14).

Fig 13 - Advanced Search Interface
Fig 13 - Advanced Search Interface - Sequential documents selected using the Shift key
Fig 14 - Advanced Search Interface
Fig 14 - Advanced Search Interface - Non-sequential document selected using the Ctrl key
Fig 15 - Advanced Search Interface
Fig 15 - Advanced Search Interface - Documents of the same "family" selected; document restrictions remain active (compare with previous figures)

You may choose not to search the complete body of a document, but to restrict your search to a certain structural type, such as "tables", "titles" or "rule requirements". This may help you to blend out results you're not interested in. See Figure 15, the second yellow arrow points to the dropdown menu where you can choose from a number of possible restrictions.

Note: The choice of items depends on the type of document selected (obviously, a rule requirement will not be available in an IMO publication). Also, if you select more than one document to search, and they are not 'compatible' in the sense that they belong to the same 'family' of publications, the menu will be disabled, grayed out.

top



Search Results

Fig 16 - Search Results
Fig 16 - Search Results

When you click the go button, it will take a while to display the results in the main contents area on the right-hand side of the screen. This is particularly long for the very first query, but once it has finished, you will see a screen like the shown in Figure 16. At the top of the screen you can see a tab labeled Steelships (101). This indicates that for the publication "Steelships" (i.e. the Rules for the Classification of Steel Ships), 101 matches have been found.

Underneath this tab, the white horizontal area is used to show data about the search, such as the search expression ("bulk carrier" in the figure shown), there are no "restrictions" (see the next help topic, Advanced Search, for more information), the time it took to execute this query, and the "navigator" to be used to go from one page with results to the next.

The search results are displayed in a list form (reminiscent of today's modern search engines). Each match is shown in some context to make it easier for the user to decide whether the hit is interesting or not. This "Keyword in Context" box is clickable and will transport you to the place in the publication where it occurs. The yellow arrow in the figure highlights this fact.

If the number of search results is too large, the results are paged, use the « previous results and next results » buttons to move forward and backward inside the result set.

Fig 17 - Publications box and Toc box reflect the search
            results
Fig 17 - Publications box and Toc box reflect the search results

Apart from the list of search results shown in the main contents area, the publications box and the Table of Contents box also reflect the search results by displaying next to each node the number of matches contained inside (see Figure 17). This will also work when you change to type of the Table of Contents to List of Tables or Figures. Also, when you change the publication, your search will be remembered.

Another change is that in Browse mode the menu will have two additional buttons, « previous hit and next hit ». Clicking these buttons will take you directly to the Rule Requirement (or similar unit) that contains the match. Sometimes, when your screen is relatively small, and the match appears toward the end of the Rule Requirement that some scrolling is still required.

If you want to clear up everything, you can simply click the clear query button in the Quicksearch Interface, and everything will be cleaned up.

top



Search Expressions

You can use a number of search expression to make your search more specific. Just a couple of examples (a more exhaustive list will be forthcoming):

bulk searches simply for the word bulk anywhere in the current publication
bulk carrier searches for occurrences of both words inside a paragraph (or title, or table cell)
"bulk carrier" searches for the phrase consisting the two words anywhere in the current publication.
carrier _bulk exclusion: searches for carrier without bulk
carrier? will find all occurences of carrier and carriers (or any other combinations of carrier + one character)
You can use wildcards anywhere in a search expression, for example: h?ll will find hall, hell, hill, holl (few of these words will actually appear in our documents, and some may not even exist) and hull.
weld* will find all occurrences of words starting with weld, such as welding, welded, welder, welds, weldable etc.
* will find all occurrences of the structural type defined in the field "Search In" (like "Rules Requirements", "Legends Figures", ...) in the document(s).

top



Print and PDF

Print PDF (where available)

Fig 18a - The PDF icon indicates this section is available
            as a PDF
Fig 18a - The PDF icon indicates this section is available as a PDF

For Bureau Veritas publications, and the official Rules for the Classification of Steel Ships in particular, PDF equivalents are available. They are accessible through icons next to the begin of each Section or Appendix (see figure 18a).

Print What's on Screen

It is possible to print each fragment using the browser's print mechanism. As all browser buttons are hidden, you have to use a trick in order to be able to print: Right-click on the fragment you want to print, and select "Print" or "Imprimer" from the context menu (see figure 18b). If "Print" is not visible, try using the shortcut Ctrl+p.

Fig 18b - Internet Explorer's right-click context menu
Fig 18b - Internet Explorer's right-click context menu

top

Problems

Sometimes, when you want to view the current publication, eRules displays the previous publication.

The problem comes from the browser's cache of Internet Explorer or Firefox.

You can avoid it by cleaning the cache. Please refer to the following instructions:

Internet Explorer:

  1. Click Tools on the Menu bar and then choose Internet Options. The Internet Options dialog box appears.
  2. Click the General tab.
  3. Click the Delete Temporary Files button in the Temporary Internet Files section. The Delete Files dialog box appears.
  4. Click OK in the Delete Files dialog box.
  5. Click OK in the Internet Options dialog box.

Firefox:
  1. Go to Tools located on the Navigation Bar.
  2. Select Clear Private Data... Ctrl+Shift+Del.
  3. We are just clearing the cache so uncheck all option except Cache.
  4. Click Clear private Data Now.

top