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
pathname
Logs
If the request succeeds, a transaction success message is written to the
QuarkXPress Server transaction log file. For example: 8/5/2005 18:11:54 —
sample.qxp — Type: image/jpeg — Size: 65982 — Client: 127.0.0.1If an alert
displays, an error message is written to the QuarkXPress Server error log file. For
example:8/5/2005 18:01:59 — Error — Error Code: 10343 — A locked Layer
cannot be manipulated.
Example GET
URL
When QuarkXPress Server is running on Windows, use a URL like the
following:http://localhost:8080/Sample.qxp?modify= file:c:\file.xml When
QuarkXPress Server is running on macOS, use a URL like the
following:http://localhost:8080/Sample.qxp?modify= file:HDD:file.xml You can
also supply a string that consists of valid XML commands. For example:
http://localhost:8080/sample.qxp?modify= <PROJECT><LAYOUT><ID
UID=”Layout1”/><SPREAD><ID UID=”1”/> <BOXBOXTYPE=”CT_TEXT”><ID
NAME=”TREES”/> <CONTENT>C:\docs\file1.jpg</CONTENT>
</BOX></SPREAD></LAYOUT></PROJECT> When specifying a path, use URLs
like the following: http://localhost:8080/Sample.qxp?
textboxname@dataimport=file:c:\file.txt http://localhost:8080/Sample.qxp?
pictureboxname@dataimport=c:\file.jpg You can import text directly into a box
from the URL string. For example: http://localhost:8080/Sample.qxp?
textboxname@dataimport=Newdata When you import a file that uses style sheets,
you can control how those style sheets are handled. For example:
http://localhost:8080/Documentname?
textboxname@dataimport=file:c:\file.doc&
textboxnameincludestylesheets@dataimport=yes You can control how quotation
marks are handled at import. For example:
http://localhost:8080/Documentname?
textboxname@dataimport=file:c:\file.doc&
textboxnameconvertquotes@dataimport=yes
Example,
object model
Request object names: ModifierRequest ModifierStreamRequest Project RichText
Text ID Box Layout ModifierFileRequestFor ModifierFileRequest, the member
contents are used to set the file path or send the XML itself.
com.quark.qxpsm.QRequestContext rc = new
com.quark.qxpsm.QRequestContext();
if(!this.DocumentSettings1.documentName.Text.Equals(“”)) rc.documentName
= this.DocumentSettings1.documentName.Text; // STEP 2 (SPECIFIC TO
REQUESTS):Create the data import // request and embed it in request context
ModifierRequest request = new ModifierRequest(); Project requestContents = new
Project(); Content boxContent1 = new Content(); Box box1 = new Box();
box1.UID = txtBox1; box1.content = boxContent1; Layout layout1 = new
Layout(); layout1.name = layoutText; if(!this.content1.Text.Equals(“”)) {
boxContent1.value = this.content1.Text; Text text1 = new Text(); text1.font =
this.fontname1.Text; box1.text = text1; if(this.includestylesheets1.Checked ==
false) boxContent1.includeStylesheets = “false”;
if(this.convertquotes1.Checked == false) boxContent1.convertQuotes = “false”;
} else if (null != uplTheFile.PostedFile) { Stream theStream =
uplTheFile.PostedFile.InputStream; StreamReader reader = new
StreamReader(theStream); boxContent1.value = reader.ReadToEnd(); }
layout1.boxes = new Box[]{box1}; requestContents.layouts = new
116 | A GUIDE TO QUARKXPRESS SERVER 2020