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
Working with hidden text
Hidden text, represented in Modifier XML by the HIDDEN element, allows XTensions
software developers to insert custom, non-printing data into a text flow. This hidden text
can be retained when QuarkXPress Server deconstructs and reconstructs QuarkXPress
projects. For more information, see the Modifier DTD .
<PARAGRAPH MERGE="false" PARACHAR="HARDRETURN"
PARASTYLE="001-TEXT">
<RICHTEXT MERGE="false">
The population of Iceland is 500,000,000.
</RICHTEXT>
<HIDDEN DATALEN="100" OPCODE="51434410"
OWNER="514344" TYPE="CHARACTERTYPE">
<RICHTEXT LANGUAGE="USEnglish" MERGE="false">
VGhpcyBpcyB0aGUgdGV4dCBvZiBhIENvcHlEZXNrIG5vdGU=
</RICHTEXT>
</HIDDEN>
<RICHTEXT MERGE="false">
Iceland is located north of the Equator.
</RICHTEXT>
</PARAGRAPH>
The example XML extract above shows the output from the xml namespace of text that
contains a note inserted by the Notes XT XTensions software. Developed by Quark for
QPS, the Notes XT XTensions software stores its data as hidden text. The note contains
"This is the text of a CopyDesk note," which is represented as
"VGhpcyBpcyB0aGUgdGV4dCBvZiBhIENvcHlEZXNrIG5vdGU=" in the sample above.
If this text is passed back to QuarkXPress Server in a Modify or Construct request, the
hidden text inserted by the Notes XT XTensions software is preserved. Also, the hidden
text can be read by the Notes XT XTensions software if the project is opened in QuarkXPress.
The data within the RICHTEXT element inside a HIDDEN element is a Base 64-encoded
representation of the raw data that is stored within the hidden text. Considering that
hidden text in QuarkXPress can contain any type of data, and the structure of that data
is specified by the XTensions software that creates it, this method ensures that the data
can be safely represented in XML. Also, this data can be converted back into the same raw
data structure so that it can be read by the destination XTensions software. If the content
is edited, the destination XTensions software may not be able to interpret it. Only XTensions
software developers should attempt to interpret data from their own XTensions software.
For the <HIDDEN> element, the OPCODE attribute is a decimal representation of the XTension
ID of the XTensions software that inserted this hidden text. The OWNER attribute is a
decimal representation of the QuarkAlliance developer ID of the XTensions software
developer who inserted this hidden text. By default, hidden text is not output from the
xml namespace. To output hidden text, specify the “opcode=” parameter in your request
as follows:
http://server:port/xml/projectname.qxp?opcode=51433410
You can also specify "...opcode=*" to specify all hidden text in the XML output.
This example URL outputs all of the hidden text inserted by the XTensions software with
this ID. To avoid byte order issues when cross-platform rendering is enabled, the XTID is
represented decimally, rather than with the usual char[4] representation.
110 | QXP SERVER 9.2 WEB INTEGRATION GUIDE
USING THE WEB INTERFACE