2020
Table Of Contents
- Conventions
- Getting started with QuarkXPress Server
- The QuarkXPress Server user interface
- Using QuarkXPress Server
- Creating URL requests
- Supported interfaces
- The Dynamic Publishing Process (DPP)
- 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
- Working with indexes
- Working with cross references
- Creating and using hyperlinks
- Using the Streaming Document Provider
- Using administrative request handlers
- Using the QXPSM SDK
- Sample applications
- QuarkXPress Server Features
- Modifier schema (annotated)
- Entities (Modifier schema)
- ADDCELLS (Modifier schema)
- ALIGNHORSETTINGS (Modifier schema)
- ALIGNVERSETTINGS (Modifier schema)
- ALLOWBOXOFFPAGE (Modifier schema)
- ALLOWBOXONTOPASTEBOARD (Modifier schema)
- ANCHOREDBOXREF (Modifier schema)
- ARTICLE (Modifier schema)
- AUTHOR (Modifier schema)
- BNSTYLE (Modifier schema)
- BORDER (Modifier schema)
- BOTTOM (Modifier schema)
- BOTTOMGRID (Modifier schema)
- BOX (Modifier schema)
- BOXATTRIBUTE (Modifier schema)
- BOXREF (Modifier schema)
- CALLOUTANCHOR (Modifier schema)
- CALLOUTBOXREF (Modifier schema)
- CELL (Modifier schema)
- CHILDID (Modifier schema)
- CLIPPING (Modifier schema)
- COLGROUP (Modifier schema)
- COLSPEC (Modifier schema)
- COLUMN (Modifier schema)
- COLUMNFLOW (Modifier schema)
- COLUMNSPAN (Modifier schema)
- COLUMNSPLIT (Modifier schema)
- COMPONENT (Modifier schema)
- COMPOSITIONZONE (Modifier schema)
- CONDITIONALMASTERPAGEREFERENCE (Modifier schema)
- CONTENT (Modifier schema)
- CONTENTPH (Modifier schema)
- CONTINUEDHEADER (Modifier schema)
- CONTINUEDTROWSTYLE (Modifier schema)
- CONTOUR (Modifier schema)
- CONTOURS (Modifier schema)
- COPYFIT (Modifier schema)
- COPYRIGHT (Modifier schema)
- DATAPROVIDER (Modifier schema)
- DEL (Modifier schema)
- DELETECELLS (Modifier schema)
- DESCRIPTION (Modifier schema)
- DROPCAP (Modifier schema)
- EBOOKMETADATA (Modifier schema)
- ENTRY (Modifier schema)
- EVENTCOLSTYLE (Modifier schema)
- EVENTROWSTYLE (Modifier schema)
- FIRSTTCOLSTYLE (Modifier schema)
- FIT (Modifier schema)
- FITTEXT (Modifier schema)
- FOOTER (Modifier schema)
- FOOTERTROWSTYLE (Modifier schema)
- FORMAT (Modifier schema)
- FRAME (Modifier schema)
- GEOMETRY (Modifier schema)
- GRADIENT (Modifier Schema)
- GRID (Modifier schema)
- GRIDLINE (Modifier schema)
- GROUP (Modifier schema)
- GROUPCHARACTERS (Modifier schema)
- GROWACROSS (Modifier schema)
- GROWDOWN (Modifier schema)
- GUIDE (Modifier Schema)
- HEADER (Modifier schema)
- HEADTROWSTYLE (Modifier schema)
- HEIGHT(Modifier schema)
- HIDDEN (Modifier schema)
- HYPERLINK (Modifier schema)
- ID (Modifier schema)
- INDEXTERM (Modifier schema)
- INLINEBOX (Modifier schema)
- INLINETABLE (Modifier schema)
- INS (Modifier schema)
- INSET (Modifier schema)
- INTERACTIVITY (Modifier schema)
- ISBN (Modifier schema)
- KEEPLINESTOGETHER (Modifier schema)
- KEYWORDS (Modifier schema)
- LASTTCOLSTYLE (Modifier schema)
- LAYER (Modifier schema)
- LAYOUT (Modifier schema)
- LAYOUTMETADATA (Modifier schema)
- LAYOUTREF (Modifier schema)
- LEFT (Modifier schema)
- LEFTCONTROLPOINT (Modifier schema)
- LEFTGRID (Modifier schema)
- LINESTYLE (Modifier schema)
- LINKEDBOX (Modifier schema)
- LIST (Modifier schema)
- LOCATION (Modifier schema)
- LOCKTOGRID (Modifier schema)
- MASTERPAGESEQUENCE (Modifier schema)
- MATHEQUATION (Modifier schema)
- MAX (Modifier schema)
- METADATA (Modifier schema)
- MIN (Modifier schema)
- MOVEDOWN (Modifier schema)
- MOVELEFT (Modifier schema)
- MOVERIGHT (Modifier schema)
- MOVEUP (Modifier schema)
- NOTE (Modifier schema)
- ODDTROWSTYLE (Modifier schema)
- ODDTCOLSTYLE (Modifier schema)
- ORIGIN (Modifier schema)
- OVERMATTER (Modifier schema)
- PAGE (Modifier schema)
- PAGEBREAK (Modifier schema)
- PAGEREF (Modifier schema)
- PAGESEQUENCE (Modifier schema)
- PARAGRAPH (Modifier schema)
- PARENTTABLE (Modifier schema)
- PICTURE (Modifier schema)
- PLACEHOLDER (Modifier schema)
- POSITION (Modifier schema)
- PROJECT (Modifier schema)
- PUBLICATION (Modifier schema)
- PUBLICATIONCHANNEL (Modifier schema)
- PUBLISHER (Modifier schema)
- REFNOTE (Modifier schema)
- RELPOSITION (Modifier schema)
- REPEATABLEMASTERPAGEALTERNATIVES (Modifier schema)
- REPEATABLEMASTERPAGEREFERENCE (Modifier Schema)
- RGBCOLOR (Modifier schema)
- RICHTEXT (Modifier schema)
- RIGHT (Modifier schema)
- RIGHTCONTROLPOINT (Modifier schema)
- RIGHTGRID (Modifier schema)
- ROW (Modifier schema)
- RUBI (Modifier schema)
- RUBITEXT (Modifier schema)
- RULE (Modifier schema)
- RUNAROUND (Modifier schema)
- SAVEAS (Modifier schema)
- SCALETO (Modifier schema)
- SECTION (Modifier schema)
- SECTIONNUMBERFORMAT (Modifier schema)
- SHADINGSTYLE (Modifier schema)
- SHADOW (Modifier schema)
- SHRINKACROSS (Modifier schema)
- SHRINKDOWN (Modifier schema)
- SINGLEMASTERPAGEREFERENCE (Modifier schema)
- SIZE (Modifier schema)
- SPINEIMAGE (Modifier schema)
- SPLINESHAPE (Modifier schema)
- SPREAD (Modifier schema)
- STACKINGORDER (Modifier schema)
- STATICCONTENT (Modifier schema)
- STOP (Modifier Schema)
- STORY (Modifier schema)
- SUPPRESSOUTPUT (Modifier schema)
- TAB (Modifier schema)
- TABLE (Modifier schema)
- TABLEBREAK (Modifier schema)
- TABLESTYLE (Modifier schema)
- TABSPEC (Modifier schema)
- TBODY (Modifier schema)
- TCOL (Modifier schema)
- TCOLSTYLE (Modifier schema)
- TCONTINUED (Modifier schema)
- TEXT (Modifier schema)
- TEXTATTRIBUTE (Modifier schema)
- TEXTNODEPH (Modifier schema)
- TEXTPH (Modifier schema)
- TFOOT (Modifier schema)
- THEAD (Modifier schema)
- TITLE (Modifier schema)
- TOP (Modifier schema)
- TOPGRID (Modifier schema)
- TROW (Modifier schema)
- TROWSTYLE (Modifier schema)
- VALUE (Modifier schema)
- VERTEX (Modifier schema)
- VERTEXPOINT (Modifier schema)
- VERTICES (Modifier schema)
- WIDTH (Modifier schema)
- XREF (Modifier schema)
- Using SSL
- QuarkXPress Server XTensions software
- Telegraph XTensions software
- QuarkXPress Server Manager
- Understanding QuarkXPress Server Manager
- Working with QuarkXPress Server Manager
- Starting QuarkXPress Server Manager
- Request handler binding
- Configuring QuarkXPress Server instances
- Managing the cache
- Managing logs
- Using a proxy server
- Generating automatic e-mail messages
- Using other global settings
- Saving a server configuration
- Using custom error messages
- Sending requests from a browser
- The XTensions Developer Kit (XDK)
- Glossary
- Legal Notices
USING QUARKXPRESS SERVER
literal
The literal render type returns the contents of a file without any attempt to
process it as a template. Depending on the file’s MIME type, the requested project
can be displayed within the browser (for example, if the response is a JPEG file) or
saved to disk (for example, if the response is a Microsoft Word document).
Render modifier
parameters
layout String
Lets you specify a
layout by name or ID.
The first layout is
Layout 1.
outputstyle String
Lets you specify a
Kindle output style by
name or ID.
Response A Kindle (.mobi) file.
Alerts
The renderer for this
image type has no
way of rendering the
desired objects.
HTTP Error #406 This alert displays if you submit a
render request with the pages or box parameter.
Kindle not created.
There is no reflow
layout in the
document.
HTTP Error #10543This error appears if there is no
reflow layout.
Logs See “Understanding logging.”
Example, GET URL http://localhost:8080/kindle/sample.qxp? outputstyle=kindle&layout=2
Example, object
model
Request object name: KindleRenderRequest //STEP1: Create the
QuarkXPress Server Request //Context and set the necessary properties
com.quark.qxpsm.QRequestContext requestCtx = new
com.quark.qxpsm.QRequestContext(); Boolean responseAsURL = false;
requestCtx.setDocumentName(docName); //STEP 2(SPECIFIC TO
REQUESTS): //Create the Kindle renderer //request and embed it in the
request context. KindleRenderRequest kindlereq = new
KindleRenderRequest();
kindlereq.setKindleData(request.getParameter(“KindleData”));
kindlereq.setCreateTOC(request.getParameter( “CreateTOC”));
kindlereq.setLayout(request.getParameter( “Layout”));
requestCtx.setRequest(kindlereq); //STEP3: Create the service and call the
//processRequest() API RequestService service = new RequestServiceStub();
com.quark.qxpsm.QContentData data =
service.processRequest(requestCtx);
Notes
You can only create a Kindle file from a project that includes a reflow
article.
Namespace literal
Response The requested file returned in the HTTP response.
Alerts
Incorrect
administratio
HTTP Error #401 This alert displays if you specify an invalid
administrator user name and password.What to do: Use the user
60 | A GUIDE TO QUARKXPRESS SERVER 2020