|
|
|
|
|
Commonly Used Terminology
The following section explains the commonly used terms in this manual.
Template
A template refers to a set of pre-designed style formats on which new source documents can be based and offers writers a standardized means on which to start creating their content from, thus promoting uniformity and conformity. In other words, it is a blank, reusable document that contains predefined style and formatting information that writers can use to create a new document.
Stationery
A Stationery refers to a complete set of processing rules and styles that allow you to automatically incorporate a full set of output features and functionality without having to modify the source content that is going to be published. In other words, a Stationery is a Template that is already complete, and rather than acting as a starting point, it acts as a finishing point that automatically applies information and behavior to your source content to create publications that can satisfy a wide range of output requirements.
A Stationery contains the following:
|
1. |
One or more Targets that have been pre-configured. Each target has a unique name and is based on an output Format, such as: HTML Help, WebWorks Help, PDF, etc. |
|
4. |
A .wxsp file that stores all the settings for the entire Stationery. |
Each Format that is configured in the Stationery (e.g., WebWorks Help 5.0, HTML Help, JavaHelp, Dynamic HTML, etc.) uses a set of XSL program files that define the entire generation instruction set for generating to that output. These files are packaged as part of the Stationery when it is created or updated, thus ensuring that the conversion process will always be consistent no matter which version of ePublisher Express (and AutoMap) is being used.
In order to create Stationery, the Stationery designer first must create an ePublisher Pro project, or what is commonly referred to as the “Stationery Master.” Using ePublisher Pro, and the Stationery Master, a Stationery can be created and made available to any number of other ePublisher Express and AutoMap users. In the future, when a feature is added, or a format is added, or a style change is required, the Stationery Master, along with ePublisher Pro, is used to make the necessary adjustments and then recreate the deployed Stationery. Since the Stationery represents a complete snapshot of all the used Format files and settings, it is very important to always retain the original Stationery Master so that future migration and feature additions can be handled and properly tested.
Once the Stationery designer creates or updates the Stationery using ePublisher Pro, it needs to be distributed to all ePublisher Express (and AutoMap) users. If the Stationery designer moves or deletes the Stationery from the location from which ePublisher Express projects are accessing it, then the ePublisher Express will alert you that it cannot find the location of the Stationery file. If this occurs, you will need to update your project and direct it to the new location of the Stationery.
|
|
You can at anytime redirect your Express project’s Stationery to alternative Stationery and back again, thus allowing you to easily test against different versions of Stationery without having to recreate your project. |
Project
A Project creates and produces online output; it contains a .wrp file that is used to store all of your Project’s specific settings, thus allowing you to update or reproduce the Project’s published output without having to reconfigure anything. When you create a new project, you are creating a new .wrp file that will contain references to the source documents that are to be published. After you have created a Project, you will have the ability to add source documents, merge groups, modify your project settings, and synchronize with existing Stationery.
Stationery Master
A Stationery Master, also known as an ePublisher Pro Project or as a Master Project, creates and maintains a Stationery. It contains a .wep file that stores all of its specific settings. It is very similar to either a .wrp or .wxsp file, and in fact uses the same XML syntax. However, what makes a Stationery Master unique from either a Project or Stationery, is that it only stores the minimum set of XSL processing files and thus acts as a convenient vehicle for tracking and managing custom Format and Target configurations (also called Overrides).
Format
An (output) Format refers to the type of electronic format you wish to create, along with its required standards and features. There are many Formats available to choose from, including WebWorks Help, Dynamic HTML, and PDF. It is also possible to have custom Formats.
In the future, there will be new Formats made available to address changing technologies for viewing content. What is nice is that you will be able to incorporate new Formats into your existing Stationery Master without having to re-implement any of your style configurations, thus meaning that even your existing Projects can be easily updated.
Format Target
Format Targets are based on output Formats (e.g. WebWorks Help 5.0, HTML Help, WinHelp, Dynamic HTML, etc.) and are unique to each Stationery. A Format Target refers to a specific “branded” output that you would like to generate and have settings associated with it.
Input Format
Input Formats represent source document file types or content structures, such as: Adobe FrameMaker, Microsoft Word, and DITA-XML that can be feed into an existing Project. In the future, other Input Formats will be supported, however it is already possible to configure a Stationery that will publish most any type of non-proprietary file format, so long as a configuration has been implemented using the XML Adapter (available with DITA-XML conversions).
Conformance Reports
There are five types of conformance reports:
|
1. |
|
2. |
|
3. |
|
4. |
Each report provides you with data with which you can use to proof your source documents. Conformance reports indicate where discrepancies exist between your source document and Stationery and alert you when potential problems occur. The number of warnings and errors can be controlled via settings in the Stationery or Project.
Document Manager
The Document Manager is part of the Express user interface and allows you to create groups and add/remove source files in which you wish to create publications. Groups in the Document Manager actually create a representative folder structure in the generated output directory. These groups do not necessarily represent how the publication will display, as that can be changed using Merge Settings.
Merge Settings
Merge Settings are part of the Express user interface that allow you to alter how your publication will display when viewed. In addition to being able to rename the display values of Document Manager Group, Merge Settings allow you to create virtual hierarchies. Virtual hierarchies are useful when managing a large number of manuals or documents that need to be pulled together and organized as a single viewable unit.
