Format Settings

Modifying Project Settings : Format Settings

Format Settings

In ePublisher Express, the Format Settings window allows you to control preferences specific to the target format. Within the Format Settings window, there are expandable groups, which display options your format supports.

Generally, most formats will contain the following groups:

Accessibility

Since many browsers and screen readers do not support the longdesc attribute, ePublisher Express enables you to include a link labeled [D] alongside any image for which a long description is available. Because the [D] link is a standard hyperlink, it can be processed correctly by browsers and screen readers.

The Accessibility group in the Format Settings window allows you to enable the include visible [D] links to images with long descriptions option. This option will display a [D] link that will take the user to the long description text.

The following formats do not support [D] links: JavaHelp 1.x, JavaHelp 2.x, Simple HTML, Dynamic HTML, WinHelp, and Palm Reader.

To enable [D] links to images with long descriptions:

1.	In your ePublisher Express project, select Format > Format Settings.

2.	Under the Accessibility group, find the option Include visible [D] links to images with long descriptions.

3.	Click in the Value field next to the option to enable the dropdown menu.

4.	Select Enabled.

5.	Click the OK button to apply your changes and close the Format Settings window.

To modify the company information entries:

1.	In your ePublisher Express project, select Format > Format Settings.

2.	Locate the Company Information group and type your desired information into the designated fields.

3.	Click OK to apply your changes and close the Format Settings window.

Files

When ePublisher Express encounters a page break, it will create a new topic page. Page breaks are set in the stationery file; however, you can choose how you would like ePublisher Express to handle the page breaks.

In the Format Settings window, the setting Page break handling controls how ePublisher Express handles page breaks. The page break handling setting can be set to one of the following values:

Never: ePublisher Express will ignore any page break settings specified in the stationery file.

Always: ePublisher Express will always honor the page break settings specified in the stationery file.

Combine: ePublisher Express will only honor the page break setting if there was not a page break at the previous heading, and if the heading has a greater page break priority assigned to it.

For example, if Heading 1 has a page break priority of 1, Heading 2 has a page break priority of 2, and Heading 3 has a page break priority of 3, then a page break will only occur at Heading 1 because Heading 1 has the greatest page break priority.

If not previous: ePublisher Express will only honor the page break setting if there was not a page break at the previous heading, and if the heading has a greater or equal page break priority assigned to it.

For example, if you have a Heading 1 with a page break priority of 1 followed by two Heading 2s whose page break priorities are 2, new topic pages will be created at Heading 1 and at the second Heading 2.

To set the page break handling option:

1.	In your ePublisher Express project, select Format > Format Settings.

2.	Find the option Page break handling under the Files group.

3.	Click in the Value field next to the option to enable the dropdown menu.

4.	Select one of the available settings.

5.	Click on the OK button to apply your changes and close the Format Settings window.

Index

In ePublisher Express, you can choose to generate an index for your Help set. If you choose to generate an index for your Help set, you must have index markers embedded in your source documents. For more information on embedding index markers in your source documents, please visit your authoring tool’s documentation.

The following format does not offer the Generate index option: WinHelp.

To set index generation options:

1.	In your ePublisher Express project, select Format > Format Settings.

2.	Find the option Generate Index under the Index group.

3.	Click in the Value field next to the option to enable the dropdown menu.

4.	Select one of the available settings.

5.	Click on the OK button to apply your changes and close the Format Settings window.

Links

ePublisher Express allows you to determine how links display from your output files. The following are the available link options in the Format Settings window for the external URL target setting:

_blank: Use this setting to always open in a new browser window and leave the current window in its current state.

_parent: Use this setting to open the page in the immediate parent window of the link tag; useful for specialized cases only and is quite uncommon.

_self: Use this setting to open the page in the same frame as the link tag.

_top: Use this setting to open the page in the full body of the same window as the link tag; useful for breaking out of a frame all the way to the top of a window.

None: Use this setting to open links within the same window, however, unlike _self, this action may be controlled by the browser’s own settings.

Custom: You can configure any window name (default is external_window), which will have the effect of creating a new browser window, unless one already exists with the same name, in which case it will use that window.

The following formats do not support external URL targets: Oracle Help, Palm Reader, and Microsoft Reader.

To set the external URL target:

1.	In your ePublisher Express project, select Format > Format settings.

2.	Click on the dropdown button in the Value field next to the External URL Target setting.

3.	Select one of the target values.

4.	Click OK to apply your changes and to close the Format Settings window.

Locale

The locale refers to the language in which your Help system displays. If you have a localized Help system, you will need to choose the correct locale for your Help set.

To set the locale for your Help system:

1.	In your ePublisher Express project, select Format > Format settings.

2.	Click on the dropdown button in the Value field next to the Locale setting.

3.	Select one of available locales

4.	Click OK to apply your changes and to close the Format Settings window.

PDF

You can generate PDFs for each source document and/or each top-level group in your project.

To generate a PDF for each source document:

1.	In your ePublisher Express project, select Format > Format settings.

2.	Find the PDF group.

3.	Click on the dropdown button in the value field next to the Generate a PDF per document setting.

4.	Select Enabled.

5.	Click OK to apply your changes and to close the Format Settings window.

To generate a PDF for each top-level group:

1.	In your ePublisher Express project, select Format > Format settings.

2.	Find the PDF group.

3.	Click on the dropdown button in the value field next to the Generate a combined PDF per top level group setting.

4.	Select Enabled.

5.	Click OK to apply your changes and to close the Format Settings window.

Conformance Reports

Conformance reports are proofing tools that identify where problems occur in your source documents. Anytime a conformance report encounters a problem or behavior within your source document, it will display a notification alert in the report. You can set different types of alerts for your notification messages. For more information on the types of notifications, please see “Configuring Conformance Reports” on page 81.

For information on setting the notification type for the messages within each conformance report, please visit the section for that specific conformance report. There are five types of conformance reports:

1.	Styles Report

2.	Topics Report

3.	Filenames Report

4.	Links Report

5.	Accessibility Report

ePublisher Express uses the TOC levels assigned in the stationery file to create a table of contents for your Help system. Oftentimes, TOC levels will be skipped in the table of contents, and when this occurs, an empty TOC icon can display in the table of contents.

Typically, empty TOC levels occur when you skip a TOC heading in the source document. For example, let’s say that in your stationery file, you have assigned Heading 1, Heading 2, and Heading 3 as TOC levels; however, in your source document, you have skipped several Heading 2 headings.

When you generate your table of contents, you can specify how you would like your skipped TOC levels handled. The following are the available Format Setting options for collapsing your table of contents:

1.	Don’t collapse: Select this option if you want ePublisher Express to automatically insert empty table of contents entries for the skipped levels.

Figure 5-1: Uncollapsed TOC Hierarchy

2.	Fully collapse: Select this option if you want ePublisher Express to remove all skipped TOC entries and place all TOC headings at the same level, regardless of what TOC level they have been assigned.

Figure 5-2: Fully Collapsed TOC Hierarchy

3.	Smart collapse: Select this option if you want to remove empty TOC entries, and move the subsequent heading up a level to replace the skipped TOC level.

Figure 5-3: Smart Collapsed TOC Hierarchy

4.	Re-label: Select this option if you want to automatically insert labeled entries for the skipped TOC levels. The heading text from the TOC entry appearing below the current entry will be used as the TOC label.

Figure 5-4: Re-labeled TOC Hierarchy

Whether or not an empty TOC icon displays depends on the setting you have specified for your table of contents in the Format Settings window.You can specify how you would like your empty TOC levels handled.

To specify how empty TOC levels are handled:

1.	In your ePublisher Express project, select Format > Format Settings.

2.	Find the Table of contents group.

3.	Click on the dropdown button in the Value field next to the Collapse table of contents setting.

4.	Select one of the available options.

5.	Click OK to apply your changes and to close the Format Settings window.

XHTML 1.0 CSS WAI-A

To enable [D] links to images with long descriptions:WebWorks_WriteArrow(WebWorksRootPath, "wwdd998341", false);

To modify the company information entries:WebWorks_WriteArrow(WebWorksRootPath, "wwdd998357", false);

To set the page break handling option:WebWorks_WriteArrow(WebWorksRootPath, "wwdd998390", false);

To set index generation options:WebWorks_WriteArrow(WebWorksRootPath, "wwdd998400", false);

To set the external URL target:WebWorks_WriteArrow(WebWorksRootPath, "wwdd998415", false);

To set the locale for your Help system:WebWorks_WriteArrow(WebWorksRootPath, "wwdd998424", false);

To generate a PDF for each source document:WebWorks_WriteArrow(WebWorksRootPath, "wwdd998433", false);

To generate a PDF for each top-level group:WebWorks_WriteArrow(WebWorksRootPath, "wwdd998440", false);

To specify how empty TOC levels are handled:WebWorks_WriteArrow(WebWorksRootPath, "wwdd998486", false);