Defining a new output style

From UPK wiki
Jump to: navigation, search

Contents

Placeholder

Basic process

  1. Take a copy of an existing output style
  2. Include this style in the Publishing Wizard
  3. Customize the publishing parameters
  4. Customize the output document

Copying an existing output style

Create a new publishing category

Caution: It is strongly recommended that you do not update the default publishing category (User Productivity Kit). Instead, you should take a copy of this and then edit the copy.

  1. Go to the /System/Publishing/Styles folder.
  2. Take a full copy of the exiting User Productivity Kit (just drag and drop it into the same folder) and rename this to be whatever you want to call your new publishing styles (maybe your project name, client name, etc.). Note that this package contains all of the output styles, so do not call this "Work Instructions" - that would be the name of a style within this category.
  3. if you will also be using the in-application support (context-sensitive help) feature of UPK, go to the /System/Publishing/In-Application Support folder and do the same thing - take a full copy of the existing User Productivity Kit folder, and give it exactly the same name as used for the publishing style.

Create a new publishing style

If you are creating a new output style (and not just customizing an existing (copy of) one) then it is normally much easier to take an existing style that is close to the format you want, and then update that. The following steps explain how to create this copy. If you have already taken a copy of the existing publishing category, and now just want to customize that copy, you can skip this step.

  1. Locate the Package for the output style that you want to copy, in the folder for your new publishing category.
  2. Take a full copy of this output style, and rename the Publishing Package file to the name of your new output style.

Tip:
If you take a copy of an existing publishing style, you will create a new Publishing Package that contains all of the files needed to publish that style. However, a Publishing Package is no different from a Content Package (it's basically a type of folder), so if you really want to create a new style from scratch, you can create a normal Package and then put your style files inside that (or copy them from an existing Publishing Package before updating them)). You'll have a different icon in the Library, but that may not necessarily be a bad thing, as it lets you identify 'brand new' styles vs. 'customization of existing styles'.

Including your new style in the Publishing Wizard

  1. Update style.xml
    1. Update the Name tag to specify a name for your new style
    2. If you are using a new, custom category (recommended) then update the Category tag to specify the name and position of this
  2. Update style.resources.xml
    1. Update the Stylename tag to specify your neew style name
    2. Update the CategoryName tag to specify the category to which your neew style belongs.
    3. Update the PreviewTitle tag to specify the preview name
    4. Update the SubFolderName tag to specify the folder to save this output style to
    5. Update the labelFormatDescriptionText tag to include a dewcription of your new output style

Customizing the publishing parameters

  1. Update style.xml
  2. Update styleconfig.xml

Customizing the output document

  1. For Word-based output styles: Update PrintTemplate.docm
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox