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
Creates a new session and returns a session ID.
createSession
DescriptionTypeParameter
Timeout for the session in
milliseconds. If no call is executed
Long
timeout
in that time, session is expired and
all the open documents in that
session are closed without saving. If
0 is passed as value of timeout,
default timeout is used. If a negative
value is passed as timeout, the
session never expires.
Closes all open documents in the session without saving them. If the session
does not exist, an error is returned. If an error occurs while closing the
closeAlldocs
document, it is logged and the document is marked closed in the internal
cache. No error is returned.
DescriptionTypeParameter
Session whose documents are to be
closed.
String
sessionId
Closes the specified document without saving it. If the session does not exist,
an error is returned. If the document is not open, and error is returned. If the
closeDoc
document is open in another session, an error is returned. If an error occurs
while closing the document, it is logged and the document is marked closed
in the internal cache. No error is returned.
DescriptionTypeParameter
Document to be closed.String
docName
Session in which document was
opened.
String
sessionId
Closes the specified session. If the session does not exist, an error is returned.
If any documents are still open in the session, an error is returned.
closeSession
DescriptionTypeParameter
Session to be closed.String
sessionId
Gets all the open documents in the session. If the session does not exist, an
error is returned.
getOpenDocs
DescriptionTypeParameter
Session whose open documents are
sought.
String
sessionId
Gets all open sessions.
getOpenSessions
Gets QuarkXPress Server preferences.
getPreferences
Sets QuarkXPress Server preferences.
setPreferences
Creates a DOM for the specified document.
getXPressDOM
22 | QXP SERVER 9.2 WEB INTEGRATION GUIDE
GETTING STARTED