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
Lets you specify whether to display pasteboard items. Works
only with spread parameter. The default value is true. For
example:
http://localhost:8080/jpeg/document.qxp?
spread=1&pasteboard=true
true | false
pasteboard
Lets you request multiple boxes.String
boxes
Render
modifier
parameters
Lets you request a single page.Integer
page
Lets you specify a scaling percentage. The valid values are from .1
(10%) to 8 (800%) on Mac OS or 6.92 (692%) on Windows.
Float .1 to 6.92
for Windows .1
to 8 on Mac OS)
scale
Lets you request a single box.String
box
Lets you specify a spread. The first spread is spread 1. In a
facing-page document, spread 1 consists of the first page.
Integer
spread
Lets you specify a layout by name or ID. The first layout is Layout
1.
String
layout
A JPEG file.Response
If the request succeeds, a transaction success message is written to the QuarkXPress Server transaction
log file. This message includes the date, time, request type, project name, response type, response
size in bytes, and client IP address. For example:
Logs
8/3/2005 11:27:42 — jpeg/sample.qxp — Type: image/jpeg — Size: 31715 — Client: 127.0.0.1
If an alert is displayed, an error message is written to the QuarkXPress Server error log file. The
transaction entry in the error log contain the date and time of the request, the error code, and the
error message. The following is a sample of an error log transaction entry:
8/3/2005 11:27:24 — Error — Error Code: 10008 — The renderer for this image type has no way of
rendering the desired objects.
http://localhost:8080/jpeg/sample.qxp?jpegquality=1
Example, GET
URL
Request object name: JPEGRenderRequest
//STEP1: Create the QuarkXPress Server Request
//Context and set the necessary properties
Example, object
model
sdk.QRequestContext requestCtx = new sdk.QRequestContext();
Boolean responseAsURL = false;
requestCtx.setDocumentName(docName);
//STEP2: Create the JPEG renderer request and attach it
//to the request context.
JPEGRenderRequest jpreq = new JPEGRenderRequest();
jpreq.setJPEGQuality(request.getParameter("jpegQuality"));
jpreq.setLayout(request.getParameter("Layout"));
requestCtx.setRequest(jpreq);
//STEP3: Create the WIG service and call the processRequest() API
QManagerSDKSvcServiceLocator serviceLocator =
new QManagerSDKSvcServiceLocator();
QManagerSDKSvc service = serviceLocator.getqxpsmsdk();
sdk.QContentData data = service.processRequest(requestCtx);
40 | QXP SERVER 8.1 WEB INTEGRATION GUIDE
USING THE WEB INTERFACE