Table of Contents

Previous

Next


Specifying File Names for Pages Using Page Naming Patterns

By default, ePublisher uses the following values when specifying file names for pages:

$D;.$DN;.$PN

This specifies that ePublisher name the files using the following syntax when it generates page files for a target:

SourceDocumentName.SourceDocumentNumber.TopicNumber

The parts of the default naming rule are defined as follows:

SourceDocumentName

Identifies the name of the source document that the topic came from without the file extension.

SourceDocumentNumber

Identifies the number of the source document in the order it is included in its containing group in the project, such as 1 for the first source document in a group and 2 for the second source document in a group. This value starts at 1 for the first source document in each group in your project.

TopicNumber

Identifies the number of the topic (output page) generated from the source document, such as 1 for the first topic generated from a source document and 2 for the second topic generated from a source document. This value starts at 1 for the first topic in each source document.

For example, if you have a MyFile.fm source document that contains three topics that start with a paragraph style that has a page break priority set in Style Designer, ePublisher generates the following default output file names: MyFile.1.1.html, MyFile.1.2.html, and MyFile.1.3.html. You can change the default file extension for each page style.

You can use the following values to specify a page file naming pattern for a target:

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.

You can also specify 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.

To specify a page file naming patterns for a target

  1. On the Project menu, select the target next to Active Target for which you want to specify settings.

  2. On the Target menu, click Target Settings. You must have target modification permissions to modify target settings. For more information, see “Customizing Target Settings” on page 339.

  3. Under Files, specify the appropriate values for the page file naming pattern you want to use. For more information about file settings and values, click Help.

ePublisher/2009.3/Help/02.Designing_Templates_and_Stationery/3.093.Designing_Stationery (last edited 2009-11-16 17:05:34 by TonyMcDow)