8.1
Table Of Contents
- Contents
- Overview
- Changes in this version
- Getting started
- Using the Web interface
- Understanding rendering
- Understanding render types
- Understanding render modifiers
- Using content modifiers
- Using XML modify
- Using XML deconstruct and construct
- Deconstructing a project
- Constructing a project
- Working with pages and spreads
- Working with layers
- Working with boxes
- Working with groups
- Working with pictures
- Working with text
- Working with tables
- Working with sections
- Working with Composition Zones
- Using XSL transformation
- Working with lists
- Working with anchored boxes
- Working with placeholders
- Working with metadata
- Working with hidden text
- Using administrative request handlers
- Modifier DTD (annotated)
- Entities (Modifier DTD)
- PROJECT (Modifier DTD)
- SAVEAS (Modifier DTD)
- LAYOUT (Modifier DTD)
- ID (Modifier DTD)
- LAYOUTPROPERTY (Modifier DTD)
- COLUMNGUIDES (Modifier DTD)
- ARTICLE (Modifier DTD)
- COMPONENT (Modifier DTD)
- SPREAD (Modifier DTD)
- PAGE (Modifier DTD)
- SECTION (Modifier DTD)
- BOX (Modifier DTD)
- METADATA (Modifier DTD)
- VALUE (Modifier DTD)
- TEXT (Modifier DTD)
- INSET (Modifier DTD)
- STORY (Modifier DTD)
- COPYFIT (Modifier DTD)
- PARAGRAPH (Modifier DTD)
- TEXTNODEPH (Modifier DTD)
- TEXTPH (Modifier DTD)
- GROUPCHARACTERS (Modifier DTD)
- FORMAT (Modifier DTD)
- KEEPLINESTOGETHER (Modifier DTD)
- DROPCAP (Modifier DTD)
- LOCKTOGRID (Modifier DTD)
- TABSPEC (Modifier DTD)
- TAB (Modifier DTD)
- RULE (Modifier DTD)
- HIDDEN (Modifier DTD)
- RICHTEXT (Modifier DTD)
- RUBITEXT (Modifier DTD)
- ANCHOREDBOXREF (Modifier DTD)
- LINKEDBOX (Modifier DTD)
- OVERMATTER (Modifier DTD)
- PICTURE (Modifier DTD)
- CLIPPING (Modifier DTD)
- SPLINESHAPE (Modifier DTD)
- CONTOURS (Modifier DTD)
- CONTOUR (Modifier DTD)
- VERTICES (Modifier DTD)
- VERTEX (Modifier DTD)
- LEFTCONTROLPOINT (Modifier DTD)
- VERTEXPOINT (Modifier DTD)
- RIGHTCONTROLPOINT (Modifier DTD)
- GEOMETRY (Modifier DTD)
- FIT (Modifier DTD)
- MAX (Modifier DTD)
- MIN (Modifier DTD)
- LOCATION (Modifier DTD)
- SIZE (Modifier DTD)
- SCALETO (Modifier DTD)
- RELPOSITION (Modifier DTD)
- ORIGIN (Modifier DTD)
- WIDTH (Modifier DTD)
- HEIGHT(Modifier DTD)
- POSITION (Modifier DTD)
- MOVEUP (Modifier DTD)
- MOVEDOWN (Modifier DTD)
- MOVELEFT (Modifier DTD)
- MOVERIGHT (Modifier DTD)
- GROWACROSS (Modifier DTD)
- GROWDOWN (Modifier DTD)
- SHRINKACROSS (Modifier DTD)
- SHRINKDOWN (Modifier DTD)
- ALLOWBOXONTOPASTEBOARD (Modifier DTD)
- ALLOWBOXOFFPAGE (Modifier DTD)
- STACKINGORDER (Modifier DTD)
- SUPPRESSOUTPUT (Modifier DTD)
- TOP (Modifier DTD)
- LEFT (Modifier DTD)
- BOTTOM (Modifier DTD)
- RIGHT (Modifier DTD)
- RUNAROUND (Modifier DTD)
- LAYER (Modifier DTD)
- RGBCOLOR (Modifier DTD)
- LINESTYLE (Modifier DTD)
- CONTENTPH (Modifier DTD)
- CONTENT (Modifier DTD)
- SHADOW (Modifier DTD)
- FRAME (Modifier DTD)
- PLACEHOLDER (Modifier DTD)
- TABLE (Modifier DTD)
- PARENTTABLE (Modifier DTD)
- TABLEBREAK (Modifier DTD)
- CHILDID (Modifier DTD)
- ADDCELLS (Modifier DTD)
- DELETECELLS (Modifier DTD)
- COLSPEC (Modifier DTD)
- COLUMN (Modifier DTD)
- ROW (Modifier DTD)
- HEADER (Modifier DTD)
- FOOTER (Modifier DTD)
- CELL (Modifier DTD)
- GRID (Modifier DTD)
- GRIDLINE (Modifier DTD)
- GROUP (Modifier DTD)
- BOXREF (Modifier DTD)
- COMPOSITIONZONE (Modifier DTD)
- LIST (Modifier DTD)
- RUBI (Modifier DTD)
- Sample applications
- Contacting Quark
- Index
•
[DocumentName]: The name of the QuarkXPress project that you can access from the
document pool or the content provider.
•
[parameter]: Further defines the URL action with attributes and values allowed for the
namespace or general call. Pass parameters in the form attribute=value, with parameters
separated by the "&" character.
For QuarkXPress Server Manager, use a URL like the following:
http://[server]:[port]/quark/servlet/qxpsm/[namespace]/[directory]/[DocumentName]?[parameter]=Value
This Guide provides numerous sample URLs in QuarkXPress Server format. To convert
these examples for use with QuarkXPress Server Manager, simply insert /
quark/servlet/qxpsm after [port]/ .
Versions of QuarkXPress Server Manager prior to 7.22 required absolute paths. You can
now use both absolute and relative paths when you modify a project with SDK objects or
classes. Relative paths are almost always relative to the document pool. If you use multiple
QuarkXPress Server instances, you should use a common document pool.
Interpreting the QXP Server Manager response
When QuarkXPress Server Manager successfully processes a request through the HTTP
interface, the response is the same as QuarkXPress Server's response unless the user has
supplied additional parameters to QuarkXPress Manager. For more information, see
"Working with QuarkXPress Server Manager" in A Guide to QuarkXPress Server.
If an error occurs, QuarkXPress Server Manager retries the request, either on the same
QuarkXPress server instance or a different one (depending on the error and global settings
established in the QuarkXPress Server Manager client). If QuarkXPress Server Manager
cannot process the request, it returns an XML response describing the error, plys any
header error codes returned by QuarkXPress Server. For example:
<?xml version="1.0" encoding="UTF-8" ?>
<error>
<httpresponsecode>404</httpresponsecode>
<xpressservererrorcode>-43</xpressservererrorcode>
<xpressservererrormessage>File not found.</xpressservererrormessage>
<xpressserverextendedmessage> <![CDATA[ Error #-43 - File not found. ]]>
</xpressserverextendedmessage>
<xpressservermanagererrorcode>M8000001</xpressservermanagererrorcode>
<xpressservermanagererrormessage>The server could not locate the specified
file.
</xpressservermanagererrormessage>
</error>
HTTP GET and POST Requests
The topics below describe how you can use HTML to interact with QuarkXPress Server.
QuarkXPress Server supports both the GET and POST HTML methods. When you use the
GET method, the browser encodes form data into a URL. When you use the POST method,
form data is passed within the message body. Use the GET method only when the form
processing is idempotent. In short: GET is for retrieving data, whereas POST can involve
storing or updating data, ordering a product, or sending an e-mail.
QXP SERVER 8.1 WEB INTEGRATION GUIDE | 13
GETTING STARTED