Navigation:  Project Properties Reference > Browser-based Help >

Layout

Print this Topic Previous pageReturn to chapter overviewNext page
Expand All   Collapse All

These settings define the layout of your Browser-based Help output. The default setting is Two Frames and you should leave this unchanged for most projects.

For more background information see Browser-based Help in the Configuring Your Output chapter and Browser-based Help and Browser compatibility in the Reference > Help Formats chapter.
There are also some special variables you can use in the layout page's HTML template. For details see HTML template variables in the Reference section.

Layout settings:

Let me edit HTML code directly:

Selecting this lets you edit the code of the frameset page manually.  Please only choose this option if you have experience in editing HTML code manually and understand all the details of the code you are changing. Errors made here can make your help unusable.

returns you to the standard code if something goes wrong.

Two frames:

Default, choose for stand-alone help:

Two frames is the default layout. It creates a stand-alone help project that is effectively a website in its own right. Navigation is dynamic with an expanding and collapsing contents tree if the user's browser supports it and static if it doesn't.

The output is fully compatible with all modern browsers, even if they have features like JavaScript turned off, and it will also display and work correctly in older browsers, just with fewer features.

Three frames:

Choose for integration in an existing website

This is the same as two frames but with an additional frame above for integration in your website – you can use the top frame to insert your standard website header components. Navigation is dynamic with an expanding and collapsing contents tree if the user's browser supports it and static if it doesn't.

Here too, the output is fully compatible with all modern browsers, even if they have features like JavaScript turned off, and it will also display and work correctly in older browsers, just with fewer features.

No frames, no scripts:

Choose for fully-manual website integration

This completely turns off the dynamic TOC and outputs your help as simple HTML pages without frames, without any scripting and with a single separate TOC page containing all the links to your individual topics.

Show borders between frames:

Displays border lines between the two or three frames of your layout. Turn off for a "seamless" look.

Width of the left frame:

Defines the width of the navigation frame containing your project's TOC. Only displayed if a frame mode is activated. You can enter the values as either pixels or percent:

Values under 100 are interpreted as percent.
Values above 100 are interpreted as pixels.

Height of head frame:

Defines the height of the head frame in pixels. Only displayed if the Three Frame option is selected. The height of this frame is always fixed so you must choose the right height to match the layout of the file you are loading into the head frame.

Head frame has scrollbars:

If you deselect this no scrollbars will be displayed, even if the content does not fit in the head frame. Only displayed if the Three Frame option is selected. Deactivate for a seamless appearance (you must plan the height of your head frame content precisely for this to work properly).

Head frame loads external file:

Select to load an existing HTML file into the top frame. Only displayed if the Three Frame option is selected.

Enter the name of the HTML file you want to load into your top frame here. Filenames are case sensitive in most web servers so be careful to enter the entire name correctly.

Enter the absolute or relative path to the file if is not going to be in the same directory as your help (for example if you are going to use the standard header file for your website).

Important:Help & Manual will not copy this file or any files that it references to your output folder for you! You are responsible for ensuring that the file and any files it references (graphics etc.) are stored in the correct location.

 

File will be in help directory:

headframe.html

File will be in another directory two levels up from your help on the server:

././headframe.htm

File will be on a different server:

http://www.servername.com/general/headframe.htm

Edit head frame HTML code:

Choose this option to create and edit the HTML code to be loaded into the head frame directly. Only displayed if the Three Frame option is selected.

When you choose this option the head frame file is generated automatically using the code you enter here when you compile your help. You can reference graphics and other files in it in the same way that you would in all other HTML template files.

Please study Using HTML Templates first.

See also:

Browser-based Help (Configuring your Output)

Browser-based Help (Help Formats)

HTML template variables (Reference)

Browser compatibility

 


Page url: http://www.helpandmanual.com/help/index.html?hm_projectprops_htmlex_layout.htm