8.5
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
- Legal notices
- Index
Embedding QXP Server Manager
You can embed QuarkXPress Server Manager in applications (stand-alone or otherwise).
To do so, you must first initialize QuarkXPress Server Manager, as shown below:
QConfigurationData initializationData = new QConfigurationData();
initializationData.setBeanDefinitionConfigFile("ManagerContainerConfig.xml");
QClassFactory.getInstance().init(initializationData);
You can configure other QuarkXPress Manager options using QConfigurationManager.
Next, you must register one or more QuarkXPress Server hosts, like so:
QConfigManager configManager =
QClassFactory.getInstance().getExecutionEngine().getConfigManager();
String currentDirectory = System.getProperty("user.dir");
configManager.setCacheFolder(
new File(new File(currentDirectory), "cache").getAbsolutePath());
configManager.setLogLevel(STANDALONE_CLIENT_LOG_LEVEL);
configManager.setPingType(QPingTypeEnum.PING_SIMPLE);
QConnectionInfo connInfo = new QConnectionInfo();
connInfo.setServerName(<XPRESS_SERVER_NAME>);
connInfo.setServerPort(<XPRESS_SERVER_PORT>);
connInfo.setUserName(<XPRESS_SERVER_ADMIN_USER>);
connInfo.setPassword(<XPRESS_SERVER_ADMIN_PASSWORD>);
QHostSummary host = new QHostSummary();
host.setConnectionInfo(connInfo);
configManager.registerHost(host);
Once you have done so, you can use the embedded QuarkXPress Server Manager as shown
below:
XMLRequest xmlRequest = new XMLRequest();
QRequestContext context = new QRequestContext();
context.setDocumentName(<SAMPLE_DOCUMENT>);
context.setResponseAsURL(false);
context.setRequest(xmlRequest);
QContentData response = QRequestProcessor.getInstance().processRequest(context);
System.out.println(response.getTextData());
Writing special request handlers
If you need to perform custom actions on specific flags, you need to define special flags
and write handlers for them. These flags can then be passed as GET parameters to the
servlet, as additional QParam parameters in QCommand (executed using
QManagerSvc.executeCommand), or as additional NameValueParam parameters in a
derived class of QRequest using QManagerSDKSvc.processRequest. The servlet will
automatically create parameters out of these flags and set these in the command before
sending it for execution.
To handle these special flags, you can write your request handler derived from the class
QRequestHandler. You can then insert this new handler class anywhere in the chain of
responsibility pattern, starting with QDocProviderImpl and ending with
QHostRequestHandler.
Try not to change end points. In your handler implementation, handle your special flags,
then either return a response after handling or pass the control to the successor for further
handling.
QXP SERVER 8.5 WEB INTEGRATION GUIDE | 27
GETTING STARTED