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 we're assuming about you
In writing this guide, we assume that you are familiar with your computer and know how
to:
• Launch an application
• Open, save, and close files
• Use menus, dialog boxes, and palettes
• Work within a networked computing environment
• Use the mouse, keyboard commands, and modifier keys
Consult the documentation provided with your computer or other resources if you need
more information in any of these areas.
Where to go for help
If you're new to QuarkXPress® Server, or if you want to explore one of its other longstanding
features, consult the following resources:
• A Guide to QuarkXPress Server
• The QuarkXPress Server Web Integration Guide
• Third-party books
• General books about desktop publishing
If your issues are at the system level — saving files, moving files, activating fonts, for
example — consult the documentation resources provided with your computer.
6 | A GUIDE TO QUARKXPRESS SERVER 8.5
ABOUT THIS GUIDE
Conventions
Formatting conventions 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 OK."
• References: In descriptions of features, parenthetical references guide you in accessing
those features. For example: "The Find/Change dialog box (Edit menu) lets you find and
replace text."
• Arrows: You will often see arrows (>), which map out the menu path to a feature. For
example: "Choose Edit > Style Sheets to display the Style Sheets dialog box."
• 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. For example,
"Click the button on the Measurements palette to center text."
• Cross-platform issues: This application is quite consistent across operating systems. However,
some labels, buttons, key combinations, and other aspects of the application must 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 OS version of 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.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 7
GETTING STARTED WITH QUARKXPRESS SERVER
Getting started with
QuarkXPress Server
QuarkXPress Server lets you render 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®— from a centralized
QuarkXPress Server application. To send a 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 "QXPServer" to return
the file "MyProject.qxp" as a PDF file:
http://QXPServer: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 "Creating URL
requests" and in the QuarkXPress Server Web 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 QuarkXPress Server 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 and other types of requests.
• 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.
8 | A GUIDE TO QUARKXPRESS SERVER 8.5
GETTING STARTED WITH 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 language edition of QuarkXPress 5.0 or later. QuarkXPress Server can save and export
projects in QuarkXPress 7.x and QuarkXPress 8.x format. QuarkXPress Server can also
export projects in QuarkXPress 6.x Japanese format and QuarkXPress 6.x Korean 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 "Telegraph
XTensions software.")
For more information about the document pool, see "Server Configuration dialog box."
QuarkXPress Server 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 document providers.
Projects and layouts
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.
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, see "Server Configuration dialog box
A GUIDE TO QUARKXPRESS SERVER 8.5 | 9
GETTING STARTED WITH QUARKXPRESS SERVER
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 a "QuarkXPress Server.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 2003 and Windows XP: C:\Documents and
Settings\[username]\Application Data\Quark\QuarkXPress Server
8\Preferences
• Windows 2008 and Windows Vista, when QuarkXPress Server is running as a service under
the "local system user" account: C:\ProgramData\Quark\QuarkXPress Server
8\Preferences
• Windows 2008 and Windows Vista, when QuarkXPress Server is running normally or as
a service under the "Domain user" account :
C:\Users\Administrator\AppData\Local\Quark\QuarkXPress Server 8
For more information about preferences, see "Server preferences."
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.
The master QuarkXPress Server application and all of the subrenderers it launches share
the following elements:
10 | A GUIDE TO QUARKXPRESS SERVER 8.5
GETTING STARTED WITH QUARKXPRESS SERVER
• The same application preferences (each subrenderer has its own preferences files, but
QuarkXPress Server keeps them synchronized)
• The same document cache in memory
• The same memory cache
• The same server XTensions modules (a separate instance of each XTensions module runs
with each subrenderer)
• 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.
By default, QuarkXPress Server launches in master-subrenderer mode. You can change this
setting by changing the parameters in the "QuarkXPress Server.config" file. For more
information, see "Launching QuarkXPress Server."
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)"
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; Modifier XTensions software lets you retrieve, manipulate,
and reconstruct XML representations of projects; and QuarkCopyDesk® Renderer XTensions
software lets you create QuarkCopyDesk articles. Telegraph XTensions software works with
QuarkXPress to allow designers to name boxes in template files so that those boxes can
be addressed by URLs.
For more information about XTensions software included with QuarkXPress Server, see
"QuarkXPress Server XTensions software" and "Telegraph XTensions software."
The QuarkXPress Server XTensions 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).
A GUIDE TO QUARKXPRESS SERVER 8.5 | 11
GETTING STARTED WITH QUARKXPRESS SERVER
As of version 8.0, the QuarkXPress Server XDK is Unicode-compliant.
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.
• When executed in no-UI mode, QuarkXPress Server displays no visible user 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 control which mode QuarkXPress Server launches in, edit the "QuarkXPress Server.config"
file, which is located at the root level of the QuarkXPress Server application folder. This
file supports the following options:
12 | A GUIDE TO QUARKXPRESS SERVER 8.5
GETTING STARTED WITH QUARKXPRESS SERVER
•
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.
•
The -subrenders parameter lets you specify how many subrenderers to use.
•
The -tm parameter makes the transaction layer of the server mask exceptions into
transaction errors.
•
The -tt parameter makes the transaction layer of the server throw exceptions to the server
layer.
•
The -monitorsubrenders option turns on subrenderer monitoring.
To use the subrenderer monitoring feature, add the following command line parameters
to the "QuarkXPress Server.config" file:
-monitorsubrenders -queryinterval x -noofretries y -recycle
If a subrenderer process has been attempting to fulfill a request for the specified number
of retries (with the specified query interval in seconds between retries), the subrenderer
monitor recyles that process.
Windows only: If the recycle parameter is not supplied, the subrenderer monitor performs
a periodic memory check on all subrenderer processes. If the memory used by a subrenderer
process does not change within the specified number of retries with the specified query
interval, that process is recycled.
By default, the contents of the "QuarkXPress Server.config" file are as follows:
COMMANDLINE=-subrenders 1
To launch QuarkXPress Server with the options specified in the "QuarkXPress Server.config"
file, double-click the "QuarkXPress Server" icon.
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:
• QUARKXPRESS SERVER_EXIT_NORMAL (0): The server exited normally.
• QUARKXPRESS SERVER_EXIT_EXCEPTION (6969): The server exited as a result of an
exception that was handled by the server layer.
• QUARKXPRESS SERVER_EXIT_STARTUP (6970): The server exited as a result of a startup
problem. In this case, restarting does not solve the problem. You must relaunch QLA.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 13
GETTING STARTED WITH QUARKXPRESS SERVER
• QUARKXPRESS SERVER_EXIT_RESTART (6971): The server exited as a result of a remotely
requested restart.
• QUARKXPRESS SERVER_EXIT_SHUTDOWN (6972): The server exited as a result of a
remotely requested shutdown.
14 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
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 (Server/QuarkXPress 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)
The Server tab in the Server Configuration dialog box (QuarkXPress Server > Server
Configuration) lets you control memory and timing settings. You can also define the
location of the document pool and designate default documents for display.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 15
THE QUARKXPRESS SERVER USER INTERFACE
Server tab of Server Configuration dialog box
Check Allow Memory Caching to store disk-based documents in a memory-resident cache.
Documents from external document providers also use this cache. Allow Memory Caching
is checked by default.
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.
In the Content Loading Timeout field, 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.
Use the Default Render area to specify the format in which QuarkXPress Server renders
QuarkXPress projects if the client does not specify a format. You can change the render
type using URL parameters in the HTTP request.
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
16 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
• PDF: Returns a PDF file
• PNG: Returns a Portable Network Graphics (PNG) file
• PostScript: Returns a PostScript file
• PPML: Returns a PPML file
• QCDDOC: Returns a QuarkCopyDesk article
• 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.
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.
Check Disable QuarkXPress Document Return to prevent QuarkXPress Server from
returning QuarkXPress projects to clients.
Use the Document Pool area to control location and configuration of the document pool.
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.
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.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 17
THE QUARKXPRESS SERVER USER INTERFACE
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 is checked in the QuarkXPress Server pane of the QuarkXPress Preferences dialog
box when Telegraph XTensions software 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.
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.
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.
To specify which HTML file should display by default when a client accesses
QuarkXPress Server, enter the file's path in the Default Document field or click Browse
and navigate to the file. This file must be an HTML file.
To specify which HTML file should display by default when QuarkXPress Server cannot
process a request, enter the file's path in the Error Document field or click Browse and
navigate to the file. This file must be an HTML file.
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.
To specify which HTML file should display by default when a client is denied access to a
server function or project, enter the file path in the No Access Document field or click
Browse and navigate to the file. This file can contain whatever information you like, but
it must be an HTML file.
18 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
Logging (Tab)
Click the Logging tab in the Server Configuration dialog box (QuarkXPress Server >
Server Configuration) 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.
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.
Check Log Errors to log PDF-generation and PostScript-generation errors. Checking this
box enables the Use Log Folder check box.
Check Log Transactions to enter every non-error response returned from transactions on
QuarkXPress Server into the transaction log.
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.
• HTTP request and body parsed time: The total time duration in which the following
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, but timing starts after request parsing is complete.
• Opening QuarkXPress document time: The time required to open a QuarkXPress project
for rendering.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 19
THE QUARKXPRESS SERVER USER INTERFACE
• 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.
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.
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 uses the font specified in the Fonts tab of the Preferences dialog box (see
"Preferences — Application — Fonts"). If this font is also unavailable, QuarkXPress Server
substitutes Helvetica (Mac OS) or Arial (Windows). This behavior is the same as it is 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 template 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.
20 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
Check Log Non-conformant SXT Dialog Messages to prevent server XTensions modules
from displaying dialog boxes.
HTTP (Tab)
Click the HTTP tab in the Server Configuration dialog box (QuarkXPress Server > Server
Configuration) to control port and connection settings.
HTTP tab
Check Enable HTTP Interface to activate the HTTP 1.0 server that is built in to
QuarkXPress Server and enable the other controls in this area.
In the Port Number field, enter the port number of the HTTP server. The acceptable range
of values is from 1024 to 65,535 (Mac OS) or from 1 to 65,535 (Windows). When the HTTP
server is initialized, an alert displays if this value falls outside this range or if the specified
port number is already in use. If QuarkXPress Server is running in no-UI mode, an entry
regarding this alert is made in the log file. The default value for this field is 8080.
In the Max Connections field, enter the maximum number of rendering requests to be
recognized and processed by the QuarkXPress Server connection queue. The acceptable
range of values is from 1 to 16. The default value for this field is 16.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 21
THE QUARKXPRESS SERVER USER INTERFACE
In the Max Listens field, enter the maximum number of requests to be queued up for
processing while waiting for an open connection. An alert displays if this value exceeds
the maximum number of listens. The acceptable range of values is from 1 to 32. The default
value for this field is 20.
In the Default Buffer Size field, enter the total size (in kilobytes) of the HTTP buffer. The
HTTP buffer is the size of the data block that is sent to the client from the server as part
of the HTTP response. The smaller the block size, the less memory consumed by the
application. Large blocks facilitate faster performance, but might cause memory shortages
in other parts of the application. The acceptable range of values is from 16KB to 256KB.
The default value for this field is 32KB.
In the Connection Timeout field, enter the total time in seconds before an HTTP
connection should time out. The client must send a request within this period. The
acceptable range of values is from 1 second to 32,767 seconds. The default value for this
field is 120 seconds.
Check Realm Verif. for Admin. Requests to enable the User Name, Password, and
Confirm fields. These fields let youcontrol access to administrative parameters and features.
You must enter valid values that contain at least four characters in the User Name,
Password, and Confirm fields, and you can enter up to 32 characters. This box is
unchecked by default.
Check Use Connection Filters to enable controls that let you enter and modify IP addresses
and subnet masks in the connection filters list. This box is unchecked by default.
• Click Insert to display the Insert Connection Filter dialog box, in which you can enter
an IP address between 1 and 254 and a subnet mask between 0 and 255. The maximum
number of allowed IP addresses/subnet masks is 128.
• Click Modify to display the Modify Connection Filter dialog box, in which you can
specify an action for a particular IP address, edit an IP address, and edit a subnet mask.
Each field in the Modify Connection Filter dialog box accepts a value between 0 and 255.
The default setting is Deny Connection.
• Click Remove to delete the selected IP address from the connection filters list.
•
Click or to move the selected IP address up or down in the connection filters list.
• If no rules have been applied to an IP address, you can select the IP address and click Allow
Connections to allow the IP address to be used or click Deny Connections to prevent the
IP address from being used. The "allow" and "deny" actions are performed on IP addresses
in the order they display in the connection filters list.
Email (Tab)
Click the Email tab in the Server Configuration dialog box (QuarkXPress Server > Server
Configuration) to display controls that let you set up automatic e-mail messages to warn
of license expiration.
22 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
Email tab
Check SMTP Configuration to enable QuarkXPress Server to send an e-mail to an
administrator when the application's QLA license expires. Checking this box enables the
other controls in this area. This box is unchecked by default.
In the SMTP Server field, enter the domain name or IP address of the e-mail server that
QuarkXPress Server should use to send messages (for example, mail.quark.com).
In the SMTP Server Port field, enter the port number of the e-mail server that
QuarkXPress Server should use to send messages. The acceptable range of values is from
0 to 255. The default value for this field is 25.
In the From (Email Address) field, enter the source e-mail address the QuarkXPress Server
application should use to send messages (for example, QXPSserver1@quark.com).
In the To (Email Address) field, enter the e-mail address to which the QuarkXPress Server
application should send messages (for example, QXPServerAdmin@quark.com).
Server preferences
Use the Preferences dialog box (Server/QuarkXPress Server > Preferences) to set up
default preferences for use when projects are created in QuarkXPress Server.
Many of these preferences come into play only when you create a project in
QuarkXPress Server. You cannot directly create projects in the QuarkXPress Server user
interface, but XTensions software can create projects.
Changes to preferences in the Application category affect all projects. For example, when
you create a project using a server XTensions module or other external software, preference
settings in the Application category are applied to the new project.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 23
THE QUARKXPRESS SERVER USER INTERFACE
Changes to preferences in the Project category affect all layouts in the active project. If
you change project preferences with no projects open, the new preferences become the
default settings for all new projects.
Changes to preferences in the Default Layout categories affect all layouts of that type
created in QuarkXPress Server.
Preferences — Application — Display
Use the Display pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to specify how TIFF files display on screen for all projects.
Use the Color TIFFs drop-down list to specify the color depth of screen previews created
for color TIFFs when they are imported.
Use the Gray TIFFs drop-down list to specify the resolution of screen previews created for
grayscale TIFFs when they are imported.
Choose a profile that corresponds to your monitor from the Monitor Profile drop-down
menu, or choose Automatic. Profiles can be placed in the "Profiles" folder in the
QuarkXPress Server application folder.
Preferences — Application — Input Settings
Use the Input Settings pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to customize the display of quotation marks and the selection of characters
used to specify page ranges.
Use the Quotes area to choose a style for converting and entering quotation marks. The
preferences set in the Quotes area of QuarkXPress Server override the preferences set for
a project.
Use the Format drop-down menu to specify the default characters to be used with the
Smart Quotes feature and Convert Quotes option in the Get Text dialog box (File > Get
Text).
Check Smart Quotes to force QuarkXPress to replace feet (')and inches (") marks
automatically with the specified quotation marks.
Hyphens and commas are the default separators for indicating sequential and nonsequential
ranges in the Pages field of the Print dialog box for a print project. In the Sequential and
Nonsequential fields, enter new characters to be used as separators when the project is
rendered by QuarkXPress Server. The preferences set in the Page Range Separators area
of QuarkXPress Server override the preferences set for a project.
Check Maintain Picture Box Attributes to make a picture box "remember" its scaling and
other attributes by default when you import a new picture into the box.
By default, you can input text directly into text boxes the same way you would in a
system-supplied input window for East Asian characters. To disable this feature, uncheck
Inline Input .
24 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
To also allow OpenType® fonts to be scanned at print, check Enable OTF Printer Font
Scan.
Preferences — Application — Font Fallback
Use the Font Fallback pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to control what happens when the application opens a project that uses
missing fonts.
Check Font Fallback to activate the Font Fallback feature. When this feature is active, if
the application encounters a character it cannot display in the current font, it attempts
to find a font that can display the character.
If the application encounters a missing font when opening a project, it uses the preferences
in this pane to determine which substitute fonts to use.
If you add characters to an exising project and the font cannot support those characters,
the application will search the system for a font that can display the characters.
Check Search to have the application search for a suitable font that is used in the active
project. To restrict the search to a particular range, check Last and then enter a number
in the Paragraphs field. To expand the search to the entire story where a missing font
occurs, check Entire Story.
To indicate which fallback fonts should be used when no other font can be found (taking
the Search settings into account), choose an option in the Font column for each
script/language listed in the Script/Lang column.
To indicate which font should be used for the slug line when a layout is printed with
registration marks turned on, choose an option from the Slug Line Font drop-down menu.
Preferences — Application — Open and Save
Use the Save pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to control Unicode options.
Under Non-Unicode Support, choose an option from the Encoding drop-down menu to
indicate how the applications should display characters in non-Unicode text.
Preferences — Application — XTensions Manager
Use the XTensions Manager pane of the Preferences dialog box
(Server/QuarkXPress Server > Preferences) to control when the XTensions Manager
dialog box displays.
If the XTensions Manager dialog box displays as a result of the When > Error occurs
while loading XTensions setting, the server stops (as it does when any dialog box displays).
This can be a problem during an automatic restart, because it will prevent the server from
completely restarting.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 25
THE QUARKXPRESS SERVER USER INTERFACE
Preferences — Application — Fonts
Use the Fonts pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to specify the following preferences.
In the Font Mapping area:
• To specify default replacement fonts, check Specify Default Replacement Font and choose
options from the Roman and East Asian drop-down menu.
• To highlight characters that are in a Traditional Chinese encoding's UDA/VDA (User
Defined Area/Vendor Defined Area) range so that these characters can be visually verified,
check Highlight character ranges defined by Traditional Chinese font vendors.
Preferences — Application — EPS
Use the EPS pane of the Preferences dialog box (Server/QuarkXPress Server > Preferences)
to specify options related to imported EPS pictures.
To control whether the application should generate a preview of an EPS file or use the
preview (if any) embedded in the file, choose an option from the Preview drop-down list.
The option specified in this pane is used only when the EPS preview is being created. If
you change the preference, you need to reimport the EPS file.
Mac OS only: To increase the amount of virtual memory available for rendering large EPS
files during a Save Page as EPS operation, increase the value in the Virtual Memory field.
Preferences — Application — Error Reporting
Use the Error Reporting pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to control how the application reports problems to Quark.
To have the application send error reports to Quark directly over the Internet, check Send
Error Report via Internet. To have the application send error reports to Quark in e-mail
if direct Internet connection fails, check On Internet Failure, Send Error Report via
Email.
Preferences — Application — Full Res Preview
Use the Full Res Preview pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to control where QuarkXPress Server caches high-resolution images.
To control where the application caches high-resolution images for display, either click
QuarkXPress Server Preferences Folder or click Other Folder and then indicate a different
location.
To indicate a maximum size for the preview cache folder, enter a value in the Maximum
Cache Folder Size field.
In the Display Full Resolution Previews For area:
• When All Full Resolution Previews is selected, all pictures in the project that are set to
display at full resolution are displayed at full resolution.
26 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
• When Selected Full Resolution Previews is checked, pictures set to display at full resolution
will only do so when they are selected.
You may want to turn off Full Resolution Preview if you are experiencing a performance
issue that you think might be related to this XTensions module. To turn off Full Resolution
Preview when opening a project, check Disable Full Resolution Previews on Open.
Preferences — Application — Job Jackets
Use the Job Jackets pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to specify preferences for automatic layout evaluation and to indicate a default
location for Job Jackets® files.
Use the options in the Layout Evaluation area to control when the application
automatically executes the File > Evaluate Layout command. For example, by checking
On Output, you can make sure that you always evaluate a layout before you send it to
output. The options are:
• At Open
• At Save
• At Output
• At Close
Use the options in the Job Jacket Location area to specify where Job Jackets files are stored
by default. To save Job Jackets files in the default location, click Use Default Path for
Shared Jackets. The default location is the "Documents" folder on Mac OS and the "My
Documents" folder on Windows.
Preferences — Application — Modifier
Use the Modifier pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to set preferences pertaining to the way Modifier XTensions software updates
text in projects.
The Modifier pane displays only if Modifier XTensions software is loaded. For more
information, see "Modifier XTensions software."
In the Amount by which Text will Increase/Decrease field, enter the percentage by
which Modifier XTensions software can increase or decrease text size when the parameter
<FITTEXTTOBOX> is used. Valid values for this field are from 0% to 20%. For example, if
the font size in use is 10pt, and you enter 20% in this field, the font size can vary from
8pt to 12pt when <FITTEXTTOBOX> is used.
In the Font Size Min and Max fields, enter the minimum and maximum font size that
the Modifier parameter <SIZE> can apply to text in a text box. The default values are "2pt"
(Min) and "720pt" (Max).
A GUIDE TO QUARKXPRESS SERVER 8.5 | 27
THE QUARKXPRESS SERVER USER INTERFACE
The value of the <SIZE> parameter does not override the value in the Amount by which
the Text will Increase/Decrease field.
Check Allow Text to Grow to allow the Modifier parameter <FITTEXTTOBOX> to increase
the font size of text in a text box.
Check Adjust Other Font Attributes to enable the font attributes in this area. You can
then use the check the boxes to allow Modifier XTensions software to set Horizontal
Vertical Scale, Tracking Amount, and Baseline Shift for text.
To use a particular default XSLT file, check Use default XSLT and then click Browse and
navigate to the XSLT file.
Preferences — Application — PDF
Use the PDF pane of the Preferences dialog box (Server/QuarkXPress Server > Preferences)
to set preferences for rendering in PDF format.
The PDF pane displays only if PDF Filter XTensions software is loaded. For more
information, see "PDF Filter XTensions software"
Use the PDF Workflow area to set a location for PDF files:
• Click PDF Direct to generate PDF output in the browser. This is the default option.
• Click PDF to Folder to generate and save PDF files to a folder. Click Select/Browse to
specify a location for the folder in the Watched Folder field, and choose a default name
for PDF files from the Default Name scroll list.
• Click PostScript File for Later Distilling to generate a PostScript file. Click Select/Browse
to specify a location for the folder in the Watched Folder field, and choose a default name
for PostScript files from the Default Name scroll list.
Use the Error Settings area to specify whether and where PDF-generation and
PostScript-generation errors are logged.
Check Log Errors to log PDF-generation and PostScript-generation errors. Checking this
box enables the Use Log Folder check box.
To specify where errors should be logged, check Use Log Folder and then click
Select/Browse and navigate to the target folder. If you do not check this box, log files are
stored in the watched folder for PDF generation, as defined in the PDF pane.
In Mac OS, you can define the amount of memory your system allocates for rendering PDF
files by entering a value in the Virtual Memory field.
Preferences — Application — PSD Import
Use the PSD Import pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to control where previews of imported PSD files are cached and how large
the cache is allowed to become.
28 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
To create the cache in the preferences folder, click QuarkXPress Server Preferences. To
create the cache in a different folder, click Other Folder and select a different folder. To
set the size of the cache folder, enter a value in the Maximum Cache Folder Size field.
You may want to clear the PSD Import cache if previews look incorrect. To clear this cache,
click Clear Cache.
Preferences — Application — Placeholders
Use the Placeholders pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to set text placeholder display preferences.
Use the Color button in the Text Placeholder area to specify the color of the text
placeholders in the layout. Choose a shade percentage for the color from the Shade
drop-down menu.
Use the Color button in the TextNode Placeholder area to specify the color of the text
node placeholders in the layout. Choose a shade percentage for the color from the Shade
drop-down menu.
Preferences — Application — Fraction/Price
Use the Fraction/Price pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to format fractions and prices automatically.
In the Numerator area, the Offset option positions the numerator in relation to the
baseline; the VScale option determines the height of the numerator as a percentage of
font size; the HScale option determines the width of the numerator as a percentage of
normal character width; and the Kern option adjusts the spacing between the characters
and the forward slash.
In the Denominator area, the Offset option positions the denominator in relation to the
baseline; the VScale option determines the height of the denominator as a percentage of
font size; the HScale option determines the width of the denominator as a percentage of
normal character width; and the Kern option adjusts the spacing between the characters
and the forward slash.
In the Slash area, the Offset option positions the forward slash in relation to the baseline;
the VScale option determines the height of the forward slash as a percentage of font size;
the HScale option determines the width of the forward slash as a percentage of normal
character width; and the Kern option adjusts the spacing between the characters and the
forward slash. Check Fraction Slash to retain type size when you choose Style > Type
Style > Make Fraction.
In the Price area, the Underline cents option places an underline beneath the cents
characters and the Delete Radix option removes the decimal or comma character from
the price.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 29
THE QUARKXPRESS SERVER USER INTERFACE
Preferences — Application — Picture Effects
You can sometimes get improved performance by specifying a cache folder located on a
different drive from the drive or drives where the application and project are located. Use
the Picture Effects pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to specify the location of the cache folder for picture editing.
The Picture Effects pane displays only if QuarkVista XTensions software is loaded. For
more information, see "QuarkVista XTensions software."
Preferences — Project — General
Use the Project version of the General pane of the Preferences dialog box
(Server/QuarkXPress Server > Preferences) to specify default settings for auto picture
import, single layout mode, and OpenType kerning (for OpenType fonts).
Use the Auto Picture Import area to control whether QuarkXPress automatically updates
pictures that have been modified since you last opened a layout.
• To enable the Auto Picture Import feature, click On. When you open a project, the
application automatically reimports modified pictures into each layout using the modified
files.
• To disable the Auto Picture Import feature, click Off.
• To receive an alert before the application imports modified pictures, click Verify. Note
that if the Missing/Modified dialog box displays as a result of Verify being checked, the
server stops (as it does whenever any dialog box displays). This can be a problem during
an automatic restart, because it will prevent the server from completely restarting.
Checking Single Layout Mode will cause new projects to be created in single-layout mode.
Only the project name is used when saving PDF files or in AppleScript references.
Check Use OpenType Kerning to activate the default kerning values for OpenType fonts.
When OpenType kerning is active, it overrides any kerning specified through Kerning
Table Edit (Utilities menu) for OpenType fonts. To disable kerning for full-width characters
when using OpenType kerning, check Do Not Kern Full Width Characters.
Preferences — Project — XML Import
The controls in the XML Import pane of the Preferences dialog box
(Server/QuarkXPress Server > Preferences) are not relevant to QuarkXPress Server and
should be ignored.
Preferences — Layout — General
Use the Layout versions of the General pane of the Preferences dialog box
(Server/QuarkXPress Server > Preferences) to specify various default settings for page
layout, such as the colors of hyperlinks and anchors.
30 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
Use the Hyperlinks area to choose the color for anchor icons and hyperlinks. You might
want to choose anchor and hyperlink colors for a Print layout if you are planning to export
that layout as a PDF file.
Use the Master Page Items area to control what happens to master items when master
pages are applied. New master pages are applied to layout pages whenever you (1) drag
and drop a master page icon from the master page area in the Layout palette onto a layout
page icon in the Layout palette (Window > Show Layout); (2) delete a master page that
is applied to layout pages using the Layout palette; or (3) add, delete, or move an odd
number of pages in a facing-page layout.
• Click Keep Changes if you intend modified master items on your layout pages to remain
when a new master page is applied. The items that are kept are no longer master items.
• Click Delete Changes if you want modified master items on your layout pages to be deleted
when a new master page is applied.
Use the Framing area to specify whether frames are placed inside or outside text and
picture boxes.
• When you click Inside, the distance between the text and the frame is determined by the
box's Text Inset values (Item > Modify). When you place a frame inside a picture box,
the frame overlaps the picture.
• When you click Outside, the frame is placed outside the box, increasing the box's width
and height. The frame cannot extend beyond a constraining box or the pasteboard.
Use the Auto Page Insertion options (Print layouts only) to determine whether pages are
inserted automatically to contain text overflow from an automatic text box or a chain of
text boxes (on a page associated with a master page that contains an automatic text box).
The drop-down menu also enables you to determine where any pages will be inserted.
Preferences — Layout — Measurements
Use the Measurements pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to specify default measuring units for layout rulers and the Measurements
palette.
Use the Horizontal and Vertical drop-down menus to specify the measurement system
for the rulers displayed along the top and left of the layout window. Horizontal corresponds
to the top ruler; Vertical corresponds to the left ruler.
Use the Points/Inch field to override the default value of 72 points per inch. The application
uses the value here as the basis for all point and pica measurements, as well as for all point-
and pica-to-inch conversions. The desktop publishing standard for points per inch is 72.
However, the traditional typographic standard used on most metal typographic rulers is
usually approximately 72.27 or 72.307 points per inch (range = 60 to 80 pt, measurement
system = points, smallest increment = .001).
A GUIDE TO QUARKXPRESS SERVER 8.5 | 31
THE QUARKXPRESS SERVER USER INTERFACE
Use the Ciceros/cm field to specify a ciceros-to-centimeter conversion value different from
the standard 2.1967 (range = 2 to 3 c, measurement system = ciceros, smallest
increment = .001).
Use the Item Coordinates buttons (Print layouts only) to specify whether the increments
of the horizontal ruler repeat from zero for each Page or are continuous across a Spread.
This setting determines the coordinates of items displayed in fields. The default option is
Page.
Use the Measurement Units drop-down menu to set the default measurement unit for
new layouts.
Preferences — Layout — Paragraph
Use the Paragraph pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to control various paragraph-level settings.
Use the Auto Leading feature to automatically set line spacing. You can apply this setting
to a paragraph by entering "auto" or "0" in the Leading field of the Paragraph Attributes
dialog box (Style > Leading). Unlike paragraphs with absolute leading (identical line
spacing above every line), paragraphs with auto leading may include lines with different
leading when fonts and font sizes are mixed in the same paragraph.
Auto leading starts with a base amount of leading, which the application calculates by
examining the ascent and descent values built into the fonts used in an auto-leaded line
and the line above it; however, the user-specified text size (Style > Size) plays the largest
part in determining this base amount. Finally, a value specified by the user in the Auto
Leading field is added to the base amount to arrive at the total amount of leading.
To specify percentage-based auto leading, enter a value from 0% to 100% in 1% increments.
This value determines the amount of leading between two lines of text as follows: The
largest font size in the line above is multiplied by the percentage value. This outcome is
added to the base amount of auto leading between the two lines. Although the design of
certain fonts complicates the process, here is a simplified example: 10-point text styled
consistently in a "standard" font with Auto Leading set to 20% has 12 points of leading
(10 pts + [20% of 10] = 12 pts). To specify incremental auto leading, enter a value preceded
by a plus sign (+) or a minus sign (–) from –63 points to +63 points using any measurement
system. Entering "+5" will add 5 points of leading to the base amount of auto leading;
entering "+5 mm" will add 5 millimeters.
Use the Maintain Leading check box to control the placement of a line of text that falls
immediately below an obstruction in a column or box. If Maintain Leading is checked,
the line's baseline is placed according to its applied leading value. If Maintain Leading is
unchecked, the ascent of the line will abut the bottom of the obstruction or any applied
runaround value (Item > Runaround).
In the Lock to Grid Based On area:
• Click Ascent and Descent to lock text to grid based on the ascenders and descenders of
characters.
32 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
• Click Font Size (Em Box) to lock text to grid based on the size of the em boxes of the
characters.
For each language in the Hyphenation list, use the Method drop-down menu in the
Hyphenation area to specify the method the application uses to automatically hyphenate
paragraphs when no corresponding entry is found in your Hyphenation Exceptions
dictionary. The setting you choose affects only paragraphs for which Auto Hyphenation
(Edit > H&Js) is enabled:
• Choose Standard to hyphenate using the algorithm built into versions of QuarkXPress
prior to 3.1. Documents created in versions of QuarkXPress prior to 3.1 default to
Standard when they are opened in version 3.1 or later.
• Choose Enhanced to hyphenate using the algorithm built into QuarkXPress
version 3.1 and later.
• Extended 2 uses the same algorithm as Enhanced but checks any built-in hyphenation
dictionaries before resorting to the algorithm. Extended 2 uses the Dieckmann exception
resources and algorithm for hyphenation. This option was first introduced in
QuarkXPress 4.11 for German (Reformed) and has been expanded to other languages in
more recent versions. If available for a language, it is the default method for projects created
in QuarkXPress Server.
Preferences — Layout — Character
Use the Character pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to specify how the application constructs typographic styles such as Superscript
and Subscript:
• Use the Superscript area to control the placement and scale (size) of superscript characters.
The Offset value determines how far below the baseline the application places a superscript
character. The Offset value is measured as a percentage of font size. The default value is
33%. The VScale value determines the vertical size of the character and is a percentage of
font size. The HScale value determines width and is a percentage of the normal character
width (as specified by the font designer). The default value for both scales is 60% (range =
0 to 100%, measurement system = percentage, smallest increment = .1).
• Use the Subscript area to control the placement and scale (size) of subscript characters.
The Offset value determines how far above the baseline the application places a subscript
character. The Offset value is measured as a percentage of font size. The default value is
33%. The VScale value determines the vertical size of the character and is a percentage of
font size. The HScale value determines width and is a percentage of the normal character
width (as specified by the font designer). The default value for both scales is 100% (range =
0 to 100%, measurement system = percentage, smallest increment = .1).
• Use the Small Caps area to control the scale of characters with the Small Caps type style
applied to them. The VScale value determines the vertical size of the character and is
measured as a percentage of font size. The HScale value determines width and is measured
as a percentage of the normal character width (as specified by the font designer). The
A GUIDE TO QUARKXPRESS SERVER 8.5 | 33
THE QUARKXPRESS SERVER USER INTERFACE
default value for both scales is 75% (range = 0 to 100%, measurement system = percentage,
smallest increment = .1).
• Use the Superior area to control the scale of superior characters. The VScale value
determines the vertical size of the character and is measured as a percentage of font size.
The HScale value determines width and is measured as a percentage of the normal character
width (as specified by the font designer). The default value for both scales is 60% (range =
0 to 100%, measurement system = percentage, smallest increment = .1).
• Use the Ligatures area to use ligatures built into a font. A ligature is a typographic
convention in which certain characters are combined into a single glyph. Most fonts
contain ligatures for the characters "f" followed by "i" and "f" followed by "l". The Break
Above field enables you to specify the kerning or tracking value (measured in 1/200 em
space increments) above which characters will not be combined into ligatures. For example,
a headline with a large tracking value would probably not contain ligatures. The default
value is 1 (range = 0 to 10, measurement system = .005 [1/200] em space, smallest
increment = .001). To prevent the second two letters in "ffi" and "ffl" (as in office and
waffle) from being combined into ligatures, check Not "ffi" or "ffl". Three-character ligatures
for these combinations, common in traditional typesetting systems, are not standardized
in fonts designed for Mac OS, so some typographers prefer to keep all three letters separate
rather than combine only two of them. Note that many PostScript fonts do not have "ffi"
and "ffl" ligatures, but most OpenType fonts do. This option is unchecked by default.
• Check Auto Kern Above to specify that the application should use kerning tables, which
are built into most fonts, to control intercharacter spacing. The Auto Kern Above field
enables you to specify the point size above which automatic kerning must be used. The
Auto Kern Above feature also implements custom tracking information specified in the
Tracking Values dialog box for a selected font (Utilities > Edit Tracking). This option is
checked by default, with a 4-point threshold (range = 0 to 72 pt, measurement system =
various [", pt, cm, etc.], smallest increment = .001).
• Check Standard Em Space to specify an em-space equivalent to the point size of the text
(for example, 24pt text has a 24pt em space). If Standard Em Space is unchecked, the
application uses the width of the two zeros in the current font as the em-space width. This
option is checked by default. You can insert an em space in text by pressing
Option+space/Ctrl+Shift+6.
• Use the Flex Space Width field to change the 50% default width of a flexible space. To
create a breaking flexible space, press Option+Shift+space/Ctrl+Shift+5; to create a
nonbreaking flexible space, press Command+Option+Shift+space/Ctrl+Alt+Shift+5. The
Flex Space Width value is expressed as a percentage of the normal en space for a given
font and font size (range = 0 to 400%, measurement system = percentage, smallest
increment = .1).
• Use the Accents for All Caps check box to specify whether to include accent marks on
accented characters with the All Caps type style applied. This option is checked by default.
• Use the Space between CJK & R field to indicate how much space should be included by
default between a Chinese, Japanese, or Korean character and an adjacent Roman character.
34 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
Preferences — Layout — Trapping
Use the Trapping pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to set default trapping for Print layouts.
Select a Trapping Method:
• Click Absolute to trap using the values in the Auto Amount and Indeterminate fields
according to the object and background colors involved. If the object color is darker, the
object is choked by the background using the Auto Amount value. If the object color is
lighter, the object is spread into the background using the Auto Amount value.
• Click Proportional to trap using the value in the Auto Amount field multiplied by the
difference between the luminance (lightness or brightness) of the object color and the
background color.
• Click Knockout All to turn off trapping and print objects with a zero trap amount.
• Check Process Trapping to trap each process separation plate individually when a page
contains overlapping process colors.
• Check Ignore White to specify that an object color in front of multiple background colors
(including white) does not take white into account when trapping.
Enter a trapping value in the Auto Amount field or choose Overprint:
• Enter a value in the Auto Amount field to control the amount of trapping that QuarkXPress
applies to object and background colors that have an Auto Amount specified in the Trap
Specifications dialog box (Edit > Colors > Edit Trap), and to control the amount of
trapping applied to items with an Auto Amount (+) Trap Information or (–) specified
in the Trap Information palette (Window > Trap Information).
• Choose Overprint to cause overprinting for object and background colors with an Auto
Amount specified in the Trap Specifications dialog box (Edit > Colors > Edit Trap), as
well as for items with an Auto Amount (+) or (–) specified in the Trap Information palette
(Window > Trap Information).
Enter a trapping value in the Indeterminate field or choose Overprint:
• Enter a value in the Indeterminate field to control the amount of trapping that
QuarkXPress applies to object colors that are in front of indeterminate backgrounds
(multiple colors with conflicting trapping relationships).
• Choose Overprint to cause an object color to overprint an indeterminate background.
Enter a Knockout Limit value. The knockout limit is the value (expressed as a percentage
of darkness of the object color) that enables you to control the point at which an object
color knocks out a background color.
Enter an Overprint Limit value. Overprint limit is a trapping setting that allows an object
set to overprint to trap according to the Auto Amount value if the object's shade is less
than a particular percentage.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 35
THE QUARKXPRESS SERVER USER INTERFACE
Preferences — Layout — Grid Cell Fill
Use the Grid Cell Fill pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to control how design grid cells are filled.
To specify which cells will be filled, check Increment Fill and enter a value in the field.
For example, to fill cells four, eight, and twelve, enter 4.
To restart cell counting at the beginning of each line in a text box, click Start of Line. To
start cell counting from the beginning of the grid and continue counting regardless of line
breaks, click Start of Story.
Preferences — Layout — Color Manager
Use the Color Manager panes of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to define colors so they display or output consistently across all devices.
In the Transformation Method area:
• To specify an engine for color transformation, choose an option from the Color Engine
drop-down menu.
• To achieve the darkest possible blacks in all output methods, check Black Point
Compensation.
In the Source Options area:
• Use the Source Setup drop-down menu to specify the source color space of pictures and
colors used in the application.
• To enable the Profile Information command in the Window menu and the Color
Management tab in the Import Picture dialog box, check Enable access to image profiles.
This option allows you to view information about profiles.
Print layouts only: To specify how layouts display when you use the View > Proof Output
submenu, use the options in the Soft Proofing area (Print layouts only):
• To specify a default proof output setup, choose an option from the Proof Output drop-down
menu.
• To specify a rendering intent for soft proofing, choose an option from the Rendering
Intent drop-down list. Perceptual scales all the colors in the source gamut so that they
all fit within the destination gamut. Relative Colorimetric retains colors that are in both
the source gamut and the destination gamut. The only source colors that are changed are
those that are not within the destination gamut. Saturation considers the saturation of
source colors and changes them to colors with the same relative saturation in the
destination gamut. Absolute Colorimetric retains colors that are in both the source gamut
and the destination gamut. Colors that are outside the destination gamut are adjusted in
relation to how they would look when printed on white paper. Defined by Sources uses
the rendering intents defined in source setup for all colors and images.
Print layouts only: In the Vector EPS/PDF Files area:
36 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
• To color manage vector content in imported EPS and PDF files, check Color Manage
Vector EPS/PDF. Note that this preference applies only to EPS and PDF files imported
after this box is checked.
• To color manage vector content in EPS and PDF files that have already been imported in
the active project, check Include Existing Vector EPS/PDF in Layout.
Interactive layouts only: To specify an output profile for SWF export, choose an option from
the SWF Export drop-down menu.
Preferences — Layout — Layers
Use the Layers pane of the Preferences dialog box (Server/QuarkXPress Server >
Preferences) to specify the settings used when a new layer is created.
• To make new layers visible by default, check Visible.
• To suppress the printout of new layers by default, check Suppress Output.
• To make new layers locked by default, check Locked.
• To maintain runaround on new layers so that text on visible layers flows around items on
hidden layers, click Keep Runaround.
Style sheets
The Style Sheets command (Server/QuarkXPress Server > Document Controls > Style
Sheets) displays the Default Style Sheets dialog box, which lets you create and manage
paragraph and character style sheets.
Default Style Sheets dialog box
A GUIDE TO QUARKXPRESS SERVER 8.5 | 37
THE QUARKXPRESS SERVER USER INTERFACE
Default style sheets can be applied to content in projects using Modifier XTensions software.
For more information, see "Modifier XTensions software."
Creating and editing character style sheets
A character style sheet is a named package of character attributes. You can apply all of a
character style sheet's formatting attributes to text by simply applying the style sheet to
the text. To create, edit, or delete character style sheets, use the Default Style Sheets dialog
box (Server/QuarkXPress Server > Document Controls > Style Sheets).
To create a character style sheet, choose Character from the New drop-down button. The
Edit Character Style Sheet dialog box displays. Use the controls in this dialog box to
configure the attributes of the style sheet.
Edit Character Style Sheet dialog box
First, configure the controls in the General tab:
• Name: Enter a name in this field, or the application will use the default "New Style Sheet"
name.
• Keyboard Equivalent: To define a keyboard command for the style sheet, enter one in
the Keyboard Equivalent field. You can enter any combination of Command, Option,
Shift, or Control/Ctrl or Ctrl+Alt, along with a function or keypad key.
• Based On: To base the attributes of a new style sheet on an existing one, choose a style
sheet from the Based On drop-down menu.
38 | A GUIDE TO QUARKXPRESS SERVER 8.5
THE QUARKXPRESS SERVER USER INTERFACE
Next, choose character attributes from the lower section of the Edit Character Style Sheet
dialog box. When you're done, click OK.
Creating and editing paragraph style sheets
A paragraph style sheet is a named package of paragraph and character attributes. You can
apply all of a paragraph style sheet's formatting attributes to text by simply applying the
style sheet to the text. To create, edit, duplicate, or delete paragraph style sheets, use the
Some URL parameters require Boolean arguments. For such parameters, valid values include
1 or 0, true or false, y or n, and yes or no.
You can also send requests to QuarkXPress Server using the HTTP GET and POST protocols
and using XML with XSLT. For more information about these approaches, see the
QuarkXPress Server Web Integration Guide.
Understanding QuarkXPress Server namespaces
QuarkXPress Server namespaces differentiate among types of requests that are otherwise
identical. For example, consider the following three URLs:
http://QXPServer:8080/project1.qxp
http://QXPServer:8080/pdf/project1.qxp
http://QXPServer:8080/postscript/project1.qxp
These requests are identical, except each uses a different namespace (in italic). (The first
request does not specify a namespace, but this simply means the project is to be rendered
using the server's default render type.)
Namespaces can be used to determine the format in which a rendered project is returned,
as indicated above, but they can also be used to direct a request to XTensions software
that performs other functions. For example, if you use Modifier XTensions software's xml
namespace, Modifier XTensions software can return an XML representation of the project.
Looking up a namespace
The QuarkXPress Server Web Integration Guide lists the namespaces for every
QuarkXPress Server function. There is no single list of namespaces because some functions
do not require a particular namespace or are available in multiple namespaces. To determine
which namespace you want to use:
Open the QuarkXPress Server Web Integration Guide.
1
Choose Complete API List from the QuarkXPress Server Functions menu at the top of
2
the page.
Click the link for the render type you want or the function you want to use. (The link
3
might be a dynamic publishing process, a renderer, or a request handler.) The page
corresponding to that render type or function displays.
Locate the Namespace row. If the render type or function has an associated namespace,
4
that namespace is listed here.
Third-party XTensions can add their own namespaces. For information about a third-party
namespace, see the documentation for the XTensions module that adds that namespace.
66 | A GUIDE TO QUARKXPRESS SERVER 8.5
CREATING URL REQUESTS
Understanding QuarkXPress Server parameters
Parameters let you control the details of how a request is executed. For example, you can
use the page parameter to create a request that returns only the third page of a project:
http://QXPServer:8080/jpeg/project1.qxp?page=3
You can include multiple parameters in the same request; simply separate them with an
ampersand (&). For example, here's a new version of the above URL that returns page three
You can also return documents in two different "raw" formats. Developers can implement
additional rendering formats through server XTensions software.
For more information, see the QuarkXPress Server Web Integration Guide.
General parameters
General parameters are parameters that are applicable to most render types. These
parameters allow you to render an individual box, component, layout, page, or spread.
You can also render a particular selection of layers, pages, and spreads. In addition, you
can control whether the pasteboard is included and how the output should be scaled.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 67
CREATING URL REQUESTS
For more information, see the QuarkXPress Server Web Integration Guide.
Specialized parameters
Specialized parameters are parameters that serve special purposes. Some of these parameters
work by asking the server to read the contents of XML files.
For more information, see the QuarkXPress Server Web Integration Guide.
Server control parameters
Server control parameters let you perform a variety of server administration tasks, including
adding and deleting files from the document pool, retrieving information about files, and
flushing caches.
For more information, see the QuarkXPress Server Web Integration Guide.
Document providers
Document providers allow QuarkXPress to render the following types of documents:
•
copydesk: Allows QuarkXPress Server to render article files created by QuarkCopyDesk.
•
Preference administration parameters
PortNumber
MaxListens
MaxConnections
qcddoc: Allows QuarkXPress Server to render projects created by QuarkXPress.
For more information, see the QuarkXPress Server Web Integration Guide.
The /getprefs handler lets clients remotely retrieve an XML representation of the current
QuarkXPress Server preferences, as described below.
The /setprefs handler lets clients remotely control QuarkXPress Server preferences. For
example,
http://<servername>:<port>/setprefs?AddConnectionFilter=action=allow;
ipaddr=206.195.80.80;mask=255.255.255.1;pos=0 permits connection filters and
specifies the IP address and the subnet mask of the connection.
DescriptionTypeAttribute
integer
Specifies a port number from 1024 to 65,535 (Mac OS) or 1 to
65,535 (Windows).
Specifies the maximum number of listens from 1 to 32.integer
Specifies the maximum number of connections from 1 to 16.integer
CacheSize
DocumentRootFolder
AllowAddFile
68 | A GUIDE TO QUARKXPRESS SERVER 8.5
Specifies the memory cache size from 1MB to 1024MB.integer
Specifies the document root directory.string
Allows the addition of files to the document root directory.Boolean
CREATING URL REQUESTS
DescriptionTypeAttribute
LoggingEnabled
LogFolder
LogErrors
LogTransactions
LogTiming
LogEvents
ForceServedDocumentsClosed
AllowMemoryCaching
DefaultDoc
ErrorDoc
NoAccessDoc
string
Boolean
Boolean
Boolean
Boolean
string
string
string
Controls whether transactions and errors are logged.Boolean
Specifies the path to the log folder, which contains the error and
transaction log files.
Specifies whether to log error conditions.Boolean
Specifies whether to log all successful transactions.Boolean
Specifies whether to include timing information (such as
processing time and opening time) in the transaction log.
Specifies whether to log server events that are not related to error
conditions.
Causes QuarkXPress Server to close projects that are loaded into
cache from the document pool after rendering them.
Specifies whether to store disk-based projects in a
memory-resident cache.
Specifies the default HTML file to be returned when the server
is accessed through HTTP.
Specifies the HTML file to be retrieved when an error occurs on
the server.
Specifies the HTML file to be returned when access is denied to
a server function or project file.
DefaultRenderType
EnableFileSystemDocPool
VerboseStatusMonitoring
LogDocProblems
LogBadSXTDialogs
EnableHTTPInterface
ConnectionTimeout
UseConnectionFilters
DefaultBufferSize
RequireAdmin Verification
VerificationUsername
string
Boolean
Boolean
integer
Boolean
integer
string
Sets the default. Valid values include PNG, PDF, EPS, PSCR, QXPD,
RAW, RLER, JPEG, and PPML.
Controls whether you can specify a folder as the document pool.
The default value is YES.
Specifies whether to allow verbose status monitoring.Boolean
Specifies whether to log any project problems.Boolean
Specifies whether to log server XTensions software dialog boxes
that do not conform to QuarkXPress Server expectations.
Turns the built-in HTTP server on or off.Boolean
Specifies the amount of time (in seconds) before a connection
times out. Valid values are from 1 to 32,767.
Specifies whether to allow the addition and modification of
IP addresses.
Specifies the size (in KB) of the HTTP buffer. Enter a value from
16 to 256.
Specifies whether to require a user name and password.Boolean
Lets you supply a user name. Minimum length is 4 characters;
maximum length is 32 characters.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 69
CREATING URL REQUESTS
DescriptionTypeAttribute
VerificationPassword
ConfirmPassword
GenerateHierarchy
AddConnectionFilter
ipaddr
mask
pos
RemConnectionFilter
DisableQxdReturn
ContentLoadingTimeout
string
string
Boolean
(allow/deny)
string
string
boolean
integer
Lets you supply a password. Minimum length is 4 characters;
maximum length is 32 characters.
Confirms a password. Minimum length is 4 characters; maximum
length is 32 characters.
On an OnAddfile request, specifies whether to create a new file
hierarchy as files are added to the document pool.
Specifies whether to allow the addition of connection filters.Boolean
Specifies an IP address for use with connection filters. Use the
following format: 123.456.789.123.
Specifies a subnet mask for use with connection filters. Use the
following format: 123.456.789.123.
Specifies the position at which to add a connection filter.integer
Removes a filter at a given index.integer
Controls whether a project can be rendered as a QuarkXPress
project.
Controls the amount of time (in seconds) the server waits for a
server XTensions module or other document provider to load
content asynchronously before timing out the transaction.
70 | A GUIDE TO QUARKXPRESS SERVER 8.5
Modifying layouts with XML
The xml namespace deconstructs a project according to the Modifier DTD. The construct
namespace lets the server turn an XML representation of a QuarkXPress project back into
an actual project. With these namespaces, you can deconstruct a project into an XML
representation, change the XML in accordance with the Modifier DTD, and then have the
server generate an updated version of the QuarkXPress project. You can even create new
MODIFYING LAYOUTS WITH XML
QuarkXPress projects from scratch using XML.
In addition, you can use the construct namespace to:
• Create a page based on master page
• Create a project from XML, using a Job Jackets™ file as the basis for the project
• Modify text font and style, including OpenType® styles
• Apply style sheets and local formatting to text
• Create and populate tables
• Import pictures into picture boxes and specify picture attributes
The DTD used for XML construction and deconstruction is completely Unicode®-compliant,
making it ideal for use in international publishing. Furthermore, the use of this DTD
ensures that the schema of XML output created by Constructor does not change when
server preferences change. This DTD is provided in the QuarkXPress Server application
folder and fully documented in the QuarkXPress Server Web Integration Guide.
Deconstructor XTensions software and the deconstruct namespace are no longer
supported.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 71
QUARKXPRESS SERVER XTENSIONS SOFTWARE
QuarkXPress Server XTensions software
Just as XTensions software provides additional functionality to QuarkXPress, XTensions
software enables QuarkXPress Server to do things it can't do by default. The XTensions
modules included with QuarkXPress Server allow clients to render projects as PDF files,
apply QuarkVista picture effects to pictures, dynamically update pictures in picture boxes
and text in text boxes (as well as boxes themselves), import data on the fly, manipulate
layers in projects, and more.
CopyDeskArticle XTensions software
CopyDeskArticle XTensions software allows QuarkXPress Server to do the following things:
• Render QuarkCopyDesk articles
• Export QuarkCopyDesk articles from a QuarkXPress project
• Add a QuarkCopyDesk article to an existing QuarkXPress project
• Create and delete components in a QuarkCopyDesk article within a QuarkXPress project
Rendering articles
To render QuarkCopyDesk articles, use the copydesk namespace, as follows:
For more information, see the QuarkXPress Server Web Integration Guide.
PDF Filter XTensions software
PDF Filter XTensions software allows QuarkXPress Server to render a QuarkXPress project
as a PDF file.
PDF Filter XTensions software adds a PDF pane to the Preferences dialog
box (QuarkXPress Server > Preferences). For more information, see "Server preferences."
To take advantage of more detailed preferences, create a PDF output style and use that
output style when rendering projects as PDF files. For more information, see "Output styles."
To render QuarkXPress projects as PDF files when PDF is not the QuarkXPress Server default
render type, use the PDF namespace, as follows:
http://[server]:[port]/pdf/[projectname]
For information about the parameters for exporting in this format, see the
QuarkXPress Server Web Integration Guide.
PPML Export XTensions software
PPML Export XTensions software allows QuarkXPress Server to export a QuarkXPress
project in PPML format. This module can be used in conjunction with the XML Import
XTensions module to produce customized versions of a layout for different customers.
To render QuarkXPress projects in PPML format when PPML is not the QuarkXPress Server
default render type, use the PPML namespace, as follows:
http://server:port/ppml/projectname?path=[path of output directory on
server]
For information about the parameters for exporting in this format, see the
QuarkXPress Server Web Integration Guide.
74 | A GUIDE TO QUARKXPRESS SERVER 8.5
QUARKXPRESS SERVER XTENSIONS SOFTWARE
Modifier XTensions software
Modifier XTensions software lets clients perform all of the following tasks using XML:
• Modify the properties of pictures in a QuarkXPress project
• Modify the text in text boxes within a QuarkXPress project
• Modify the properties of text boxes and picture boxes in a QuarkXPress project
• Create and delete picture boxes and text boxes in a QuarkXPress project
• Import text or text strings into text boxes within a QuarkXPress project
• Import pictures into picture boxes within a QuarkXPress project
• Save modified QuarkXPress projects in any supported format to any location on the network
(and also in the QuarkXPress Server document pool)
• Create and delete pages
• Create and delete layers
• Move items within layers
• Create and delete tables
• Modify tables and their contents
• Create QuarkCopyDesk articles and components
• Create lines, anchored boxes, and Bézier boxes
• Create lists
• Group and ungroup boxes
• Divide layouts into sections
To use Modifier XTensions software, a client creates an XML file indicating the actions to
be taken and sends that XML file to the QuarkXPress Server application, where Modifier
XTensions software reads the XML and makes the requested changes. Clients can use a
single XML file or string to manipulate multiple documents and boxes.
For more specific information about Modifier XTensions software, and for the Modifier
DTD, see the QuarkXPress Server Web Integration Guide.
Modifier XTensions software supports both GET and POST functionality.
Modifier XTensions software supports XML containing code that uses Unicode UTF-8 and
UTF-16 encodings. Use the encoding attribute of the XML declaration to specify an
encoding, as you would with any other XML file.
Modifier XTensions software adds a Modifier pane to the Preferences dialog box
(QuarkXPress Server > Preferences). For more information, see "Server preferences."
A GUIDE TO QUARKXPRESS SERVER 8.5 | 75
QUARKXPRESS SERVER XTENSIONS SOFTWARE
Using Modifier XTensions software
To use Modifier XTensions software:
Create a QuarkXPress project. Note the IDs or names of any text and picture boxes you
1
want to manipulate.
Upload the project to the QuarkXPress Server document pool.
2
Create XML that describes the changes you want, as described in "Creating XML for Modifier
3
XTensions software."
Send the XML to the server in one of the following ways:
4
• Put the XML in a file on the server and then use a URL to point to the file, as follows:
http://server:port/namespace/path/projectname?modify=file:absolute
path to XML file on server
Clients can also send XML in the form of a POST request.
Creating XML for Modifier XTensions software
All XML used with Modifier XTensions software uses the Modifier DTD. This DTD is
documented in full in the QuarkXPress Server Web Integration Guide.
In general, the structure for addressing items in a particular layout is as follows:
<PROJECT>
<LAYOUT>
<ID NAME="[name of layout]">
<[Item being addressed]>
<[Parameters of item]>
</[Item being addressed]>
</LAYOUT>
</PROJECT>
For more information, see the QuarkXPress Server Web Integration Guide.
QuarkVista XTensions software
A QuarkVista preset file is a file that contains a list of one or more QuarkVista picture effects
and instructions for applying those effects. You can use QuarkVista XTensions software
to apply and remove preset files containing QuarkVista effects to pictures in picture boxes
before rendering a project.
QuarkVista effects work only with projects that were last saved in QuarkXPress 6.0 or later.
76 | A GUIDE TO QUARKXPRESS SERVER 8.5
QUARKXPRESS SERVER XTENSIONS SOFTWARE
Creating preset files
To create a preset file, open a project in a copy of QuarkXPress that is running QuarkVista
XTensions software, select a picture box that contains a picture, apply effects to the picture,
and then click the Save Preset button on the Picture Effects palette. The effects you apply
are saved in a preset (.vpf) file at the location you indicate. (By default, preset files are
stored in the location specified in the Picture Effects pane of the Preferences dialog box.)
To use preset files in QuarkXPress Server, copy them to the folder indicated by the Picture
Effects Presets field in the Picture Effects pane of the QuarkXPress Server Preferences
dialog box (QuarkXPress Server menu).
Using QuarkVista XTensions software
To indicate which preset file should be applied, use the applyvistaeffect parameter.
To indicate which picture box the preset file should be applied to, use the vistabox
In this example, color.vpf is the name of the preset file containing the QuarkVista
effects, and pb2 is the name of the box to which the preset file is applied.
You can apply the same preset file to multiple pictures using a single URL. For example,
This URL removes any QuarkVista effects applied to pictures in the picture boxes named
p1, p2, and p3.
If you apply and remove QuarkVista effects in the same URL, the deletevistaeffect
parameter takes precedence.
If you open a project that uses QuarkVista effects, but QuarkVista XTensions software is
not enabled, the QuarkVista effects are ignored. If Log Errors is enabled
(QuarkXPress Server > Server Configurations > Logging tab), an entry is made in the
QuarkXPress Server error log file.
QuarkXPress Server Layer XTensions software
You can use QuarkXPress Server Layer XTensions software to control the visibility of
specific layers in a rendered QuarkXPress project. You can also add layers, delete layers,
edit layer attributes, and control whether layers are rendered.
When you use the getdocinfo namespace, QuarkXPress Server returns information about
items on all of the layers in the QuarkXPress project, including layers that are not visible.
QuarkXPress Server Layers XTensions software adds a Layers pane to the Preferences
dialog box (QuarkXPress Server > Preferences). For more information, see "Server
preferences."
Clients can use the layer parameter to specify a layer (even a hidden layer) to be rendered.
For example, the URL http://QXPServer:8080/doc.qxp?layer=layer1 renders only
the layer named "layer1" in the project named "doc.qxp."
Clients can specify more than one layer in a single URL. For example, the URL
http://QXPServer:8080/doc.qxp?layer=layer1,layer2 renders the layers named
"layer1" and "layer2."
For information about the parameters for this feature, see the QuarkXPress Server Web
Integration Guide.
78 | A GUIDE TO QUARKXPRESS SERVER 8.5
QUARKXPRESS SERVER XTENSIONS SOFTWARE
If Suppress Output is selected for a layer, QuarkXPress Server does not render that layer
when producing PDF, EPS, or PostScript files.
InteractiveDesignerSXT Server XTensions software
InteractiveDesignerSXT XTensions software allows QuarkXPress Server to render both Print
and Interactive layouts in QuarkXPress projects as SWF (Flash) files. If you render a Print
layout as an SWF file, you can use the right and left arrow keys to navigate between pages
in the SWF file.
InteractiveDesignerXT XTensions software adds SWF and Presentation panes to the
Preferences dialog box (QuarkXPress Server > Preferences). For more information, see
"Server preferences."
To render an Interactive layout in a QuarkXPress project as a SWF file when SWF is not
the QuarkXPress Server default render type, use the SWF namespace, as follows:
If you have edited the project since you last saved it, QuarkXPress prompts you to save
the project.
Upload Template dialog box
Choose a server from the Server drop-down menu. This drop-down menu includes the
2
servers listed in the QuarkXPress Server pane of the Preferences dialog box
(QuarkXPress/Edit menu).
If you specified a directory path for the server, that path automatically displays in the
3
Directory Path field. If you did not specify a directory path in the preferences, this field
remains blank. This path defaults to the document pool directory specified in
QuarkXPress Server.
If you are uploading to QuarkXPress Server, and you have configured that server to require
4
authentication, enter a valid user name and password in the User Name and Password
fields. (If the QuarkXPress Server application does not require authentication, leave these
fields empty.)
84 | A GUIDE TO QUARKXPRESS SERVER 8.5
TELEGRAPH XTENSIONS SOFTWARE
To specify authentication information for a QuarkXPress Server application, display the
HTTP tab of the QuarkXPress Server Preferences dialog box, check the Realm Verif. for
Admin. Requests box and enter a user name and password.
To collect and upload fonts used by the project, check Fonts.
5
To collect and upload pictures used by the project, check Pictures. This will upload high-
6
or low-resolution pictures that are linked to or embedded in the project.
If picture files are missing or have been modified since they were imported into the project,
an alert displays. For more information about missing or modified picture files, see
"Uploading missing or modified pictures."
Click OK.
7
If you check Fonts, an alert reminds you of possible restrictions regarding copying font
software. Click OK to continue uploading the project with the fonts, click Do Not Collect
Fonts to upload the project without the fonts, or click Cancel to stop the upload.
The Upload Status window displays a progress bar that displays the status of the upload.
When the upload is complete, a message notifies you whether the project uploaded
successfully.
Uploading missing or modified pictures
If the picture files linked to the project are missing or have been modified since they were
imported into the project, an alert displays at upload. Choose from among the following
options:
• To continue the upload with low-resolution versions of the pictures, click OK.
• To stop the upload, click Cancel.
• To locate missing pictures or update modified pictures, click List Pictures.
If you click List Pictures, the Missing/Modified Pictures dialog box displays:
• To view a picture in the project, select the picture's name in the list and click Show.
• To locate a missing picture file, select it and click Update. The Find dialog box displays.
Locate and choose the appropriate file, and then click Open.
• To update a modified picture file, click Update. Every instance of the modified picture in
the project is updated.
• When OK displays in the Status column for each picture, click Collect. If the status of
any picture is still Missing or Modified when you click Collect, that picture file will not
be uploaded, but a low-resolution preview will remain in the project.
• To stop the upload and return to the project window, click Cancel.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 85
QUARKXPRESS SERVER MONITOR
QuarkXPress Server Monitor
QuarkXPress Server Monitor is no longer included with QuarkXPress Server. All
QuarkXPress Server Monitor functionality is available in QuarkXPress Server Manager. For
more information, see "QuarkXPress Server Manager."
86 | A GUIDE TO QUARKXPRESS SERVER 8.5
QUARKXPRESS SERVER MANAGER
QuarkXPress Server Manager
QuarkXPress Server Manager is a server application that efficiently routes rendering requests
in an environment that uses one or more QuarkXPress Server applications.
QuarkXPress Server Manager uses load-balancing methods to determine which server in
the QuarkXPress Server pool can best process a document request, and uses caching to
improve speed and efficiency. QuarkXPress Server Manager also provides failsafe capability
by reliably resubmitting failed requests, either to the same QuarkXPress Server instance
or to a different one (depending on the error message returned by the server instance).
QuarkXPress Server does not require QuarkXPress Server Manager, but a QuarkXPress Server
Manager server can coordinate multiple QuarkXPress Server applications so that they work
together with maximum speed, reliability, and availability.
QuarkXPress Server Manager also provides a Web services interface that allows developers
to use QuarkXPress Server features without having to use the HTTP interface.
To configure a QuarkXPress Server Manager server application, you must use the
QuarkXPress Server Manager client application. The topics below explain how the
QuarkXPress Server Manager client application works and provide examples for using it.
Understanding QuarkXPress Server Manager
Before you begin, take time to review the topics below so that you understand how this
chapter is structured and how you can get the most out of it.
Load balancing
Load balancing ensures that each rendering request is sent to a server that is likely to be
able to handle it quickly. QuarkXPress Server Manager lets you use choose from three
load-balancing settings:
• Random: Each rendering request is sent to a random server.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 87
QUARKXPRESS SERVER MANAGER
• Round robin: Requests are sent to servers in a set order. For example, if you have three
QuarkXPress Server instances and QuarkXPress Server Manager receives ten rendering
requests, the requests are distributed as follows:
QuarkXPress Server instance usedRequest
11
22
33
14
25
36
17
• Dynamic: The QuarkXPress Server Manager server considers file size and throughput
requirements for each request. For example, assume the following series of requests is sent
to QuarkXPress Server Manager in an environment that uses two QuarkXPress Server
instances:
SizeRequest
8MB1
1MB2
2MB3
The first request is assigned to server #1, and the second request is assigned to server #2.
When the third request arrives, QuarkXPress Server Manager checks the loads that the two
servers are already handling and assigns the task to the server with the smallest load — in
this case, server #2.
If a request fails because a server stops responding or because of a "File Not Found" error,
QuarkXPress Server Manager does not resubmit that request to that server.
The Dynamic setting is typically the most efficient setting for environments with more
than one QuarkXPress Server instance.
For information about choosing a load-balancing setting, see "Controlling load balancing"
Developers can implement their own load-balancing systems; for more information, see
the QuarkXPress Server Web Integration Guide.
Request timeout interval
QuarkXPress Server Manager attempts to send each request to a QuarkXPress Server instance
that can promptly handle that request. However, in some situations a QuarkXPress Server
88 | A GUIDE TO QUARKXPRESS SERVER 8.5
QUARKXPRESS SERVER MANAGER
instance might be unable to process a request in a reasonable amount of time (for example,
if the server is working on a large rendering job, or if the server computer has stopped
functioning). If you specify a certain period of time as the request timeout interval,
QuarkXPress Server Manager will wait for the response until that period of time elapses,
and then send the request to a different QuarkXPress Server instance. This ensures that a
request does not get "lost" if its assigned QuarkXPress Server instance does not become
available promptly.
For information about setting a request timeout interval, see "Using other global settings."
If a client request fails despite being sent to multiple QuarkXPress Server instances,
QuarkXPress Server sends the end user a customizable error message or exception so that
the end user can appropriately handle the failure. A QuarkXPress Server Manager server
can also automatically send e-mail to an administrator in the event of a problem; for more
information, see "Generating automatic e-mail messages."
Determining QuarkXPress Server instance availability
QuarkXPress Server Manager uses two methods to determine the availability of a
QuarkXPress Server instance: ping and ping document.
Ping
QuarkXPress Server Manager periodically sends a ping request to all of its QuarkXPress Server
instances to determine whether they are available. Ping requests use the following format:
http://[Server]:[Port]/getprocessid
Ping document
QuarkXPress Server Manager periodically sends a render request to all of
its QuarkXPress Server instances to determine whether they can render a document. Ping
document requests use the following format:
http://[Server]:[Port]/[PingDocumentName.qxp]
You can specify the document to be used for this render request. To avoid long ping
document rendering times, use a simple document.
You can specify the interval between pings and ping documents in the Other Settings
pane in the Global Settings pane of the QuarkXPress Server Manager window (see "Using
other global settings").
Logging
QuarkXPress Server Manager logs all interactions with QuarkXPress Server instances.
QuarkXPress Server Manager log files contain the following information:
• Render requests
• QuarkXPress Server responses
A GUIDE TO QUARKXPRESS SERVER 8.5 | 89
QUARKXPRESS SERVER MANAGER
• Information about events (such as alerts) that occur during the render-request process
• Details about requests that were sent to a different QuarkXPress Server instance after the
first assigned QuarkXPress Server instance was unable to process the request
Within the logs, each QuarkXPress Server instance is identified by its IP address and port
number.
You can export log files in XML (Extensible Markup Language) or comma-separated values
(CSV) format. For more information, see "Exporting log files"
Caching
To increase speed and efficiency, QuarkXPress Server Manager caches information in
memory. If the response to a render request, URL request, or file request is included in the
QuarkXPress Server Manager memory cache, QuarkXPress Server Manager returns the
response from the disk cache instead of sending the request to a QuarkXPress Server
instance. For more information, see "Managing the cache"
Requests that contain a binary parameter and multipart responses are not cached, regardless
of whether global caching or command-specific caching is enabled.
When the QuarkXPress Server Manager server application receives response data from a
QuarkXPress Server instance, QuarkXPress Server Manager can return that response directly
or write it as a file and return the file's URL. The second approach maximizes efficiency
for SOAP-based clients, because SOAP transfers binary data very slowly. Cached response
files have names that begin with "TMP_", and they are removed when they reach the age
specified in the cache settings (see "Managing the cache"). QuarkXPress Server Manager uses
the cache file this way regardless of whether caching is turned on or off; however, you can
override this behavior by setting the responseasurl parameter to false for every request.
Web services
QuarkXPress Server Manager provides a Web services interface that makes it easy for
developers to create applications that use QuarkXPress Server. This Web services interface
provides the same functionality that is available through the QuarkXPress Server HTTP
interface. For more information about the Web services interface, see the QuarkXPress Server
Web Integration Guide.
Working with QuarkXPress Server Manager
The general process for using QuarkXPress Server Manager is as follows:
Install QuarkXPress Server Manager software.
1
Launch one or more QuarkXPress Server instances on your network.
2
90 | A GUIDE TO QUARKXPRESS SERVER 8.5
QUARKXPRESS SERVER MANAGER
Launch the QuarkXPress Server Manager Console application (see Starting the Manager
3
server application").
From the QuarkXPress Server Manager Console application, start the Server Manager server
4
application (see Starting the Manager server application").
Launch the QuarkXPress Server Manager client application (see Starting the Manager
5
client application").
Using the QuarkXPress Server Manager client application, connect to a QuarkXPress Server
6
Manager server (see "Starting QuarkXPress Server Manager").
Use the Manage QuarkXPress Server pane of the QuarkXPress Server Manager window
7
to add QuarkXPress Server instances and specify information about those servers (see
"Configuring QuarkXPress Server instances").
Configure logging options, caching options, a load-balancing method, proxy server settings,
8
automatic e-mail settings, and various other settings in the Global Settings pane of the
QuarkXPress Server Manager window (see "Controlling load balancing," "Using a proxy
server," "Generating automatic e-mail messages," and "Using other global settings").
As necessary, export and delete logs using the Manage Logs pane of the
9
QuarkXPress Server Manager window (see "Managing logs").
As necessary, delete cache items and clear the QuarkXPress Server Manager server cache
10
using the Manage Cache pane of the QuarkXPress Server Manager window (see "Managing
the cache").
Starting QuarkXPress Server Manager
You can use one copy of the QuarkXPress Server Manager client application to administer
multiple copies of the QuarkXPress Server Manager server application (but only one at a
time). Each QuarkXPress Server Manager server can handle multiple QuarkXPress Server
instances.
A GUIDE TO QUARKXPRESS SERVER 8.5 | 91
QUARKXPRESS SERVER MANAGER
QuarkXPress Server Manager diagram
Starting the Manager server application
To launch the QuarkXPress Server Manager server application:
•
Mac OS: Open the QuarkXPress Server Manager/Server folder inside the applications