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
Understanding ManagerSDK.xml
"ManagerSDK.xml" is used to generate client SDK classes for QuarkXPress Server requests.
Each element in "ManagerSDK.xml" corresponds to a request handler, a render type, or
an element in the DTD.
A client SDK class is generated for each element in the XML. Each property in the DTD
and each parameter of the request handler or render type also corresponds to a unique
element in the XML.
A Class variable is generated for each property, as follows.
•
<Class>: One element for each SDK class generated. The class generated is derived from
QRequest. Attributes are:
•
name: The name of the generated class.
•
namespace: The namespace recognized by QuarkXPress Server when this request
class is translated into a QuarkXPress Server request.
•
description: A description of the class. Unless this value is null, the description
forms the header of the generated class and is included in the generated API docs.
•
alias: The alias to be used as an element name if this request class is serialized to
XML. For example, when the Project class is serialized to XML, the element used
is Project.
•
serializeAs: Determines how the class is serialized. The valid values are:
•
nameValue indicates that all members of the class should be handled as
name-value pairs in the request to QuarkXPress Server. (This is the default
option in JPEGRenderRequest and ModifierStreamRequest.)
•
xml indicates that the class should be serialized as XML with the class name
or alias as the element value. All of the fields of the class are serialized as
child elements. If the field is a subclass of QRequest, it is processed
recursively. If the field is an array, it must be an array of QRequest-derived
classes.
•
mixed indicates that the class should be serialized as XML with the class
name or alias as the element. All the primitive fields of the class are serialized
as attributes. If the field is a subclass of QRequest, it is serialized as a child
element and processed recursively. If the field is an array, it must be an array
of QRequest-derived classes.
•
attribute indicates that the class should be serialized as XML with the
class name or alias as the element. The class must be primitive. All such
fields must be serialized as attributes of the element. Also, "value" fields
must be serialized as values of the element. Valid only if the parent class
has a serializeAs value of "xml" or "mixed."
•
<Attribute>: One element for each class field.
146 | QXP SERVER 9.2 WEB INTEGRATION GUIDE
USING THE QXPSM SDK