# Help documents and markers dialog

The 'Help documents and markers' dialog provides an interface to the FrameMaker HyperText system.

The dialog contains a Documents section to the left and a Markers section to the right.

You may select a document from the Documents list, or enter the name of a document within the Selection field provided for the purpose. Alternatively you can press the Find button to display the find documents dialog, which allows you to browse the file system for FrameMaker documents. Document names should be either absolute path names, or relative to any path specified in the Help defaults dialog.

Similarly, you can select a marker from the list provided, or enter a name in the Selection field underneath the list. There are two default markers provided: can be used to open the document and is interpreted to mean that the current widget name is to be used as the marker.

The Preview button can be used to check that the document exists and that the marker is contained within the document.

In FrameMaker, documents have an Own Window attribute: if true, the system will always display the document in a separate window, otherwise the system will re-use windows already open, thereby overwriting the previous document displayed. You can specify how your application will request FrameMaker to behave in this respect by setting the 'Own window' toggle within the dialog.

NOTES

Within FrameMaker documents themselves, you should specify a marker in the form 'newlink marker'. It is this marker which is used within WorkShop Visual as the marker name.

The help document for a widget is, unless specified otherwise, inherited from the parent widget. The Help default dialog allows you to specify a default help document for the entire module. Thus using the inheritance mechanism, you can use a single document to provide help for a number of widgets which you want to treat as a logical group. Each of the widgets can still have a distinct marker to provide context sensitive help. The module default could then be the top level help entry point.

See also:

- Help defaults dialog
- Document finder
- Core Resources panel
- About WorkShop Visual