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
THE QUARKXPRESS SERVER USER INTERFACE
13. Average Queue Time: The average time a rendering job stays in the queue
before it gets processed. The average queue time = total queue time / total rendering
transactions completed.
For example, if the total queue time is 3 minutes (i.e. 180 seconds) and 150
transactions are completed, then the Average Queue Time = (3 * 60) /150 = 1.2
seconds
14. Peak Queue Time: The highest waiting time a rendering job stays in the queue.
For example, if during a given Observation Time, the waiting times are:
Tr1 = 0 sec
Tr2 = 5 sec
Tr3 = 2 sec
…
…
Trn = 4 sec
Peak Queue Time = MAX(0,5,2, …4) = 5 sec.
15. Current Queue Length: The number of rendering jobs waiting in the queue to
be processed.
16. Peak Queue Length: The highest queue lengths recorded during a given
observation time.
17. Rendering Requests: The total number of transactions delegated to renderers
during a given observation time (e.g. PDF, JPG, /getprojinfo, /jobjacket,
/getrendererprefs, /setrendererprefs, etc).
18. Pages Rendered: Sum total of all pages rendered for each rendering transaction
during a busy time.
19. Images Processed: Sum total of all image files either imported or rendered as a
part of the rendering transaction during the observation time.
20. Average Rendering Time Per Page: The average time taken to render a page.
Average rendering time per page = busy time / total pages rendered.
For example, if a total of 15000 pages are rendered when the server was busy for 50
minutes (i.e. 3000 sec), the Average Rendering Time Per Page = (50*60)/15000 = 0.2
seconds
21. Total Renditions: The number of renditions of various formats rendered by the
server during the observation time. By default, this includes PDF, JPEG, HTML5,
EPUB, KINDLE, APPSTUDIO, EPS, XML, PNG, CopyDesk Articles, QuarkXPress
Projects.
22. Failed Transactions Count: The number of failed transactions.
23. Error Rate: The percentage of failed transactions during the Observation Time.
For example if out of 500 rendering transactions, if 10 transactions failed, then the
Error Rate (%) = (10 / 500) * 100 = 2%.
14 | A GUIDE TO QUARKXPRESS SERVER 2020