Define the Default Settings for Each Target
You can have one or more output formats in your Stationery. You can also define multiple targets in your Stationery. The Stationery Designer properties and options are shared across all targets and output formats. Some settings, such as the target settings, variable values, conditions, and cross-reference formats, are defined per target. Some targets and output formats also offer additional features and customizations.
For each target in your Stationery, define the following default settings in your Stationery. If a writer installs the support with ePublisher Express, that writer can modify these settings in each project based on the Stationery:
Defining the Default Index Settings
The index provides the user with a point-and-click resource for quickly navigating your online content. ePublisher generates the index by default for the available formats, using the native indexing features of the source document tool used to create the printed index.
The groups and order of index entries in your online index are determined through index entries defined in the source document, the locales.xml file in the ePublisher installation folder, and the output format display environment. The locales.xml file also defines the text that identifies See and See also style entries in your index. For more information about customizing the index appearance, see Modifying the Appearance of the Index in Dynamic HTML.
Depending on your output format, you can specify the file name for the generated index whether to generate the index. With the power of many full-text search engines, you may choose not to include an index in your generated output.
Note: If you selected the WebWorks Help or WebWorks Reverb output format, you must generate an index with the given file name. These options are predefined and cannot be changed.
To enable index generation in your online content
  1. On the Project menu, select the Active Target you want to specify settings for.
  2. On the Target menu, click Target Settings.
  3. Set Generate index to Enabled.
  4. If you want to change your index file name and your output format supports it, specify the new file name in Index filename.
Defining the Default Processing of Variables
A variable provides a placeholder for standard terms and for names that may change. By defining variables in your source documents, you have global control over the values contained within those variables. For example, you can create a variable for the copyright date of your documentation. You can then use that variable as needed in your content. Each year when you need to update the copyright, you can change the variable value in a single location instead of using the search and replace method through your documents.
In your project, you can specify the value of any variable. When you change the value of a variable in your project, it changes the value only in your generated output. The variable value is not changed in your source documents. You can also use the value of the variable defined in your source documents. To use the value defined in a source document for a variable, select Use Document Value for that variable.
To specify a variable value
  1. On the Project menu, select the Active Target you want to specify settings for.
  2. On the Target menu, click Variables.
  3. Find the variable you want to modify.
  4. In the Value column, select its current definition and make the desired changes, or select Use Document Value.
Defining the Default Processing of Conditions
In your source documents, you can define conditions and use them to show or hide parts of your content. ePublisher allows you to define the visibility for each condition in your project. The conditions that are available in your project come directly from your source documents. You can modify the value for any of your conditions, which affects how your conditional text is incorporated into your generated output. You can also select passthrough for a condition to insert the content directly into your output without being transformed and coded for your output format. This option allows you to directly add HTML coding or multimedia files to your output.
Note: You can also use PassThrough markers and the Pass Through paragraph style and character style options to insert content directionly into your output without being transformed and coded for your output.
To modify the value of a condition
  1. On the Project menu, select the Active Target you want to specify settings for.
  2. On the Target menu, click Conditions.
  3. Find the condition you want to modify.
  4. In the Value column, select the visibility option you want to use for that condition.
Defining the Default Processing of Cross References
Cross-references help users navigate through your content. ePublisher automatically transforms cross-references to links in the generated output. However, you often want cross-references in your online content to use a different format than your printed content. For example, you usually include page numbers only in your printed content. ePublisher enables you to add, edit, and delete cross-reference formats for your online output.
Note: This option is available only for specific source document types and each defined cross reference rule applies only to the selected source document type.
To define and manage cross-reference formats
  1. On the Project menu, select the Active Target you want to specify settings for.
  2. On the Target menu, click Cross Reference Rules.
  3. In Document type, select the source document type for which you want to define the cross-references.
  4. If you want to add a cross reference format, complete the following steps:
    1. Click Add New Cross Reference.
    2. In Name, type the format or name of the cross reference format you want to define. For example, to remove the phrase see page followed by a page number from a Word source document, type: see page {PAGEREF \h}. You can find the correct syntax for the search pattern by inspecting your source documents for the values.
    3. In Replacement, type the format or text you want to replace the format you specified in Name. To replace the format with nothing, leave the Replacement field blank.
    4. Click OK.
  5. If you want to modify a defined cross-reference format, complete the following steps:
    1. Double-click an existing cross-reference format you want to modify.
    2. In Replacement, type the format or text you want to replace the format you specified in Name. To replace the format with nothing, leave the Replacement field blank.
    3. Click OK.
  6. If you want to change the order in which ePublisher processes the cross-reference formats, select a cross reference rule in the list, and then use the arrow buttons to arrange the formats from top to bottom in the order you want ePublisher to process them:
  7. If you want to delete a defined cross-reference format, select the cross reference rule in the list, and then click Delete Cross Reference:
  8. Click OK to close the Cross Reference Rules window.
Defining Default PDF Generation Settings
ePublisher provides PDF options that enable you to generate a PDF file for each source document or to generate a PDF file for each top-level group in a project. If you generate a PDF for each top-level group, ePublisher combines all the source documents within a single top-level group, and then generates a single PDF file for those documents.
You can deliver the PDF files separate from your help system, or in some output formats you can add a PDF button to your toolbar that displays the PDF files in the window. The PDF file displayed when the user clicks the PDF button depends on which PDF generation options you chose in your project. If you have selected to:
  • Generate PDF files only for the top-level groups, the window displays the PDF file for the top-level group in which the currently viewed topic is located when the user clicks the PDF button.
  • Generate PDF files only for each source document, the window displays the PDF file for the source document in which the currently viewed topic is located when the user clicks the PDF button.
  • Generate PDF files for all source documents and for all top-level groups, the window displays the PDF file for the source document in which the currently viewed topic is located when the user clicks the PDF button.
To specify the PDF file generation settings and enable the PDF toolbar button
  1. On the Project menu, select the Active Target you want to specify settings for.
  2. On the Target menu, click Target Settings.
  3. If you want to generate a PDF file for each source document, set Generate a PDF per document to Enabled.
  4. If you want to generate a PDF file for each top-level group of source documents, set Generate a PDF per top level group to Enabled.
  5. Set Show PDF button to Enabled.
  6. Click OK.
Defining the Accessibility Report to Validate Content
Content that must be accessed by people with disabilities must conform to guidelines published by both the W3C and the United States government. These guidelines are intended to help authors produce accessible content. ePublisher helps you produce online content that conforms to the W3C Web Content Accessibility Guidelines 1.0 (WCAG), Section 508 of the U.S. Rehabilitation Act of 1998, and the Americans with Disabilities Act (ADA).
If you take certain steps in creating your source documents and setting up your project, your generated output is accessible through assistive technologies such as screen readers. When you generate your project, ePublisher can perform several checks to verify that you embedded information and conform to the accessibility standard in these areas:
  • Alternate text for all images (ImageAltText marker)
  • Alternate text for clickable regions in all image maps (ImageAreaAltText marker)
  • Long descriptions for all images (ImageLongDescText and ImageLongDescByRef markers)
  • Summaries for all tables (TableSummary marker)
Note: ePublisher does not check to ensure that you have provided expansion text for abbreviations or acronyms nor does it verify that you have included citation markers for quotations. You can use the AbbreviationTitle, AcronymTitle, and Citation markers to add this information to your content.
For more information about producing accessible content, and to check your content further for compliance, see the following Web sites:
ePublisher does not perform accessibility validation by default. You must enable accessibility validation of the content. ePublisher validates that all images and image maps have alternate text, all images have long descriptions, and all tables have summaries. You can choose which accessibility validation checks you want ePublisher to run.
Note: If you disable any of the accessibility validation checks, you cannot consider your content to be accessible or Section 508 compliant.
To define the accessibility report that validates online content for accessibility compliance
  1. On the Project menu, select the Active Target you want to specify settings for.
  2. On the Target menu, click Target Settings.
  3. Set Generate accessibility report to Enabled.
  4. If you want to exclude the alternate text check for images, disable Validate accessibility image alternate tags.
  5. If you want to exclude the alternate text check for image maps, disable Validate accessibility image map alternate tags.
  6. If you want to exclude the long description check for images, disable Validate accessibility image long descriptions.
  7. If you want to exclude the summary check for tables, disable Validate accessibility table summaries.
When a project based on this Stationery is generated, the accessibility report is created with the information you selected to include in that report.
Defining Other Reporting Options
In addition to the accessibility reporting features, ePublisher provides reports to help you identify and resolve potential transformation issues. You can define which conditions are informational messages, warnings, or errors. Errors force ePublisher AutoMap to return a non-zero return code and stops the output deployment process.
To define the other report options
  1. On the Project menu, select the Active Target you want to specify settings for.
  2. On the Target menu, click Target Settings.
  3. Review and define the settings for the following categories of report settings:
    • Filenames Report
    • Links Report
    • Styles Report
    • Topics Report
  4. Click OK.
Was this helpful?
Last modified date: 01/28/2026