Table of Contents

Previous

Next


Files Settings

The settings in this category are defined as follows:

Convert spaces to underscores

Specifies if you want ePublisher to convert spaces in file names to underscore (_) characters when generating output. If you enable this setting, when you generate output, spaces in file names are replaced with the underscore character. For example, with this setting disabled, file names display as Word1 Word2.html. With this setting enabled, when you generate output file names display as Word1_Word2.html.

Graphic naming pattern

Specifies the file naming pattern you want ePublisher to use when generating output files for images.

ePublisher preserves the original file names for images imported by reference. If images are inserted directly into a source document, or if ePublisher cannot process the image by reference, then ePublisher assigns a file name using a graphic naming pattern.

By default, ePublisher uses the following values when specifying the image naming pattern:

$D;.$DN;.$PN;$.GN

This specifies that ePublisher name the files using the following syntax when it generates output:

SourceDocumentName.SourceDocumentNumber.TopicNumber.ImageNumber

where SourceDocumentName is the name of the source document, SourceDocumentNumber is the number that identifies the position of the source document in the project, TopicNumber is the number of the topic (output page) in the source document, and ImageNumber is the number of the image in the source document.

The values for this setting are defined as follows:

Note: Each value you specify must begin with a dollar sign ($) character and end with a semicolon (;) character. Inserting a period (.) character immediately before the value specifies that ePublisher use a period to separate the values when generating output.

S

Value

Description

$P;

Includes the name of the project in the file name.

$T;

Includes the name of the target in the file name.

$G;

Includes the name of the group in Document Manager that contains the file name.

$C;

Includes the project to project linking context value of the group in the file name. WebWorks Help uses the context value when generating merged, or multivolume help that includes context-sensitive help. In WebWorks Help, you need to include this context and the TopicAlias value in the help call to display the correct help topic. For more information, see “Merging Help Systems (Multivolume Help)” on page 332 and “Opening Context-Sensitive Help in WebWorks Help” on page 220.

$H;

Includes the heading text or title of the topic in the file name.

$D;

Includes the name of the source document that the topic came from in the file name.

$DN;

Includes the source document number in the file name. The source document number is the number that identifies the position of the source document in the project.

$PN;

Includes the page number in the file name. The page number is the number of the page that the topic is on in the source document.

$GN;

Includes the graphic number in the file name. The graphic number is the sequential number of the graphic in the source document, and it is based on the position of the graphic in the source document. For example, if you have five images in the source document and you use this setting, the page with you first image has the number 1 in the file name, and the page with your fifth image has the number 5 in the file name.

Page break handling

Specifies how ePublisher processes the Page break priority value the Stationery designer specifies in Style Designer for each paragraph style. For example, if you set the Page break handling format setting to Always, all paragraph styles with the Page break priority set greater than 0 will create a new page. The default value is Combine. The values for this setting are defined as follows:

 

Value

Description

Never

Ignores all Page break priority values specified in the Stationery.

Always

Creates a new page for all paragraph styles with a Page break priority value greater than 0.

Combine

Creates a new page for all paragraph styles with a Page break priority value greater than 0 unless the previous paragraph created a new page and the Page break priority value for the previous paragraph is a number less than the Page break priority value for this paragraph.

If not previous

Creates a new page for all paragraph styles with a Page break priority value greater than 0 unless the previous paragraph created a new page.

Page naming pattern

Specifies the file naming pattern you want ePublisher to use when generating output pages for topics. By default, ePublisher uses the following values when specifying the page naming pattern:

$D;.$DN;.$PN

This specifies that ePublisher name the files using the following syntax when it generates output:

SourceDocumentName.SourceDocumentNumber.TopicNumber

where SourceDocumentName is the name of the source document, SourceDocumentNumber is the number that identifies the position of the source document in the project, and TopicNumber is the number of the topic (output page) in the source document.

The values for this setting are defined as follows:

Note: Each value you specify must begin with a dollar sign ($) character and end with a semicolon (;) character. Inserting a period (.) character immediately before the value specifies that ePublisher use a period to separate the values when generating output.

 

Value

Description

$P;

Includes the name of the project in the file name.

$T;

Includes the name of the target in the file name.

$G;

Includes the name of the group in Document Manager that contains the file name.

$C;

Includes the project to project linking context value of the group in the file name. WebWorks Help uses the context value when generating merged, or multivolume help that includes context-sensitive help. In WebWorks Help, you need to include this context and the TopicAlias value in the help call to display the correct help topic. For more information, see “Merging Help Systems (Multivolume Help)” on page 332 and “Opening Context-Sensitive Help in WebWorks Help” on page 220.

$H;

Includes the heading text or title of the topic in the file name.

$D;

Includes the name of the source document that the topic came from in the file name.

$DN;

Includes the source document number in the file name. The source document number is the number that identifies the position of the source document in the project.

$PN;

Includes the page number in the file name. The page number is the number of the page that the topic is on in the source document.

Table naming pattern

Specifies the file naming pattern you want ePublisher to use when generating output pages that contain tables in MoinMoin. By default, ePublisher uses the following values when specifying the file naming pattern for MoinMoin pages that contain tables:

$D;.$DN;.$PN;.TN

This specifies that ePublisher name the files that contain tables using the following syntax when it generates output:

SourceDocumentName.SourceDocumentNumber.TopicNumber.TableNumber

where SourceDocumentName is the name of the source document, SourceDocumentNumber is the number that identifies the position of the source document in the project, TopicNumber is the number of the topic (output page) in the source document, and TableNumber is the number of the table in the source document.

Note: Inserting a period (.) character immediately before the value specifies that ePublisher use a period to separate the values when generating output.

The values for this setting are defined as follows:

Note: Separate values with a semicolon (;) character.

 

Value

Description

$P;

Includes the name of the project in the file name.

$T;

Includes the name of the target in the file name.

$G;

Includes the name of the group in Document Manager that contains the file name.

$C;

Includes the project to project linking context value of the group in the file name. WebWorks Help uses the context value when generating merged, or multivolume help that includes context-sensitive help. In WebWorks Help, you need to include this context and the TopicAlias value in the help call to display the correct help topic. For more information, see “Merging Help Systems (Multivolume Help)” on page 332 and “Opening Context-Sensitive Help in WebWorks Help” on page 220.

$H;

Includes the heading text or title of the topic in the file name.

$D;

Includes the name of the source document that the topic came from in the file name.

$DN;

Includes the source document number in the file name. The source document number is the number that identifies the position of the source document in the project.

$PN;

Includes the page number in the file name. The page number is the number of the page that the topic is on in the source document.

$TN;

Includes the table number in the file name. The table number is the sequential number of the table in the source document, and it is based on the position of the table in the source document. For example, if you have five tables in the source document and you use this setting, the page with your first table has the number 1 in the file name, and the page with your fifth table has the number 5 in the file name.

ePublisher/2009.3/Help/04.Reference_Information/2.021.ePublisher_Window_Descriptions (last edited 2009-11-16 17:45:40 by TonyMcDow)