9.2
Table Of Contents
- Contents
- Overview
- Changes in this version
- Getting started
- Using the Web interface
- Understanding rendering
- Understanding logging
- 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
- Creating and using hyperlinks
- Using the Streaming Document Provider
- Using administrative request handlers
- Using the QXPSM SDK
- Modifier DTD (annotated)
- Entities (Modifier DTD)
- ADDCELLS (Modifier DTD)
- ALIGNHORSETTINGS (Modifier DTD)
- ALIGNVERSETTINGS (Modifier DTD)
- ALLOWBOXOFFPAGE (Modifier DTD)
- ALLOWBOXONTOPASTEBOARD (Modifier DTD)
- ANCHOREDBOXREF (Modifier DTD)
- ARTICLE (Modifier DTD)
- AUTHOR (Modifier DTD)
- BNSTYLE (Modifier DTD)
- BOTTOM (Modifier DTD)
- BOTTOMGRID (Modifier DTD)
- BOX (Modifier DTD)
- BOXREF (Modifier DTD)
- CALLOUTANCHOR (Modifier DTD)
- CALLOUTBOXREF (Modifier DTD)
- CELL (Modifier DTD)
- CHILDID (Modifier DTD)
- CLIPPING (Modifier DTD)
- COLGROUP (Modifier DTD)
- COLSPEC (Modifier DTD)
- COLUMN (Modifier DTD)
- COMPONENT (Modifier DTD)
- COMPOSITIONZONE (Modifier DTD)
- CONTENT (Modifier DTD)
- CONTENTPH (Modifier DTD)
- CONTINUEDHEADER (Modifier DTD)
- CONTINUEDTROWSTYLE (Modifier DTD)
- CONTOUR (Modifier DTD)
- CONTOURS (Modifier DTD)
- COPYFIT (Modifier DTD)
- COPYRIGHT (Modifier DTD)
- DATAPROVIDER (Modifier DTD)
- DELETECELLS (Modifier DTD)
- DESCRIPTION (Modifier DTD)
- DROPCAP (Modifier DTD)
- EBOOKMETADATA (Modifier DTD)
- ENTRY (Modifier DTD)
- EVENTCOLSTYLE (Modifier DTD)
- EVENTROWSTYLE (Modifier DTD)
- FIRSTTCOLSTYLE (Modifier DTD)
- FIT (Modifier DTD)
- FITTEXT (Modifier DTD)
- FOOTER (Modifier DTD)
- FOOTERTROWSTYLE (Modifier DTD)
- FORMAT (Modifier DTD)
- FRAME (Modifier DTD)
- GEOMETRY (Modifier DTD)
- GRID (Modifier DTD)
- GRIDLINE (Modifier DTD)
- GROUP (Modifier DTD)
- GROUPCHARACTERS (Modifier DTD)
- GROWACROSS (Modifier DTD)
- GROWDOWN (Modifier DTD)
- HEADER (Modifier DTD)
- HEADTROWSTYLE (Modifier DTD)
- HEIGHT(Modifier DTD)
- HIDDEN (Modifier DTD)
- HYPERLINK (Modifier DTD)
- ID (Modifier DTD)
- INLINETABLE (Modifier DTD)
- INSET (Modifier DTD)
- INTERACTIVITY (Modifier DTD)
- ISBN (Modifier DTD)
- KEEPLINESTOGETHER (Modifier DTD)
- KEYWORDS (Modifier DTD)
- LASTTCOLSTYLE (Modifier DTD)
- LAYER (Modifier DTD)
- LAYOUT (Modifier DTD)
- LAYOUTREF (Modifier DTD)
- LEFT (Modifier DTD)
- LEFTCONTROLPOINT (Modifier DTD)
- LEFTGRID (Modifier DTD)
- LINESTYLE (Modifier DTD)
- LINKEDBOX (Modifier DTD)
- LIST (Modifier DTD)
- LOCATION (Modifier DTD)
- LOCKTOGRID (Modifier DTD)
- MAX (Modifier DTD)
- METADATA (Modifier DTD)
- MIN (Modifier DTD)
- MOVEDOWN (Modifier DTD)
- MOVELEFT (Modifier DTD)
- MOVERIGHT (Modifier DTD)
- MOVEUP (Modifier DTD)
- ODDTROWSTYLE (Modifier DTD)
- ODDTCOLSTYLE (Modifier DTD)
- ORIGIN (Modifier DTD)
- OVERMATTER (Modifier DTD)
- PAGE (Modifier DTD)
- PAGEREF (Modifier DTD)
- PARAGRAPH (Modifier DTD)
- PARENTTABLE (Modifier DTD)
- PICTURE (Modifier DTD)
- PLACEHOLDER (Modifier DTD)
- POSITION (Modifier DTD)
- PROJECT (Modifier DTD)
- PUBLICATION (Modifier DTD)
- PUBLICATIONCHANNEL (Modifier DTD)
- PUBLISHER (Modifier DTD)
- RELPOSITION (Modifier DTD)
- RGBCOLOR (Modifier DTD)
- RICHTEXT (Modifier DTD)
- RIGHT (Modifier DTD)
- RIGHTCONTROLPOINT (Modifier DTD)
- RIGHTGRID (Modifier DTD)
- ROW (Modifier DTD)
- RUBI (Modifier DTD)
- RUBITEXT (Modifier DTD)
- RULE (Modifier DTD)
- RUNAROUND (Modifier DTD)
- SAVEAS (Modifier DTD)
- SCALETO (Modifier DTD)
- SECTION (Modifier DTD)
- SHADOW (Modifier DTD)
- SHRINKACROSS (Modifier DTD)
- SHRINKDOWN (Modifier DTD)
- SIZE (Modifier DTD)
- SPINEIMAGE (Modifier DTD)
- SPLINESHAPE (Modifier DTD)
- SPREAD (Modifier DTD)
- STACKINGORDER (Modifier DTD)
- STORY (Modifier DTD)
- SUPPRESSOUTPUT (Modifier DTD)
- TAB (Modifier DTD)
- TABLE (Modifier DTD)
- TABLEBREAK (Modifier DTD)
- TABLESTYLE (Modifier DTD)
- TABSPEC (Modifier DTD)
- TBODY (Modifier DTD)
- TCOL (Modifier DTD)
- TCOLSTYLE (Modifier DTD)
- TCONTINUED (Modifier DTD)
- TEXT (Modifier DTD)
- TEXTNODEPH (Modifier DTD)
- TEXTPH (Modifier DTD)
- TFOOT (Modifier DTD)
- THEAD (Modifier DTD)
- TITLE (Modifier DTD)
- TOP (Modifier DTD)
- TOPGRID (Modifier DTD)
- TROW (Modifier DTD)
- TROWSTYLE (Modifier DTD)
- VALUE (Modifier DTD)
- VERTEX (Modifier DTD)
- VERTEXPOINT (Modifier DTD)
- VERTICES (Modifier DTD)
- WIDTH (Modifier DTD)
- Sample applications
- Contacting Quark
- Legal notices
- Index
If the request succeeds, a transaction success message is written to the QuarkXPress Server transaction
log file. For example:
Logs
11/16/2005 15:41:42 — saveas/5mb.qxp — Type: — Size: 28 — Client: 127.0.0.1
If an alert displays, an error message is written to the QuarkXPress Server error log file. For example:
11/16/2005 15:42:12 — Error — Error Code: 10371 — The file path is invalid.
To save a PDF file named "Customer1.pdf" in the folder HDD:temp and also in the document pool,
use a URL like the following. Note that this URL will cause the saved-as file to replace any existing
file with the same name.
http://localhost:8080/saveas/pdf/sample.qxp?
newname=Customer1&path=HDD:temp&savetopool=true
Example, GET
URL
Request object name: SaveAsRequest
com.quark.qxpsm.QRequestContext rc = new com.quark.qxpsm.QRequestContext();
Example, object
model
if(!this.DocumentSettings1.documentName.Text.Equals(""))
rc.documentName =
this.DocumentSettings1.documentName.Text;
// STEP 2 (SPECIFIC TO REQUESTS):
// Create the Save as request and chain it to the document context
SaveAsRequest saveasreq = new SaveAsRequest();
saveasreq.newName = this.newname.Text;
if((this.path.Text != null) &&
(!this.path.Text.Equals("")))
saveasreq.newFilePath = this.path.Text;
saveasreq.replaceFile = this.replace.Checked.ToString();
saveasreq.saveToPool =
this.savetopool.Checked.ToString();
rc.request = saveasreq;
// Create the service and call it with QRequestContext object
RequestService svc = new RequestService();
com.quark.qxpsm.QContentData qc = svc.processRequest(rc);
Importing XML with placeholders
This topic explains how to import XML data into boxes using QuarkXPress placeholders.
To use this feature, you must have a QuarkXPress project that has been set up with
placeholders that correspond to the element types in a source XML file. For more
information, see A Guide to XML Import.
Lets you specify the XML file containing the data to import. The path
can be absolute or relative to the location of the XML file. You can
also supply XML as a string.
XML
thexmldoc
Parameters
Lets you specify which layout to render. The first layout is layout 1.
You can also specify a layout by name.
String
layout
Lets you specify the XML file containing the data to import. The
paginate parameter reates enough pages in the target layout to
accommodate the records in the XML.
XML
paginate
This parameter works only with the pdf, postscript, and qxp render
types. If you use it with any other render type, the server returns only
the first page of the paginated layout.
QXP SERVER 9.2 WEB INTEGRATION GUIDE | 65
USING THE WEB INTERFACE