Quark Publishing Platform 9.5.1 Instruction Manual

A Guide to Quark Publishing Platform 9.5.1
Índice
Introduction...................................................................................................8
Where we're coming from.....................................................................................................8
Conventions in this book.......................................................................................................8
About Quark Publishing Platform............................................................10
Platform concepts................................................................................................................11
Platform components...........................................................................................................12
Platform architecture..........................................................................................................13
Platform features.................................................................................................................14
Configuration..............................................................................................16
Administration client...........................................................................................................16
System area............................................................................................................................17
Content Model area................................................................................................................17
Workflow area........................................................................................................................17
Users and Groups area...........................................................................................................17
Configuring storage options................................................................................................17
Adding repositories................................................................................................................18
Deleting repositories..............................................................................................................18
Working with content types................................................................................................18
Working with collection types...............................................................................................20
Working with attributes......................................................................................................20
Defining attributes.................................................................................................................20
Adding constraints to attributes.............................................................................................26
Working with relationships.................................................................................................28
Working with workflows.....................................................................................................29
Creating a workflow..............................................................................................................29
Working with statuses............................................................................................................30
Working with forms.............................................................................................................31
Defining Roles and Privileges.............................................................................................32
Roles and Privileges..............................................................................................................32
Creating and deleting users ...............................................................................................33
Managing user lists with LDAP............................................................................................34
Creating and deleting groups..............................................................................................38
Configuring Redline colors.................................................................................................39
Maintenance and asset management.........................................................41
Monitoring user activity and logging off users.................................................................41
ii | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
Deleting assets......................................................................................................................42
Archiving assets....................................................................................................................42
Restoring assets....................................................................................................................43
User interface...............................................................................................45
Roles, views, and content structure overview....................................................................45
The Workspace Browser window.......................................................................................45
Workspace Browser window...............................................................................................45
Workspace toolbar.................................................................................................................47
View display options..............................................................................................................51
Icon columns..........................................................................................................................56
Preview pane..........................................................................................................................57
Menus (Quark Publishing Platform Client)......................................................................58
Quark Publishing Platform Client menu (Mac OS only).......................................................59
File menu...............................................................................................................................59
Edit menu...............................................................................................................................59
View menu.............................................................................................................................60
Actions menu.........................................................................................................................60
Go To menu...........................................................................................................................61
Search menu...........................................................................................................................61
Window menu (Mac OS).......................................................................................................62
Help menu..............................................................................................................................62
Menus (QCD).......................................................................................................................62
QuarkCopyDesk menu (Mac OS only)..................................................................................62
Platform menu.......................................................................................................................62
Menus (QXP)........................................................................................................................63
QuarkXPress menu (Mac OS only).......................................................................................63
Utilities menu.........................................................................................................................63
Window menu........................................................................................................................64
Platform menu.......................................................................................................................64
Client tasks ..................................................................................................66
Understanding how Quark Publishing Platform works..................................................66
Quark Publishing Platform Server and Quark Publishing Platform client applications........66
Administering a Quark Publishing Platform workflow.........................................................66
Using XML Author with Quark Publishing Platform...........................................................66
Assigning and managing assets from QXP...........................................................................67
Routing and tracking..............................................................................................................71
Automating output and export...............................................................................................71
Archiving and restoring.........................................................................................................71
Logging on............................................................................................................................72
Creating assets (QCD and QXP)........................................................................................73
Working with collections.....................................................................................................73
Working with collection templates........................................................................................73
Creating a collection..............................................................................................................74
Editing collections.................................................................................................................81
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | iii
Duplicating a collection.........................................................................................................82
Deleting a collection..............................................................................................................82
Appending content (QCD and QXP).................................................................................83
Checking in assets................................................................................................................83
Check In command................................................................................................................83
Check In Other command .....................................................................................................85
Check in multiple assets........................................................................................................85
Check In Project With Pictures (QXP only)..........................................................................86
Assigning assets....................................................................................................................86
Assigning assets: Quark Publishing Platform Client.............................................................87
Assigning assets: QXP...........................................................................................................88
Performing a search.............................................................................................................88
Using the Quick Search feature.............................................................................................90
Performing a nested search....................................................................................................91
Performing a full-text search.................................................................................................92
Performing a collection search..............................................................................................93
Search from here....................................................................................................................94
Working with saved searches.................................................................................................94
Managing searches.................................................................................................................94
Specifying search result display options ...............................................................................95
Checking out assets..............................................................................................................95
Checking out an asset: Quark Publishing Platform Client....................................................96
Checking out an asset: QCD..................................................................................................96
Checking out an article or project: QXP................................................................................96
Checking out a project with attachments: QXP.....................................................................96
Checking out and editing pictures: QXP & QCD..................................................................97
Using Advanced search: QCD and QXP ..............................................................................97
Cancelling a Checkout ..........................................................................................................98
Working with templates......................................................................................................98
Attaching content to layouts...............................................................................................98
Primary and secondary attachments......................................................................................99
Attaching article components by dragging..........................................................................100
Attaching articles by dragging.............................................................................................100
Attaching articles by assigning............................................................................................102
Attaching text files to layouts..............................................................................................102
Attaching pictures to layouts...............................................................................................103
Attaching App Studio assets................................................................................................103
Attaching multimedia assets to reflow articles....................................................................103
Tracking attachments...........................................................................................................103
Detaching components.........................................................................................................104
Attaching digital assets to layouts.......................................................................................104
Replacing article geometry...............................................................................................105
Working with libraries......................................................................................................105
Using Read-Only to view an asset....................................................................................106
Publishing assets................................................................................................................106
Viewing and editing attribute information......................................................................107
iv | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
Saving a revision of an asset..............................................................................................108
Customizing the search results pane................................................................................108
Setting Quark Publishing Platform Client preferences.................................................109
General pane........................................................................................................................109
Workspace pane...................................................................................................................111
Startup Mode pane...............................................................................................................112
Archive pane........................................................................................................................113
Setting Quark Publishing Platform preferences: QXP .................................................114
QXP preferences: General pane...........................................................................................114
QXP preferences: Workspace pane......................................................................................116
QXP preferences: Project and Attachments pane................................................................118
QXP preferences Article pane.............................................................................................119
QXP preferences: Alerts pane..............................................................................................119
Setting Quark Publishing Platform preferences: QCD..................................................121
QCD preferences: General pane..........................................................................................121
QCD preferences: Workspace pane.....................................................................................124
QCD preferences: Article pane............................................................................................125
QCD preferences: Alerts pane.............................................................................................126
Redlining....................................................................................................127
Using Redline controls.......................................................................................................127
Notes...........................................................................................................129
Working with notes............................................................................................................129
Opening and closing notes...................................................................................................129
Showing and hiding notes....................................................................................................129
Deleting notes......................................................................................................................129
Converting between notes and text......................................................................................130
Viewing notes by author, date, name, or color....................................................................130
Moving and resizing notes...................................................................................................130
Printing notes.......................................................................................................................130
Notes in PDFs......................................................................................................................130
Web Client.................................................................................................131
Logging on with Quark Publishing Platform Web Client.............................................131
Changing password...........................................................................................................132
Customize search results display......................................................................................132
Searching in Web Client....................................................................................................133
Archiving and Restoring in Web Client...........................................................................133
Using display options.........................................................................................................133
Previewing assets with Quark Publishing Platform Web Client...................................135
Using the Publish features.................................................................................................135
Editing asset attributes......................................................................................................135
Viewing asset revisions......................................................................................................136
Viewing relationship information.....................................................................................137
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | v
Creating articles in Quark Publishing Platform Web Client........................................137
Creating projects from templates in Quark Publishing Platform Web Client............138
Editing articles in Quark Publishing Platform Web Client...........................................138
Editing text components......................................................................................................139
Editing picture components.................................................................................................141
Managing components.........................................................................................................141
Finding and replacing text in articles...................................................................................142
Adjusting background color for editing...............................................................................143
Changing text size for editing..............................................................................................144
Working with Rubi...............................................................................................................144
Working with Grouped Characters......................................................................................145
Using notes in articles..........................................................................................................146
Editing projects in Quark Publishing Platform Web Client..........................................146
Callouts in Quark Publishing Platform Web Client.......................................................146
Checking in Other files......................................................................................................146
Editing Other Files............................................................................................................147
Using the Web Client Preview pane.................................................................................147
Setting Quark Publishing Platform Web Client preferences.........................................147
Script Manager .........................................................................................150
Quark Publishing Platform Script Manager configuration..........................................150
Working with Quark Publishing Platform Script Manager..........................................150
Logging on with Quark Publishing Platform Script Manager.............................................151
Creating a script...................................................................................................................152
Importing a script.................................................................................................................152
Deleting and exporting scripts.............................................................................................153
Writing, editing, and triggering a script..........................................................................154
Accessing Quark Publishing Platform Server objects.........................................................154
Loading a script in a script...................................................................................................154
Logging and debugging scripts............................................................................................154
Using utility methods in scripts...........................................................................................155
Triggering a script................................................................................................................156
Quark Publishing Platform event-based script example......................................................157
Executing a script manually.................................................................................................158
Privileges....................................................................................................159
Content privileges..............................................................................................................160
Content privileges: General.................................................................................................160
Content privileges: Edit Attributes......................................................................................161
Content privileges: Job Jackets............................................................................................161
Content privileges: Edit Redlining......................................................................................162
Content privileges: Article Components..............................................................................162
Content privileges: Edit Pictures.........................................................................................162
Content privileges: Editing..................................................................................................162
Application privileges........................................................................................................163
Application privileges: Administration...............................................................................163
vi | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
Application privileges: Workspace......................................................................................163
Glossary......................................................................................................165
Legal notices..............................................................................................175
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | vii

INTRODUCTION

Introduction
Quark® Publishing Platformis a collection of networked applications for creative workgroups. This Guide provides a high-level introduction to the Quark Publishing Platform Client application and the functionality Quark Publishing Platform adds to QuarkXPress® and QuarkCopyDesk®. You can use this Guide to learn what each feature is, what it's for, how you can put it to work for you, and where you can find it. For information about using Quark Publishing Platform with XML Author, see the Quark XML Author for Quark Publishing Platform documentation.

Where we're coming from

This book assumes you are familiar with your computer and know how to:
• Launch an application
• Open, save, and close files
• Use menus, dialog boxes, and palettes
• Use the mouse, keyboard commands, and modifier keys
If you needhelp performing any of these tasks, consultthe documentationresources (user or reference guides) provided with your computer.

Conventions in this book

Formatting conventions in this guide highlight information to help you quickly find what you need.
• Bold type style: The names of all dialog boxes, fields, and other controls are set in bold type. For
example: "Click Storage in the Administration pane."
• References: In descriptionsof features, parenthetical references guide you inaccessing those features.
For example: "The System Storage controls (Administration pane) let you designate asset storage."
• Arrows: You will often see arrows (>), which map the path to a feature. For example: "Choose
Administration > User Profiles to add a user."
• Icons: Although many tools and buttons are referenced by name, which you can see by displaying ToolTips, in some cases icons are shown for easy identification.
• Cross-platform issues: Somelabels, buttons,key combinations, and other aspects of QuarkPublishing Platform client applications differ between Mac OS® and Windows® because of user interface conventions or other factors. In such cases, both the Mac OS and Windows versions are presented, separated by a slash, with the Mac OS version presented first. For example, if the Mac OSversion of
8 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
INTRODUCTION
a button is labeled Select, and the Windows version is labeled Browse, you are directed to "Click Select/Browse." More complex cross-platform differences are mentioned in notes or parenthetical
statements.
Notes provide helpful information about particular features and general techniques for using the software.
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 9

ABOUT QUARK PUBLISHING PLATFORM

About Quark Publishing Platform
Quark Publishing Platform is a highly configurable solution for complete, automated, end-to-end multichannel publishing.Quark Publishing Platform is purpose-built to support end-to-end publishing needs, from complete manual publishing systems to highly automated workflows.
The Platform consists of a set of core modules that can be combined in various ways and integrated with third-party systems to accommodate almost any workflow. Its capabilities can be described in terms of content creation, management, publishing, and delivery.
Create
Quark Publishing Platform lets you:
• Design professional templates for different publications
• Author structured content in the familiar Microsoft Word environment
• Integrate content from databases with other forms of content
• Utilize multimedia content such as video, audio, and slideshows
Manage
Quark Publishing Platform provides:
• Workflow and collaboration tools
• Task and update notifications
• Component management
• Automated checks
• Version control
Publish
With Quark Publishing Platform, you can:
• Automatically assemble componentsof varioustypes from various sources into sophisticated layouts
• Automatically publish those layouts in a variety of formats for a variety of devices
Deliver
The automation features built into Quark Publishing Platform make it easyfor you to deliver content to your content consumers in both public and secure environments.
10 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1

Platform concepts

In order to use Quark Publishing Platform effectively, you should understand some of the key concepts that it uses.
Assets: An asset is a unit of independent content. Quark Publishing Platform stores, tracks, and manages assets along with their metadata. The Platformalso provides version control of assets, with both major and minor versions. Versioning policy can be configured for each content type within a collection. The Platform also supports multiple renditions of assets (such as previews, thumbnails, XML representations, and so forth), storing renditions along with each version of their original assets. Assets are stored in a configurable repository; the default repository on a file server, but pluggable third-party repositories are also supported.
Content types: Every asset has a content type. The content type concept is a unified mechanism for associating metadata, workflows, relationships, privileges, and rendering and publishing actions with different types of content. The Platform can automatically detect a variety of different content types, including pictures, QuarkXPress projects, DITA topics, and DITA for Business Documents. Assigning content types to assets allows the Platform to apply different lifecycles, workflows, and publishing requirements to different types of content. Content types are hierarchical, with child content types inheriting from their parents, for easy and logical configuration. Child content types can be fine-tuned by associating specific metadata and publishing activities with them. In addition to the standard set of content types, the Platform allows you to define your own and provides an auto-detection mechanism for so that they can be automatically recogized.
ABOUT QUARK PUBLISHING PLATFORM
Attributes: Assets can have attributes, which are containers for metadata that model the intrinsic
properties of those assets. The selection of attributes for an asset is determined by its content type. You can use attributes to drive custom workflows and publishing processes, and to reflect system-managed state. Attributes are created globally and can be applied to one or more content types.
Relationships: A relationship links two assets with one another, with one asset being the parent and the other being the child, and hassome associated metadata. There are different types of relationships, with different sets of associated metadata. Relationships can be specific to a particular version of a child asset, or can apply to all versions. Relationships enable component-content management use cases. There are predefined relationships between QuarkXPress projects and article components, and betweenQuarkCopyDesk articlecomponents and pictures, and there is a predefined relationship for XML component references. You can also create your own relationships.
Component management and referencing features are available both for XML content and for QuarkXPress/QuarkCopyDesk components.In thiscontext, an asset can be a single topic, a concept, an image, or a media file. Aggregated documents (including DITA maps and QuarkXPress layouts) are also modeled as assets. The content type of an asset determines its role.
The Platform uses asset relationships to model content-component references. For cases of content reuse, the Platform creates multiple relationships, which define suchthings as a component’s location, its update status, and so forth. You canselectively burst content when you check it into the Platform, for easy reuse. You can pin content to a particular version, or be automatically updated when the master version of the content changes.
Collections: A collection is a generic hierarchy that you can use to organize assets. You can model departmental hierarchies,folders, or jobs. You can then map one ormore workflows to each collection, and the assets in each collection will follow that collection's workflow. Collections also have users associated with them, and different users can have different roles in different collections. You can apply collection-specific routing rules and revision control settings, and assign collection-specific
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 11
ABOUT QUARK PUBLISHING PLATFORM
attributes, and search on a collection-specific basis.A collection'sJob Jackets file defines theresources available for the projects and articles in that collection.
Workflows: A workflow helps you to manage the lifecycle of assets by providing a named, ordered set of statuses for those assets to move through. A status-based auto-routing feature helps keep everything on track. You can create different workflows for different content types, use different forms to present attributes in different workflows, and color-code the statuses in aworkflow foreasy identification. Each workflow can have its own QuarkXPress/QuarkCopyDesk redlining settings and Job Jacket rule evaluations, and you can apply status-based constraints for each attribute.
Publishing Services: The Publishing Service Framework is a server-sideframework that automates publishing and delivery tasks. You can create configurable and extensible publishing processes that use a variety of renderers, including third-party renderers.
• A Publishing Process is a pipeline consisting of re-usable Activitiesthat encapsulate common tasks such as resolving XML component references and QuarkXPress attachments, applying transformations, submitting content to the appropriate rendering engine, packaging and collecting the output, and delivering the rendered output to a CMS or via FTP or HTTP.
• A Publishing Channel is a specific configuration of a publishing process that can be mapped to specific content types. The Platform ships witha library of commonly required Activities and several pre-configured Publishing Channels.
• An SDK for developing custom Activities is also available.

Platform components

Quark Publishing Platform consists of a set of core modules that can be combined in various ways with each other and with other systems. Depending on the needs of your organization, you may choose to use some or all of these modules.
Quark Publishing Platform Server: The heart of Quark Publishing Platform. The Server manages content, controls and coordinates workflows, provides a hierarchical scheme for organizing assets and tracks the relationships between those assets, implements automated versioning, and lets you keep track of users and their permissions. A Web-based administrative interface lets you control and configure the Server.
Quark Publishing Platform Clients: A Platform client is any application that can talk to Quark Publishing Platform Server. Available clients include QuarkXPress for Quark Publishing Platform, Quark XML Author for Quark Publishing Platform, Quark Publishing Platform Web Client, QuarkCopyDesk for Quark Publishing Platform, and desktop client for Mac and Windows. You can also implement and integrate your own clients with the Quark Publishing Platform SDK. A sample client for iOS "Gateway Starter App" is also included with the SDK.
• Quark XML Author for Platform: For XML content authoring and reuse in Microsoft Word.
• QuarkXPress: For template development, custom layout, content authoring, and layout and content review.
• QuarkCopyDesk: For content authoring and review.
• Quark Publishing Platform Web Client: For content authoring and review in a Web browser.
• Quark Publishing Platform Client: A generic desktop client, available for Windows and Mac OS.
12 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
ABOUT QUARK PUBLISHING PLATFORM
Work-in-Progress Repository: A repository that provides versioning and component management
capabilities for XML assets, QuarkXPress assets, and QuarkCopyDesk assets. Once a publication is finalized, the published files can be archived in a system of record.
Quark Publishing Platform Renderer: QuarkXPress Server, an engine that produces published files from component assets. QuarkXPress Server can produce outputin avariety of formats, including PDF, ePub, and AVE (for deployment to the iPad and other devices).
DITA Open Toolkit: An engine thatproduces published files from XML content thatuses the DITA schema. Working with an XSL-FO processor such as Antenna House, the DITA Open Toolkit can produce output in PDF, HTML, RTF, and HTML Help formats.
Quark Publishing Platform Script Manager: A scripting engine that allows you to build sophisticated custom functionality into Quark Publishing Platform Server without having to know a programming language.
Quark Publishing Platform SDK and REST interface: Robust interfaces that allow you to easily develop your own custom Quark Publishing Platform clients.
In addition to the clients listed above, Quark Publishing Platform can support custom mobile client applications. The Platform includes the source code for a sample mobile application called the Gateway iOS Starter App, which demonstrates how to create a custom Platform client for iPhone or iPad.

Platform architecture

Quark Publishing Platform is built using open industry standards such as SOA and the Spring framework, to allow easy integration with existing business systems. The architecture of Quark Publishing Platform is shown in the following diagram.
Quark Publishing Platform architecture
At the center is Quark Publishing Platform Server, which is a Spring-based Java applicationrunning in a Web container. This application has a number of services, hosted using the Spring framework,
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 13
ABOUT QUARK PUBLISHING PLATFORM
which it uses to perform various operations such as querying, honoring privileges, and maintaining metadata. You can also write your own custom services for business system integration.
The Publishing Service provides a component-aware publishing framework that can integrate with multiple renderers and delivery systems to publish content in multiple formats, including PDF, eBooks, iPad content, RSS feeds , syndications, and so forth.
At the top of the diagram arethe QuarkPublishing Platform client applications. These include desktop applications (such as QuarkXPress, QuarkCopyDesk, and Quark XML Author), Web applications (including the Web client and Web administrator), and mobile clients such as the Gateway iOS Starter App. Such client applications can communicate with Quark Publishing Platform Server via SOAP or the REST interface, whichever is a better fit.
Also within the Web container are any adapters that are necessary for Quark Publishing Platform Sever to talk to the Work-in-Progress repository or databases. Other adapters connect Quark Publishing Platform Server with output technologies such as the DITA Open Toolkit and the Antenna House XSL-FO formatter.
The Web container also hosts Quark Publishing Platform Renderer, which provides output in a variety of formats (shown in the boxes around the lower left corner). The Renderer includes a load balancer called Server Manager and some number of subrenderers running separately to handle requests as efficiently as possible.
Messaging within the system is handled with Java Message Service (JMS) messages, managed by ActiveMQ.
The Platform can securely communicate with external resources such as LDAP servers using either Kerberos or NTLM encryption. This enables the Platform to support single sign-on and domain users.

Platform features

In addition to the features already discussed, Quark Publishing Platform offers the following.
Powerful content reuse features: You can easily use and reuse assets and XML content in an interface that allows you to preview your changes as they will look at outlook without leaving Microsoft Word. For more information, see the documentation for Quark XML Author for Quark Publishing Platform.
Versatile automation features: Using the Quark Publishing Platform publishing framework, you can create publishing channels (for automatically building output) and delivery channels (for delivering published content to its destination).
Workflow management: Quark Publishing Platform lets you construct workflows that can automatically route files to the appropriate parties based on their statuses, notify those parties of their assigned tasks, add comments to drafts of document, track and review changes, and divide the work on a single document so that different users can work on it simultaneously.
Collections hierarchy: The Work-in-Progress repository can be organized into whatever kind of hierarchy works for your organization.
Sophisticated query engine: Quark Publishing Platform clients can take advantage of a powerful query engine, including metadata search and full-textsearch, using an intuitive user interface. Queries can be named, saved, and shared among users.
14 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
ABOUT QUARK PUBLISHING PLATFORM
Server-side scripting: Quark Publishing Platform Server comes pre-configured with the Rhino scripting enginefor JavaScript. Scripting is implemented using the Apache Bean Scripting Framework (BSF). All services, data transfer objects (DTOs), and JMS messages are available to the script engines. Scripts are executed on the server in a separate thread of the server process for maximum safety and efficiency. Scripts can be triggered manually, by a schedule, or by a server-side event. For more information, see "Script Manager ."
Directory server integration: You can import users from LDAP servers to enable single sign-on. For more information, see "Managing user lists with LDAP."
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 15

CONFIGURATION

Configuration

Administration client

Users with the Administration role can configure and maintain a Quark Publishing Platform workgroup's workflow. In addition to establishing structure for users and the content they generate, Administrators controlsecurity, setdefaults, specifystorage locations,and customize the parameters for tracking every asset in their workflow.
To administer Quark Publishing Platform Server, navigate to the following URL in a Web browser:
http://[IP address of Platform Server computer]:61400/admin
You can also display the administration from the home page, which is http://[IP address of Platform
Server computer]:61400
The Quark Publishing Platform Web Administrator displays.
When you select User Activity, the admin client displays the list of all logged-on users, including each user's name, the time and date each user logged on, each user's machine name, and each user's application. If you need to log off a user, select the user's name in the list and click Log Off Users. You can also log off users and send a message to a logged-on user.
Admin client running in Web client
16 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1

System area

The System area includes the following controls:
Storage: Use this control to specify one or more storage folders for assets and to establish rules for storing different file types. For more information, see "Configuring storage options."
User Activity: Lets you view logged-on users. For more information, see "Administration client."

Content Model area

The Content Model area includes the following controls:
Content Types: Use these controls to specify which types of content the Platform is managing. For more information, see "Working with content types."
Attributes (also called "metadata" or "headers"):Use these controls to create and configureattributes that can be associated with assets, articlecomponents, collectiontypes, and layout types. For example, you could create an attribute called "Image approved" for picture file types. When a user approves an image, he or she can check "Image approved" for the picture. When another user searches for approved pictures,the usercan includethe "Image approved" attribute in the search criteria and limit the search results to approved images. For more information, see "Defining attributes."
CONFIGURATION
Relations: Use these controls to configure the relationships available between Platform assets. For more informaiton, see "Working with relationships."

Workflow area

The Workflow area includes the following controls:
Workflow Definition: Use these controls to createand configure workflows. For moreinformation, see "Working with workflows."

Users and Groups area

The Users and Groups area includes the following controls:
Roles and Privileges: Use these controls to create, delete, rename, and modify roles and their associated privileges. For details about setting privileges, see "Privileges." For example, you can create a role called "Editorial," and assign this role to your writers and editors. All users with this role will have the same privileges to perform editorial functions.
User Profiles: Use these controls to create a user, assign a role to the user, assign a password, and enable or disable the user's ability to log on. You can also delete, rename, and modify user accounts.
Groups: Use these controls tocombine user profiles into groups to whichassets can be routed. When you route an assignment to a group, that asset appears in the assignments for everyone in that group. The firstperson in the group who checks out the assetgains controlof that asset. You can also delete, rename, and modify groups.
Redline: Use these controls to specify default redline tracking colors for each user.

Configuring storage options

In versions of Quark Publishing Platform prior to 9.5, you could set up separate repositories for different file types. In version 9.5 and later, you can simply set up a single repository for all asset
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 17
CONFIGURATION
types. You can add additional repositories if you need additional space, and change the priority of your repositories to control which one new assets are written into.
To configure storage options, click Storage.

Adding repositories

To add a storage repository:
1
Click the Repository tab in the Administration: Storage window.
Use the Repository tab of the Administration: Storage area to view and manage the folders where Quark Publishing Platform assets are stored.
2
Click + to display the New Repository dialog box.
3
Enter a name for the repository in the Name field.
4
To specify a specific file system directory, choose fileRepositoryAdapter and then specify a URL in the URL field (for example: /Users/Name/QPP Repository for Mac OS, or C:\QPP Repository for Windows).
For information about creating a SharePoint repository, see the Quark Publishing Platform SharePoint Adapter ReadMe.
The storage location must include read/write permissions.

Deleting repositories

To remove a storage repository, click the Repository tab in the Administration: Storage window, select the repository you want to remove, then click – (minus sign). A warning message prompts you to confirm the deletion.

Working with content types

Quark Publishing Platform supports a variety of different types of content, including QuarkXPress projects, QuarkCopyDesk articles, picture files, multimedia files, and XML files. TheContent Types
18 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
CONFIGURATION
pane lets you control the way in which information about each of these content types display in Quark Publishing Platform user interfaces.
Content Types pane
Different types of content have different attributes. For example, the list of attributes for a picture includes values for "Pixel width," "Pixel height," and "Resolution," and the list of attributes for a text componentincludes values for "Word count" and "Line count." Some attributes, such as "Checked out duration," are relevant only to QuarkPublishing Platform,and are stored only in Quark Publishing Platform.
For XML files that adhere to the DITA and BusDocs schemas, Quark Publishing Platform provides access to specific file-level element and attribute values. For example, you can use the Quark Publishing Platform user interface to view the values of a DITA XML file's <title> and <author> elements without having to open the file.
By default, Quark Publishing Platform is configured to provide access to a variety of attributes for four categories of content types:
• Article components
• Assets (of various types)
Quark Publishing Platform collection types (for more information, see "Working with collection
types")
• QuarkXPress layouts
You can create new content types for asset, text components, and picture components. You can also create new collection types. To add a new content type, select an eligible parent content type, then click the plus button under the content type list on the left.
You can add new attributes to any content type. These can be existing attributes from the Attributes pane, or entirely new attributes.
• To add an existing attribute to the selected content type, click the plus button under the attribute list on the right and choose Select from Existing.
• To createa new attribute, click the plus button under the attribute list on the right and choose Create New. (For more information, see "Understanding attribute types.") Any new attributes you create are automatically added to the attribute list displayed in the Attributes pane.
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 19
CONFIGURATION
There are two ways to disassociate an attribute from a content type:
• To permanently delete the attribute, select it, click the minus button under the attribute list on the right, and choose Delete.
• To disassociate the attribute from the selected content type but leave it in the attribute pool, select the attribute, click the minus button under the attributelist on the right, and choose RemoveMapping.

Working with collection types

A collection type is similar to an asset type in that it has a particular set of attributes. By applying a collection type to a collection, you enable users to view and edit attributes for that collection and create a form for editing those attributes.
To configure a collection type, expand the Collection category in the content type tree and select the collection type you want to configure.
Configuring a collection type
For more information, see "Working with collection types."

Working with attributes

Each content type has its own set of attributes. For convenience, all attributes are listed in the Attributes pane. You can assign attributes to content types in the Content Types pane. For more information, see "Working with content types."

Defining attributes

Each asset in Quark Publishing Platform has a correspondingset of attributes that describes the asset and its status in the Quark Publishing Platform workflow. Each content type can have its own set of attributes. These attributes include system-generated information such as the date and time of the last modification, default Quark Publishing Platform attributes such as Checked Out By, and any custom attributes you create to meet the needs of your workflow. For example, you could create an attribute called Image approved for picture file types. When a user approves an image, he or she could check Image approved for the picture. When another user searches for approved pictures, the usercould include the Image approved attribute in the search criteria and limit the search results to approved images.
20 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
CONFIGURATION
You can create eight kinds of attribute types: Text, Date, Time, Number, Measurement, Check Box, Drop-down Menu, and Date Time. Each attribute type can have a default value. For each
attribute, you can limit access so that only users with the privileges to edit "limited-access" fields can edit the attribute values. Attributes are defined at the server level, so each attribute can be used by multiple asset types and collection types.
To create, delete, and modify attributes, click Attributes in the navigation pane. The right pane displays the list of attributes available in the system.
Use the Attributes pane to create, edit, and delete attributes that help identify Quark Publishing Platform assets.
Creating an attribute
To create an attribute:
1
Click + (plus sign) to display the Create Attribute dialog box.
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 21
CONFIGURATION
Specify the attribute name and type in the Create Attribute dialog box.
2
Choose an attribute type from the Type drop-down menu. (For more information about attribute types, see "Understanding attribute types.")
3
Enter a name for the attribute in the Name field.
4
To allow only users with the "Edit normal- and limited-access fields" privilege to access the attribute, check "Limited Access." For more information, see "Defining Roles and Privileges."
5
Configure theremaining controls.These controlsvary dependingon which attribute type is selected. For more information, see "Understanding attribute types."
6
To control which content types the attribute is applicable to, check the appropriate boxes in the Applicable Types list.
Understanding attribute types
There are eight kinds of attributes: Text, Date, Time, Number, Measurement, Check Box, Drop-down Menu, and Date Time.
Text
Use the Text attribute type to create text attributes.
• Enter a default value in the Default Text field.
• To indicate the maximum length of text in the field, enter a value in the Maximum Length field.
Date
Use the Date attribute type to create date attributes.
• Enter a default date in the Default Date field.
22 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
CONFIGURATION
• To constrain users to a particular date range, enter a starting date in the Start Date field and an ending date in the End Date field.
Time
Use the Time attribute type to create attributes where users can enter times.
• Enter a default time in the Default Time field.
• To constrain users to a particular time range, choose a starting time from the Start Time drop-down menu and an ending time from the End Time drop-down menu.
Time values are determined by the Quark Publishing Platform user's locale setting.
Number
Use the Number attribute type to create attributes where users can enter only numbers.
• Enter a default number in the Default Value field.
• To constrain users to a particular numeric range, enter a minimum number in the Minimum Value field and a maximum value in the Maximum Value field.
Measurement
Use the Measurement attribute type to create attributes where users can enter only measurements.
• Enter a default number in the Default Value field.
• Use the Units drop-down menu to specify the unified unit of measure (for example, Picas or Millimeters).
• To constrain users toa particular measurement range, enter a minimum value inthe MinimumValue field and a maximum value in the Maximum Value field.
Check box
Use the Check Box attribute type to create check box attributes. To display the attribute with a checkmark by default, check Checked by Default.
Drop-down Menu
Use the Drop-down Menu attribute type to create drop-down menu attributes.
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 23
CONFIGURATION
Choose Drop-down Menu from the Type drop-down menu to create a Drop-down Menu attribute type.
Drop-down menu attributes can display lists of values called attribute domains. For example, if you create a drop-down menu attribute that requires the list of users on your system, you can use the existing list of users with the attribute rather than entering all the names manually.
1
To assign an attribute domain to a drop-down menu attribute, choose the attribute domain from the
Select Domain drop-down menu. The attribute domain's contents display in the Menu Items list.
2
To create a custom attribute domain, click to the right of the Select Domain drop-down menu. The Attribute Domain dialog box displays.
24 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
CONFIGURATION
Use the controls in the Attribute Domain dialog box to create and view lists that you can add to drop-down menu attributes.
The Domain Name list includes the available attribute domains. The Domain Values column lists the values for the selected attribute domain.
3
To add an attribute domain, click + (plus sign) below the Domain Name column.
4
Toenable usersto add entries to the drop-down menuattribute, checkthe box in the Allow Expansion column.
5
Towarn users when they add an entryto the drop-down menu attribute, check thebox in the Display Warning column.
6
Toalphabetically sortitems in the drop-down menu attribute, checkthe boxin the Sort Items column.
7
To rename the domain name, double-click its name.
8
Toadd valuesto theselected attribute domain, click + (plus sign) below the Domain Values column.
9
Click Done to close the Attribute Domain dialog box and continue creating your drop-down menu attribute.
Date Time
Use the Date Time attribute type to create attributes for tracking both dates and times.
• Enter a default date and time in the Default Date field.
• To constrain users to a particular date/time range, enter a starting date and time in the Start Date field and an ending date and time in the End Date field.
Time values are determined by the Quark Publishing Platform user's locale setting.
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 25
CONFIGURATION
Setting priority search attributes
Priority search attributes display at the top of the list of search criteria in the search controls. After the priority search attributes, all search attributes display alphabetically.
Priority Search Attributes dialog box
Todesignate priority search attributes, click Attributes in the navigationpane, and then click Priority Search Attributes. The Priority Search Attributes dialog box displays. To add an attribute to the list, select it in the list on the left and then click the right arrow button.

Adding constraints to attributes

Users can edit asset attributes when theycheck in an asset, when they savea revision, and by selecting an asset and clicking Edit Attributes. Constraints let a Quark Publishing Platform administrator place some controls on how users edit attributes at these times. For example, if you want users with the Editor role to explicitly approve an asset when it reaches Final status, you can use the Require Value constraint to require these users to indicate that the asset is approved or not approved. If a user does not enter a value, "Errors found" displays in red at the bottom of the Check In, Save Revision, or Edit Attribute dialog box. The attribute is also highlighted in red, and the user cannot proceed until he or she provides a value.
Only user-modifiable attributes can be constrained. In addition, you cannot constrain the Workflow and Collection attributes because privileges determine whether these attributes can be modified.
To constrain an attribute for a particular workflow:
1
Click Workflows. The Workflows pane displays.
2
Select a workflow in the Workflow Name list.
3
Click the Attribute Constraints tab.
4
Select the attribute you want to constrain and click Add Constraints. The Add Constraints dialog box displays.
26 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
Add Constraints dialog box
5
Choose an option from the View as drop-down menu. This value controls how the information in the list of statuses and roles displays while you establish a constraint. Options include:
CONFIGURATION
Status then Role: Displays a hierarchical list with statusesas mainheadings and roles as subheadings. You can apply the constraint to individual roles at specific statuses.
Role then Status: Displays a hierarchical list with rolesas mainheadings and statuses as subheadings. You can apply the constraint to individual statuses for specific roles.
If you change the View as option, the active setting will be retained, but will display according to the View as drop-down menu hierarchy.
6
Check the box for the status or user role the constraint is for.
7
When you check a role or status in the list, the constraint types become available for the selected line in the list. There are three kinds of constraints:
Prevent Change: Prevents users from altering the attribute's value.
Require Value: Prevents users from leaving an attribute's value unspecified.
Require Change: Forces users to change the attribute value.
8
To display the status only, check Select All. You can apply the constraint to all or none of the roles at specific statuses. Unchecking Select All displays the roles only.
Constraints are applied based on the user's role and the asset's status at the time the Check in, Save Revision, or Edit Attribute dialog box is displayed. The constraints in effect in these dialog boxes remain the same even if you change the value of the Status drop-down menu.
You can use constraints to enforce automatic routing according to status. For example, you can set up automatic routing for a collection at the status level and use Prevent Change (in the Add Constraints dialog box) to disable modifications of the Route to drop-down menu in the Check In dialog box. This will cause assets to be rerouted when their status changes and prevent users from changing the routing of the asset.
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 27
CONFIGURATION

Working with relationships

A relationship is an object that storesthe metadata for the association between two objects. Whenever you assign an article froma QuarkXPress layout, drag a picture into a layout, or create an interactive object with App Studio, a relationship object is created to store information about the link you've just created.
For example, if you draga picture into a QuarkXPress layout, a relationship is created. Among other things, that relationship stores the IDs of both the picture and the layout. This makes it easy to find out which layouts are using a given picture, or how many pictures are attached to a given layout.
There are six types of relationship:
Primary attachment: Stores information about a primary attachment.
Secondary attachment: Stores information about a secondary attachment.
Overlay attachment: Stores an information about an App Studio or ePub attachment.
Article component reference: Stores informationabout the association between anarticle component and a linked asset such as a picture.
XML component reference: Stores information about a reference from one XML file to another.
Custom: Developers can create their own relationship types for custom applications.
For more information about attachments, see "Primary and secondary attachments."
Administrators can view the fields assigned to each type of relationship in the Relations pane.
Relations pane
Administrators can also add custom relationship types and assign atributes to them. To view or edit the attributes associated with a relationship type, double-click the relationship type.
In Quark Publishing Platform Web client, users can view the relationships for an asset by displaying that assetin ListView with Relationship Status. Other Platform clients can view relationships with
Relationship View.
28 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1

Working with workflows

In Quark Publishing Platform terminology, a workflow is a set of steps that helps you to publish a document. You define workflows at the server level and then apply them to collections.
Each workflow has the following characteristics:
• A name.
• A list of the asset types to which it applies.
• A set of statuses, in a particular order. The order of the statusesreflects the order of thesteps necessary for completing the workflow. For example, you might specify that assets begin with a status called "Assigned," followedby "In Progress," "In Review," and "Completed." Youcan specifythat an asset with the "Completed" status automatically routes to an editorfor final approval (for more information, see "Setting up auto routing"). You can also enable or disable Redline tracking, check-in layout evaluation, and output layout evaluation for each status.
• A list of asset attributes. Attributes are defined at the server level, so you can use an attribute in any number of workflows. You can define constraints for some attributes at the workflow level.
• An attribute form for each asset type. (The attribute form displays when you check an asset in.)
CONFIGURATION

Creating a workflow

To create a workflow:
1
Click Workflows. The Administration: Workflows screen displays.
Administration: Workflows screen
2
To create a workflow, click + under the Name list. The Add Workflow dialog box displays.
A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1 | 29
CONFIGURATION
Add Workflow dialog box
3
Enter a name for the workflow in the Name field.
4
Under Asset Types, check the asset types you want this workflow to be available for.
5
Click OK.
For information on configuring a workflow, see the following topics.

Working with statuses

Each workflow has its own sequence of statuses. To work with a workflow's statuses:
1
Click Workflows. The Workflows pane displays.
2
Select a workflow in the Workflow Name list.
3
Click the Status tab.
4
To add a status, click + in the Status tab. The Create Status dialog box displays.
Create Status dialog box
5
Enter a name for the status in the Name field.
6
Use the Color control to associate a color with the status. This color displays in the Status icon column in the Workspace window.
7
To enable redline tracking for articles with this status in this workflow, check Enable Redline Tracking.
30 | A GUIDE TO QUARK PUBLISHING PLATFORM 9.5.1
Loading...
+ 147 hidden pages