OOMMF documentation is written in hypertext. Most pages on the World Wide Web are also written in hypertext., If you are familiar with browsing the World Wide Web, you should have no difficulty using the OOMMF Help Browser.
Reading hypertext differs from reading ordinary text in only one way. Some of the text in a hypertext document will have a special appearance, like this. Such text is called a hyperlink. When you select a hyperlink with a pointing device (for example, click it with a mouse), you are presented another page of hypertext to read. Try selecting the hyperlink above.
By selecting hyperlinks, you can move from page to page of hypertext. The OOMMF Help Browser keeps a list of the pages you have viewed in the order in which you have viewed them. Using the Back and Forward buttons, you can move backward and forward through this list of pages.
Some hyperlinks, like those in the Contents section near the beginning of this page, do not lead to the display of an entirely new page, but cause the display of the current page to scroll to a particular section. When the target section is already visible in the window, nothing will appear to happen, but this navigation step will still be added to the list of pages viewed.
The first page displayed to you in an OOMMF Help Browser window will be a table of contents for a particular topic on which help is available. The Contents button will always display that table of contents page.
The Back, Forward, and Contents operations may also be invoked by selecting the appropriate item from the Navigate menu. Menu selection may be made by either a pointing device (mouse) or by keyboard shortcuts.
In addition to hypertext navigation, the OOMMF Help Browser provides the following functions.
Although the OOMMF Help Browser is patterned after World Wide Web browsers, it does not have all of their capabilities. The OOMMF Help Browser displays only a simplified form of hypertext suitable for help documentation. It is not able to display many of the advanced hypertext features provided by modern World Wide Web browsers.
When the OOMMF Help Browser encounters hypertext it cannot display, it will attempt to work around the problem. However, in some cases it will not be able to make sense of the hypertext, and will display an error message. As an end user, you should be viewing only help documentation which has been tested for viewing with the OOMMF Help Browser, so you should never see such error messages. If you do, you should report the erroneous documentation to the author of the application.
The OOMMF Help Browser displays error messages in one of two ways: within the browser window, or in a separate window. Errors reported in the browser window replace the display of the page of hypertext. They usually indicate that the hypertext page could not be retrieved, or that its contents are not hypertext. File permission errors are also reported in this way.
Errors reported in a separate window are usually due to a formatting error within the page of hypertext. Selecting the Continue button of the error window will attempt to resume display of the hypertext page beyond the error. Selecting Abort will abandon further display. When an error message is displayed in a separate window, first check to be sure that the Strict HTML Level 1 option under the Options Menu has not been checked. If it has been checked, uncheck it, Abort the error message window, and Refresh the browser window. If the error recurs, the erroneous documentation should be reported to the author of the application.
Please report any bugs you encounter in the OOMMF Help Browser to donald.porter@nist.gov.