Protected by one or more of U.S. Patent Nos. 5,541,991; 5,680,619; 5,907,704;
6,005,560; 6,052,514; 6,081,262; 6,633,666 B2; 6,947,959 B1; 6,940,518 B2; and other
patents pending.
Information in this document is subject to change without notice and does not represent
a commitment on the part of Quark Technology Partnership or its licensee, Quark Inc.
Quark Products and materials are subject to the copyright and other intellectual property
protection of the United States and foreign countries. Unauthorized use or reproduction
without Quark’s written consent is prohibited.
QUARK IS NOT THE MANUFACTURER OF THIRD PARTY SOFTWARE OR OTHER
THIRD PARTY HARDWARE (HEREINAFTER “THIRD PARTY PRODUCTS”) AND
SUCH THIRD PARTY PRODUCTS HAVE NOT BEEN CREATED, REVIEWED, OR
TESTED BY QUARK, THE QUARK AFFILIATED COMPANIES OR THEIR LICENSORS.
(QUARK AFFILIATED COMPANIES SHALL MEAN ANY PERSON, BRANCH, OR
ENTITY CONTROLLING, CONTROLLED BY OR UNDER COMMON CONTROL
WITH QUARK OR ITS PARENT OR A MAJORITY OF THE QUARK SHAREHOLDERS,
WHETHER NOW EXISTING OR FORMED IN THE FUTURE, TOGETHER WITH
ANY PERSON, BRANCH, OR ENTITY WHICH MAY ACQUIRE SUCH STATUS IN
THE FUTURE.)
QUARK, THE QUARK AFFILIATED COMPANIES AND/OR THEIR LICENSORS MAKE
NO WARRANTIES, EITHER EXPRESS OR IMPLIED, REGARDING THE QUARK
PRODUCTS/SERVICES AND/OR THIRD PARTY PRODUCTS/SERVICES, THEIR
MERCHANTABILITY, OR THEIR FITNESS FOR A PARTICULAR PURPOSE. QUARK,
THE QUARK AFFILIATED COMPANIES AND THEIR LICENSORS DISCLAIM ALL
WARRANTIES RELATING TO THE QUARK PRODUCTS/SERVICES AND ANY THIRD
PARTY PRODUCTS/SERVICES. ALL OTHER WARRANTIES AND CONDITIONS,
WHETHER EXPRESS, IMPLIED OR COLLATERAL, AND WHETHER OR NOT, MADE
BY DISTRIBUTORS, RETAILERS, XTENSIONS DEVELOPERS OR OTHER THIRD
PARTIES ARE DISCLAIMED BY QUARK, THE QUARK AFFILIATED COMPANIES
AND THEIR LICENSORS, INCLUDING WITHOUT LIMITATION, ANY WARRANTY
OF NON-INFRINGEMENT, COMPATIBILITY, OR THAT THE SOFTWARE IS ERRORFREE OR THAT ERRORS CAN OR WILL BE CORRECTED. THIRD PARTIES MAY
PROVIDE LIMITED WARRANTIES AS TO THEIR OWN PRODUCTS AND/OR
SERVICES, AND USERS MUST LOOK TO SAID THIRD PARTIES FOR SUCH WARRANTIES, IF ANY. SOME JURISDICTIONS, STATES OR PROVINCES DO NOT
ALLOW LIMITATIONS ON IMPLIED WARRANTIES, SO THE ABOVE LIMITATION
MAY NOT APPLY TO PARTICULAR USERS.
IN NO EVENT SHALL QUARK, THE QUARK AFFILIATED COMPANIES, AND/
OR THEIR LICENSORS BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL,
CONSEQUENTIAL OR PUNITIVE DAMAGES, INCLUDING, BUT NOT LIMITED
A, LOST FEES,
TO, ANY LOST PROFITS, LOST TIME, LOST SA
OR EXPENSES OF ANY KIND ARISING FROM INSTALLATION OR USE OF THE
QUARK PRODUCTS/SERVICES, IN ANY MANNER, HOWEVER CAUSED AND
ON ANY THEOR
QUARK, THE QUARK AFFILIATED COMPANIES AND/OR THEIR LICENSORS ARE
Y OF LIABILITY. IF, NOTWITHSTANDING THE FOREGOING,
VINGS, LOST DA
T
II
|
LEGAL NOTICES
FOUND TO HAVE LIABILITY RELATING TO THE QUARK PRODUCTS/SERVICES
OR THIRD PARTY PRODUCTS/SERVICES, SUCH LIABILITY SHALL BE LIMITED
TO THE AMOUNT PAID BY THE USER TO QUARK FOR THE SOFTWARE/SERVICES
AT ISSUE (EXCLUDING THIRD PARTY PRODUCTS/SERVICES), IF ANY, OR THE
LOWEST AMOUNT UNDER APPLICABLE LAW, WHICHEVER IS LESS. THESE LIMITATIONS WILL APPLY EVEN IF QUARK, THE QUARK AFFILIATED COMPANIES,
THEIR LICENSORS AND/OR THEIR AGENTS HAVE BEEN ADVISED OF SUCH
POSSIBLE DAMAGES. SOME JURISDICTIONS, STATES OR PROVINCES DO NOT
ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL
DAMAGES, SO THIS LIMITATION OR EXCLUSION MAY NOT APPLY. ALL OTHER
LIMITATIONS PROVIDED UNDER APPLICABLE LAW, INCLUDING STATUTES OF
LIMITATION, SHALL CONTINUE TO APPLY.
IN THE EVENT ANY OF THESE PROVISIONS ARE OR BECOME UNENFORCEABLE
UNDER APPLICABLE LAW, SUCH PROVISION SHALL BE MODIFIED OR LIMITED
IN ITS EFFECT TO THE EXTENT NECESSARY TO CAUSE IT TO BE ENFORCEABLE.
USE OF THE QUARK PRODUCTS IS SUBJECT TO THE TERMS OF THE END USER
LICENSE AGREEMENT OR OTHER APPLICABLE AGREEMENTS FOR SUCH PRODUCT/SERVICE. IN THE EVENT OF A CONFLICT BETWEEN SUCH AGREEMENTS
AND THESE PROVISIONS THE RELEVANT AGREEMENTS SHALL CONTROL.
Quark, QuarkXPress and XTensions are trademarks of Quark Inc. and all applicable
affiliated companies, Reg. U.S. Pat. & Tm. Off. and in many other countries. The Quark
logo, Job Jackets, Composition Zones, QuarkVista and other Quark related marks which
Quark may adopt from time to time are trademarks of Quark Inc. and all applicable
affiliated companies.
Windows and OpenType are registered trademarks of Microsoft Corporation in the
United States and/or other countries.
Mac OS and QuickDraw are trademarks or registered trademarks of Apple Computer, Inc.
in the U.S.A. and other countries. QuickTime is a trademark used under license. QuickTime
is registered in the U.S. and other countries.
PostScript is a registered trademark of Adobe Systems Incorporated in the United States
and/or other countries. PANTONE
Color Data is produced under license from Dainippon Ink and Chemicals, Inc.
TONE and FOCOL
FOCOL
The concept, structure, and form of FOCOL
protected by patent and copyright law
TONE Colour System are registered trademarks of FOCOLTONE.
TONE material and intellectual property are
. Any reproduction in any form, in whole or in part,
for private use or for sale, is strictly forbidden. Contact FOCOLTONE, Ltd. for specific
patent information.
oyo Ink Mfg. Co., Ltd. is the copyright owner of TOYO INK COLOR FINDER
T
™
SYSTEM
AND SOFTWARE which is licensed to Quark Inc. to distribute for use only in connection with QuarkXPress. TOYO INK COLOR FINDER SYSTEM AND SOFTWARE shall
TD., 1991. COLOR FINDER is in the process of registration as the registered
™
computer video simulation used
III
|
LEGAL NOTICES
in the product may not match the COLOR FINDER™book, and additionally some printer
color used in the product may also not match. Please use the COLOR FINDER book to
obtain the accurate color.”
TRUMATCH, TRUMATCH Swatching System, and TRUMATCH System are trademarks
of TRUMATCH, Inc.
THE TTF2PT1 SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS
“AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PRATICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSSOF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distrib-
uted under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR
ou may obtain a copy of the License at
, WHETHER IN CONTRACT
.apache.org). Licensed under the Apache
www
VICES; LOSS OF USE, DA
, STRICT LIABILITY, OR TORT
http://www
.apache.org/licenses/
TA
IV
|
LEGAL NOTICES
CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
language governing permissions and limitations under the License. Portions of this
product include technology used under license from Global Graphics.
USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE
SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT,
TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN
IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
c written permission. DISCLAIMER This software is provided ‘as is’ with no
explicit or implied warranties in respect of any properties, including, but not limited
to, correctness and fi
tness for purpose.
As to STLport technology, Copyright 1999, 2000 Boris Fomitchev. This material is provided “as is”, with absolutely no warranty expressed or implied. Any use is at your own
risk. Permission to use or copy this sofware for any purpose is hereby granted without
fee, provided the above notices are retained on all cpies. Permission to modify the code
and to distribute modified code is granted, provided the above notices are retained, and
a notice that the code was modifi
ed is included with the above copyright notice. The
Licensee may distribute binaries compiled with STLport (whether original or modified)
without any royalties or restrictions. The Licensee may distribute original or modifi
ed
STLport sources, provided that: The conditions indicated in the above permission notice
are met; The following copyright notices are retained when present, and conditions
®
VI
|
LEGAL NOTICES
provided in accompanying permission notices are met: Copyright 1994 Hewlett-Packard
Company. Copyright 1996,97 Silicon Graphics Computer Systems, Inc. Copyright 1997
Moscow Center for SPARC Technology.
Permission to use, copy, modify, distribute and sell this software and its documentation
for any purpose is hereby granted without fee, provided that the above copyright notice
appear in all copies and that both that copyright notice and this permission notice
appear in supporting documentation. Hewlett-Packard Company makes no representations about the suitability of this software for any purpose. It is provided “as is” without
express or implied warranty.Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that
the above copyright notice appear in all copies and that both that copyright notice and
this permission notice appear in supporting documentation. Silicon Graphics makes no
representations about the suitability of this software for any purpose. It is provided “as
is” without express or implied warranty.Permission to use, copy, modify, distribute and
sell this software and its documentation for any purpose is hereby granted without fee,
provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. Moscow
Center for SPARC Technology makes no representations about the suitability of this
software for any purpose. It is provided “as is” without express or implied warranty.
As to DOM4J software, Redistribution and use of this software and associated documentation (“Software”), with or without modification, are permitted provided that the
following conditions are met:
Redistributions of source code must retain copyright statements and notices.
Redistributions must also contain a copy of this document.
Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
The name “DOM4J” must not be used to endorse or promote products derived from this
Software without prior written permission of MetaStuff, Ltd. For written permission,
please contact dom4j-info@metastuff.com.
Products derived from this Software may not be called “DOM4J” nor may “DOM4J”
appear in their names without prior written permission of MetaStuff, Ltd. DOM4J is a
registered trademark of MetaStuff, Ltd.
Due credit should be given to the DOM4J Project - www.dom4j.org
THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS
“AS IS” AND ANY EXPRESSED OR IMPLIED W
NOT LIMITED TO, THE IMPLIED W
FITNESS FOR A P
METASTUFF, LTD. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEOR
TRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
All other marks are the properties of their respective owners.
VIII
|
Introduction
bout this Guidexvi
A
What you will seexvi
1Getting started with
QuarkXPress Server
Understanding QuarkXPress Server1
Server templates and static projects2
The document pool2
Projects and layouts2
Caching3
QuarkXPress Server preferences3
Quark License Administrator3
Master-Subrenderer environment3
The Keepalive script4
TABLE OF CONTENTS
Understanding QuarkXPress Server
XTensions software4
The QuarkXPress Server XTensions Application
Programming Interface (API)5
Launching QuarkXPress Server5
Command line options6
Exit Codes6
2The QuarkXPress Server
user interface
Server configuration dialog box7
Server (Tab)7
Logging (Tab)12
HTTP (Tab)14
Email (Tab)16
Server preferences18
Application preferences (category)18
IX
|
TABLE OF CONTENTS
Display (pane)18
Input Settings (pane)20
XTensions Manager (pane)21
Font Mapping (pane)22
Deconstruct (Pane)23
EPS (pane)24
Full Res Preview (pane)25
Job Jackets (pane)26
Modifier (pane)27
PDF (Pane)28
Placeholders (pane)30
PSD Import (pane)31
Fraction/Price (pane)32
Picture Effects (pane)33
Project preferences (category)34
General (pane)34
XML Import (pane)35
Default Print Layout (category)35
General (pane)36
Measurements (pane)38
Paragraph (pane)39
Character (pane)41
Tools (pane)44
Trapping (pane)
Color Manager (pane)
Layers (pane)50
Style sheets51
Default Style Sheets (dialog box)51
Edit Paragraph Style Sheet (dialog box)52
General (tab)53
44
48
X
|
Formats (tab)55
Tabs (tab)58
Rules (tab)60
Edit Character Style Sheet (dialog box)63
Colors66
Default Colors (dialog box)66
Edit Color (dialog box)68
Trap Specifications (dialog box)72
H&Js75
Default H&Js (dialog box)75
Edit Hyphenation & Justification (dialog box)78
Output styles81
Output Styles (dialog box)81
Edit EPS Style (dialog box)82
TABLE OF CONTENTS
Panes83
General (pane)84
Color (pane)85
Marks (pane)86
Fonts (pane)86
Bleed (pane)87
Transparency (pane)88
OPI (pane)88
JDF (pane)89
Advanced (pane)
Summary (pane)
Edit PPML Style (dialog box)91
Panes92
Device (pane)92
Pages (pane)95
Colors (pane)96
90
91
XI
|
TABLE OF CONTENTS
Pictures (pane)98
Marks (pane)99
Bleed (pane)99
JDF (pane)100
Advanced (pane)101
Summary (pane)101
Edit PDF Style (dialog box)101
Panes102
Pages (pane)103
Meta Data (pane)104
Hyperlink (pane)104
Compression (pane)106
Color (pane)109
Fonts (pane)110
Marks (pane)110
Bleed (pane)111
Transparency (pane)112
OPI (pane)113
OPI Active (check box)113
JDF (pane)114
Summary (pane)115
Edit Print Style (dialog box)115
Panes117
Device (pane)
Pages (pane)
Colors (pane)121
Pictures (pane)123
Fonts (pane)124
Marks (pane)125
Bleed (pane)125
117
120
XII
|
Transparency (pane)126
OPI (pane)127
JDF (pane)128
Summary (pane)129
Font mapping129
Font Mapping (Dialog box)129
Source Setups130
Default Source Setups (dialog box)131
Edit Source Setup (dialog box)132
Output Setups133
Default Output Setups (dialog box)134
Edit Output Setup (dialog box)135
Server XTensions Manager136
Server XTensions Manager (dialog box)136
TABLE OF CONTENTS
Status Monitor138
Status Monitor (Window)138
Verbose Status Monitoring (command)140
Other menu items141
About QuarkXPress Server (dialog box)141
Check Out License (dialog box)141
Pause Server (command)141
Start Server (command)141
Stop Server (command)141
Shut Down Server (command)
Clear Status Monitor (command)
3Creating URL requests
Understanding URL requests142
Understanding QuarkXPress
Server namespaces143
Understanding QuarkXPress
Server parameters144
141
141
XIII
|
TABLE OF CONTENTS
QuarkXPress Server Web Integration
Guide overview144
Render types144
General parameters145
Specialized parameters146
Server control parameters147
Preference Administration parameters148
4XTensions software
PDF Filter XTensions software152
Rendering QuarkXPress projects as PDF files152
URL parameters for PDF rendering152
PPML Export XTensions software153
Rendering QuarkXPress projects in PPML format153
URL parameters for PPML rendering153
Modifier XTensions software153
Using Modifier XTensions software154
Creating XML for Modifier XTensions software154
Modifying images155
Modifying text158
Modifying boxes161
Creating and deleting boxes165
Importing data166
Saving projects168
DTD for Modifier XTensions software
Deconstructor XT
Using Deconstructor XTensions software172
Using QuarkVista XTensions software180
Creating preset files180
Using QuarkVista XTensions software180
Removing QuarkVista effects181
ensions software172
169
XIV
|
QuarkXPress Server Layer
XTensions software182
Using QuarkXPress Server Layer
XTensions software182
QuarkXPress Server Layers parameters182
5Telegraph XTensions software
Setting Telegraph preferences184
Adding a server185
Editing server properties185
Deleting a server185
Setting document cache preferences186
Using Telegraph XTensions software186
Identifying QuarkXPress items186
Assigning item names187
Viewing Box ID numbers187
TABLE OF CONTENTS
Uploading templates187
Uploading missing or modified pictures189
6QuarkXPress Server Monitor
Running QuarkXPress Server Monitor190
Configuring QuarkXPress Server Monitor190
Viewing QuarkXPress Server status193
Glossary
XV
|
ABOUT THIS GUIDE
Introduction
Before you begin, take time to review this chapter so that you understand
how A Guide to QuarkXPress®Server 7 is structured and how you can get the
most out of it.
ABOUT THIS GUIDE
You do not need to read this guide from cover to cover. Instead, use this guide
to quickly look up information, find out what you need to know, and proceed
with your work. Use the detailed table of contents at the beginning of the
guide to find information quickly.
WHAT YOU WILL SEE
Various conventions (styles) in this guide highlight information to help you
quickly find what you need.
BOLD TYPE STYLE CONVENTION
The names of menu commands, dialog boxes, and other controls are set in bold
type. For example: “You can use the
text, pictures, lines, and box backgrounds.”
Colors palette to apply colors or inks to
XVI
INTRODUCTION
|
REFERENCES AND ARROWS
Whenever a feature is mentioned, a reference shows you how to access that
feature. For example: “You can use the
a copy of a project.” Arrows indicate the menu path to a feature. For example:
“Choose
MAC OS AND WINDOWS REFERENCES
QuarkXPress Server is quite consistent across operating systems. However,
some labels, buttons, key combinations, and other aspects of QuarkXPress
Server must differ between Mac OS
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 fi
and the Windows version is labeled Browse, you are directed to “Click Select/
Browse
parenthetical statements.
NOTES
Notes cover additional information about particular features or concepts. They
may also contain suggestions to improve your workflow or to perform a step
more effi
File Þ Print to display the Print dialog box.”
rst. For example, if the Mac OS version of a button is labeled
.” More-complex cross-platform differences are mentioned in notes or
.
ciently
Save as dialog box (File menu) to save
®
and Windows®because of user interface
Select
UNDERSTANDING QUARKXPRESS SERVER
Chapter 1: Getting started with
QuarkXPress Server
QuarkXPress Server lets you use a Web browser to view and output QuarkXPress
projects in a variety of formats.
UNDERSTANDING QUARKXPRESS SERVER
QuarkXPress Server lets you output customized QuarkXPress layouts in a
variety of formats (including JPEG, Portable Document Format — PDF, and
PostScript
request to a QuarkXPress Server application, all you need to do is enter a
URL into your Web browser’s address field. For example, the following URL
instructs the QuarkXPress Server application named “QXPServer7” to return
the file “MyProject.qxp” as a PDF file:
®
) from a centralized QuarkXPress Server application. To send a
http://QXPServer7:8080/PDF/MyProject.qxp
The QuarkXPress Server application receives these requests, renders (creates)
the requested projects in the requested formats, and then returns the rendered
file to the client application (in this case, the Web browser).
The format of QuarkXPress Server URL requests is described in detail in
Chapter 3, “Creating URL requests,” and in the
Integration Guide
You can also create custom applications that communicate with a
QuarkXPress Server application using HTTP, Simple Object Access Protocol
(SOAP), or another protocol. For more information, see the
Web Integration Guide.
You can think of QuarkXPress Server as a special version of QuarkXPress that
runs on a server with the following main differences:
• Instead of accepting input from a keyboard and mouse, QuarkXPress Server
accepts input in the form of URLs.
• Instead of sending a project to a printer, QuarkXPress Server renders (creates)
output in a particular format and sends the rendered file to a client.
.
QuarkXPress Server Web
QuarkXPress
CHAPTER 1: GETTING ST
ARTED WITH QUARKXPRESS SERVER
1
|
UNDERSTANDING QUARKXPRESS SERVER
SERVER TEMPLATES AND STATIC PROJECTS
QuarkXPress Server can open, render, and serve two types of projects:
• Static projects are QuarkXPress projects that can be rendered and served as-is
in a variety of formats by the QuarkXPress Server application. For example,
you might make a product manual available as a static project and allow
customers to download that manual in a variety of formats.
Server templates are QuarkXPress projects that can be manipulated by the
•
QuarkXPress Server application before being rendered and served. For example, you might make a sales piece available as a server template so that each
person who downloads it receives a personalized copy.
QuarkXPress Server can open QuarkXPress documents, projects, and templates
created in any non-East-Asian edition of QuarkXPress 5.0 or later. QuarkXPress
Server can save and export projects only in QuarkXPress 6.x and
QuarkXPress 7.x format.
THE DOCUMENT POOL
QuarkXPress Server reads server templates and static projects from a directory called the
document pool. The document pool can be any directory that
is available to QuarkXPress Server through a file system or an FTP server. You
can use any of the following methods to place files in the document pool:
• Drag the files to the document pool directory.
• Upload the files using FTP to the document pool directory.
®
• Use Telegraph XTensions
software to upload the files to the document pool
from within QuarkXPress. (For more information about Telegraph XTensions
software, see Chapter 5, “Telegraph XTensions software.”)
For more information about the document pool, see “
Server configuration
dialog box” in Chapter 2, “The QuarkXPress Server user interface.”
QuarkXPress Server 7 can also serve documents from a database, a content
management system, or other sources. Collectively, the document pool and
any other source of files to be served are referred to as
PROJECTS AND LA
YOUTS
document providers.
QuarkXPress projects can contain one or more layouts, and only one layout can
be rendered at any given time. If you do not specify a layout when you send a
rendering request, QuarkXPress Server renders the first layout in the project.
CHAPTER 1: GETTING ST
2
|
ARTED WITH QUARKXPRESS SERVER
UNDERSTANDING QUARKXPRESS SERVER
CACHING
To maximize efficiency, QuarkXPress Server uses cached versions of all rendered
projects whenever possible. You can configure projects so that they are never
cached, so that they are cached for a particular amount of time, or so that they
are rendered every time they are served. For more information about caching,
Server configuration dialog box” in Chapter 2, “The QuarkXPress Server
see “
user interface.”
QUARKXPRESS SERVER PREFERENCES
When you launch QuarkXPress Server, the application creates preferences
files that are functionally and structurally equivalent to the preferences files
created by QuarkXPress. These preferences files reside in the QuarkXPress
Server “Preferences” folder. QuarkXPress Server also creates an “XPressServer
Preferences.prf” file in the “Preferences” folder; this file contains preference
settings that are specific to QuarkXPress Server.
QuarkXPress Server uses these preferences the same way QuarkXPress uses
them. If an XTensions module creates a project in QuarkXPress Server, that
project draws its settings from the QuarkXPress Server preferences just as a
new QuarkXPress project draws its settings from the QuarkXPress preferences.
Preferences files are stored in the following locations:
• Mac OS:
[User]/Library/Preferences/Quark
• Windows: C:\Documents and Settings\[username]\Application Data\
Quark\QuarkXPress Server 7.0\Preferences
For more information about preferences, see “Server preferences” in Chapter 2,
“The QuarkXPress Server user interface.”
QUARK LICENSE ADMINISTRATOR
To prevent unauthorized use, QuarkXPress Server requires the presence of a
®
Quark
License Administrator (QLA) server to launch. QuarkXPress Server follows the configuration and control rules that are enforced by QLA. For more
information about QLA, see the QLA documentation included with
QuarkXPress Server.
MASTER-SUBRENDERER ENVIRONMENT
Requests for project renders are stored in a connection queue. The requests in
the rendering queue can be processed by a single QuarkXPress Server application, or by a master QuarkXPress Server application and several subrenderers
(additional instances of QuarkXPress Server). The master QuarkXPress Server
application launches the available number of subrenderers and then passes
the requests in the connection queue to those subrenderers as they become
available. The number of subrenderers available for launch is determined by
the number of licenses available from the QLA server.
CHAPTER 1: GETTING ST
ARTED WITH QUARKXPRESS SERVER
3
|
UNDERSTANDING QUARKXPRESS SERVER
he master QuarkXPress Server application and all of the subrenderers it
T
launches share the following elements:
• The same application preferences files on disk
• The same document cache in memory
• The same memory cache
• The same server XTensions modules
• The same server document pool (if defined in the QuarkXPress Server preferences
or if a document provider is used in place of the document pool)
If a subrenderer unexpectedly quits, the master QuarkXPress Server restarts
the subrenderer without requiring any action from you.
The master-subrenderer environment can be initiated from the command line
or by any means that can issue a command-line command (such as scripts
and shortcuts).
THE KEEPALIVE SCRIPT
A script called the keepalive script can monitor a QuarkXPress Server application
and restart the application if it fails. To use this feature, launch QuarkXPress
Server by running the “keepalive.sh” script (Mac OS) or “keepalive.bat”
(Windows) script. Note that the keepalive script works only if you run it before
you launch QuarkXPress Server. You can also manually restart QuarkXPress
Server using this script.
On both platforms, information about unexpected shutdowns (including the
error date, time, code, and description) is stored in an error log file. For more
information about logging, see “Logging (tab)” in Chapter 2, “The QuarkXPress
Server user interface.”
UNDERSTANDING QUARKXPRESS SERVER XTENSIONS SOFTWARE
QuarkXPress Server ships with a collection of XTensions software that adds
capabilities to QuarkXPress Server. For example, PDF Export XTensions software lets QuarkXPress Server serve content in PDF format, Deconstructor
XTensions software lets you retrieve XML representations of projects, and
Modifier XT
ensions software lets you manipulate text, pictures, and boxes
(among other things). Telegraph XTensions software works with QuarkXPress
to allow designers to name boxes in template files so that those boxes can be
addressed by URLs and to control caching for individual items.
For more information about XT
, see Chapter 4, “XT
ver
Ser
ensions software included with QuarkXPress
ensions software,” and Chapter 5, “T
XTensions software.”
CHAPTER 1: GETTING ST
4
|
ARTED WITH QUARKXPRESS SERVER
elegraph
UNDERSTANDING QUARKXPRESS SERVER XTENSIONS SOFTWARE
THE QUARKXPRESS SERVER XTENSIONS APPLICATION
PROGRAMMING INTERFACE (API)
In addition to the XTensions modules included with QuarkXPress Server, developers can create custom XTensions software that add features. The complete
server XTensions Application Programming Interface (API) documentation is
available in the QuarkXPress Server XTensions Developer’s Kit (XDK).
The QuarkXPress Server XDK lets you create XTensions modules that provide
the following abilities:
• The ability to register request handlers
• The ability to register project providers
• The ability to register new render formats
• The ability to add items to the list of response properties, cookies, and HTTP
header items
• The ability to log messages in log files and in the status monitor
• The ability to initiate a new transaction to be processed by the server
• The ability to completely control how projects are processed by the server
In addition, QuarkXPress Server XTensions software can register for the
following basic callbacks:
• Pre-processing
• Content loading
• Layout modification
• Post-processing
• Removing slugs while running the QuarkXPress project renderer
• Analyzing the server after a transaction is complete
• Pre- and post-transaction callback
LAUNCHING QUARKXPRESS SERVER
QuarkXPress Server consists of a single executable that can be executed in two
modes. Both modes are available on Mac OS and Windows.
When executed in
console mode, QuarkXPress Server displays a limited user
interface for configuring the server. To access QuarkXPress Server in console
mode, double-click the program icon.
CHAPTER 1: GETTING ST
ARTED WITH QUARKXPRESS SERVER
5
|
LAUNCHING QUARKXPRESS SERVER
hen executed in no-UI mode,QuarkXPress Server displays no visible user
W
interface and must be controlled (started and stopped) from a command
prompt. Running QuarkXPress Server in no-UI mode will slightly improve
its performance. To access QuarkXPress Server in no-UI mode, launch the
application from the command line. For example:
• To launch QuarkXPress Server in no-UI mode on Mac OS, Control+click the
QuarkXPress Server application file and choose
the “QuarkXPress Server.exe” file from the
X11 terminal window, add “ –noui” to the end of the command, and press Enter.
• To launch QuarkXPress Server in no-UI mode from the command line on
Windows, use a command such as:
Server 7\QuarkXPress Server\QuarkXPress Server.exe -noui.
COMMAND LINE OPTIONS
QuarkXPress Server supports the following command-line options:
• The
noui option makes the server run without any user interface. This is the
normal mode for production use of QuarkXPress Server.
• The
-nonetwork parameter makes the server run without loading any network
interfaces; in this mode, the only transactions a server can run are those passed
to it by another process.
-tm parameter makes the transaction layer of the server mask exceptions
• The
into transaction errors.
-tt parameter makes the transaction layer of the server throw exceptions
• The
to the server layer.
Show Package Contents. Drag
Contents Þ MacOS folder to an open
C:\Program Files\Quark\QuarkXPress
EXIT CODES
When the server shuts down, QuarkXPress Server returns exit codes. The
“keepalive.sh” file (Mac OS) or “keepalive.bat” file (Windows) uses these
codes to check the type of QuarkXPress Server shutdown. If the exit code
indicates that QuarkXPress Server shut down unexpectedly, the “keepalive”
utilities automatically relaunch QuarkXPress Server.
Valid exit codes are as follows:
• QUARK DYNAMIC DOCUMENT SERVER_EXIT_NORMAL (0): The server
exited normally.
• QUARK DYNAMIC DOCUMENT SERVER_EXIT_EXCEPTION (6969): The server
exited as a result of an exception that was handled by the server layer.
QUARK DYNAMIC DOCUMENT SER
•
exited as a result of a startup problem. In this case, restarting does not solve
the problem; you must relaunch QLA.
• QUARK DYNAMIC DOCUMENT SERVER_EXIT_RESTART (6971): The server
exited as a result of a remotely requested restart.
• QUARK DYNAMIC DOCUMENT SERVER_EXIT_SHUTDOWN (6972):
The server exited as a result of a remotely requested shutdown.
CHAPTER 1: GETTING ST
6
|
VER_EXIT_ST
ARTED WITH QUARKXPRESS SERVER
ARTUP (6970): The server
SERVER CONFIGURATION DIALOG BOX
Chapter 2: The QuarkXPress
Server user interface
This chapter describes the QuarkXPress Server user interface and explains how
you can use it to configure and customize your QuarkXPress Server application
and manage your server XTensions modules. Menu items are covered in the
same order they display in the user interface, from left to right and top
to bottom.
When you open a dialog box in the QuarkXPress Server user interface, the HTTP
server pauses to prevent conflicts with any jobs that are being processed. When
you close the dialog box, the HTTP server starts again.
SERVER CONFIGURATION DIALOG BOX
The Server Configuration dialog box (QuarkXPress Server/Server menu)
lets you specify the document pool location and control cache memory sizes,
log options, HTTP settings, and other options related to the functioning of
QuarkXPress Server.
SERVER (TAB)
Server Configuration dialog box
The Server tab in the Server Configuration dialog box lets you control memory and timing settings. You can also define the location of the document pool
and designate default documents for display.
CHAPTER 2: THE QUARKXPRESS SERVER USER INTERF
ACE
7
|
SERVER CONFIGURATION DIALOG BOX
Server tab of Server Configuration dialog box
ALLOW MEMORY CACHING (CHECK BOX)
Server Configuration dialog box Þ Server tab
Check Allow Memory Caching to store disk-based documents in a memoryresident cache. Documents from external document providers also use this
cache.
Allow Memory Caching is checked by default.
MAX MEMORY CACHE SIZE (FIELD)
Server Configuration dialog box Þ Server tab
In the Max Memory Cache Size field, enter the maximum memory size
allocated to the cache memory. The default value is 100MB. The acceptable
range of values is from 10MB to 1024MB.
All subrenderers in a master-subrenderer environment share the same
memory cache.
CONTENT LOADING TIMEOUT (FIELD)
Server Configuration dialog box Þ Server tab
In the Content Loading T
imeoutfield, enter the amount of time (in seconds)
the server should wait for a server XTensions module (or another document
provider) to load content asynchronously before timing out the transaction.
The default value is 120 seconds. Valid values are from 1 second to 3600 seconds.
T RENDER (AREA)
AUL
DEF
Server Configuration dialog box Þ Server tab
Use the Default Render area to specify the format in which QuarkXPress Server
renders QuarkXPress projects if the client does not specify a format. Y
change the render type using URL parameters in the HTTP request.
CHAPTER 2: THE QUARKXPRESS SERVER USER INTERF
8
|
ou can
ACE
SERVER CONFIGURATION DIALOG BOX
TYPE (DROP-DOWN MENU)
Server Configuration dialog box Þ Server tab
To indicate the default rendering format for the server, choose an option from
the
Default Rendering Type drop-down menu:
EPS Document: Returns an Encapsulated PostScript (EPS) file
•
JPEG: Returns a JPEG file
•
PDF: Returns a PDF file
•
PNG: Returns a Portable Network Graphics (PNG) file
•
PostScript: Returns a PostScript file
•
QuarkXPress Document: Returns a QuarkXPress project
•
Raw Custom: Returns a file in internal QuarkXPress format for use by server
•
XTensions software developers
•
RLE Raw Custom: Returns a file in internal QuarkXPress format (compressed
using Run Length Encoding) for use by server XTensions software developers
If a copy of QuarkXPress Server running on Mac OS renders a project that was
created in Mac OS and returns the project in QuarkXPress format, the resulting project has no resource fork. (A resource fork is a hidden file that contains
information about the application that created a file.) You cannot preview a
project that does not have a resource fork, but such projects function normally
in all other respects.
You can set up helper applications on local systems to display files in
formats such as PostScript on the screen, but this feature is not built into
QuarkXPress Server.
SCALE (FIELD)
Server Configuration dialog box Þ Server tab
In the Scale field, enter the default scale at which QuarkXPress Server should
render projects.
Scale is not available for PDF
, PostScript, Personalized Print Markup Language
(PPML), and QuarkXPress project rendering formats.
DISABLE QUARKXPRESS DOCUMENT RETURN (CHECK BOX)
Server Configuration dialog box Þ Server tab
Check Disable QuarkXPress Document Return to prevent QuarkXPress Server
from returning QuarkXPress projects to clients.
DOCUMENT POOL (AREA)
Server Configuration dialog box Þ Server tab
Use the Document Pool area to control location and configuration of the
document pool.
CHAPTER 2: THE QUARKXPRESS SERVER USER INTERF
ACE
9
|
SERVER CONFIGURATION DIALOG BOX
ENABLE FILE SYSTEM DOCUMENT POOL (CHECK BOX)
Server Configuration dialog box Þ Server tab
Check Enable File System Document Pool to enable the Document Root field
and the
Browse button. This box is checked by default.
To specify the document pool directory, click
Browse or enter a path in the
Document Root field.
The document pool directory can be on the same computer as the QuarkXPress
Server application or on a file server that is accessible on a Local Area Network
(LAN) or a Wide Area Network (WAN), as long as the drive containing the pool
can be mounted.
You cannot specify the QuarkXPress Server application folder as the document
pool directory.
ALLOW REMOTE CHANGES (CHECK BOX)
Server Configuration dialog box Þ Server tab
Check Allow Remote Changes to allow other applications to upload items to
or delete items from the document pool. You can upload or delete QuarkXPress
projects and their associated files. This box is checked by default.
FORCE SERVED DOCUMENTS CLOSED (CHECK BOX)
Server Configuration dialog box Þ Server tab
Check Force Served Documents Closed to make QuarkXPress Server close projects from the document pool after it renders them, regardless of the Telegraph
XTensions software setting. Uncheck
Force Served Documents Closed to keep
such projects open on the server. This box is checked by default.
The ability of project to remain open is determined by whether Allow
Document to Stay Open
QuarkXPress
Preferences dialog box when Telegraph XTensions software
is checked in the QuarkXPress Server pane of the
uploads the file. (For more information, see Chapter 5, “Telegraph XTensions
software.”) If a project is not set to remain open by the Telegraph XTensions
software, unchecking
Force Served Documents Closed does not cause the
project to remain open.
Setting a project to remain open does not guarantee that the project will
be left open. This is because server memory and load requirements are also
involved. For example, if the server requires memory to open additional projects, it might close a project that has been left open. The maximum number
of open projects is 32. This feature enhances performance, and the cache can
be cleared at any moment.
10
CHAPTER 2: THE QUARKXPRESS SERVER USER INTERF
|
ACE
SERVER CONFIGURATION DIALOG BOX
GENERATE HIERARCHY ON DOCUMENT UPLOAD (CHECK BOX)
Server Configuration dialog box Þ Server tab
Check Generate Hierarchy on Document Upload to make QuarkXPress Server
automatically generate any file hierarchy that is requested when a user uploads
content to the document pool from Telegraph XTensions software. For more
information, see Chapter 5, “Telegraph XTensions software.” This box is
checked by default.
DOCUMENTS (AREA)
Server Configuration dialog box Þ Server tab
Use the Documents area of the Server tab to specify which HTML files should
display by default when a client accesses QuarkXPress Server, when errors occur,
and when access is denied to a client.
DEFAULT DOCUMENT (FIELD)
Server Configuration dialog box Þ Server tab
To specify which HTML file should display by default when a client accesses
QuarkXPress Server, enter the file’s path in the
click
Browse and navigate to the file. This file must be an HTML file.
Default Document field or
ERROR DOCUMENT (FIELD)
Server Configuration dialog box Þ Server tab
To specify which HTML file should display by default when QuarkXPress Server
cannot process a request, enter the file’s path in the
click
Browse and navigate to the file. This file must be an HTML file.
Error Document field or
Your error document can contain whatever information you like. QuarkXPress
Server also supports the following special tags:
• If you include an
<!--ERRORNUMBER--> comment in the file, QuarkXPress
Server replaces that comment with a number that identifies the particular
error that occurred.
• If you include an
<!--ERRORSTRING--> comment in the file, QuarkXPress Server
replaces that comment with details about the particular error that occurred.
NO ACCESS DOCUMENT (FIELD)
Server Configuration dialog box Þ Server tab
To specify which HTML file should display by default when a client is denied
access to a ser
Document
field or click Browse and navigate to the file. This file can contain
ver function or project, enter the file path in the
No Access
whatever information you like, but it must be an HTML file.
CHAPTER 2: THE QUARKXPRESS SERVER USER INTERF
ACE
11
|
SERVER CONFIGURATION DIALOG BOX
LOGGING (TAB)
Server Configuration dialog box
Click the Logging tab in the Server Configuration dialog box to control how
errors and transactions are logged.
Logging tab of Server Configuration dialog box
The log folder contains two log files: The transaction log and the error log. You
can configure the system to save the log folder to your computer or to a file
server that is accessible over a LAN or a WAN, as long as the drive containing
the folder can be mounted.
LOGGING ENABLED (CHECK BOX)
Server Configuration dialog box Þ Logging tab
Check Logging Enabled to enable the Log Folder field and then enter the path
to the folder or click
Browse and navigate to the folder.
You cannot specify the QuarkXPress Server application folder as the document
pool directory.
LOG ERRORS (CHECK BOX)
Server Configuration dialog box Þ Logging tab
Check Log Errors to set the system to record unsuccessful transactions in the
log file.
LOG TRANSACTIONS (CHECK BOX)
Server Configuration dialog box Þ Logging tab
Check Log Transactions to enter every non-error response returned from
transactions on QuarkXPress Server into the transaction log.
LOG DETAILED TIMING DATA (CHECK BOX)
Server Configuration dialog box Þ Logging tab
Depending on the render type, certain transactions must include transaction timing data. Check
Log Detailed Timing Data to include the following
transaction timing data (measured in milliseconds) in the transaction log for
each transaction:
Connection acceptance and closure time: The duration between the network
•
connection opening and closing time.
12
CHAPTER 2: THE QUARKXPRESS SERVER USER INTERF
|
ACE
SERVER CONFIGURATION DIALOG BOX
TTP request and body parsed time:The total time duration in which the fol-
• H
lowing operations are performed: The client connects to the server and sends
a request, timing starts, a request is parsed, QuarkXPress Server processes the
request, and timing stops.
•
QuarkXPress Server request processing time: Same as Connection acceptance
and closure time
Opening QuarkXPress document time: The time required to open a
•
, but timing starts after request parsing is complete.
QuarkXPress project for rendering.
Instantiate document time: The time required to carry out the dynamic
•
publishing process.
• Total of rendering process time: The total amount of time spent rendering
a project.
Time required to generate an image of the QuarkXPress document: The
•
time required for the generation of files that use JPEG, PNG, or any other
compressed format.
•
Closing QuarkXPress document time: The time required to close a
QuarkXPress project.
• Data ready and all sent to client: The difference between the time when all
data for the page return has been processed and is ready to be sent and the
time when the last bit of data is sent to the client.
Server XTensions software can be configured to add module-specific timing
entries to the transaction log.
LOG SERVER EVENTS (CHECK BOX)
Server Configuration dialog box Þ Logging tab
Check Log Server Events to record QuarkXPress Server events that are not
related to error conditions in the transaction log. Server events include
the following:
Server Started: The date and time at which the server was started.
•
Server Stopped: The date and time at which the server was stopped.
•
Errors Starting Up: The server records errors, such as issues loading XTensions
•
software, in the error log. In no-UI mode, errors that cause an alert to display
in the console mode are recorded in the error log.
Exceptions Caught (Windows only): Any exceptions logged by the server.
•
Application exception-type errors: An “exception masked” notice and a code.
•
You can use this information for troubleshooting.
CHAPTER 2: THE QUARKXPRESS SERVER USER INTERF
ACE
13
|
SERVER CONFIGURATION DIALOG BOX
LOG DOCUMENT PROBLEMS (CHECK BOX)
Server Configuration dialog box Þ Logging tab
Check Log Document Problems to include problem descriptions in transaction
log files. Logged problems include the following:
Missing Fonts: If fonts are missing from a project that has been requested for
•
rendering, a one-line description of each missing font is added to the error log.
If QuarkXPress Server receives a request to render a project and does not have
access to the fonts required by the project, it substitutes Helvetica (Mac OS) or
Arial (Windows). This behavior is the same as in QuarkXPress.
•
Missing SXTs: If a required server XTensions module is missing when a rendering request is received, a one-line description of each missing module is
added to the error log. If the name of the missing module is not returnable,
the XTensions module ID number is returned.
Text Encoding/Character Set Problems: If text is sent to a text box in the tem-
•
plate and the system does not have access to the correct font glyph, the issue
is logged. The log data indicates the character set that the system attempted
to convert. For example, the log entry might show that a request for Japanese
characters was sent to an English project.