Help Control Details

Maintain System Help Control Details - HLPF0010

Purpose To allow the creation and maintenance of the base URL addresses for the on-line user documentation

Facility Help

Structure Single Block System Help Control

Image

System Help Control

Explanation

The on-line user manual is displayed as 'Web' pages viewed using a web browser. A web page equates to a file which may be located on the user's desktop computer, on a networked file server or on a web server. The user manual consists of thousands of these files. Each file has a unique physical location, known as its URL (Uniform Resource Locator). This form, together with the Maintain Online Help URL Details form (HLPF0020), is used to record the URLs which are accessed when navigation buttons are selected in the Field Help form. This is explained in the On-line User Documentation Facility - Introduction.
Some URLs are divided into two parts, a base URL and a detail URL. This is done to facilitate the portability of the on-line manual. The detail URL specifies the location of a file within the manual's filing system. The base URL specifies a common directory pathway to which all the detail URLs are linked. The Maintain System Help Control Details form is used to maintain base URLs. Detail URLs are maintained using the Maintain Online Help URL Details form (HLPF0020).

Example

The location of this page of the user manual when mounted on a user's desktop computer might be: c:/ausis/help/html/hlpf0010.htm. All the files comprising the user manual reside in the sub-directory help/ ,therefore c:/ausis/ will be common to all the files and can be defined as the base URL. If the files comprising the user manual were to be transferred onto a fileserver at Deakin University, the directory help/ and its entire contents could be moved to a directory on the file server such as servername.its.deakin.edu.au/directory1/…/directoryn/ . This path could then be specified as the base URL and this page would have a URL of servername.its.deakin.edu.au/directory1/…/directoryn/help/html/hlpf0010.htm . Changing the base URL will have made all of the files of the user manual accessible from the System's Help form.

To set up the Base URL data for the Field Help form navigation buttons using the Maintain System Help Control Details form:

Determine the content of the base URL. (In most cases this will be a directory path specifying the location of the help/ directory.)
Enter the base URL for context sensitive manual entries in the Base URL field.
Enter the full directory/file path for the Table of Contents "page" in the TOC URL field. (This is currently "base URL/help/html/tocframe.htm")
Enter the full directory/file path for the Index "page" in the Index URL field. (This is currently "base URL/help/html/indframe.htm")
Enter the text to be displayed as the label of the fourth user defined navigation button of the Field Help form, in the Link #1 Button Label field. (optional)
Enter the base URL for any institution specific web files to be accessed via the fourth navigation button, in the Base URL field directly below the button label field. (optional)
Where required, repeat steps 5. and 6. for the fifth and sixth navigation buttons. (optional)
Save.
Rules:

All of the files comprising the AUSIS User Manual are located in the subdirectory help/. When relocating the User Manual, help/ and all its contents should be relocated.
The first three navigation buttons in the Field Help form have been allocated for specific purposes (context, Index and TOC). Buttons 4 to 6 can be used to invoke other types of files accessed via a web browser (eg. institution defined policies, procedures etc.).
Navigation buttons not defined in this form will not be displayed in the Field Help form.

To delete Base URL data for a Field Help form navigation button using the Maintain System Help Control Details form:

Select the data to be deleted.
Delete record.
Save.
Rules:

Deleting the base URL of a navigation button will cause that navigation button to become inoperative in the Field Help form displayed for all fields within the System.

To modify a Base URL for a Field Help form navigation button using the Maintain System Help Control Details form:

Select the data to be modified.
Modify the data as required.
Save.

Purpose	To allow the creation and maintenance of the base URL addresses for the on-line user documentation
Facility	Help
Structure	Single Block	System Help Control
Image

To set up the Base URL data for the Field Help form navigation buttons using the Maintain System Help Control Details form:
Determine the content of the base URL. (In most cases this will be a directory path specifying the location of the help/ directory.) Enter the base URL for context sensitive manual entries in the Base URL field. Enter the full directory/file path for the Table of Contents "page" in the TOC URL field. (This is currently "base URL/help/html/tocframe.htm") Enter the full directory/file path for the Index "page" in the Index URL field. (This is currently "base URL/help/html/indframe.htm") Enter the text to be displayed as the label of the fourth user defined navigation button of the Field Help form, in the Link #1 Button Label field. (optional) Enter the base URL for any institution specific web files to be accessed via the fourth navigation button, in the Base URL field directly below the button label field. (optional) Where required, repeat steps 5. and 6. for the fifth and sixth navigation buttons. (optional) Save.	Rules: All of the files comprising the AUSIS User Manual are located in the subdirectory help/. When relocating the User Manual, help/ and all its contents should be relocated. The first three navigation buttons in the Field Help form have been allocated for specific purposes (context, Index and TOC). Buttons 4 to 6 can be used to invoke other types of files accessed via a web browser (eg. institution defined policies, procedures etc.). Navigation buttons not defined in this form will not be displayed in the Field Help form.
To delete Base URL data for a Field Help form navigation button using the Maintain System Help Control Details form:
Select the data to be deleted. Delete record. Save.	Rules: Deleting the base URL of a navigation button will cause that navigation button to become inoperative in the Field Help form displayed for all fields within the System.
To modify a Base URL for a Field Help form navigation button using the Maintain System Help Control Details form:
Select the data to be modified. Modify the data as required. Save.