Top
Interstage Studio User's Guide
FUJITSU Software

10.1.6 Help

Adding Documents to Help

A customer-specific document that is referenced during development work can be added to the Help system. To add a document, from the [Window] menu, select [Preferences], then [Help] > [Documentation].

Specify the following values in the [User documentations] page that is displayed when a document is added or edited:

Item

Settings Value

Documentation name

Specify the document name.

Documentation URL

Select this item if the document is not archived.


Location path

Specify the first page of the document in URL format. If it is a local file, specify as "file:".

Documentation in archive

Select this item if the document is archived in a ZIP file or a JAR file.


Archive path

Specify the path to the archive file.

Path within archive

Specify the first page within the archive file.

Contents are automatically generated recognizing the link of the initial page

When this option is selected, the links within the HTML page specified in the location path or the path within the archive are extracted and a table of contents is created.
If the document is not archived, this option is enabled only if the location path begins with "file:".

Searches the documents in the same folder

When this option is selected, the following HTML pages within the document can be added as search targets:
- *.html, *.htm
- *.xhtml, *.xhtm
However, for a Javadoc file, only the following HTML pages can be added as search targets:
- overview-summary.html
- package-summary.html
If this option is not selected, the only search targets are the HTML pages registered in the table of contents.

Note

Do not include national language characters in location paths, archive paths, or paths within archives. HTML pages do not display correctly if national language characters are included in these paths.

Infopop Help

If the method for using a dialog box, window, or similar is not understood, press the [F1] key while that GUI is displayed. This displays the Help associated with that GUI.