10.2.1

ManualsBrandsQuark ManualsApplicationsQuarkXPress Server

Table Of Contents

A Guide to QuarkXPress

Server 10.2.1

Summary of content (350 pages)

PAGE 1
A Guide to QuarkXPress Server 10.2.
PAGE 2
CONTENTS Contents Conventions..................................................................................9 Getting started with QuarkXPress Server.................................10 QuarkXPress Server architecture....................................................................10 Understanding QuarkXPress Server...............................................................10 Server templates and static projects.......................................................................
PAGE 3
CONTENTS Getting started: Web services.................................................................................41 QXP Server Manager...............................................................................................49 Using the Web interface..................................................................................49 Understanding rendering........................................................................................50 Understanding logging..............................
PAGE 4
CONTENTS BOX (Modifier schema).................................................................................208 BOXATTRIBUTE (Modifier schema)...............................................................210 BOXREF (Modifier schema)...........................................................................211 CALLOUTANCHOR (Modifier schema)..........................................................212 CALLOUTBOXREF (Modifier schema)...........................................................
PAGE 5
CONTENTS HEADTROWSTYLE (Modifier schema)...........................................................241 HEIGHT(Modifier schema).............................................................................241 HIDDEN (Modifier schema)...........................................................................241 HYPERLINK (Modifier schema)......................................................................243 ID (Modifier schema)................................................................................
PAGE 6
CONTENTS POSITION (Modifier schema)........................................................................266 PROJECT (Modifier schema)..........................................................................267 PUBLICATION (Modifier schema)..................................................................267 PUBLICATIONCHANNEL (Modifier schema).................................................268 PUBLISHER (Modifier schema)......................................................................
PAGE 7
CONTENTS TEXTPH (Modifier schema)............................................................................302 TFOOT (Modifier schema).............................................................................303 THEAD (Modifier schema).............................................................................303 TITLE (Modifier schema)................................................................................303 TOP (Modifier schema)..............................................................
PAGE 8
CONTENTS Understanding QuarkXPress Server Manager..............................................322 Load balancing......................................................................................................322 Request timeout interval.......................................................................................323 Determining QuarkXPress Server instance availability..........................................324 Logging with QXP Server Manager................................................
PAGE 9
CONVENTIONS Conventions Formatting conventions highlight information to help you quickly find what you need. • Bold type style: The names of all dialog boxes, fields, and other controls are set in bold type. For example: "Click OK." • References: In descriptions of features, parenthetical references guide you in accessing those features. For example: "The Find/Change dialog box (Edit menu) lets you find and replace text." • Arrows: You will often see arrows (>), which map out the menu path to a feature.
PAGE 10
GETTING STARTED WITH QUARKXPRESS SERVER Getting started with QuarkXPress Server QuarkXPress Server lets you render QuarkXPress projects in a variety of formats. QuarkXPress Server architecture The QuarkXPress Server architecture is shown in the following diagram.
PAGE 11
GETTING STARTED WITH QUARKXPRESS SERVER application, all you need to do is enter a URL into your Web browser's address field. For example, the following URL instructs the QuarkXPress Server application named "QXPServer" to return the file "MyProject.qxp" as a PDF file: http://QXPServer:8080/pdf/MyProject.
PAGE 12
GETTING STARTED WITH QUARKXPRESS SERVER QuarkXPress Server through a file system or an FTP server. You can use any of the following methods to place files in the document pool: • Drag the files to the document pool directory. • Use the Add Files command in the Document Pool screen of the QuarkXPress Server Web interface. • Upload the files using FTP to the document pool directory. • Use Telegraph XTensions® software to upload the files to the document pool from within QuarkXPress.
PAGE 13
GETTING STARTED WITH QUARKXPRESS SERVER Caching To maximize efficiency, QuarkXPress Server uses cached versions of all rendered projects whenever possible. You can configure projects so that they are never cached, so that they are cached for a particular amount of time, or so that they are rendered every time they are served.
PAGE 14
GETTING STARTED WITH QUARKXPRESS SERVER renderers as they become available. The number of renderers available for launch is determined by the number of licenses available from the QLA server.
PAGE 15
GETTING STARTED WITH QUARKXPRESS SERVER 5 To define the logging level for other activity, scroll to the . The structure is as follows: 6 Save and close "log4j.xml." Understanding QuarkXPress Server XTensions software QuarkXPress Server ships with a collection of XTensions software that adds capabilities to QuarkXPress Server.
PAGE 16
GETTING STARTED WITH QUARKXPRESS SERVER • Post-processing • Removing slugs while running the QuarkXPress project renderer • Analyzing the server after a transaction is complete • Pre- and post-transaction callback Configuring QuarkXPress Server for launch To configure QuarkXPress Server prior to launch, open the file [QuarkXPress Server application folder]/conf/ServerApp.
PAGE 17
GETTING STARTED WITH QUARKXPRESS SERVER For information on launching QuarkXPress Server in a separate Tomcat installation, see "Deploying QuarkXPress Server externally" in the QuarkXPress Server ReadMe. QuarkXPress Server offers a browser-based user interface instead of a conventional user interface. Quitting QuarkXPress Server To quit QuarkXPress Server, press Control+C. A GUIDE TO QUARKXPRESS SERVER 10.2.
PAGE 18
THE QUARKXPRESS SERVER USER INTERFACE The QuarkXPress Server user interface QuarkXPress Server offers a browser-based user interface instead of a conventional user interface. This chapter describes that interface and explains how you can use it to configure and customize your QuarkXPress Server application and manage your server XTensions modules.
PAGE 19
THE QUARKXPRESS SERVER USER INTERFACE Status Monitor screen If you click Manage Logs, the Logs screen displays the current transaction log. Logs screen • To download the active log, including recent crash reports, click Download Logs at the top of the Logs header. • To make the log scroll automatically as events occur, check Auto Scroll. • To clear all logs, click Clear All Logs. • To clear the current log, click Clear Log. • To display the Log Settings dialog box, click Log Settings.
PAGE 20
THE QUARKXPRESS SERVER USER INTERFACE Fonts screen To search fonts, use the list search box in the top right corner. To add fonts to the Server machine, click the Add Fonts button. This will copy the fonts to the "privatefonts" folder in the QuarkXPress Renderer folder. Administration menu The administration menu lets you manage QuarkXPress Server. You do not have to restart the server in GUI mode to set preferences.
PAGE 21
THE QUARKXPRESS SERVER USER INTERFACE Use the Allow Memory Caching check box to control whether memory is cached. Use the Max Memory Cache Size field to specify the maximum memory size allocated to the cache memory. Valid values are from 10MB to 1024MB. Use the Force Served Documents Closed check box to control whether QuarkXPress Server closes projects from the document pool after it renders them, regardless of the Telegraph XTensions software setting.
PAGE 22
THE QUARKXPRESS SERVER USER INTERFACE • QuarkXPress Server Log.log: The log for the Java process. This log contains source code-level logging information that can be useful in troubleshooting. • QuarkXPress Server Transaction Log.log: This log lists all transactions and all errors. Detailed application logging is enabled for these log files only if it is enabled in the "log4j.xml" file. To log detailed transaction timing data, check Log Timing Data.
PAGE 23
THE QUARKXPRESS SERVER USER INTERFACE Use the Port field to specify the port number of the e-mail server that QuarkXPress Server should use to send messages. Valid values are from 0 to 255. Use the From to specify the source e-mail address the QuarkXPress Server application should use to send messages (for example, QXPSserver1@quark.com). Use the To to specify the e-mail address to which the QuarkXPress Server application should send messages (for example, QXPServerAdmin@quark.com).
PAGE 24
THE QUARKXPRESS SERVER USER INTERFACE Check Smart Quotes to force QuarkXPress to replace feet (')and inches (") marks automatically with the specified quotation marks. Use the Format drop-down menu to specify the default characters to be used with the Smart Quotes feature and Convert Quotes option in the Get Text dialog box (File > Get Text). To change the separators used for indicating sequential ranges for output, enter a value in the Sequential Page Range Separator.
PAGE 25
THE QUARKXPRESS SERVER USER INTERFACE To specify default replacement fonts, check Specify Default Replacement Font and choose options from the Roman and East Asian drop-down menu. To highlight characters that are in a Traditional Chinese encoding's UDA/VDA (User Defined Area/Vendor Defined Area) range so that these characters can be visually verified, check Highlight character ranges defined by Traditional Chinese font vendors.
PAGE 26
THE QUARKXPRESS SERVER USER INTERFACE The default path to the log file is /Documents. If you choose to change the default, the log folder specified must be a pre-existing folder on the system. Preferences — Project General Settings The Project General Settings pane (Administration > Preferences > Renderer > Project General Settings) includes the following controls. Check Use OpenType Kerning to activate the default kerning values for OpenType fonts.
PAGE 27
THE QUARKXPRESS SERVER USER INTERFACE Use the Points/Inch field to override the default value of 72 points per inch. The application uses the value here as the basis for all point and pica measurements, as well as for all point- and pica-to-inch conversions. The desktop publishing standard for points per inch is 72. However, the traditional typographic standard used on most metal typographic rulers is usually approximately 72.27 or 72.
PAGE 28
THE QUARKXPRESS SERVER USER INTERFACE Use the Superscript fields to control the placement and scale (size) of superscript characters. The Superscript Offset value determines how far below the baseline the application places a superscript character. The Superscript Offset value is measured as a percentage of font size. The default value is 33%. The Superscript VScale value determines the vertical size of the character and is a percentage of font size.
PAGE 29
THE QUARKXPRESS SERVER USER INTERFACE QuarkXPress. This option is checked by default, with a 4-point threshold (range = 0 to 72 pt, measurement system = various [", pt, cm, etc.], smallest increment = .001). Check Standard Em Space to specify an em-space equivalent to the point size of the text (for example, 24pt text has a 24pt em space). If Standard Em Space is unchecked, the application uses the width of the two zeros in the current font as the em-space width. This option is checked by default.
PAGE 30
THE QUARKXPRESS SERVER USER INTERFACE • Choose Overprint to cause overprinting for object and background colors with an Auto Amount specified in the Trap Specifications dialog box (Edit > Colors > Edit Trap), as well as for items with an Auto Amount (+) or (–) specified in the Trap Information palette (Window > Trap Information).
PAGE 31
THE QUARKXPRESS SERVER USER INTERFACE To color manage vector content in imported EPS and PDF files, check Color Manage Vector EPS/PDF. Note that this preference applies only to EPS and PDF files imported after this box is checked. To color manage vector content in EPS and PDF files that have already been imported in the active project, check Include Existing Vector EPS/PDF in Layout. Preferences — Layers The Layers pane (Administration > Preferences > Renderer > Layers) has the following controls.
PAGE 32
THE QUARKXPRESS SERVER USER INTERFACE 5 Click Submit. The QuarkXPress Server Job Jackets file is replaced with the modified version. App Studio preferences The AppStudio dialog box lets you specify credentials and proxy settings so that QuarkXPress Server can upload HTML5 App Studio articles to the App Studio Publishing Portal. Enter your App Studio Publishing Portal user name and password, then enter the proxy settings for your proxy server (if any).
PAGE 33
USING QUARKXPRESS SERVER Using QuarkXPress Server The xml namespace deconstructs a project according to the Modifier DTD. The construct namespace lets the server turn an XML representation of a QuarkXPress project back into an actual project. With these namespaces, you can deconstruct a project into an XML representation, change the XML in accordance with the Modifier DTD, and then have the server generate an updated version of the QuarkXPress project.
PAGE 34
USING QUARKXPRESS SERVER Understanding URL requests QuarkXPress Server URL requests should use the following format: http://server:port/namespace/path/projectname?parameter=value • server: Indicates the name or IP address of the QuarkXPress Server computer. • port: Indicates the QuarkXPress Server application's port number. The default port number is 8080. • namespace: Sets the render type (or indicates another server functionality to access).
PAGE 35
USING QUARKXPRESS SERVER software's xml namespace, Modifier XTensions software can return an XML representation of the project. Looking up a namespace This guide lists the namespaces for every QuarkXPress Server function. There is no single list of namespaces because some functions do not require a particular namespace or are available in multiple namespaces. To determine which namespace you want to use: 1 In this Guide, go to the page that documents the render type you want to use.
PAGE 36
USING QUARKXPRESS SERVER • HTTPS: Provides secure HTTP access. • Web services: Lets you interact with the server via Web services using the QuarkXPress Server Manager object model. You can write client applications in Java, .NET, or any other programming language that can consume SOAP-based Web services. For more information, see "Getting started: Web services". To develop a custom load balancer or a custom application in Java, you must have version 1.5 or 1.6 of the JDK.
PAGE 37
USING QUARKXPRESS SERVER or HTTPS requests and sends the requests to QuarkXPress Server or QuarkXPress Server Manager, which processes the requests and returns rendered content. Dissecting a QXP Server URL To interact with QuarkXPress Server from a Web browser, use a URL like the following: http://[server]:[port]/[namespace]/[directory]/[DocumentName]?[parameter]=Value • [server]: The name or IP address of the computer for QuarkXPress Server or QuarkXPress Server Manager.
PAGE 38
USING QUARKXPRESS SERVER Manager cannot process the request, it returns an XML response describing the error, plus any header error codes returned by QuarkXPress Server. For example: 500 -43 File not found.
PAGE 39

USING QUARKXPRESS SERVER
To create a drop-down menu that lets the end user specify a render format, use HTML like the following: To create a button that lets the end user submit the request, use HTML like the following: The above HTML calls a function named Submit_onclick().
PAGE 41

USING QUARKXPRESS SERVER Using HTTP GET with QXP Server Manager HTTP GET with QuarkXPress Server Manager works the same way as HTTP GET with QuarkXPress Server (see "Using HTTP GET with QXP Server"), except that Quark does not recommend using GET if you are working with non-ASCII characters. The behavior of GET requests with characters is highly browser-dependent, and there is no standard that all browsers follow. Instead, use POST.
PAGE 42

USING QUARKXPRESS SERVER These classes can be chained together to form compound QuarkXPress Server requests. The sample applications (see "Sample applications") show how to use these classes to invoke a QuarkXPress Server command and manipulate the response. For more information, see "Using the Web interface." In addition to the classes listed there, the Web services interface includes the following: • RequestService processes QuarkXPress Server requests.
PAGE 43

USING QUARKXPRESS SERVER serverName String Server name. Default is NULL. Load balancer searches for the host itself in this case. serverPort Integer Port at which the desired server is listening. userName String Server admin username. userPassword String Server admin password. maxRetries Integer Max number of times to try executing the command before returning failure. requestTimeout Integer Max time out in milliseconds.
PAGE 44

USING QUARKXPRESS SERVER timeout closeAlldocs closeDoc closeSession getOpenDocs Long Timeout for the session in milliseconds. If no call is executed 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.
PAGE 45

USING QUARKXPRESS SERVER openDoc docName String Document to be opened for modification. Provide the name only. You can proivde a relative path when you save the document. jobJacketName String Name of the Job Jackets file to be used. The Job Jackets file is assumed to be already available on the QuarkXPress server computer. jobTicketName String Name of the Job Ticket to be used. host String The QuarkXPress Server instance that should be used for this document modification.
PAGE 46

USING QUARKXPRESS SERVER sessionId saveAllDocs saveDoc getXPressDOMEx String Session in which the request should be executed. This value may be null. If a session ID is provided, the document is kept open. If no session ID is provided, the request is executed normally, as if processRequest had been called. Saves all open documents in the session. The documents are saved one by one. If error occurs while saving a document, an error is returned immediately and the rest of the documents remain unsaved.
PAGE 47

USING QUARKXPRESS SERVER getXPressDOMFromXML Takes a raw XML representation of a project as a string and returns an object model representing that project, with Project as the root class. Example, object model QRequestContext rc = new QRequestContext(); rc.documentName = "test.qxp"; rc.responseAsURL = false; JPEGRenderRequest jpegRequest = new JPEGRenderRequest(); rc.request = jpegRequest; RequestService svc = new RequestService(); QContextData response = svc.
PAGE 48

USING QUARKXPRESS SERVER paramName String Name of the parameter. In most cases this will be the name/ID of the box. textValue String Text value of the box. (You can set either textValue or streamValue.) streamValue byte[] Stream value of the box. (You can set either textValue or streamValue.) contentType String The MIME content type of the parameter. QContentData Description A response to a Web Services call to QuarkXPress Server.
PAGE 49

USING QUARKXPRESS SERVER Example, object model httpResponseCode String HTTP response code. managerErrorCode String QuarkXPress Server Manager error code. managerErrorMessage String QuarkXPress Server Manager localized error message. serverErrorCode String QuarkXPress Server error code. serverErrorMessage String QuarkXPress Server response message. serverExtendedMessage String QuarkXPress Server extended error message. String docName = "notexisting.
PAGE 50

USING QUARKXPRESS SERVER • Content modifiers let you alter the content and formatting of boxes in layouts without using the XML modify parameter. • XML modify lets you modify QuarkXPress projects using XML. • The xml namespace deconstructs a project according to the Modifier DTD. The construct namespace lets you turn an XML representation of a QuarkXPress project back into a QuarkXPress project. • Administrative request handlers let you change the behavior of QuarkXPress Server.
PAGE 51

USING QUARKXPRESS SERVER Example, GET URL http://localhost:8080/sample.qxp Notes There are two ways to specify a render format: 1. Enter the render type directly in the browser address field:http://localhost:8080/pdf/project.qxp. 2. In the QuarkXPress Server administration interface, choose Administration > Preferences > General and choose the default render type from the Default Renderer Type drop-down menu.
PAGE 52

USING QUARKXPRESS SERVER Function Description QuarkXPress Server Manager object model classes png Returns a PNG image. PNGRenderRequest postscript Returns a PostScript file. PostScriptRenderRequest qcddoc Returns a QuarkCopyDesk article. CopyDeskDocRequest qxpdoc Returns a QuarkXPress project file. QuarkXPressRenderRequest qxpr Returns an RLE Raw Custom format image. RLERawCustomRenderRequest raw Returns a project in a QuarkXPress internal RawCustomRenderRequest format.
PAGE 53

USING QUARKXPRESS SERVER config String Lets you retrieve the current publication hierarchy from the App Studio Publishing Portal. For example: http://qxpserver:port/ appstudio/config Render modifier parameters layout String Lets you specify a layout by name or ID. The first layout is Layout 1. page Integer Lets you specify a page. pages String (page range) Lets you specify a range of pages. Response A .zip file containing an HTML5 article.
PAGE 54

USING QUARKXPRESS SERVER To use settings that have been captured with the Capture Settings in the QuarkXPress Export AVE for iPad dialog box, use document. For example: http://localhost:8080/ave/ sample.qxp?outputstyle=document Render modifier parameters format String Lets you specify an output format. Use avemag for AVE-Mag or avedoc for AVE-Doc. The default is avemag. layout String Lets you specify a layout by name or ID. The first layout is Layout 1. page Integer Lets you specify a page.
PAGE 55

USING QUARKXPRESS SERVER //STEP3: Create the service and call the //processRequest() API RequestService service = new RequestServiceStub(); com.quark.qxpsm.QContentData data = service.processRequest(requestCtx); Notes The default AVE output style is used. eps The eps render type returns an EPS rendering of a page or spread. Namespace EPS Parameters outputstyle stylename Lets you specify an output style. To use a named output style, use the name of that output style.
PAGE 56

USING QUARKXPRESS SERVER document, spread 1 consists of the first page. layout String Lets you specify a layout by name or ID. The first layout is Layout 1. downloadlayoutFonts 1 | 0 | true | false | yes | no Lets you specify whether to download all fonts used in the layout and all system fonts. downloadImportedPdfEpsFonts 1 | 0 | true | false | yes | no Lets you specify whether to download all fonts required by imported PDF and EPS files. Response An EPS file.
PAGE 57

USING QUARKXPRESS SERVER If you do not specify an EPS output style, the default EPS output style is used. epub The epub render type returns an ePUB rendering of a layout. Namespace ePUB 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 an ePUB output style by name or ID. Response An ePUB (.epub) file. Alerts The renderer for this image type has no way of rendering the desired objects.
PAGE 58

USING QUARKXPRESS SERVER quality), 3 (medium quality), and 4 (lowest quality). The default value is 1. upadateimage true | false Lets you specify whether to update imported pictures. updateflow true | false Lets you specify whether to update the text flow version of a project to the current version. pasteboard true | false Lets you specify whether to display pasteboard items. Works only with spread parameter. The default value is true. For example: http://localhost:8080/jpeg/document.
PAGE 59

USING QUARKXPRESS SERVER kindle The kindle render type returns a rendering of a layout that can be viewed on Amazon Kindle readers. Namespace kindle 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.
PAGE 60

USING QUARKXPRESS SERVER Response The requested file returned in the HTTP response. Alerts HTTP Error #401 Incorrect administration This alert displays if you specify an invalid administrator user name and realm username password. and password. What to do: Use the user name and password set in the Authentication pane of the General Preferences dialog box (Administration > Preferences > General) in the QuarkXPress Server Web interface.
PAGE 61

USING QUARKXPRESS SERVER exportlistsasbookmarks 1 | 0 | true | Lets you specify whether to export lists as false | yes | no bookmarks. To use this parameter, you must set includehyperlinks to true. mode composite or separations printcolors cmyk, rgb, Lets you specify the color space of the PDF file. grayscale, This option is available only when mode is set cmykandspot, to composite.
PAGE 62

USING QUARKXPRESS SERVER pdffile String Lets you specify the PDF name. This option is available only when PDF to Folder is selected in QuarkXPress Server PDF preferences. psfile String Lets you specify the PostScript file name. This option is available only when PostScript for later Distilling is selected in QuarkXPress Server PDF preferences. thumbnail bw | color Lets you embed a thumbnail in the PDF file. mode composite | separations Lets you specify the PDF file's color mode.
PAGE 63

USING QUARKXPRESS SERVER true | false Lets you specify whether to update the text flow version of a project to the current version. Integer Lets you specify a single page. String (page range) Lets you specify a range of pages. spread Integer Lets you specify a spread. The first spread is spread 1. In a facing-page document, spread 1 consists of the first page. layout String Lets you specify a layout by name or ID. The first layout is Layout 1.
PAGE 64

USING QUARKXPRESS SERVER if( strLowResolution !=null && strLowResolution.equals("True")) pdfreq.setLowResolution("true"); requestCtx.setRequest(pdfreq); // STEP3: Create the service and // call the processRequest() API RequestService service = new RequestServiceStub(); com.quark.qxpsm.QContentData data = service.processRequest(requestCtx); For more information about the object model, see the samples. Notes There are three ways to generate PDF files with QuarkXPress Server.
PAGE 65

USING QUARKXPRESS SERVER transparentpng true | false Lets you specify whether to generate a PNG file that uses transparency. upadateimage true | false Lets you specify whether to update imported pictures. updateflow true | false Lets you specify whether to update the text flow version of a project to the current version. String Lets you request multiple boxes. Integer Lets you specify a single page. scale Float .1 to 6.92 for Windows .1 to 8 on Mac OS Lets you specify a scaling percentage.
PAGE 66

USING QUARKXPRESS SERVER top, bottom, left, right | sym, clip, amount To specify an asymmetric bleed, use the following format: prntbleed=asym,clip,top,bottom, left, right The clip value is Boolean (yes/no). The top, bottom, left, and right values are float values. For example: http://localhost:8080/ postscript/Sample.
PAGE 67

USING QUARKXPRESS SERVER contains only blank pages. PostScript printer HTTP Error #500 mapped to file This alert displays if the PostScript printer or driver is not set to Print to not found File. This Output Style This alert displays if you specify a nonexistent output style. does not exist. This Output Style This alert displays if you specify an output style that is incompatible with cannot be used this render type. with this render type.
PAGE 68

USING QUARKXPRESS SERVER Parameters article String Lets you specify which article in a project to render. For example: http://localhost:8080/qcddoc/ abc.qxp?article=article1 component String Lets you specify which component in an article to render. For example: http://localhost:8080/copydesk/ abc.qcd?component=comp1 format lightweight | fullfeatured Lets you render an article in lightweight or full-featured format. For example: http://localhost:8080/qcddoc/ abc.
PAGE 69

USING QUARKXPRESS SERVER Example, GET URL http://localhost:8080/qcddoc/copydesk/sample.qcd Example, object model Request object name: CopyDeskDocRequest qxpdoc The qxpdoc render type returns a QuarkXPress project. Namespace qxpdoc Parameters qxpdocver 8|9 Indicates the QuarkXPress version format to use. For example: http://localhost:8080/qxpdoc/ construct/project1.
PAGE 70

USING QUARKXPRESS SERVER requestCtx.setDocumentName(docName); // STEP 2(SPECIFIC TO REQUESTS):Create the QuarkXPress // renderer request and embed it in the request context. QuarkXPressRenderRequest qxpreq = new QuarkXPressRenderRequest(); qxpreq.setDocumentVersion(request.getParameter( "XpressDocVersion")); qxpreq.setLayout(request.getParameter("Layout")); requestCtx.setRequest(qxpreq); // STEP3: Create the service and call the processRequest() API RequestService service = new RequestServiceStub(); com.
PAGE 71

USING QUARKXPRESS SERVER printcolors cmyk, rgb, grayscale, cmykandspot, asis Lets you specify the color space of the PDF file. This option is available only when mode is set to composite. plates inripseps Lets you specify a separation method. This option is available only when mode is set to separations. produceblankpages 1 | 0 | true | false | yes | no Lets you specify whether to include blank pages. This option is available only when mode is set to composite.
PAGE 72

USING QUARKXPRESS SERVER Render modifier parameters thumbnail bw | color Lets you embed a thumbnail in the PDF file. mode composite | separations Lets you specify the PDF file's color mode. fontdownload yes | no Lets you turn font download on or off. You cannot specify which fonts are downloaded. layers String Lets you specify which layers should be included, as a comma-separated list. transparencyres Integer value from Lets you specify the resolution for flattened 36 to 3600 content.
PAGE 73

USING QUARKXPRESS SERVER // STEP 2(SPECIFIC TO REQUESTS): // Create the QuarkXPress renderer // request and embed it in the request context. ScreenPDFRenderRequest screenpdfRequest = new ScreenPDFRenderRequest(); screenpdfRequest.setColorImageDownSample( request.getParameter("ColorImageDownSample")); screenpdfRequest.setCompression(request.getParameter( "Compression")); requestCtx.
PAGE 74

USING QUARKXPRESS SERVER Response spreads Boolean 1 | 0 | Lets you specify that the output use spreads. true | false | Applicable only to Print layouts. yes | no updateimage true | false Lets you specify whether to update imported pictures. updateflow true | false Lets you specify whether to update the text flow version of a project to the current version. A single SWF file or a multipart reply containing an SWF file and a set of support files.
PAGE 75

USING QUARKXPRESS SERVER call the processRequest() API RequestService service = new RequestServiceStub(); com.quark.qxpsm.QContentData data = service.processRequest(requestCtx); Understanding render modifiers Render modifiers let you control which parts of a project are rendered and set the scale of the returned renderings. The topics covered here include the following: Property Description box The box render modifier lets you render a single box.
PAGE 76

USING QUARKXPRESS SERVER appenderrors The appenderrors render modifier lets you include descriptions of rendering errors after the last page in the layout. Descriptions of rendering errors are formatted in 10-point magenta Arial. Parameters appenderrors String Includes descriptions of rendering errors after the last page in the layout. Compatible with pdf, qxpdoc, xml, postscript Logs See Understanding logging Example GET URL http://localhost:8080/png/sample.
PAGE 77

USING QUARKXPRESS SERVER overlap String Lets you specify whether to show the area overlapped by the specified boxes. Compatible with jpeg, png, raw Alerts There is no box with HTTP Error #500 the specified This alert displays if you request a box that does not exist. identifier. Cannot render box. The box must be within the page boundaries. HTTP Error #500 This alert displays if you request a box that is outside the page boundary. .
PAGE 78

USING QUARKXPRESS SERVER Parameters layer String Lets you specify which layer to render. You can specify multiple layer names in one request. addlayer String Lets you add a new layer. You can add one layer per request. deletelayer String Lets you delete a layer and the items on that layer. You can delete one layer per request. alllayers Boolean (1 | 0 | true Lets you render every layer in the project, including | false | yes | no) hidden and suppressed layers.
PAGE 79

USING QUARKXPRESS SERVER Invalid parameter value. HTTP Error #500 This layer has been locked and cannot be modified. HTTP Error #500 This alert displays if you do not specify additional attributes or specify attributes with invalid values in an addlayer or layerattribute request. This alert displays if you try to add or modify an item on a locked layer. Logs See Understanding logging Example GET URL To render a single layer, use a URL like the following: http://localhost:8080/doc.
PAGE 80

USING QUARKXPRESS SERVER Alerts The requested layout does not exist. HTTP Error #500 This alert displays if you supply an invalid layout value. Logs See Understanding logging Example GET URL To render a layout by its layer ID, use a URL like the following: http://localhost:8080/png/sample.qxp?layout=2 To render a layout by its name, use a URL like the following: http://localhost:8080/png/sample.qxp?layout=Layout 2 movepages The movepages render modifier lets you move pages prior to rendering.
PAGE 81

USING QUARKXPRESS SERVER pdfreq.setMovePages("2-4"); pdfreq.setAfterPage("7"); requestCtx.setRequest(pdfreq); // STEP3: Create the service and call the // processRequest() API RequestService service = new RequestServiceStub(); com.quark.qxpsm.QContentData data = service.processRequest( requestCtx); Notes The movepages operation executes only after all other modifications are complete. For example, if you use movepages in a modify request, the pages are moved only after the modify request is complete.
PAGE 82

USING QUARKXPRESS SERVER This alert displays if you try to render a page range that exceeds the number of pages in the project. The renderer for this image type has no way of rendering the desired objects. HTTP Error #406 This alert displays if you use the pages parameter with the jpeg, eps, png, or qxpdoc render type. Logs See Understanding logging Example, GET URL http://localhost:8080/pdf/sample.
PAGE 83

USING QUARKXPRESS SERVER Spread is located at the following place in the object hierarchy: ModifierRequest < Project < Layout < Spread To delete a spread, set its operation attribute to "DELETE". spreads The spreads render modifier lets you render layouts in spreads mode, so that pages in spreads are rendered side-by-side rather than as individual pages. Parameters spreads Boolean (1 | 0 | true | false | yes | no) Lets you specify whether to render spreads (true) or individual pages (false).
PAGE 84

USING QUARKXPRESS SERVER QuarkXPress Server Error #–43 This alert displays if the imported file is not available to QuarkXPress Server. Logs If the request succeeds, a transaction success message is written to the QuarkXPress Server transaction log file. For example: 8/3/2005 11:27:42 — jpeg/sample.qxp — Type: image/jpeg — Size: 31715 — Client: 127.0.0.1 If an alert displays, an error message is written to the QuarkXPress Server error log file.
PAGE 85

USING QUARKXPRESS SERVER If an error occurs, the error message is written to the QuarkXPress Server Error Log. The transaction entry in the error log contains the date and time of the request, the error code, and the error message. The following is a sample of an error transaction log entry: 12/2/2005 16:16:26 — Error — Error Code: –43 — File not found. Example, GET URL To apply Comic Sans MS to text in the box named "HeadBox," use a URL like the following: http://localhost:8080/png/sample.
PAGE 86

USING QUARKXPRESS SERVER 8/10/2005 10:39:07 — Error — Error Code: 10339 — The specified file failed to load in the picture box. Example, GET URL http://localhost:8080/sample.qxp? PictureBox=file:FrenchOpen.pdf Example, object Request object name: RequestParameters model com.quark.qxpsm.QRequestContext rc = new com.quark.qxpsm.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.
PAGE 87

USING QUARKXPRESS SERVER This alert displays if you supply an incorrect file name or the file is not available to QuarkXPress Server. Bad filename/ pathname. HTTP Error #404 QuarkXPress Server Error #–43 This alert displays if you supply an incorrect file name or the file is not available to QuarkXPress Server. The file path is invalid. HTTP Error #500 This alert displays if you supply an invalid path parameter. What to do: Specify the correct file path with the path parameter.
PAGE 88

USING QUARKXPRESS SERVER Parameters thexmldoc XML Lets you specify the XML file containing the data to import. The path can be absolute or relative to the location of the XML file. You can also supply XML as a string. layout String Lets you specify which layout to render. The first layout is layout 1. You can also specify a layout by name. paginate XML Lets you specify the XML file containing the data to import.
PAGE 89

USING QUARKXPRESS SERVER rc.request = xmlimportreq; // STEP 3(SPECIFIC TO REQUESTS): Create the JPEG renderer request JPEGRenderRequest jpreq = new JPEGRenderRequest(); xmlimportreq.request = jpreq; // Create the service and call it with QRequestContext object RequestService svc = new RequestService(); com.quark.qxpsm.QContentData qc = svc.
PAGE 90

USING QUARKXPRESS SERVER rc.request = xmlimportreq; // STEP 3(SPECIFIC TO REQUESTS): Create the JPEG renderer request JPEGRenderRequest jpreq = new JPEGRenderRequest(); xmlimportreq.request = jpreq; // Create the service and call it with QRequestContext object RequestService svc = new RequestService(); com.quark.qxpsm.QContentData qc = svc.processRequest(rc); Highlighting text in rendered output To apply highlighting to text in rendered output, use XML like the following.
PAGE 91

USING QUARKXPRESS SERVER Response The updated QuarkXPress project. Logs If the request succeeds, a transaction success message is written to the QuarkXPress Server transaction log file. For example: 8/3/2005 11:27:42 — jpeg/sample.qxp — Type: image/jpeg — Size: 31715 — Client: 127.0.0.1 If an alert is displayed, an error message is written to the QuarkXPress Server error log.
PAGE 92

USING QUARKXPRESS SERVER 30 30 BRINGTOFRONT false If you know the UID attribute of a element, you can insert content into that element without having to speci
PAGE 93

USING QUARKXPRESS SERVER When QuarkXPress Server is running on Mac OS, use a URL like the following: http://localhost:8080/sample.qxp?modify= file:MacHD:xml:updateBox.xml You can also supply a string that consists of valid XML commands. For example: http://localhost:8080/sample.qxp?modify= file:Services.
PAGE 94

USING QUARKXPRESS SERVER The Geometry object has the following properties: allowBoxOffPage allowBoxOnToPasteBoard angle growAcross growDown layer linestyle (of type 'Linestyle') moveDown moveLeft moveRight moveUp page position (of type 'Position') runaround (of type 'Runaround') shape shrinkAcross shrinkDown stackingOrder suppressOutput The Runaround object has the following properties: bottom edited invert left noise outset outsideOnly pathName restrictToBox right smoothness threshold top type Creating b
PAGE 95

USING QUARKXPRESS SERVER 5 10 10 Response A preview of the QuarkXPress project with new box created in specified position. Alerts File not found. HTTP Error #404 QuarkXPress Server Error #–43 This alert displays if you specify an invalid XML file or request a document that is not available to QuarkXPress Server. Bad filename/ pathname.
PAGE 96

USING QUARKXPRESS SERVER geometry.position = position; geometry.shape = "SH_RECT"; geometry.page = "1"; geometry.layer = "Default"; box.geometry = geometry; box.boxType = "CT_TEXT"; box.operation = "CREATE"; spread.
PAGE 97

USING QUARKXPRESS SERVER Example GET URL When QuarkXPress Server is running on Windows, use a URL like the following: http://localhost:8080/sample.qxp?modify= file:C:\deleteBox.xml When QuarkXPress Server is running on Mac OS, use a URL like the following: http://localhost:8080/sample.qxp?modify= file:MacHD:xml:deleteBox.xml You can also supply a string that consists of valid XML commands. For example: http://localhost:8080/sample.
PAGE 98

USING QUARKXPRESS SERVER The order of the elements in a indicates the order in which the boxes were selected prior to grouping. The z-order of boxes in the layout is determined by the order of the elements in the XML, from rearmost to frontmost. XML representations of groups created by versions of QuarkXPress Server prior to 8.1 are ignored during construct and modify calls, as they were in earlier versions of QuarkXPress Server.
PAGE 99

USING QUARKXPRESS SERVER SIZE="20">This text is bold, red, italic, and 20pt. Response A preview of a QuarkXPress project with the values in the ModifierXT tags applied on text boxes. Alerts File not found. HTTP Error #404 QuarkXPress Server Error #–43 This alert displays if you specify an invalid XML file or request a document that is not available to QuarkXPress Server. Bad filename/ pathname.
PAGE 100

USING QUARKXPRESS SERVER Example GET URL When QuarkXPress Server is running on Windows, use a URL like the following: http://localhost:8080/sample.qxp?modify= file:C:\modifier.xml When QuarkXPress Server is running on Mac OS, use a URL like the following: http://localhost:8080/sample.qxp?modify= file:MacHD:xml:modifier.xml You can also supply a string that consists of valid XML commands. For example: http://localhost:8080/sample.
PAGE 101

USING QUARKXPRESS SERVER Example 2, object model To edit the properties of an existing text box in a QuarkXPress project, use the following object hierarchy: ModifierRequest < Project < Layout < Spread < Box < Text < Story < Paragraph < RichText For a list of the RichText object's properties, see the JavaDoc installed with QuarkXPress Manager. The Story object also contains some text-related properties: fitTextToBox, includeStylesheets, convertQuotes, and clearOldText.
PAGE 102

USING QUARKXPRESS SERVER Bad filename/ pathname. HTTP Error #404 QuarkXPress Server Error #–37 This alert displays if you specify an invalid file name or path. The XML HTTP Error #500 document is not This alert displays if the XML you supply is not well-formed or does not valid or well adhere to the Modifier DTD. formed. There is no box with the specified identifier. HTTP Error #500 The value of Scale Across should be between 10% and 1000%.
PAGE 103

USING QUARKXPRESS SERVER 8/10/2005 10:39:07 — Error — Error Code: 10339 — The specified file failed to load in the picture box. Example GET URL When QuarkXPress Server is running on Windows, use a URL like the following: http://localhost:8080/sample.qxp?modify= file:C:\imageProperties.xml When QuarkXPress Server is running on Mac OS, use a URL like the following: http://localhost:8080/sample.qxp?modify= file:MacHD:xml:imageProperties.xml You can also supply a string that consists of valid XML commands.
PAGE 104

USING QUARKXPRESS SERVER Example 2, object model To edit the properties of an existing text box in a QuarkXPress project, use the following object hierarchy: ModifierRequest < Project < Layout < Spread < Box < Picture For a list of the Picture object's properties, see the JavaDoc installed with QuarkXPress Manager. Notes You cannot replace an image with the Modifier XTensions software.
PAGE 105

USING QUARKXPRESS SERVER The XML document is not valid or well formed. HTTP Error #500 This alert displays if the XML you supply is not well-formed or does not adhere to the Modifier DTD. There is no box HTTP Error #500 with the This alert displays if the box specified by the child text node of the specified element does not exist. identifier. The specified box is not a picture or text box. HTTP Error #500 A locked layer cannot be manipulated.
PAGE 106

USING QUARKXPRESS SERVER 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.
PAGE 107

USING QUARKXPRESS SERVER Notes BoxParam XTensions software lets you import only files in the document pool. Modifier XTensions software, however, lets you import files that are located anywhere on the server computer, at any accessible network location, or supplied as part of a multipart HTTP request.
PAGE 108

USING QUARKXPRESS SERVER Deconstructing a project The xml namespace returns an XML representation of the target project. To use this namespace, use a URL like the following: http://QXPServer8:8080/xml/project1.qxp When you use the xml namespace, QuarkXPress Server returns an XML file that represents the deconstructed project. This XML file adheres to the Modifier DTD (see "Modifier schema (annotated)").
PAGE 109

USING QUARKXPRESS SERVER elements in which ORIGIN@RELATIVETO="page" (as opposed to "spread"). copyfitinfo QuarkXPress Server returns copyfitting information for QuarkCopyDesk articles by default. To retrieve copyfitting information when deconstructing a QuarkXPress project, include copyfitinfo=true in the xml request. For example: http://localhost:8080/xml/sample.qxp? copyfitinfo=true Refer to the Modifier DTD Response Sample response:
PAGE 110

USING QUARKXPRESS SERVER 0 0 800 600 false Logs If the request succeeds, a transaction success message is writ
PAGE 111

USING QUARKXPRESS SERVER When you create a project using the construct namespace, you must supply the path to the Job Jackets file that will supply the project's resources. To do so, indicate the URL of the Job Jackets file in the PROJECT@JOBJACKET attribute and the name of the Job Ticket in the PROJECT@JOBTICKET attribute. ( is the root element of the Modifier DTD. For more information, see "Modifier schema (annotated).
PAGE 112

USING QUARKXPRESS SERVER The XML document is not valid or well formed. HTTP Error #500 This alert displays if the XML you supply is not well-formed or do not adhere to the Modifier DTD. The XML document HTTP Error #500 contains an invalid tag This alert displays if you supply an invalid value in the XML. value. Logs If the request succeeds, a transaction success message is written to the QuarkXPress Server transaction log file. For example: 8/3/2005 11:27:42 — jpeg/construct/table.
PAGE 113

USING QUARKXPRESS SERVER Construct and modify The modify parameter lets you modify existing projects. For example: http://QXPServer8:8080/project1.qxp? modify=file:path to XML file on server or: http://QXPServer8:8080/project1.qxp?modify=XML string It's important to understand that although the construct namespace uses the same DTD that you use when you modify an existing project, the construct namespace uses it differently.
PAGE 114

USING QUARKXPRESS SERVER You can assign items to a page using the GEOMETRY element, which is a child of the BOX and TABLE elements. For example: 90 95 190 195 Master pages are stored in a deconstructed project’s Job Jackets file.
PAGE 115

USING QUARKXPRESS SERVER To create a layout using a layout specification in the template's Job Jackets structure, use XML like the following: Scrollable Layout To create a la
PAGE 116

USING QUARKXPRESS SERVER This is the text file:MyFile.jpg Column1 Column2 When QuarkXPress Server creates a new layout this way, it adds an automatic text box.
PAGE 117

USING QUARKXPRESS SERVER 475 This is text in a box.
PAGE 118

USING QUARKXPRESS SERVER For example: 224.001 110.003 381 253.253 To use this feature, you must have FitBoxToContent XTensions software loaded. For pictures, is equivalent to PICTURE@FIT="FITBOXTOPICTURE". and have no effect.
PAGE 119

USING QUARKXPRESS SERVER If the volume of text (represented by PARAGRAPH) is potentially large, the INLINEBOX automatically continues to flow the remaining text across pages. Automatic text flow example The INLINEBOX element allows to have autommatic column balanced sections. This allows you to have the text flow and bottom-align across multiple columns on a page automatically.
PAGE 120

USING QUARKXPRESS SERVER A child INTERACTIVITY element facilitates the application of interactivity on boxes. This allows for the deconstruct and modifiability of App Studio Interactivities, as shown below: file:Images/2pdf.
PAGE 121

USING QUARKXPRESS SERVER You can nest one group within another by adding a that refers to the child group, like so:
PAGE 122

USING QUARKXPRESS SERVER image.
PAGE 123

USING QUARKXPRESS SERVER New text Story IDs are unique across layouts. Applying style sheets Like other resources, style sheets are defined in a deconstructed project’s Job Jackets file. To apply a paragraph style sheet to text, use the PARASTYLE attribute of the element.
PAGE 124

USING QUARKXPRESS SERVER sun has risen. Formatting across paragraph boundaries You can use two methods to describe a run of formatting that crosses a paragraph boundary. The first is to simply close the first element and then open a new one. For example: The sun has risen. The sun has set.
PAGE 125

USING QUARKXPRESS SERVER ... ...
PAGE 126

USING QUARKXPRESS SERVER Response A preview of the QuarkXPress project with new table created in the specified position. Logs If the request succeeds, a transaction success message is written to the QuarkXPress Server transaction log file. For example: 4/10/2007 17:54:37 — tab.qxp — Type: image/jpeg — Size: 9049 — Client: 127.0.0.1 Example GET URL When QuarkXPress Server is running on Windows, use a URL like the following: http://localhost:8080/sample.qxp?modify= file:C:\createTable.
PAGE 127

USING QUARKXPRESS SERVER To add a picture cell, use XML like the following: MacintoshHD:DocPool:flower1.jpg Merging and splitting table cells To merge table cells, use XML like the following:
... ... ...

PAGE 128

USING QUARKXPRESS SERVER Using inline tables The Inline Tables feature makes it easy to create an anchored table.

PAGE 129

USING QUARKXPRESS SERVER ... The INDEX value indicates the column number. You can specify the WIDTH of a column in points by omitting a unit indicator, or as a percentage of the table width by including a % after the number. The child attribute ORIENTATION lets you specify the orientation of the table, like so: ORIENTATION="LANDSCAPE"> ... On a portrait page, this would effectively rotate the table in a clock wise direction, while the page itself is not rotated.

PAGE 130

USING QUARKXPRESS SERVER A lets you specify the following things: • : A row style to be applied to every row in the table. One of the two mandatory elements of . Includes the INSET attribute, which lets you specify the inset to apply on all four sides. • : A row style to be applied only to the header row. • and : Row styles that let you format odd and even rows differently. • : A column style.

PAGE 131

USING QUARKXPRESS SERVER To remove a section break, use XML like the following:
Working with Composition Zones A Composition Zones item in a deconstructed project is represented in XML by a element. Like the element type, this element type supports the , , and elements.

PAGE 132

USING QUARKXPRESS SERVER • HORIZONTALBINDING and VERTICALBINDING • LAYOUTOPACITY • LAYOUTREF • PREVIEWPAGE For example: Using XSL transformation You can use an XSLT file to transform the XML returned by the xml namespace into other formats.

PAGE 133

USING QUARKXPRESS SERVER LIST is a child of the STORY element. The value of LISTSTYLE will be the name of the list that had been created in QuarkXPress. When a project containing a list is deconstructed in XML, the XML will contain the text of the list, as well as a reference back to the LIST.

PAGE 134

USING QUARKXPRESS SERVER Note that there are two BOX elements. One is the parent box that has the element ANCHOREDBOXREF, which points to the name of the anchored box. The anchored box itself has the attribute ANCHOREDIN, which points to the name of the parent box. Working with placeholders Placeholders allow a region of text in a QuarkXPress project to hold non-printing metadata.

PAGE 135

USING QUARKXPRESS SERVER Text Text Text

PAGE 136

USING QUARKXPRESS SERVER
PAGE 137
USING QUARKXPRESS SERVER The structure of a hidden text marker In Modifier XML, hidden text is represented by the HIDDEN element. By default, hidden text is not output from the xml namespace. To output hidden text, specify the opcode= parameter in your request, like so: http://server:port/xml/projectname.qxp?opcode=51434450 This example URL outputs all of the hidden text inserted by the XTensions software with this ID.
PAGE 138
USING QUARKXPRESS SERVER Iceland is located north of the Equator. 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. The note contains "This is the text of a CopyDesk note," which is represented as VGhpcyBpcyB0aGUgdGV4dCBvZiBhIENvcHlEZXNrIG5vdGU=.
PAGE 139
USING QUARKXPRESS SERVER gotofirstpage Scroll Zone interactivity Below is an example of App Studio Scroll Zone interactivity.
PAGE 140
USING QUARKXPRESS SERVER true6.000000 Images\slideshow1.jpg Images\slideshow2.
PAGE 141
USING QUARKXPRESS SERVER false true true 1 Audio\abc.mp3 false Go to URL interactivity Below is an example of App Studio Go to URL interactivity.
PAGE 142
USING QUARKXPRESS SERVER true false true false 0 360 degree interactivity Below is an example of App Studio 360 degree interactivity.
PAGE 143
USING QUARKXPRESS SERVER Specifying colors When specifying colors, you can use named Web colors such as "Silver" and "MediumSlateBlue" by name. You can also use RGB colors by specifying their hexadecimal values. For example: This text is teal. Creating and using hyperlinks There are three types of hyperlink: • Web (WWWURL). • Anchor (ANCHOR).
PAGE 144
USING QUARKXPRESS SERVER To link to this Page hyperlink, use something like this: Page2 You can use a Page hyperlink without creating it at the level, but this is not the preferred method. Using the Streaming Document Provider The Streaming Document Provider feature allows all of the assets required for a transaction to be provided as part of a multi-part HTTP request. Assets that can be streamed include: • QuarkXPress templates.
PAGE 145
USING QUARKXPRESS SERVER parameter of this API is a pointer to a request handler function implemented in QuarkXPress Server XTensions software. The second parameter is a namespace string that identifies the request. When a user submits a request that has the same namespace string as a suffix to the request URL, QuarkXPress Server calls the request handler function with all the user-specified parameters in the ServerRequest structure.
PAGE 146
USING QUARKXPRESS SERVER Example, object model Request object name: AddFileRequest // STEP 1 (COMMON FOR ALL REQUESTS): com.quark.qxpsm.QRequestContext rc = new com.quark.qxpsm.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.Text; Stream theStream = uplTheFile.PostedFile.InputStream; long length = theStream.
PAGE 147
USING QUARKXPRESS SERVER The following example demonstrates how to use an HTML form to create a POST request that uses the addfile request handler. The form looks like this: To use this form: 1 Enter the name or IP address of the computer on which QuarkXPress Server is running. 2 Enter the port number in the port number field. 3 Enter the file name along with the extension in the file field. Click Browse if you need to find the file on your computer. The file will be uploaded with this name.
PAGE 148
USING QUARKXPRESS SERVER NAME="uploadFile">

The information entered in the form is created with the following tags:
Please enter the name or IP of machine where QuarkXPress Server is running:

Please enter the port number on which QuarkXPress Server is running:
PAGE 149
USING QUARKXPRESS SERVER Response The message "File deleted successfully." Alerts File not found HTTP Error #404 QuarkXPress Server Error #–43 This alert displays if you try to delete a file that does not exist in the document pool. Folder cannot be deleted. It may still contain files. HTTP Error #405 I/O error trying to read or write to disk. HTTP Error #500 This alert displays if you try to delete a folder that is not empty.
PAGE 150
USING QUARKXPRESS SERVER Namespace evaluate Response The default Job Jackets file. Alerts Incorrect administration realm user name and password. HTTP Error #401 This alert displays if you specify an invalid administrator user name and password. What to do: Use the user name and password set in the QuarkXPress Server Manager client Server Configuration dialog box. Logs See Understanding logging Example GET URL http://localhost:8080/evaluate/MyProject.
PAGE 151
USING QUARKXPRESS SERVER Parameters Lets you retrieve the creation date of a file in UTC format. For example: action=get http://localhost:8080/fileinfo/sample.qxd? action=get&creationdate Lets you set the creation and modification dates of a file in UTC format. For example: action=set http://localhost:8080/fileinfo/sample.
PAGE 152
USING QUARKXPRESS SERVER Example GET URL http://localhost:8080/flush/sample.qxp Example, object Request object name: FlushRequest model sdk.QRequestContext rc = new sdk.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.Text; rc.request = new FlushRequest(); //Create the service and call it with QRequestContext object RequestServiceService svc = new RequestServiceService(); com.quark.qxpsm.QContentData qc = svc.
PAGE 153
USING QUARKXPRESS SERVER in points, the number of pages, the names of imported picture files, the names of any required fonts, the names and IDs of any relevant XTensions modules, and (for documents saved in QuarkXPress 6.0 or later) information about synchronized content. Namespace getdocinfo Response The XML response looks like the following: WINDOWS 7.0 Sample.
PAGE 154
USING QUARKXPRESS SERVER Getdocpoollist The getdocpoollist request handler returns an XML description of all files and folders in the local document pool, including name, size, type, modification date and time, and absolute and relative path. Namespace getdocpoollist Response XML description of files and folders in the local document pool. Parameters directory Use this parameter to get information about a particular directory in the document pool.
PAGE 155
USING QUARKXPRESS SERVER Namespace getprefs Response An XML description of QuarkXPress Server preference settings. Alerts Incorrect administration realm user name and password. HTTP Error #401 This alert displays if you specify an invalid administrator user name and password. What to do: Use the user name and password set in the QuarkXPress Server Manager client Server Configuration dialog box.
PAGE 156
USING QUARKXPRESS SERVER Response The XML response looks like the following: WINDOWS 6.0 Sample.
PAGE 157
USING QUARKXPRESS SERVER Response An XML description of QuarkXPress Server renderer preference settings. Alerts Incorrect administration realm user name and password. HTTP Error #401 This alert displays if you specify an invalid administrator user name and password. What to do: Use the user name and password set in the QuarkXPress Server Manager client Server Configuration dialog box.
PAGE 158
USING QUARKXPRESS SERVER Jobjacket The jobjacket request handler returns a Job Jackets file containing copies of all of the resources in the specified project. This is similar to what happens when you use jjname= in a modifier XML request, but it returns the Job Jackets file directly, rather than writing it to the document pool. Namespace jobjacket Response A Job Jackets file containing copies of all of the resources in the specified project.
PAGE 159
USING QUARKXPRESS SERVER QuarkXPress Server Error #–43 This alert displays if you try to delete a file that is not available to QuarkXPress Server. Logs See Understanding logging Example GET URL To preflight a project in the root folder: http://localhost:8080/preflight/abc.qxp To preflight a binary file in a subfolder: http://localhost:8080/preflight/sub1/abc.qxp Example, object model Request object name: PreflightRequest com.quark.qxpsm.QRequestContext rc = new com.quark.qxpsm.
PAGE 160
USING QUARKXPRESS SERVER Example GET URL http://localhost:8080/setprefs?CacheSize=200 Example, object model EMailPreferences emailPrefs = new EMailPreferences(); emailPrefs.emailFrom = "from@email.com"; emailPrefs.emailTo = "to@email.com"; emailPrefs.smtpPort = "25"; emailPrefs.smtpServerIP = "SMTPServerIP"; Preferences prefs = new Preferences(); prefs.setEmailPreferences(emailPrefs); // Create the service and call setPreferences method RequestService svc = new RequestService(); svc.
PAGE 161
USING QUARKXPRESS SERVER levels This request handler sets the preferences for all renderers. Namespace setrendererprefs Response The message "Preferences successfully set." Alerts Incorrect administration realm user name and password. HTTP Error #401 This alert displays if you specify an invalid administrator user name and password.
PAGE 162
USING QUARKXPRESS SERVER Attribute Type Description ApplyFontFallback Boolean Set to true or false. Search Boolean Set to true or false. SearchType Boolean Set to Paragraph or Active Story. SearchLimit integer Set to search limit number.
PAGE 163
USING QUARKXPRESS SERVER Attribute Type Description VerticalUnits string Set to Inches, Inches Decimal, Picas, Points, Millimeters, Centimeters, Ciceros, Agates, or Q. PointsPerInch float Set to the number of points per inch. CicerosPerCM float Set to the number of ciceros per centimeter. AutoLeading float Set to the percentage to use for auto leading. MaintainLeading Boolean Set to true or false. LockToGridOption string Set to Ascent and Descent or Font Size (Em Box).
PAGE 164
USING QUARKXPRESS SERVER Attribute Type Description Indeterminate float Set to the indeterminate trapping value. KnockoutLimit float Set to the knockout limit value. OverPrintLimit float Set to the overprint limit value. ColorEngine string Set to Automatic, ColorSync, Kodak, or LogoSync. BlackPointCompensation Boolean Set to true or false. SourceSetup string Set to the name of the default color source setup. EnableAccessToPictureProfiles Boolean Set to true or false.
PAGE 165
USING QUARKXPRESS SERVER Response The message "Preferences successfully set." Alerts Incorrect administration realm user name and password. HTTP Error #401 This alert displays if you specify an invalid administrator user name and password. What to do: Use the user name and password set in the QuarkXPress Server Manager client Server Configuration dialog box.
PAGE 166
USING QUARKXPRESS SERVER 3 Get a reference to the RequestService: RequestService requestService = new RequestServiceStub( "http://[server]:[port]/qxpsm/services/RequestService"); 4 Get a reference to the AdminService: AdminService adminService = new AdminServiceStub( "http://[server]:[port]/qxpsm/services/AdminService"); 5 Use these two services to make requests. For sample code, see the following topics. If QuarkXPress Server Manager is running over SSL,the client-side application must also use SSL.
PAGE 167
USING QUARKXPRESS SERVER // Get reference to RequestService RequestService service = new RequestServiceStub( "http://[server]:[port]/qxpsm/services/RequestService"); //Process the request service.processRequest(qRequestContext); If made from QuarkXPress Server, this request would look like this: http://[server]:[port]/saveas/qxpdoc/Project.qxp?newname="NewDoc.
PAGE 168
USING QUARKXPRESS SERVER Add Reference dialog box 3 Get a reference to the RequestService: RequestService requestService = new RequestService(); requestService.Url = "http://:/qxpsm/services/RequestService"; 4 Get a reference to the AdminService: AdminService adminService = new AdminService(); adminService.Url = "http://:/qxpsm/services/AdminService"; 5 Use these two services to make requests. For sample code, see the following topics.
PAGE 169
USING QUARKXPRESS SERVER .NET sample: Rendering a PDF QRequestContext qRequestContext = new QRequestContext(); qRequestContext.documentName = "MyDoc.qxp"; // Setting responseAsURL to true generates the response as a URL qRequestContext.responseAsURL = true; // Create the PDFRenderRequest PDFRenderRequest pdfRenderRequest = new PDFRenderRequest(); qRequestContext.request = pdfRenderRequest; // Get reference to RequestService RequestService service = new RequestService(); service.
PAGE 170
USING QUARKXPRESS SERVER cpp/libQXPSMSoapCppBindings.a objc/libQXPSMSoapObjCBindings.a iOS: [QXPSM_Home]/XDK/WebServiceStubs/objective-c/lib/i86_64/ c/libQXPSMSoapCBindings.a cpp/libQXPSMSoapCppBindings.a objc/libQXPSMSoapObjCBindings.a 4 Create an instance of QXPSMServiceManager. (QXPSMServiceManager is an Axis2c-based factory for QXPSM Web services stubs. It maintains shared instances of stubs corresponding to different QXPSM Web services.
PAGE 171
USING QUARKXPRESS SERVER logFilePath:axisLogFile logLevel:axisLogLevel axis2Path:axis2Home useHttps:usehttps serverCertificatePath:certFilePath proxyHost:proxyHost proxyPort:proxyPort username:proxyUserName password:proxyPassword]; 6 Get a reference to the RequestService using QXPSMServiceManager and perform the required API invocations on the referenced RequestService.
PAGE 172
USING QUARKXPRESS SERVER [[QXPSMServiceManager requestService] processRequestForRequestCmd:qRequestContext]; If made from QuarkXPress Server, this request would look like this: http://[server>]:[port]/saveas/qxpdoc/MyDoc.qxp?newname="NewDoc.qxp" Extending QuarkXPress Server Manager Custom XTensions written for XPressServer can be used in the QuarkXPress Server Manager Web service interface in two ways: • Using the Extensibility tool in the QXPSM SDK.
PAGE 173
USING QUARKXPRESS SERVER Implementing a custom load balancer To implement a custom load balancer, first implement the com.quark.manager.lb.QLoadBalancer interface. To use this interface, add a reference to "managerengine.jar" to your project. This interface method contains the following methods: getLoadBalancerAlgorithm Signature public String getLoadBalancerAlgorithm(); Description Returns the name of the algorithm that is mapped to the current load balancer while loading the server.
PAGE 174
USING QUARKXPRESS SERVER 7 Above this ConfigureManager tag, define the bean ID as your new bean ID: 8 Restart the Tomcat server. 9 Log on with the QuarkXPress Server Manager client and choose Global Setting > Load Balancer Method > Choose Load Balancer. 10 Locate your new load balancer method, then click Save.
PAGE 175
USING QUARKXPRESS SERVER 4 To use the generated artifacts: • Copy the contents of [output location]/_server/conf to [QXPSM application folder]/Server/conf. • Copy the contents of [output location]/_server/lib to [QXPSM application folder]/Server/lib. • Restart QuarkXPress Server Manager. Compatible client side web-service stubs, for both Java and .NET can be found at [output location]/_client/stubs Understanding ManagerSDK.xml "ManagerSDK.
PAGE 176
USING QUARKXPRESS SERVER • nameValue indicates that all members of the class should be handled as name-value pairs in the request to QuarkXPress Server. (This is the default option in JPEGRenderRequest and ModifierStreamRequest.) • xml indicates that the class should be serialized as XML with the class name or alias as the element value. All of the fields of the class are serialized as child elements. If the field is a subclass of QRequest, it is processed recursively.
PAGE 177
USING QUARKXPRESS SERVER • deprecated: If this value is true, this field has been deprecated, should not be used, is not supported, and will be removed in a future version of QuarkXPress Server. • cdata: If this value is true, the value of this field is to be wrapped in a cdata section before being sent to QuarkXPress Server. This is valid only if the field is "value", that is value of the element in modifier XML.
PAGE 178
USING QUARKXPRESS SERVER 4 Restart IIS. 5 In a browser, enter the following URL: http://:/ClientSDKSamplesSite/Index.htm C# samples These samples show how to use C# to take advantage of bullets and numbering, callouts, and conditional styles with QuarkXPress Server requests transmitted via the QuarkXPress Server Manager Web services interface. They use .NET Web service stubs provided by the QuarkXPress Server Manager SDK.
PAGE 179
USING QUARKXPRESS SERVER Sample applications legal notice ©2012 Quark Software Inc. as to the content and arrangement of this material. All rights reserved. ©1986–2012 Quark Software Inc. and its licensors as to the technology. All rights reserved. Protected by one or more of U.S. Patent Nos. 5,541,991, 5,907,704, 6,005,560, 6,052,514, 6,081,262, 6,947,959 B1, 6,940,518 B2, 7,116,843 and other patents pending.
PAGE 180
USING QUARKXPRESS SERVER IF ANY, OR THE LOWEST AMOUNT UNDER APPLICABLE LAW, WHICHEVER IS LESS. THESE LIMITATIONS WILL APPLY EVEN IF QUARK, THE QUARK AFFILIATED COMPANIES, THEIR LICENSORS AND/OR THEIR AGENTS HAVE BEEN ADVISED OF SUCH POSSIBLE DAMAGES. SOME JURISDICTIONS, STATES OR PROVINCES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS LIMITATION OR EXCLUSION MAY NOT APPLY.
PAGE 181
USING QUARKXPRESS SERVER computer video simulation used in the product may not match the COLOR FINDER™ book, and additionally some printer color used in the product may also not match. Please use the COLOR FINDER™ book to obtain the accurate color." TRUMATCH, TRUMATCH Swatching System, and TRUMATCH System are trademarks of TRUMATCH, Inc. As to tt2pt1 technology, Copyright ©1997–2003 by the AUTHORS: Andrew Weeks Frank M. Siegert Mark Heath
PAGE 182
USING QUARKXPRESS SERVER As to Apache technology, copyright ©1999–2008 The Apache Software Foundation. All rights reserved. Any Apache software which is distributed with this software is developed by the Apache Software Foundation (http://www.apache.org/). Licensed under the Apache License, Version 2.0 (the “License”); you may not use these files except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE–2.0.
PAGE 183
USING QUARKXPRESS SERVER permission notice are met; The following copyright notices are retained when present, and conditions provided in accompanying permission notices are met: Copyright 1994 Hewlett-Packard Company. Copyright 1996,97 Silicon Graphics Computer Systems, Inc. Copyright 1997 Moscow Center for SPARC Technology.
PAGE 184
USING QUARKXPRESS SERVER grants you a personal, non-exclusive license, under Apple’s copyrights in this original Apple software (the “Apple Software”), to use, reproduce, modify and redistribute the Apple Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the Apple Software in its entirety and without modifications, you must retain this notice and the following text and disclaimers in all such redistributions of the Apple Software.
PAGE 185
USING QUARKXPRESS SERVER As to DOM4J software, Redistribution and use of this software and associated documentation ("Software"), with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain copyright statements and notices. Redistributions must also contain a copy of this document.
PAGE 186
USING QUARKXPRESS SERVER THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
PAGE 187
QUARKXPRESS SERVER FEATURES QuarkXPress Server Features Dynamic Pagination and Flow The Evolved Mechanics sample, demonstrating the flow automation constructs, can be downloaded from the QXPS Administration home page, using the Download SDK and Samples link. There are three main division in the structure of any document: 1 the front page content 2 the body content 3 the back page content The Dynamic Pagination and Flow feature gives you the ability to define multiple page layouts in a single flow.
PAGE 188
QUARKXPRESS SERVER FEATURES • full width spanned • full page - rotated / un-rotated. • The ability to format tables in the following various ways: • horizontal and vertical • gridlines • grouping headers • shading rows and columns • the inclusion of table notes with the table • The ability to break content across pages along with headers.
PAGE 189
QUARKXPRESS SERVER FEATURES • Back Page - a master page for the back page (a back cover) The pagination requirement is: 1 Cover 2 Introduction 3 Multiple sections • Section First Page • Section Content 4 Back Page Example User Pagination Requirement Previously, when a desktop user created this document, he accomplished this manually by dragging and dropping the desired master pages onto each page.
PAGE 190
QUARKXPRESS SERVER FEATURES Each PARAGRAPH object holds RICHTEXT giving you the ability to apply a wide variety of styling. 3 The SINGLEMASTERPAGEREFERENCE element defines a sequence in which a particular master page will be applied to a singles page in a page sequence. It contains the name of the master page in the QuarkXPress template to be used. The given master page is applied to one page of a page sequence. This is useful for front matter, back matter and section start pages.
PAGE 191
QUARKXPRESS SERVER FEATURES 6 The CONDITIONALMASTERPAGEREFERENCE element gives you the ability to specify the master page along with the conditions that must be satisfied to apply the given master page on a page.
PAGE 192
QUARKXPRESS SERVER FEATURES Landscape pagination The support for mixed orientation in the PDF output gives you the ability to define different page orientations in a single flow. This can be accomplished by using the PAGESEQUENCE element of the ModifierXML. The PAGESEQUENCE element contains a new attribute ORIENTATION which allows you to specifiy a page orientation for each page in the flow.
PAGE 193
QUARKXPRESS SERVER FEATURES Creating pages with the Landscape layout The following is an example of the MASTERPAGESEQUENCE to be used for Landscape mode. The following is an example of the PARAGRAPH element with the PARASTYLE attribute set to flow.
PAGE 194
QUARKXPRESS SERVER FEATURES Text here Flowing content onto pages created with the Landscape layout The following is an example of a PROJECT element. The landscape flow content under the PAGESEQUENCE that has ORIENTATION set to LANDSCAPE is flown into the flow boxes in the layout with the name Landscape.
PAGE 195
QUARKXPRESS SERVER FEATURES The landscape flow content under the PAGESEQUENCE that has ORIENTATION = LANDSCAPE is flown into the flow boxes in the layout with the name Landscape. The following is the resultant PDF from the above example: A PDF with a mixed orientation. Automatic callout stacking Automatic callout stacking allows for the tiling of multiple callouts. You use the CALLOUTANCHOR element to automate your layout design.
PAGE 196
QUARKXPRESS SERVER FEATURES Edit Callout Style dialog box Automatic callout stacking example In the following example the 2 graphic objects on the right side are related to the sub-sections on the left side. Example Automatic Callout Stacking The callout anchors applied with the same callout style will be stacked automatically. 196 | A GUIDE TO QUARKXPRESS SERVER 10.2.
PAGE 197
QUARKXPRESS SERVER FEATURES Result Automatic Callout Stacking Nested anchoring Nested anchoring allows you to anchor an item within another anchored item. This allows for nesting of INLINEBOX and INLINETABLE elements. Nested anchoring examples Nested anchoring examples Nesting an INLINEBOX within an ENTRY of an INLINETABLE An INLINEBOX within an ENTRY of anINLINETABLE A GUIDE TO QUARKXPRESS SERVER 10.2.
PAGE 198
QUARKXPRESS SERVER FEATURES Nesting an INLINETABLE within an INLINETABLE An INLINETABLE within an INLINETABLE An INLINETABLE within an INLINETABLE 198 | A GUIDE TO QUARKXPRESS SERVER 10.2.
PAGE 199
QUARKXPRESS SERVER FEATURES Nesting an INLINETABLE within an INLINEBOX An INLINETABLE within an INLINEBOX A GUIDE TO QUARKXPRESS SERVER 10.2.
PAGE 200
MODIFIER SCHEMA (ANNOTATED) Modifier schema (annotated) The topics below provide an annotated version of the Modifier schema, which is available both as a DTD and in XML Schema format. Details are provided for how to form XML code that uses the construct namespace, modify parameter, and xml namespace. The XML sent to or from these functions is case-sensitive and validated by the Modifier schema, thereby providing well-formed XML code that is compatible between each function.
PAGE 201
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct
PAGE 202
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct
PAGE 203
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct be inserted. See the INSERTPOSITION attribute. Not applicable. Specifies how many cells to Not applicable. add. INSERTPOSITION (AFTER Not applicable. | BEFORE) "AFTER" Specifies whether to add Not applicable. the new cells before or after the cell indicated in the BASEINDEX attribute. KEEPATTRIBUTE (true | Not applicable.
PAGE 204
MODIFIER SCHEMA (ANNOTATED) ALIGNVERSETTINGS (Modifier schema) Element type Construct Modify Deconstruct ALIGNVERSETTINGS (empty) Specifies vertical alignment Specifies vertical alignment Specifies vertical alignment settings for a callout. settings for a callout. settings for a callout. Attributes Indicates what a callout ALIGNRELATIVETO (ANCHOR | PARAGRAPH | should be aligned relative to. BOXCELL | PAGE | SPREAD) #IMPLIED Indicates what a callout should be aligned relative to.
PAGE 205
MODIFIER SCHEMA (ANNOTATED) ANCHOREDBOXREF (Modifier schema) Element type Construct Modify Deconstruct ANCHOREDBOXREF (#PCDATA) Specifies id of anchored box Specifies id of anchored box Specifies id of anchored box that is part of the story. that is part of the story. that is part of the story. Attributes ALIGNWITHTEXT (ASCENT Determines whether the top of the anchored box | BASELINE) will align with the top of "BASELINE" the text (ascent) or the bottom of the text (baseline).
PAGE 206
MODIFIER SCHEMA (ANNOTATED) ARTICLE (Modifier schema) Element type Construct Modify Deconstruct ARTICLE (ID, RGBCOLOR?, COMPONENT+) Describes an article (a series Describes an article (a series Describes an article (a series of one or more COMPONENT of one or more COMPONENT of one or more COMPONENT elements). elements). elements). New articles should not be created in a QuarkXPress project in systems working directly with QPS. Instead, create an article only within a QuarkCopyDesk® file.
PAGE 207
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct RESTARTNUMBERING (true | false) #IMPLIED Specifies whether Specifies whether Specifies whether renumbering should restart renumbering should restart renumbering should restart with this style. with this style. with this style. STARTAT CDATA #IMPLIED Specifies the first number for numbering. Specifies the first number for numbering. Specifies the first number for numbering.
PAGE 208
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct GAPSHADE CDATA #IMPLIED Specifies the shade of the gap (if any) between the lines that make up the grid line. Specifies the shade of the Not applicable. gap (if any) between the lines that make up the grid line. GAPOPACITY CDATA #IMPLIED Specifies the opacity of the gap (if any) between the lines that make up the grid line. Specifies the opacity of the Not applicable. gap (if any) between the lines that make up the grid line.
PAGE 209
MODIFIER SCHEMA (ANNOTATED) Element type OPACITY CDATA #IMPLIED Construct Modify Deconstruct specified as a float value from 0 to 100. specified as an integer percentage from 0 to 100. specified as an integer percentage from 0 to 100. Specifies the opacity of a box's background color, specified as a float value from 0 to 100. Specifies the opacity of a box's background color, specified as an integer percentage from 0 to 100.
PAGE 210
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct HLANCHORREF CDATA #IMPLIED Not applicable. Not applicable. If this box is a hyperlink of the HLTYPE ANCHOR, this attribute identifies the anchor by name. ADDTOREFLOW (true | false) #IMPLIED Not applicable. Not applicable. If true, adds this box to the project's reflow article. Equivalent to the Digital Publishing > Add to Reflow command in QuarkXPress. ARTICLENAME CDATA #IMPLIED Not applicable.
PAGE 211
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct BLENDANGLE CDATA #IMPLIED Specifies the angle of the blend. Specifies the angle of the blend. Not applicable. BLENDCOLOR CDATA #IMPLIED Specifies the second color of the blend. The first color of the blend is the color applied to the box. Specifies the second color Not applicable. of the blend. The first color of the blend is the color applied to the box.
PAGE 212
MODIFIER SCHEMA (ANNOTATED) CALLOUTANCHOR (Modifier schema) Element type Construct Modify Deconstruct CALLOUTANCHOR ((CALLOUTBOXREF? | INLINETABLE? | INLINEBOX?), ALIGNHORSETTINGS?, ALIGNVERSETTINGS?) Identifies a callout anchor. Identifies a callout anchor. Identifies a callout anchor. Attributes UID CDATA #IMPLIED Unique identifier for a callout anchor. Unique identifier for a callout anchor. Unique identifier for a callout anchor.
PAGE 213
MODIFIER SCHEMA (ANNOTATED) CALLOUTBOXREF (Modifier schema) Element type Construct Modify Deconstruct CALLOUTBOXREF (empty) Identifies an item or group Identifies an item or group Identifies an item or group as a callout. as a callout. as a callout. Attributes UID CDATA #IMPLIED Unique identifier for a callout box reference. Unique identifier for a callout box reference. Unique identifier for a callout box reference. NAME CDATA #IMPLIED Name for a callout box reference.
PAGE 214
MODIFIER SCHEMA (ANNOTATED) Element type Construct Specifies the type of blend BLENDSTYLE (SOLID | LINEAR | MIDLINEAR | applied to this cell (linear, RECTANGULAR | DIAMOND circular, rectangular, etc.). | CIRCULAR | FULLCIRCULAR | none) "none" Modify Deconstruct Specifies the type of blend applied to this cell (linear, circular, rectangular, etc.). Specifies the type of blend applied to this cell (linear, circular, rectangular, etc.). BLENDANGLE CDATA #IMPLIED Specifies the angle of the blend.
PAGE 215
MODIFIER SCHEMA (ANNOTATED) CHILDID (Modifier schema) Element type Construct Modify Deconstruct CHILDID (empty) Specifies a child of a parent Specifies a child of a parent Specifies a child of a parent TABLE element. TABLE element. TABLE element. Attributes NAME CDATA #IMPLIED Indicates the user-assigned Not applicable. name of the CHILD element of the parent table. Indicates the user-assigned name of the CHILD element of the parent table. UID CDATA #IMPLIED Not applicable.
PAGE 216
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct PICTUREBOUNDS. Moves the right edge of the clipping path by the specified number of points (positive=right, negative=left). PICTUREBOUNDS. Moves the right edge of the clipping path by the specified number of points (positive=right, negative=left). PICTUREBOUNDS. Moves the right edge of the clipping path by the specified number of points (positive=right, negative=left). Valid when CLIPPING@TYPE = ITEM or PICTUREBOUNDS.
PAGE 217
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct the smoothness, in points, the smoothness, in points, the smoothness, in points, of an automatically created of an automatically created of an automatically created clipping path. clipping path. clipping path. Valid when CLIPPING@TYPE = EMBEDDEDPATH, ALPHACHANNEL, or NONWHITEAREAS. Indicates that only the outer edges of the clipping path should be used. Valid when CLIPPING@TYPE = EMBEDDEDPATH, ALPHACHANNEL, or NONWHITEAREAS.
PAGE 218
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify row with the most columns. row with the most columns. Deconstruct COLUMN (Modifier schema) Element type Construct Modify Deconstruct COLUMN (LINE*) Describes a column in a table. Describes a column in a table. Describes a column in a table. COLUMNCOUNT CDATA #REQUIRED Specifies the index position of a column beginning from the left.
PAGE 219
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct AUTOFIT (true | false Specifies whether the rows Specifies whether the rows Indicates whether the rows or columns will adjust size or columns will adjust size or columns will adjust size | none) "none" to fit the content. to fit the content. to fit the content. AUTOFITMAXLIMIT CDATA Max limit for autofit. #IMPLIED Max limit for autofit. Max limit for autofit.
PAGE 220
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Title2 OrderedList UnorderedList Title2 OrderedList UnorderedList ROWNUM CDATA #IMPLIED If the component resides in If the component resides in If the component resides in a Table cell, the value will a Table cell, the value will a Table cell, the value will describe the row number. describe the row number. describe the row number.
PAGE 221
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct COLOR CDATA #IMPLIED Not applicable. Not applicable. Identifies a color applied to a Composition Zones item. Note: Only the name of a color is included in this attribute. The definition of the color is stored in the projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server, or an existing color created and saved in the project. SHADE CDATA #IMPLIED Not applicable. Not applicable.
PAGE 222
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct opacity of the color applied to the box. Not applicable. Not applicable. If true, specifies that the Composition Zones item is constrained only horizontally to the size of its composition layout. VERTICALBINDING (true Not applicable. | false) #IMPLIED Not applicable. If true, specifies that the Composition Zones item is constrained only vertically to the size of its composition layout.
PAGE 223
MODIFIER SCHEMA (ANNOTATED) CONTENT (Modifier schema) Element type Construct Modify Deconstruct CONTENT (#PCDATA) Specifies the path of an image or text file that you want to associate with the parent box. The CONTENT element also supports relative paths for images or text files. Specifies the path of an image or text file that you want to import into the parent box. Specifies the path of the image or text file (if any) associated with the parent box.
PAGE 224
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct do not specify this attribute in the CONTENT element. CONDITIONALSTYLE CDATA #IMPLIED Identifies the conditional style (if any) to be associated with the content specified in the CONTENT node. Identifies the conditional Not applicable. style (if any) to be associated with the content specified in the CONTENT node.
PAGE 225
MODIFIER SCHEMA (ANNOTATED) CONTINUEDTROWSTYLE (Modifier schema) Element type Construct Modify Deconstruct CONTINUEDTROWSTYLE (TOPGRID?, BOTTOMGRID?) Defines a style for "continued" rows in an . Defines a style for "continued" rows in an . Not applicable. Attributes PARASTYLE CDATA #IMPLIED Identifies the paragraph Identifies the paragraph Not applicable. style sheet for the row style. style sheet for the row style.
PAGE 226
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct POLYCONTOUR (true | false) "false" Specifies whether this is a Specifies whether this is a Specifies whether this is a polycontour (as opposed to polycontour (as opposed to polycontour (as opposed to a spline contour). a spline contour). a spline contour).
PAGE 227
MODIFIER SCHEMA (ANNOTATED) COPYRIGHT (Modifier schema) Element type Construct Modify Deconstruct COPYRIGHT (#PCDATA) Not applicable. Part of the Specifies copyright information for an e-book. element. Specifies copyright information for an e-book. DATAPROVIDER (Modifier schema) Element type Construct Modify Deconstruct DATAPROVIDER (empty) Not applicable. Not applicable. Provides information about the XTensions module through which interactivity is applied to a box.
PAGE 228
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct TYPE (ROW | COLUMN | HEADER | FOOTER) #REQUIRED Not applicable. Specifies whether to delete Not applicable. rows, columns, headers, or footers. BASEINDEX CDATA #REQUIRED Not applicable. Specifies the index number Not applicable. of the first cell to be deleted. DELETECOUNT CDATA #REQUIRED Not applicable. Specifies how many cells to Not applicable. delete.
PAGE 229
MODIFIER SCHEMA (ANNOTATED) ENTRY (Modifier schema) Element type Construct Describes a cell in an ENTRY (#PCDATA | RICHTEXT | PARAGRAPH . | CONTENT | PICTURE)* Modify Deconstruct Describes a cell in an . Not applicable. Attributes WIDTH CDATA #IMPLIED Specifies the width of the cell, either as an absolute measurement or as a percentage of the table width. To specify a percentage, use %. If you do not specify a width, cell widths are distributed evenly.
PAGE 230
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct COLOR CDATA #IMPLIED Specifies the background color of the column style. Specifies the background color of the column style. Not applicable. SHADE CDATA #IMPLIED Specifies the background Specifies the background Not applicable. shade of the column style. shade of the column style.
PAGE 231
MODIFIER SCHEMA (ANNOTATED) FIT (Modifier schema) Element type Construct Modify Deconstruct FIT (MAX, MIN) Lets you resize a box to fit its text or picture, within the limitations specified by the and elements. A box will expand or shrink only until it reaches the or size. Lets you resize a box to fit Not applicable. its text or picture, within the limitations specified by the and elements. A box will expand or shrink only until it reaches the or size.
PAGE 232
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct decremented until the text decremented until the text fits. fits. MAXFONTSIZE CDATA #IMPLIED Indicates the maximum font size that can be used for text fitting. The default value is the maximum text size allowed by QuarkXPress (3184 pt). Indicates the maximum Not applicable. font size that can be used for text fitting. The default value is the maximum text size allowed by QuarkXPress (3184 pt).
PAGE 233
MODIFIER SCHEMA (ANNOTATED) FOOTERTROWSTYLE (Modifier schema) Element type Construct Modify Deconstruct FOOTERTROWSTYLE (TOPGRID?, BOTTOMGRID?) Defines a style for footer rows in an . Defines a style for footer rows in an . Not applicable. Attributes PARASTYLE CDATA #IMPLIED Identifies the paragraph Identifies the paragraph Not applicable. style sheet for the row style. style sheet for the row style.
PAGE 234
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct FIRSTLINE CDATA #IMPLIED Describes the amount of space in a paragraphs first-line indent. Describes the amount of space in a paragraphs first-line indent. Describes the amount of space in a paragraphs first-line indent. LEADING CDATA #IMPLIED Describes a paragraphs line Describes a paragraphs line Describes a paragraphs line spacing. spacing. spacing.
PAGE 235
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct BACKGROUNDCOLOR CDATA Specifies a background color to be inserted behind #IMPLIED the text. This color displays only in rendered output, and is not saved with the project file. Specifies a background Not applicable. color to be inserted behind the text. This color displays only in rendered output, and is not saved with the project file. Specifies the opacity of a background color to be inserted behind the text.
PAGE 236
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server. projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server, or an existing color created and saved in the project. projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server.
PAGE 237
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct SH_NONE = Available to define in XDK API SH_NONE = Available to define in XDK API SH_NONE = Available to define in XDK API SH_ORTHPOLYLINE = Can be defined in XDK SH_ORTHPOLYLINE = Can be defined in XDK SH_ORTHPOLYLINE = Can be defined in XDK SH_SPLINELINE = Freehand SH_SPLINELINE = Freehand SH_SPLINELINE = Freehand line line line SH_ORTHPOLYBOX = Available SH_ORTHPOLYBOX = Available SH_ORTHPOLYBOX = Available to define in XDK
PAGE 238
MODIFIER SCHEMA (ANNOTATED) GRID (Modifier schema) Element type Construct Modify Deconstruct GRID (GRIDLINE) Element used for specifying Element used for specifying Element used for specifying a grid in a table. a grid in a table. a grid in a table. Attributes TYPE (HGRID | VGRID | Not applicable. ALLGRID) #IMPLIED Attribute used for selecting a horizontal or vertical grid (or both). Not applicable.
PAGE 239
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct GAPOPACITY CDATA #IMPLIED Specifies the opacity of the gap color of a line, specified as an integer percentage from 0 to 100. Specifies the opacity of the gap color of a line, specified as an integer percentage from 0 to 100. Specifies the opacity of the gap color of a line, specified as an integer percentage from 0 to 100.
PAGE 240
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct SCALEDIRECTION (HORIZONTAL | VERTICAL) #IMPLIED Specifies the direction in which text is scaled. Works only when the story direction is vertical. Specifies the direction in which text is scaled. Works only when the story direction is vertical. Specifies the direction in which text is scaled. Works only when the story direction is vertical. SCALEAMOUNT CDATA #IMPLIED Specifies the scaling percentage.
PAGE 241
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Attributes HEADERROWS CDATA #IMPLIED Specifies number of header Specifies number of header Specifies number of header row. row. row. HEADTROWSTYLE (Modifier schema) Element type Construct Modify Deconstruct HEADTROWSTYLE (TOPGRID?, BOTTOMGRID?) Defines a style for header rows in an . Defines a style for header rows in an . Not applicable.
PAGE 242
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct hidden text within the project. hidden text within the project. hidden text within the project. Not applicable. Not applicable. Number of characters the hidden text spans.
PAGE 243
MODIFIER SCHEMA (ANNOTATED) HYPERLINK (Modifier schema) Element type Construct Modify Deconstruct HYPERLINK (empty) Not applicable. Not applicable. Defines a hyperlink. NAME CDATA #IMPLIED Not applicable. Not applicable. The name of the hyperlink. TARGET CDATA #REQUIRED Not applicable. Not applicable. The name of the hyperlink target. HLTYPE (WWWURL | PAGE Not applicable. | ANCHOR) #REQUIRED Not applicable. Specifies the type of hyperlink.
PAGE 244
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct automatically assigns a UID to such elements. Ignored for spreads and pages. UID CDATA #IMPLIED The unique ID of the Required for PAGE and SPREAD elements. Ignored element to be modified. for all other element types. Specifies the unique ID of an element in the QuarkXPress project. INLINEBOX (Modifier schema) Element type Construct Modify Deconstruct Lets you create an anchored Lets you create an anchored Not applicable.
PAGE 245
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct picture is not resized. In both cases, the height of the box is adjusted to match the height of the picture. picture is not resized. In both cases, the height of the box is adjusted to match the height of the picture. ALIGNWITHTEXT (ASCENT Specifies whether the anchored box is aligned | BASELINE) with the ascent or the "BASELINE" baseline of the line in which it occurs.
PAGE 246
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct STATUS (BEGIN | END) #IMPLIED If BEGIN, this is the beginning of an insertion. If END, this is the end of an insertion. If BEGIN, this is the beginning of an insertion. If END, this is the end of an insertion. If BEGIN, this is the beginning of an insertion. If END, this is the end of an insertion.
PAGE 247
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct OWNERXTID CDATA #IMPLIED Identifies the XTensions module that enables this type of interactivity. Identifies the XTensions module that enables this type of interactivity. Identifies the XTensions module that enables this type of interactivity. Identifies the type of interactivity. Identifies the type of interactivity. Deconstruct TYPE CDATA #IMPLIED Identifies the type of interactivity.
PAGE 248
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct comma-separated list of keywords for an e-book. LASTTCOLSTYLE (Modifier schema) Element type Construct Modify Deconstruct LASTTCOLSTYLE (LEFTGRID?, RIGHTGRID?) Defines a style for the last column in an . Defines a style for the last column in an . Not applicable. WIDTH CDATA #IMPLIED Specifies the width of the column style. Specifies the width of the column style. Not applicable.
PAGE 249
MODIFIER SCHEMA (ANNOTATED) Element type Construct LOCKED (true | false | none) "none" Specifies whether a layer is Specifies whether a layer is Specifies whether a layer is locked. locked. locked. Note: In QuarkXPress, this parameter overrides the Locked setting in the Layers pane of the Preferences dialog box (QuarkXPress/Edit menu).
PAGE 250
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct REFLOWVIEWLAYOUTUID CDATA #IMPLIED Not applicable. Not applicable. Specifies the UID of the Print layout for this Reflow layout. This attribute is valid only for reflow views for Print layouts. LAYOUTHIDDEN (true | false) #IMPLIED Not applicable. Not applicable. If true, the layout is hidden. If false, the layout is visible. REFLOWVIEWLAYOUT (true | false) #IMPLIED Not applicable. Not applicable.
PAGE 251
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct LAYOUTREF (Modifier schema) Element type Construct Modify Deconstruct LAYOUTREF (ID) Not applicable. Not applicable. Identifies a layout that is a member of a layout family (a PUBLICATIONCHANNEL). Not applicable. Not applicable. Identifies the orientation of the layout.
PAGE 252
MODIFIER SCHEMA (ANNOTATED) LEFTGRID (Modifier schema) Element type Construct Modify Deconstruct LEFTGRID (empty) Describes a grid line on the Describes a grid line on the Not applicable. left edge of a cell in an left edge of a cell in an . . Attributes TYPE (TOP | LEFT | BOTTOM | RIGHT) #IMPLIED Specifies the location of the Specifies the location of the Not applicable. grid line. grid line. STYLE CDATA #IMPLIED Identifies the that styles this grid line.
PAGE 253
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct ARROWHEADS (PLAINLINE | LEFTARROW | RIGHTARROW | LEFTFARROW | RIGHTFARROW | DOUBLEARROW) "PLAINLINE" Specifies whether a line should have arrows on its ends: Specifies whether a line should have arrows on its ends: Specifies whether a line has arrows on its ends: PLAINLINE = No PLAINLINE = No arrows arrows LEFTARROW = Arrow head on left end LEFTARROW = Arrow head on left end LEFTARROW = Arrow head on left end PLAINLINE = N
PAGE 254
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct ROWCOUNT CDATA #IMPLIED If a LINKEDBOX is a table cell, this attribute identifies the row of the cell. Otherwise, not applicable. If a LINKEDBOX is a table cell, this attribute identifies the row of the cell. Otherwise, not applicable. If a LINKEDBOX is a table cell, this attribute identifies the row of the cell. Otherwise, not applicable.
PAGE 255
MODIFIER SCHEMA (ANNOTATED) LOCKTOGRID (Modifier schema) Element type Construct Modify Deconstruct LOCKTOGRID (empty) Specifies whether this paragraph is locked to the baseline grid. You can choose to lock to the page grid or the text box grid. Specifies whether this paragraph is locked to the baseline grid. You can choose to lock to the page grid or the text box grid. Specifies whether this paragraph is locked to the baseline grid. You can choose to lock to the page grid or the text box grid.
PAGE 256
MODIFIER SCHEMA (ANNOTATED) METADATA (Modifier schema) Element type Construct Modify Deconstruct METADATA (VALUE+) Specifies if the box will have metadata associated with it. Metadata takes the form of key/value pairs. Specifies if the box will Describes the metadata have metadata associated associated with the box. with it. Metadata takes the form of key/value pairs.
PAGE 257
MODIFIER SCHEMA (ANNOTATED) MOVEUP (Modifier schema) Element type Construct Modify Deconstruct MOVEUP (#PCDATA) Not applicable. Moves a box up by the Not applicable. specified number of points. Note: You can move a box or line onto another page. NOTE (Modifier schema) Element type Construct Modify Deconstruct NOTE (#PCDATA) Describes a note in text. Describes a note in text. Describes a note in text. CREATEDBY CDATA #IMPLIED Not applicable. Not applicable.
PAGE 258
MODIFIER SCHEMA (ANNOTATED) ODDTCOLSTYLE (Modifier schema) Element type Construct Modify Deconstruct ODDTCOLSTYLE (LEFTGRID?, RIGHTGRID?) Defines a style for odd columns in an . Defines a style for odd columns in an . Not applicable. WIDTH CDATA #IMPLIED Specifies the width of the column style. Specifies the width of the column style. Not applicable. COLOR CDATA #IMPLIED Specifies the background color of the column style.
PAGE 259
MODIFIER SCHEMA (ANNOTATED) PAGE (Modifier schema) Element type Construct Modify Deconstruct PAGE (ID, SECTION?) A page to be created. The page to be created or deleted. Indicates a page's absolute page number (in the ID@UID element) Note: To locate a page, for example, for creating a box, Note: Page names are not you use the returned. GEOMETRY@PAGE attribute in the BOX element. Attributes OPERATION (CREATE | DELETE) #IMPLIED Not applicable.
PAGE 260
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct BLANKPAGE (YES | NO) "NO" Indicates whether to insert a blank page between this page and the next page. Applicable only if this page and the next page are both recto or both verso. Indicates whether to insert Not applicable. a blank page between this page and the next page. Applicable only if this page and the next page are both recto or both verso.
PAGE 261
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct chapter, article etc. @MASTERREFERENCE allows you to refer to MASTERPAGESEQUENCE or a master page in template. (SECTIONNUMBERFORMAT | STATICCONTENT | STORY )) Attributes MASTERREFERENCE Not applicable. Unique name of the MASTERPAGESEQUENCE. Not applicable. FORCEPAGECOUNT Not applicable. Imposes a condition on the Not applicable. number of pages in a PAGESEQUENCE.
PAGE 262
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct If the value is set to LANDSCAPE, the project template must already contain a layout with the name Landscape, because the content of the page sequence will flow into a landscape layout made available in the template. If the value is set to LANDSCAPE, this would result in a mixed mode PDF output. PARAGRAPH (Modifier schema) Element type Construct Modify Deconstruct Describes a paragraph. Describes a paragraph.
PAGE 263
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct face that is constructed by software, as opposed to a bold font). CONDITIONALSTYLE CDATA #IMPLIED Applies a conditional style Applies a conditional style Identifies the conditional to this paragraph. to this paragraph. style (if any) associated with this paragraph. INDENTLEVEL CDATA #IMPLIED Sets the indent level for this Sets the indent level for this Indicates the indent level paragraph. paragraph. of this paragraph.
PAGE 264
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct FIT (CENTERPICTURE | FITPICTURETOBOX | FITBOXTOPICTURE | FITPICTURETOBOXPRO | NONE) "NONE" Specifies how a picture should fit within a picture box. Specifies how a picture should fit within a picture box. Not applicable. CENTERPICTURE = Shifts a picture to the center of the picture box without changing the pictures scale. CENTERPICTURE = Shifts a picture to the center of the picture box without changing the pictures scale.
PAGE 265
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Note: Only the name of a color is included in this attribute. The definition of the color is stored in the projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server. Note: Only the name of a color is included in this attribute.
PAGE 266
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct DPI CDATA #IMPLIED Not applicable. Not applicable. Indicates the picture resolution in dots per inch (DPI). Modify Deconstruct Not applicable. Describes a placeholder inserted in QuarkXPress for use with XML Import XTensions software. PLACEHOLDER (Modifier schema) Element type Construct PLACEHOLDER (#PCDATA) Not applicable.
PAGE 267
MODIFIER SCHEMA (ANNOTATED) PROJECT (Modifier schema) Element type Construct Modify Deconstruct PROJECT (SAVEAS? | PUBLICATION* | HYPERLINK* | TABLESTYLE* | LAYOUT* | STORY* | CONTENT*)* Describes the QuarkXPress project using one or more LAYOUT elements and allows you to save a copy of the project. Identifies the QuarkXPress Identifies the QuarkXPress project being modified and project being allows you to save a copy deconstructed. of that project.
PAGE 268
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct PUBLICATION may contain a PUBLICATIONCHANNEL for iPad and another PUBLICATIONCHANNEL for a different target device. PUBLICATIONCHANNEL (Modifier schema) Element type Construct Modify Deconstruct PUBLICATIONCHANNEL (ID, LAYOUTREF*) Not applicable. Not applicable. Defines a layout family — that is, a set of related layouts (LAYOUTREFs). HEIGHT CDATA #IMPLIED Not applicable. Not applicable.
PAGE 269
MODIFIER SCHEMA (ANNOTATED) REPEATABLEMASTERPAGEALTERNATIVES (Modifier schema) Element type Construct REPEATABLEMASTERPAGEALTERNATIVES Not applicable. (MAXREPEATS (CONDITIONALMASTERPAGEREFERENCE )*) Modify Deconstruct This sub-sequence is useful for the Not conditional application of master pages. applicable. The children of the REPEATABLEMASTERPAGEALTERNATIVES element are known as alternatives. Each alternative is represented by a CONDITIONALMASTERPAGEREFERENCE element.
PAGE 270
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct RED CDATA #IMPLIED An integer from 0 to 255, indicating the red component of an RGB color. An integer from 0 to 255, indicating the red component of an RGB color. An integer from 0 to 255, indicating the red component of an RGB color. GREEN CDATA #IMPLIED An integer from 0 to 255, indicating the green component of an RGB color. An integer from 0 to 255, indicating the green component of an RGB color.
PAGE 271
MODIFIER SCHEMA (ANNOTATED) Element type Construct ITALIC (true | false | none) "none" Applies the italic type style Applies the italic type style Identifies the italic type to text. to text. style applied to text. FONT CDATA #IMPLIED Identifies a font to be applied to text. Identifies a font to be applied to text. Identifies a font applied to text. MISSINGFONT (true | false) "false" If the font is missing on rendering, then this attribute is set to true.
PAGE 272
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct attribute. The definition of the color is stored in the projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server. attribute. The definition of the color is stored in the projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server, or an existing color created and saved in the project. attribute.
PAGE 273
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Shifts text up or down without affecting paragraph line spacing. A positive value raises text; a negative value lowers text. Shifts text up or down without affecting paragraph line spacing. A positive value raises text; a negative value lowers text. Identifies a shift of text up or down without affecting paragraph line spacing. A positive value raises text; a negative value lowers text.
PAGE 274
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct OT_SMALL_CAPS (true | Applies the OpenType false | none) "none" small caps type style to text. Applies the OpenType small caps type style to text. Identifies the OpenType small caps type style applied to text. OT_CONTEXTUAL_ALTERNATIVES Applies the OpenType (true | false | none) contextual alternates type style to text. "none" Applies the OpenType contextual alternates type style to text.
PAGE 275
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct OT_HVKANA_ALTERNATES Apply specially designed (true | false | none) horizontal or vertical Kana forms that correspond with "none" the story direction (vertical or horizontal). Apply specially designed horizontal or vertical Kana forms that correspond with the story direction (vertical or horizontal). Apply specially designed horizontal or vertical Kana forms that correspond with the story direction (vertical or horizontal).
PAGE 276
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct OT_ALTERNATE_HALF_METRICS Fit full-em height glyphs to Fit full-em height glyphs to Fit full-em height glyphs to half-em heights. half-em heights. (true | false | none) half-em heights. "none" Alternate glyph forms, such as JIS2004, JIS78, JIS90, Simplified, and Traditional. These glyph forms are specially designed for some OT_JIS83FORMS (true | Japanese OpenType fonts.
PAGE 277
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct APPLYSENDINGTONONCJK Describes whether sending (true | false | none) should be applied to both Roman and "none" Chinese/Japanese/Korean glyphs (true) or just to Chinese, Japanese, and Korean Glyphs (false). Describes whether sending should be applied to both Roman and Chinese/Japanese/Korean glyphs (true) or just to Chinese, Japanese, and Korean Glyphs (false).
PAGE 278
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify number. For more information, see "Working with sections." number. For more information, see "Working with sections." Not applicable. Not applicable. Specifies that this element is a hyperlink by referring to a HYPERLINK. HLTYPE (WWWURL | PAGE Not applicable. | ANCHOR) #IMPLIED Not applicable. Specifies the type of hyperlink this element hyperlinks to.
PAGE 279
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct information on drawing and manipulating bezier curves, please see A Guide to QuarkXPress. information on drawing and manipulating bezier curves, please see A Guide to QuarkXPress. information on drawing and manipulating bezier curves, please see A Guide to QuarkXPress. X CDATA #IMPLIED X coordinate of RIGHTCONTROLPOINT. X coordinate of RIGHTCONTROLPOINT. X coordinate of RIGHTCONTROLPOINT.
PAGE 280
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct GAPOPACITY CDATA #IMPLIED Specifies the opacity of the gap (if any) between the lines that make up the grid line. Specifies the opacity of the Not applicable. gap (if any) between the lines that make up the grid line. ROW (Modifier schema) Element type Construct Modify Deconstruct ROW ((CELL | GRIDLINE)*) Describes a row in a table. Describes a row in a table. Describes a row in a table.
PAGE 281
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct an integer percentage from an integer percentage from an integer percentage from 0 to 100. 0 to 100. 0 to 100. OPACITY CDATA #IMPLIED Specifies the opacity of the color applied to a row, specified as an integer percentage from 0 to 100. Specifies the opacity of the color applied to a row, specified as an integer percentage from 0 to 100.
PAGE 282
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct ALIGNMENT (LEFT | TOP | CENTERED | RIGHT | BOTTOM | JUSTIFIED | FORCED | ONETOONE | EQUALSPACE | ONERUBISPACE) "CENTERED" Controls how non-overhanging rubi text aligns with the base text. For more information, see "Rubi alignment options" in the QuarkXPress documentation. Controls how non-overhanging rubi text aligns with the base text. For more information, see "Rubi alignment options" in the QuarkXPress documentation.
PAGE 283
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct ENABLED (true | false Specifies whether to add a Specifies whether to add a Specifies whether a rule is rule to a paragraph or not. rule to a paragraph or not. applied to a paragraph or | none) "none" not. POSITION (ABOVE | BELOW) "BELOW" Specifies whether a rule Specifies whether a rule Specifies whether a rule is should be above or below a should be above or below a above or below a paragraph. paragraph. paragraph.
PAGE 284
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct SHADE CDATA #IMPLIED Specifies the shade of a rules color, as an integer percentage from 0 to 100. Specifies the shade of a rules color, as an integer percentage from 0 to 100. Specifies the shade of a rules color, as an integer percentage from 0 to 100. OPACITY CDATA #IMPLIED Specifies the opacity of a rules color, specified as an integer percentage from 0 to 100.
PAGE 285
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct SAMEASCLIPPING = Text runs around the pictures clipping path, if any. SAMEASCLIPPING = Text runs around the pictures clipping path, if any. SAMEASCLIPPING = Text runs around the pictures clipping path, if any. AUTOIMAGE = Text runs around a clipping path created based on the dark and light areas in the picture file. See the THRESHOLD attribute.
PAGE 286
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct NOISE CDATA #IMPLIED Valid when RUNAROUND@TYPE=AUTOIMAGE, ALPHACHANNEL, or NONWHITEAREAS. Specifies that areas smaller than this number of points should be ignored when creating a runaround path. Valid when RUNAROUND@TYPE=AUTOIMAGE, ALPHACHANNEL, or NONWHITEAREAS. Specifies that areas smaller than this number of points should be ignored when creating a runaround path.
PAGE 287
MODIFIER SCHEMA (ANNOTATED) SAVEAS (Modifier schema) Element type Construct Modify Deconstruct SAVEAS (empty) Lets you save a constructed QuarkXPress project to a specific location on the server computer. Roughly equivalent to choosing File > Save As in QuarkXPress. Lets you save a modified QuarkXPress project to a specific location on the server computer. Roughly equivalent to choosing File > Save As in QuarkXPress. Not applicable.
PAGE 288
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct X CDATA #REQUIRED The largest or smallest allowable width for the resized box, as an integer percentage. The largest or smallest allowable width for the resized box, as an integer percentage. Not applicable. Y CDATA #REQUIRED The largest or smallest allowable height for the resized box, as an integer percentage. The largest or smallest allowable height for the resized box, as an integer percentage. Not applicable.
PAGE 289
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct INITIALPAGENUMBER Not applicable. Fixes the page number for Not applicable. the first page of the PAGESEQUENCE to which it applies. SHADOW (Modifier schema) Element type Construct Modify Deconstruct SHADOW (empty) Describes an automatic drop shadow. Describes an automatic drop shadow. Describes an automatic drop shadow. COLOR CDATA #REQUIRED Identifies the color of a drop shadow. Identifies the color of a drop shadow.
PAGE 290
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct values are from 10 to 1000 values are from 10 to 1000 values are from 10 to 1000 percent. percent. percent. BLUR CDATA #REQUIRED Specifies the blur distance for a drop shadow, from 0 to 144 points, with higher values creating blurrier edges. Specifies the blur distance for a drop shadow, from 0 to 144 points, with higher values creating blurrier edges.
PAGE 291
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct or opacities of the item, such as differences in opacity between the box background and frame. or opacities of the item, such as differences in opacity between the box background and frame. or opacities of the item, such as differences in opacity between the box background and frame. Deconstruct SHRINKACROSS (Modifier schema) Element type Construct Modify SHRINKACROSS (#PCDATA) Not applicable.
PAGE 292
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify of a box for a fit-box-to-content operation. of a box for a fit-box-to-content operation. Deconstruct Attributes WIDTH CDATA #REQUIRED The largest or smallest allowable width for the resized box. The largest or smallest allowable width for the resized box. Not applicable. The largest or smallest allowable height for the resized box. The largest or smallest allowable height for the resized box. Not applicable.
PAGE 293
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct NEWFORMAT (true | false) "false" Specifies whether incompatible with "old" (3.31 and below) shapes. Specifies whether incompatible with "old" (3.31 and below) shapes. Specifies whether incompatible with "old" (3.31 and below) shapes. MORETHANONETOPLEVELCONTOUR Specifies whether there is more than one top-level (true | false) contour. "false" Specifies whether there is more than one top-level contour.
PAGE 294
MODIFIER SCHEMA (ANNOTATED) STATICCONTENT (Modifier schema) Element type Construct Modify Deconstruct STATICCONTENT (BOX*) Not Applicable. Enables you to specify content chunks that are intended to be repeated across multiple flow page (i.e. running headers and footers). Not Applicable. STORY (Modifier schema) Element type Construct Describes a text story in a STORY (COPYFIT?, text box or a chain of text FITTEXT?,(PARAGRAPH boxes.
PAGE 295
MODIFIER SCHEMA (ANNOTATED) Element type Construct Adds any style sheets in an INCLUDESTYLESHEETS (true | false) "true" imported text file or document to the QuarkXPress project. Modify Deconstruct Adds any style sheets in an imported text file or document to the QuarkXPress project. Not applicable. STORYDIRECTION (HORIZONTAL | VERTICAL) #IMPLIED Specified direction of this story. Specified direction of this story. Specified direction of this story.
PAGE 296
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct ALIGNON CDATA #IMPLIED> Specifies a specific character Specifies a specific character Specifies a specific character to align a tab stop on. to align a tab stop on. a tab stop is aligned on.
PAGE 297
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct an integer percentage from an integer percentage from an integer percentage from 0 to 100. 0 to 100. 0 to 100. Specifies the opacity of the color applied to a table, specified as an integer percentage from 0 to 100. Specifies the opacity of the color applied to a table, specified as an integer percentage from 0 to 100. Specifies the opacity of the color applied to a table, specified as an integer percentage from 0 to 100.
PAGE 298
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct which this table is being added as a component). If no reflow article exists and you do not include this attribute, the default reflow article name is used. TABLEBREAK (Modifier schema) Element type Construct Modify Deconstruct Sets a table break for a Sets a table break for a TABLEBREAK (CHILDID | Sets a table break for a HEADER or FOOTER or both. HEADER or FOOTER or both. HEADER or FOOTER or both.
PAGE 299
MODIFIER SCHEMA (ANNOTATED) TABSPEC (Modifier schema) Element type Construct Modify Deconstruct TABSPEC (TAB)+ Describes a group of tab stops. Describes a group of tab stops. Describes a group of tab stops. Modify Deconstruct TBODY (Modifier schema) Element type Construct TBODY (TROW+) Identifies the body portion Identifies the body portion Not applicable. of an . of an .
PAGE 300
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct WIDTH CDATA #IMPLIED Specifies the width of the column style. Specifies the width of the column style. Not applicable. COLOR CDATA #IMPLIED Specifies the background color of the column style. Specifies the background color of the column style. Not applicable. SHADE CDATA #IMPLIED Specifies the background Specifies the background Not applicable. shade of the column style. shade of the column style.
PAGE 301
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Specifies the minimum FIRSTBASELINEMIN (ASCENT | CAPHEIGHT | distance between the top edge of a text box and the CAPACCENT | none) baseline of the first line of "none" text. Specifies the minimum distance between the top edge of a text box and the baseline of the first line of text. Indicates the minimum distance between the top edge of a text box and the baseline of the first line of text.
PAGE 302
MODIFIER SCHEMA (ANNOTATED) TEXTATTRIBUTE (Modifier schema) Element type Construct Modify Deconstruct TEXTATTRIBUTE (empty) Specifies the text-related attributes of a box created with the INLINEBOX element type. Specifies the text-related attributes of a box created with the INLINEBOX element type. Not applicable. COLUMNS NMTOKEN #IMPLIED Specifies the number of columns in a text box. Specifies the number of columns in a text box. Not applicable.
PAGE 303
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct OVERMATTER)*, METADATA?) Attributes NAME CDATA #REQUIRED The name of the text node The name of the text node The name of the text node placeholder. placeholder. placeholder. OWNER (1347639377) "1347639377" The XTensions ID of the XTensions that created this placeholder. The default XT ID is PlaceHolderSXT ID (1347639377). All placeholders created through Modifier should use this ID.
PAGE 304
MODIFIER SCHEMA (ANNOTATED) TOPGRID (Modifier schema) Element type Construct Modify Deconstruct TOPGRID (empty) Describes a grid line on the Describes a grid line on the Not applicable. top edge of a cell in an top edge of a cell in an . . Attributes TYPE (TOP | LEFT | BOTTOM | RIGHT) #IMPLIED Specifies the location of the Specifies the location of the Not applicable. grid line. grid line. STYLE CDATA #IMPLIED Identifies the that styles this grid line.
PAGE 305
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct COLOR CDATA #IMPLIED Identifies the background color of the cells in the . Identifies the background color of the cells in the . Not applicable. SHADE CDATA #IMPLIED Identifies the background shade of the cells in the . Identifies the background shade of the cells in the . Not applicable.
PAGE 306
MODIFIER SCHEMA (ANNOTATED) VALUE (Modifier schema) Element type Construct Modify Deconstruct VALUE (#PCDATA) Specifies the VALUE of the key/value pair. The value can be given in CDATA form only, such as: Specifies the VALUE of the key/value pair. The value can be given in CDATA form only, such as: Specifies the VALUE of the key/value pair.
PAGE 307
MODIFIER SCHEMA (ANNOTATED) VERTEXPOINT (Modifier schema) Element type Construct Modify Deconstruct VERTEXPOINT (empty) Each point on a curve is described by three geometric positions: the x,y coordinate of the vertex point (this coordinate is relative to the bounding geometry of the shape, not the page), and the left and right control handles–as you would see onscreen in the QuarkXPress user environment.
PAGE 308
USING SSL Using SSL You can configure QuarkXPress Server with different security options. In addition to your own network security specifications, you can specify Secure Sockets Layer (SSL) protocol for client applications. Secure Sockets Layer (SSL) support You can configure Tomcat (and therefore all QuarkXPress Server clients) to run in secure mode with Secure Sockets Layer (SSL) technology. This section explains the configuration process.
PAGE 309
USING SSL 5 Replace 61399 with 61400 (or any port on which Tomcat will be listening for secure connections). 6 Save and close "server.xml." 7 Open the "ServerApp.properties" file (in the "conf" folder) and enter the port number from step 5 for qxpswebserver.port. This change means QuarkXPress Server client applications can use HTTPS. For example, the URL for a QuarkXPress Server user would be as follows: https://[server name]:[port]/.
PAGE 310
QUARKXPRESS SERVER XTENSIONS SOFTWARE QuarkXPress Server XTensions software Just as XTensions software provides additional functionality to QuarkXPress, XTensions software enables QuarkXPress Server to do things it can't do by default.
PAGE 311
QUARKXPRESS SERVER XTENSIONS SOFTWARE You cannot export an article from a QuarkXPress project unless the article has been created and named in QuarkXPress using CopyDeskArticleXT XTensions software. To export an article in a particular format, use the format parameter. • To export a standard article, use format=fullfeatured. • To export an article in lightweight mode, use format=lightweight.This format can be useful in situations where file size is an issue.
PAGE 312
QUARKXPRESS SERVER XTENSIONS SOFTWARE For more information, see "Using QuarkXPress Server." PDF Filter XTensions software PDF Filter XTensions software allows QuarkXPress Server to render a QuarkXPress project as a PDF file.
PAGE 313
QUARKXPRESS SERVER XTENSIONS SOFTWARE To use Modifier XTensions software, a client creates an XML file indicating the actions to be taken and sends that XML file to the QuarkXPress Server application, where Modifier XTensions software reads the XML and makes the requested changes. Clients can use a single XML file or string to manipulate multiple documents and boxes. For more specific information about Modifier XTensions software, and for the Modifier DTD, see "Using QuarkXPress Server.
PAGE 314
QUARKXPRESS SERVER XTENSIONS SOFTWARE Layer XTensions software You can use QuarkXPress Server Layer XTensions software to control the visibility of specific layers in a rendered QuarkXPress project. You can also add layers, delete layers, edit layer attributes, and control whether layers are rendered. When you use the getdocinfo namespace, QuarkXPress Server returns information about items on all of the layers in the QuarkXPress project, including layers that are not visible.
PAGE 315
QUARKXPRESS SERVER XTENSIONS SOFTWARE If the modify request is sent to the server and each PAGESEQUENCE in the ModifyXML has its own SECTIONNUMBERFORMAT, creating sections, and the URL parameter contains convertsectionstopagestacks=true, the digital issue navigation would be as follows: If the URL parameter contains convertsectionstopagestacks=false, the digital issue navigation would be as follows: By default, convertsectionstopagestacks is false. A GUIDE TO QUARKXPRESS SERVER 10.2.
PAGE 316
TELEGRAPH XTENSIONS SOFTWARE Telegraph XTensions software Unlike the other XTensions software described in this guide, Telegraph XTensions software works with QuarkXPress, rather than with QuarkXPress Server. You can use Telegraph XTensions software to create QuarkXPress projects that can serve as templates in QuarkXPress Server.
PAGE 317
TELEGRAPH XTENSIONS SOFTWARE For information on adding a server, see "Adding a server." To edit the properties of a server in the Server list, select the server name and then click Edit. To remove a server from the Server Setup list, select the server and then click Remove. To allow projects checked in from this copy of QuarkXPress to remain open on the server after it has been served, check Allow Document to Stay Open.
PAGE 318
TELEGRAPH XTENSIONS SOFTWARE 5 Enter the server's name or IP address in the Address field. 6 Enter the server's port number in the Port field. The default port number is 8080. Valid values are from 1 to 65535. 7 In the Document Pool Path field, enter the path to the document pool directory on the server, or to a subdirectory within the document pool.
PAGE 319
TELEGRAPH XTENSIONS SOFTWARE To make sure that all named boxes display in the Box Identifiers palette, click Populate Named Boxes . Each QuarkXPress item also has an identification number that you can use when you want to render individual project items in QuarkXPress Server. The number displays in the Box ID field in the upper right corner of the palette. In a chain of text boxes, all boxes use the same Box Name. However, each box has a unique Box ID number.
PAGE 320
TELEGRAPH XTENSIONS SOFTWARE This feature does not upload assets that are used in App Studio AVE interactivity. You must upload such assets manually. To upload the active project: 1 Choose Utilities > Upload Template. The Upload Template dialog box displays. If you have edited the project since you last saved it, QuarkXPress prompts you to save the project. Upload Template dialog box 2 Choose a server from the Server drop-down menu.
PAGE 321
TELEGRAPH XTENSIONS SOFTWARE If picture files are missing or have been modified since they were imported into the project, an alert displays. For more information about missing or modified picture files, see "Uploading missing or modified pictures." 9 Click OK. If you check Fonts, an alert reminds you of possible restrictions regarding copying font software.
PAGE 322
QUARKXPRESS SERVER MANAGER QuarkXPress Server Manager QuarkXPress Server Manager is a server application that efficiently routes rendering requests in an environment that uses one or more QuarkXPress Server applications. QuarkXPress Server Manager uses load-balancing methods to determine which server in the QuarkXPress Server pool can best process a document request, and uses caching to improve speed and efficiency.
PAGE 323
QUARKXPRESS SERVER MANAGER Request Size 2 1MB 3 2MB • Random Load Balancer: Each rendering request is sent to a random server. • Round-robin Load Balancer: Requests are sent to servers in a set order.
PAGE 324
QUARKXPRESS SERVER MANAGER For information about setting a request timeout interval, see "Using other global settings." If a client request fails despite being sent to multiple QuarkXPress Server instances, QuarkXPress Server sends the end user a customizable error message or exception so that the end user can appropriately handle the failure.
PAGE 325
QUARKXPRESS SERVER MANAGER Caching To increase speed and efficiency, QuarkXPress Server Manager caches information in memory. If the response to a render request, URL request, or file request is included in the QuarkXPress Server Manager memory cache, QuarkXPress Server Manager returns the response from the disk cache instead of sending the request to a QuarkXPress Server instance.
PAGE 326
QUARKXPRESS SERVER MANAGER Starting QuarkXPress Server Manager Each QuarkXPress Server Manager server can handle multiple QuarkXPress Server instances. QuarkXPress Server Manager diagram Starting the Manager server application To launch the QuarkXPress Server Manager server application: • Mac OS: Open the QuarkXPress Server Manager/Server folder inside the applications folder and double-click "QXPSMServerStart.command.
PAGE 327
QUARKXPRESS SERVER MANAGER The QuarkXPress Server Manager Web client Request handler binding When you add a QuarkXPress Server instance to QuarkXPress Server Manager, you can choose to bind that server instance to particular rendering type or request type. When QuarkXPress Server Manager receives a matching request, it will send the request to only those server instances that are bound to that rendering type or request type.
PAGE 328
QUARKXPRESS SERVER MANAGER Manage Servers pane To configure an individual QuarkXPress Server instance, click Manage under the icon for that instance. The QuarkXPress Server Web interface for that instance displays. Adding and enabling a QuarkXPress Server instance When you add and enable a QuarkXPress Server instance in the Manage Servers pane of the QuarkXPress Server Manager interface, the QuarkXPress Server Manager server begins routing rendering requests to that QuarkXPress Server instance.
PAGE 329
QUARKXPRESS SERVER MANAGER Add QuarkXPress Server dialog box 3 Enter the QuarkXPress Server instance's DNS name or IP address in the Name/IP Address field. 4 Enter the QuarkXPress Server instance's port number in the Port Number field. 5 If the QuarkXPress Server instance is running with the HTTPS protocol, check HTTPS. 6 To specify an alternate name for the server, enter a value in the Alias field. The Alias value displays in the Manage Servers pane of the QuarkXPress Server Manager interface.
PAGE 330
QUARKXPRESS SERVER MANAGER 11 Click OK. Editing a QuarkXPress Server instance To edit the description of a QuarkXPress Server instance, display the Manage Servers pane of the QuarkXPress Server Manager interface, select the server in the list, and then click Edit Server. You can also display the Edit QuarkXPress Server dialog box by hovering the mouse cursor over the server and then clicking the Edit Server button on the upper left.
PAGE 331
QUARKXPRESS SERVER MANAGER Load Balancer Method Settings dialog box QuarkXPress Server Manager lets you use choose from three load-balancing settings: • Dynamic Load Balancer: Sends requests to servers based on file size • Random Load Balancer: Sends each rendering request to a random server • Round-robin Load Balancer: Sends requests to servers in a set order For more information about these load-balancing settings, see "Load balancing" Deleting a QuarkXPress Server instance To delete a QuarkXPress Serve
PAGE 332
QUARKXPRESS SERVER MANAGER Manage Cache pane Requests are stored in the cache only if the cache is turned on. For more information, see "Configuring cache options." The cache stores only the results of requests that do not deliberately bypass the cache. Viewing a QuarkXPress Server Manager server cache To view QuarkXPress Server Manager cache information, display the Manage Cache pane of the QuarkXPress Server Manager interface.
PAGE 333
QUARKXPRESS SERVER MANAGER Manage Cache pane • To set the maximum number of files allowed in the cache, enter a value in the Cache Count field. When the number of files in the cache reaches the number you set here, QuarkXPress Server Manager begins deleting the least recently used files to make room in the cache. • To set the maximum disk cache size, enter a value in the Cache Disk Size field.
PAGE 334
QUARKXPRESS SERVER MANAGER Manage Logs pane Viewing log file details To view information about a specific log file, display the Manage Logs pane of the QuarkXPress Server Manager interface, then choose the log file name from the Select Log File drop-down menu. Deleting log files To delete a log file: 1 Display the Manage Logs pane of the QuarkXPress Server Manager interface. 2 Choose the target log file from the Select Log File drop-down menu. 3 Click Clear Log.
PAGE 335
QUARKXPRESS SERVER MANAGER Log Settings dialog box To set the maximum log file size, enter a value in the Max Log File Size field. When a log file reaches this size, the current log file is closed and a new log file is created. To specify the maximum number of log files to keep, enter a value in the Max Rolling Count field. When the number of log files reaches this limit, QuarkXPress Server Manager deletes the oldest log file each time a new log file is created.
PAGE 336
QUARKXPRESS SERVER MANAGER Using a proxy server Some networks route network traffic through a proxy server for reasons of efficiency or security. To use a proxy server for all requests and responses between QuarkXPress Server Manager and QuarkXPress Server: 1 Display the Proxy Server Settings tab of the Global Settings pane of the QuarkXPress Server Manager interface. Proxy Server Settings tab 2 Check Use a Proxy Server for LAN. 3 Enter the proxy server's DNS name or IP address in the Address field.
PAGE 337
QUARKXPRESS SERVER MANAGER SMTP Settings pane Two events can cause QuarkXPress Server Manager to generate an e-mail message: • If Inactive Host E-mail Notification is checked (see "Using other global settings"), a message is sent when a QuarkXPress Server instance goes from the active state to the inactive state. • If you have set up custom error messages (as described in "Using custom error messages"), certain QuarkXPress Server errors result in e-mail messages.
PAGE 338
QUARKXPRESS SERVER MANAGER • Request Timeout: To specify the maximum number of minutes the QuarkXPress Server Manager server should wait for a response from a QuarkXPress Server instance, enter a value in this field. When this time has elapsed, the QuarkXPress Server Manager server retries the request (unless the Max Retries value has been reached).
PAGE 339
QUARKXPRESS SERVER MANAGER To discard any changes you have made since logging on to the QuarkXPress Server Manager server, click Refresh. The configuration of the QuarkXPress Server Manager server remains as it was. Disabling or enabling a QuarkXPress Server instance from the QuarkXPress Server Manager client is not considered a configuration change.
PAGE 340
QUARKXPRESS SERVER MANAGER Creating custom error text To define the text that should be sent in an e-mail message when an error occurs: 1 Create a unique custom error code for the target QuarkXPress Server error (as described in "Creating a custom error code"). 2 On the computer where the QuarkXPress Server Manager server application is running, open the following file in a text-editing application: [application folder]\server\conf\ManagerErrorCodeMessage.
PAGE 341
QUARKXPRESS SERVER MANAGER • qxpsm_context: Set this value if you need to use it in a custom load balancer. • qxpsm_maxtries: This parameter lets you specify a maximum number of retries for a specific request. If this parameter is absent or set to 0, the global maximum retries value is used. To disable maximum retries for a request, use the value –1.
PAGE 342
THE XTENSIONS DEVELOPER KIT (XDK) The XTensions Developer Kit (XDK) The QuarkXPress Server XDK lets software developers implement features that are not available in QuarkXPress Server, such as server-side processing and application-specific services. The QuarkXPress Server XDK requires knowledge of C or C++. 342 | A GUIDE TO QUARKXPRESS SERVER 10.2.
PAGE 343
GLOSSARY Glossary Document pool: The document pool contains the projects that are available for rendering. By default, the document pool is a collection of discrete files or folders in a specific, identified folder located on the local server or on a connected network drive. When some type of external document provider (such as a content management system or database) is used, projects are not stored in the local document pool.
PAGE 344
LEGAL NOTICES Legal notices ©2014 Quark Software Inc. and its licensors. All rights reserved. Protected by the following United States Patents: 5,541,991; 5,907,704; 6,005,560; 6,052,514; 6,081,262; 6,633,666 B2; 6,947,959 B1; 6,940,518 B2; 7,116,843; 7,463,793; and other patents pending. Quark, the Quark logo, and QuarkXPress are trademarks or registered trademarks of Quark Software Inc. and its affiliates in the U.S. and/or other countries. All other marks are the property of their respective owners.
PAGE 345
INDEX Index .
PAGE 346
INDEX creation date 150 fonts 24 custom error messages 339, 340 fonts, applying 84 fonts, required 152 D DATAPROVIDER element type 227 deconstruct 33, 107, 108 default render type 20 DEL element type 227 delete request handler 148 DELETECELLS element type 227 deleting files 148 FOOTER element type 232 FOOTERTROWSTYLE element type 233 FORMAT element type 233 formatting text 98 FRAME element type 235 frames 26 G demonstration code 177 geometry 89 DESCRIPTION element type 228 GEOMETRY element type 2
PAGE 347
INDEX images, manipulating with XML 121 line spacing 27 inline boxes 118 LINESTYLE element type 252 inline tables 128 LINKEDBOX element type 253 INLINEBOX element type 244 LIST element type 254 INLINETABLE element type 245 literal render type 59 INS element type 245 load balancing 173, 330 INSET element type 246 local formatting 123 Interactive Designer 314 LOCATION element type 254 interactive elements 138 LOCKTOGRID element type 255 INTERACTIVITY element type 246 log levels 19 ISBN el
PAGE 348
INDEX O object model 35 Objective-C client 178 ODDTCOLSTYLE element type 258 ODDTROWSTYLE element type 257 ORIGIN element type 258 OVERMATTER element type 258 P PAGE element type 259 page numbering 130 PAGEBREAK element type 259 PAGEREF element type 260 pages, manipulating with XML 113 pages, moving 80 pages, rendering individual 81 pages, rendering multiple 81 PAGESEQUENCE element type 260 PARAGRAPH element type 262 parameters 35, 160, 161, 340 PARENTTABLE element type 263 processRequest() 41 PROJECT el
PAGE 349
INDEX RUNAROUND element type 284 S T TAB element type 295 TABLE element type 296 sample code 177 table styles 129 SAVEAS element type 287 TABLEBREAK element type 298 saving projects with a different name 86 tables 128 SCALETO element type 287 tables of contents 132 scaling output 82 tables, breaking across pages with XML 127 screenpdf render type 70 tables, creating 125 Scroll Zone interactivity 139 tables, manipulating with XML 124, 126, 127 SECTION element type 288 TABLESTYLE element ty
PAGE 350
INDEX VERTEX element type 306 XML construct 107, 110, 111, 113 VERTEXPOINT element type 307 XML deconstruct 107, 108 VERTICES element type 307 XML Import 87, 122, 134 Video interactivity 140 XML modify 90, 113 XML, importing 87 W Web services 35, 41 Web View interactivity 141 WIDTH element type 307 WSDL 41 X XML 33, 312, 313 350 | A GUIDE TO QUARKXPRESS SERVER 10.2.
Who We Are
About Us
Company
Careers
Terms & Privacy
Resources
List of Manufacturers
Support
For the Press
Media assets
FAQ
Get in touch
Blog
Email
DMCA
ManualShelf © 2013-2025