10.1

ManualsBrandsQuark ManualsApplicationsQuarkXPress Server

Table Of Contents

A Guide to QuarkXPress

Server 10.1

Summary of content (344 pages)

PAGE 1
A Guide to QuarkXPress Server 10.
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 CALLOUTBOXREF (Modifier schema)...........................................................206 CELL (Modifier schema).................................................................................206 CHILDID (Modifier schema)...........................................................................208 CLIPPING (Modifier schema).........................................................................208 COLGROUP (Modifier schema)....................................................................
PAGE 5
CONTENTS ID (Modifier schema).....................................................................................237 INLINEBOX (Modifier schema)......................................................................237 INLINETABLE (Modifier schema)...................................................................239 INS (Modifier schema)...................................................................................239 INSET (Modifier schema).............................................................
PAGE 6
CONTENTS PUBLISHER (Modifier schema)......................................................................262 RELPOSITION (Modifier schema)..................................................................262 REPEATABLEMASTERPAGEALTERNATIVES (Modifier schema)...................262 REPEATABLEMASTERPAGEREFERENCE (Modifier Schema).......................263 RGBCOLOR (Modifier schema)......................................................................263 RICHTEXT (Modifier schema).............................
PAGE 7
CONTENTS TOP (Modifier schema)..................................................................................297 TOPGRID (Modifier schema).........................................................................297 TROW (Modifier schema)..............................................................................298 TROWSTYLE (Modifier schema)....................................................................299 VALUE (Modifier schema)...................................................................
PAGE 8
CONTENTS Caching.................................................................................................................319 Web services.........................................................................................................319 Working with QuarkXPress Server Manager................................................319 Starting QuarkXPress Server Manager..................................................................320 Request handler binding......................................
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.
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 String article Lets you specify which article in a project to render. For example: http://localhost:8080/qcddoc/ abc.qxp?article=article1 String component 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 • Missing image file. • Missing text file. • Box/table node referenced by ANCHOREDBOXREF isn't available in the modifier XML • Anchored box/table is created but is not referenced in the parent box. • Invalid ROWCOUNT/COLUMNCOUNT/MERGE. • Invalid TABLEBREAK. • Applying INVALID Gridline attribute to row/column. • Table creation of incorrect rows and columns. • Invalid Cell Attributes • Invalid paragraph/character/conditional/Bullet numbering styles. • Invalid Box attributes.
PAGE 75
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 76
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 77
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 78
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 79
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 80
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 81
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 82
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 83
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 84
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 85
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 86
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 87
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 88
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 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.processRequest(rc); Highlighting text in rendered output To apply highlighting to text in rendered output, use XML like the following.
PAGE 90
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 91
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 92
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 93
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 94
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 95
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 96
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 97
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 98
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 99
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 100
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 101
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 102
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 103
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 104
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 105
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 106
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 107
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 108
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 109
USING QUARKXPRESS SERVER 0 0 800 600 false Logs If the request succeeds, a transaction success message is writ
PAGE 110
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 111
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 112
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 113
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 114
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 115
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 116
USING QUARKXPRESS SERVER 475 This is text in a box.
PAGE 117
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 118
USING QUARKXPRESS SERVER The INLINEBOX@WIDTH attribute lets you specify the width of the anchored box as a percentage of its parent column or box. If you fill an anchored box with so much text that it expands to the height of its parent box, the text is adjusted to fit in the box. The INLINEBOX@SCALEUP attribute lets you control sizing for picture boxes. The childSHADOW element lets you specify drop shadow effects. A child BOXATTRIBUTE element lets you control the formatting of the boxes.
PAGE 119
USING QUARKXPRESS SERVER Working with groups To add boxes to a group, create a element and then insert elements that refer to the boxes you want in the group.
PAGE 120
USING QUARKXPRESS SERVER Working with pictures The element supports a variety of features, including the ability to specify runaround, opacity, and drop shadow characteristics. For more information, see the Modifier schema.
PAGE 121
USING QUARKXPRESS SERVER elements are ignored by the construct namespace and the modify parameter; placeholders must be inserted in QuarkXPress using XML Import XTensions software. If you know the UID attribute of a box or story, you can insert text into that box or story without having to specify where the or element is.
PAGE 122
USING QUARKXPRESS SERVER The MERGE attribute lets you control whether formatting from one or element is carried forward to the next. For example, the following XML would result in "has risen" being italicized: The sun has risen.
PAGE 123
USING QUARKXPRESS SERVER 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.
PAGE 124
USING QUARKXPRESS SERVER • "CELL (Modifier schema)" The following XML shows how some of these parameters work.
PAGE 125
USING QUARKXPRESS SERVER table.rows = "2"; table.columns = "4"; table.maintainGeometry = "true"; table.operation = "CREATE"; spread.tables = new Table []{table}; Use the following object hierarchy: ModifierRequest < Project < Layout < Spread < Table To delete a table, provide the table's name or ID and set the operation attribute to "DELETE".
PAGE 126
USING QUARKXPRESS SERVER
...
... ... ... ... Using inline tables The Inline Tables feature makes it easy to create an anchored table.
PAGE 127
USING QUARKXPRESS SERVER • COLOR: Cell background color. • SHADE: Cell background shade. • STORYDIRECTION: Story direction. You can automatically adjust and position pictures in table cells. The VALIGN@ENTRY and ALIGNMENT@ENTRY attributes lets you specify the alignment of a cell, including picture cells.
PAGE 128
USING QUARKXPRESS SERVER PAGE 129
USING QUARKXPRESS SERVER In that section start, you can specify a number format, a starting page number, and an optional prefix. For example:
Once you have inserted a
element, QuarkXPress Server will apply section-specific numbering and formatting to automatic page numbers.
PAGE 130
USING QUARKXPRESS SERVER ... You can create a shared layout for use in a Composition Zones item like so: ... If you are creating App Studio issues, you can use this technique to create scrollable layouts on the fly.
PAGE 131
USING QUARKXPRESS SERVER Working with lists The element allows you to construct and deconstruct QuarkXPress lists. Lists allow a user to automatically create a table of contents (TOC) or list of figures. For more information, see the Modifier DTD . PAGE 132
USING QUARKXPRESS SERVER Hello Box7 , world 0 0 50 75
PAGE 133
USING QUARKXPRESS SERVER This is text that has a placeholder When a Text placeholder spans multiple paragraphs, the PARAGRAPH and RICHTEXT hierarchy is flattened. A new paragraph can be started using an empty PARAGRAPH element.
PAGE 134
USING QUARKXPRESS SERVER all placeholders from all XTensions software. The default value for placeholders is “1347639377” (this is the XTension ID of PlaceholderSXT XT). If you want to create placeholders for your own XTensions software, use that XTensions software ID here. Working with metadata You can attach box-level metadata to a QuarkXPress project created from XML using the Modifier DTD.
PAGE 135
USING QUARKXPRESS SERVER • The developer ID of the developer who created the XTensions module. • The unique identifier of the hidden text type, as defined by the XTensions developer. • The type of hidden text entry (OPENPAREN, CLOSEPAREN, NONPAREN, or IGNORED) An opcode is constructed as follows: 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.
PAGE 136
USING QUARKXPRESS SERVER the note goes between them. The piece of hidden text at the start of the note has the type OPENPAREN, and the piece at the end has the type CLOSEPAREN. The population of Iceland is 500,000,000.
PAGE 137
USING QUARKXPRESS SERVER Button interactivity Below is an example of App Studio Button interactivity.
PAGE 138
USING QUARKXPRESS SERVER Images\Slideshow01.jpg true true false false 1 true6.
PAGE 139
USING QUARKXPRESS SERVER Audio interactivity Below is an example of App Studio Audio interactivity.
PAGE 140
USING QUARKXPRESS SERVER Picture Zoom interactivity Below is an example of App Studio Picture Zoom interactivity. PAGE 141
USING QUARKXPRESS SERVER 65536 true 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.
PAGE 142
USING QUARKXPRESS SERVER Page hyperlinks To make sure a Page hyperlink works correctly, add something like this to the element: 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.
PAGE 143
USING QUARKXPRESS SERVER Using administrative request handlers Administrative request handlers let you change the behavior of QuarkXPress Server. The built-in administrative request handlers are described in the topics below You can add your own request handlers. During the DDSSETUPCBCODE callback, QuarkXPress Server XTensions software registers itself as a request handler via AddCustomRequestHandler, using the QuarkXPress Server XTensions API.
PAGE 144
USING QUARKXPRESS SERVER Logs See Understanding logging Example GET URL To post a binary file in the root folder: http://localhost:8080/addfile/abc.qxp To post a binary file in a subfolder: http://localhost:8080/addfile/sub1/abc.qxp 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.
PAGE 145
USING QUARKXPRESS SERVER Please select the file you want to upload:

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.
PAGE 146
USING QUARKXPRESS SERVER onSubmit="UploadDocument()"> Please enter the name or IP of machine where QuarkXPress Server is running:

Please enter the port number on which QuarkXPress Server is running:

Please enter the new name (along with extension) with which file will be uploaded:

Please select the file you want to upload:
PAGE 147
USING QUARKXPRESS SERVER If you send a delete request to QuarkXPress Server Manager using HTTP or the Web services interface while the common doc pool switch is set to off in the QuarkXPress Server Manager client, the file or folder is uploaded to all registered QuarkXPress Server instances. If the common doc pool is enabled, the file or folder can be deleted from any one registered QuarkXPress server instance. Namespace delete Response The message "File deleted successfully.
PAGE 148
USING QUARKXPRESS SERVER These rules are defined in the "Default Job Jacket.xml" file, which is generated by QuarkXPress Server in the preferences folder. You can specify multiple rule sets in a comma-separated list. To specify which layouts to evaluate, use the layout parameter. To evaluate using an external Job Jackets file, use the jobjacket parameter. For example: jobjacket=customjj.xml Namespace evaluate Response The default Job Jackets file.
PAGE 149
USING QUARKXPRESS SERVER Example GET URL http://localhost:8080/exportprefsasjj Notes If a user name and password have been set in the Server Configuration dialog box, the browser requests that user name and password when you submit a getdocinfo parameter request. Fileinfo The fileinfo request handler returns XML that contains the creation date, modification date, and file size of a document. Namespace fileinfo Parameters action=get Lets you retrieve the creation date of a file in UTC format.
PAGE 150
USING QUARKXPRESS SERVER Namespace flush Response The message "CACHE FLUSH COMPLETED." 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/flush/sample.
PAGE 151
USING QUARKXPRESS SERVER Notes If a user name and password have been set in the Server Configuration dialog box, the browser requests that user name and password when you submit a flushall parameter request. When you issue a flushall request, the memory usage value in the status monitor becomes zero. Getdocinfo The getdocinfo request handler returns XML information about a QuarkXPress project that is in the document pool or has been supplied as part of a multipart HTTP request.
PAGE 152
USING QUARKXPRESS SERVER Example GET URL http://localhost:8080/getdocinfo/sample.qxp Example, object Request object name: GetDocInfoRequest model sdk.QRequestContext rc = new sdk.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.Text; rc.request = new GetDocInfoRequest(); //Create the service and call it with QRequestContext object RequestServiceService svc = new RequestServiceService(); com.quark.qxpsm.QContentData qc = svc.
PAGE 153
USING QUARKXPRESS SERVER 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 154
USING QUARKXPRESS SERVER 1736 BUSY Example GET URL http://localhost:8080/getprocessid Getprojinfo The getprojinfo request handler returns XML information about a QuarkXPress project that is in the document pool or has been supplied as part of a multipart HTTP request.
PAGE 155
USING QUARKXPRESS SERVER if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.Text; rc.request = new GetProjectInfoRequest(); //Create the service and call it with QRequestContext object RequestServiceService svc = new RequestServiceService(); QContentData qc = svc.processRequest(rc); Notes The getprojinfo parameter only works with projects saved in QuarkXPress 6.0 and later.
PAGE 156
USING QUARKXPRESS SERVER Example GET URL http://localhost:8080/getserverinfo Example, object Request object name: GetServerInfoRequest model com.quark.qxpsm.QRequestContext rc = new com.quark.qxpsm.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.Text; rc.request = new GetServerInfoRequest(); //Create the service and call it with QRequestContext object RequestService svc = new RequestService(); com.quark.qxpsm.
PAGE 157
USING QUARKXPRESS SERVER platform on which a project was created is different from the platform on which QuarkXPress Server is running. The preflight request handler has been deprecated. Use the evaluate request handler instead. For more information, see "Evaluate." Namespace preflight Response The XML response looks like the following:
PAGE 158
USING QUARKXPRESS SERVER 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/setprefs?CacheSize=200 Example, object model EMailPreferences emailPrefs = new EMailPreferences(); emailPrefs.
PAGE 159
USING QUARKXPRESS SERVER tag that needs to be modified, and then submit a setrendererprefs request with the using the name of this tag.
PAGE 160
USING QUARKXPRESS SERVER Attribute Type Description SmartQuoteFormat integer Set to the zero-based index of the desired format. For the list of available formats, see the Input Settings pane of the Preferences dialog box in the QuarkXPress Server administrative interface. SequentialPageRangeSeparator string Set to one character only. NonSequentialPageRangeSeparator string Set to one character only. FONTFALLBACK ApplyFontFallback Boolean Set to true or false.
PAGE 161
USING QUARKXPRESS SERVER Attribute Type Description AutoPageInsertionMode string Set to Off, End of Story, End of Section, or End of Document. HorizontalUnits string Set to Inches, Inches Decimal, Picas, Points, Millimeters, Centimeters, Ciceros, Agates, or Q. 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.
PAGE 162
USING QUARKXPRESS SERVER Attribute Type Description TrappingMethod string Set to Absolute, Proportional, or Knockout All. ProcessTrapping Boolean Set to true or false. IgnoreWhite Boolean Set to true or false. AutoAmount float Set to the auto trapping amount value. Indeterminate float Set to the indeterminate trapping value. KnockoutLimit float Set to the knockout limit value. OverPrintLimit float Set to the overprint limit value.
PAGE 163
USING QUARKXPRESS SERVER To modify QuarkXPress Server renderer preferences, first upload a modified Job Jackets file named "QuarkXPressServerJobJacket.xml" to the document pool using addfile, then call this request handler. This request handler sets the preferences for all renderers. Namespace updateprefsfromjj Response The message "Preferences successfully set." Alerts Incorrect administration realm user name and password.
PAGE 164
USING QUARKXPRESS SERVER 1 Include the QXPSM stub jar file in the project classpath. This jar file can be found at the following location: [QXPSM_Home]/XDK/WebServiceStubs/java/qxpsm-webservicestubs.jar 2 Include all client-side third-party-dependent jar files in the project classpath.
PAGE 165
USING QUARKXPRESS SERVER // QXP doc render request QuarkXPressRenderRequest qxpreq = new QuarkXPressRenderRequest(); // Save as request that saves the file SaveAsRequest saveAsRequest= new SaveAsRequest(); saveAsRequest.setNewName("NewDoc.qxp"); qxpreq.setRequest(saveAsRequest); qRequestContext.setRequest(qxpreq); // Get reference to RequestService RequestService service = new RequestServiceStub( "http://[server]:[port]/qxpsm/services/RequestService"); //Process the request service.
PAGE 166
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 167
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 168
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 169
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 170
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 171
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 172
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 173
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 174
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 175
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 176
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 177
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 178
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 179
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 180
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 181
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 182
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 183
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 184
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 185
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 186
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 187
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 188
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 189
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 190
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 191
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 192
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 193
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. A GUIDE TO QUARKXPRESS SERVER 10.
PAGE 194
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 195
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct
PAGE 196
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct
PAGE 197
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 198
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 199
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 200
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 201
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 202
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 203
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 204
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 205
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 206
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 207
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Attributes COLUMNCOUNT CDATA #REQUIRED Specifies the column index Specifies the column index Specifies the column index position of a cell, with the position of a cell, with the position of a cell, with the first cell being cell 1. first cell being cell 1. first cell being cell 1.
PAGE 208
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct blend is the opacity of the color applied to the cell. blend is the opacity of the color applied to the cell. is the opacity of the color applied to the cell. MERGEROWSPAN CDATA #IMPLIED Attribute used for merging Attribute used for merging If a table includes merged cells and rows. cells and rows. cells, then the MERGECOLSPAN value is shown in the xml output.
PAGE 209
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct TYPE (ITEM | EMBEDDEDPATH | ALPHACHANNEL | NONWHITEAREAS | PICTUREBOUNDS) "ITEM" Specifies the type of clipping applied to a picture item: Specifies the type of clipping applied to a picture item: Specifies the type of clipping applied to a picture item: ITEM = Runs along the edges of the item. ITEM = Runs along the edges of the item. ITEM = Runs along the edges of the item.
PAGE 210
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct PATHNAME CDATA #IMPLIED Identifies a path embedded Identifies a path embedded Identifies a path embedded in a picture for use as the in a picture for use as the in a picture for use as the clipping path. clipping path. clipping path. OUTSET CDATA #IMPLIED Valid when CLIPPING@TYPE = EMBEDDEDPATH, ALPHACHANNEL, or NONWHITEAREAS. Specifies a single outset or inset integer value in points to be used on all sides.
PAGE 211
MODIFIER SCHEMA (ANNOTATED) Element type EDITED (true | false | none) "none" Construct Modify Deconstruct ALPHACHANNEL, or NONWHITEAREAS. Reverses the shape of the clipping path. ALPHACHANNEL, or NONWHITEAREAS. Reverses the shape of the clipping path. ALPHACHANNEL, or NONWHITEAREAS. Reverses the shape of the clipping path. Not applicable. Not applicable. Indicates whether the clipping path has been manually edited in QuarkXPress.
PAGE 212
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct COLOR CDATA #IMPLIED Identifies the color of a column. Overrides the TABLE@COLOR attribute. Identifies the color of a column. Overrides the TABLE@COLOR attribute. Identifies the color of a column. Overrides the TABLE@COLOR attribute. Note: Only the name of a color is included in this attribute.
PAGE 213
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct NAME CDATA #IMPLIED The name given to a specific component in an ARTICLE. Required for COMPONENT. The name given to a specific component in an ARTICLE. Required for COMPONENT. Specifies the name of the component in the ARTICLE. UID CDATA #IMPLIED QuarkXPress Server The unique ID of the Specified the unique ID of automatically assigns a COMPONENT to be modified. the COMPONENT to be unique ID to components. modified.
PAGE 214
MODIFIER SCHEMA (ANNOTATED) COMPOSITIONZONE (Modifier schema) Element type Construct Modify Deconstruct COMPOSITIONZONE (ID, (FRAME | GEOMETRY | SHADOW | PAGEREF)*, INTERACTIVITY?) Not applicable. Not applicable. Describes a Composition Zones item. (Applies only to the xml namespace.) LAYOUTREF CDATA #IMPLIED Not applicable. Not applicable. Identifies the layout referenced by this Composition Zones item. BOXTYPE (CT_TEXT | CT_PICT | CT_USER) #IMPLIED Not applicable. Not applicable.
PAGE 215
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct identifies its parent Composition Zones. Not applicable. BLENDSTYLE (SOLID | LINEAR | MIDLINEAR | RECTANGULAR | DIAMOND | CIRCULAR | FULLCIRCULAR | none) "none" Not applicable. Specifies the type of blend applied to this box (linear, circular, rectangular, etc.). BLENDANGLE CDATA #IMPLIED Not applicable. Not applicable. Specifies the angle of the blend. BLENDCOLOR CDATA #IMPLIED Not applicable. Not applicable.
PAGE 216
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct OPERATION (CREATE | DELETE) #IMPLIED Lets you create or delete a Composition Zones item. Lets you create or delete a Composition Zones item. Not applicable. CONDITIONALMASTERPAGEREFERENCE (Modifier schema) Element type Construct Modify Deconstruct CONDITIONALMASTERPAGEREFERENCE () Not Lets you specify the master page Not applicable. applicable.
PAGE 217
MODIFIER SCHEMA (ANNOTATED) Element type Construct If true, any style sheets in INCLUDESTYLESHEETS (true | false) "true" an imported text file are added to the QuarkXPress project. Modify Deconstruct If true, any style sheets in Not applicable. an imported text file or document are added to the QuarkXPress project. FONTNAME CDATA #IMPLIED Specifies a font to apply to Specifies a font to apply to Not applicable. imported text. imported text.
PAGE 218
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct 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. This ID is assigned by default by the DTD, so there is no need to specify this manually. DTD validation will add this attribute.
PAGE 219
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct SHADE CDATA #IMPLIED Specifies the background shade of the row style. Specifies the background shade of the row style. Not applicable. INSET CDATA #IMPLIED Specifies the text inset of the row style. Specifies the text inset of the row style. Not applicable. CONTOUR (Modifier schema) Element type Construct Modify Deconstruct CONTOUR (VERTICES) A single contour within a spline shape.
PAGE 220
MODIFIER SCHEMA (ANNOTATED) COPYFIT (Modifier schema) Element type Construct Modify Deconstruct COPYFIT (empty) Not applicable. Not applicable. Indicates whether the copy in this text box or chain fits the available space. STATE (fit | overFit | underFit) "fit" Not applicable. Not applicable. Indicates whether the text currently fits in the box (fit), is too long (overFit), or is too short (underFit). FITAMOUNT CDATA #IMPLIED Not applicable. Not applicable.
PAGE 221
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct DATAPROVIDERXTID CDATA #IMPLIED Not applicable. Not applicable. Provides information about the XTensions module through which interactivity is applied to a box. For example, if interactivity is provided through a built-in QuarkXPress XTensions module, this value is QDPC (Quark Digital Publishing Core).
PAGE 222
MODIFIER SCHEMA (ANNOTATED) DROPCAP (Modifier schema) Element type Construct Modify Deconstruct DROPCAP (empty) Describes a drop-capital effect at the beginning of a paragraph, which is when initial characters display at a large size and hang two or more lines below the first line of a paragraph. Describes a drop-capital effect at the beginning of a paragraph, which is when initial characters display at a large size and hang two or more lines below the first line of a paragraph.
PAGE 223
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct COLSPAN CDATA #IMPLIED If specified, indicates that this cell is merged with the following number of cells. For example, COLSPAN="2" merges this cell with the next one. If specified, indicates that Not applicable. this cell is merged with the following number of cells. For example, COLSPAN="2" merges this cell with the next one.
PAGE 224
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct JUSTIFIED | FORCED) #IMPLIED ANGLE CDATA #IMPLIED Identifies the text angle for Identifies the text angle for Not applicable. the row style. the row style. VALIGN (TOP | CENTER | BOTTOM) #IMPLIED Specifies the vertical Specifies the vertical Not applicable. alignment of the row style. alignment of the row style. COLOR CDATA #IMPLIED Specifies the background color of the row style.
PAGE 225
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct AVOIDBOXESBY CDATA #IMPLIED Lets you specify the distance between the POINT side or corner of a resized box and any other items around it. A box will expand only until it is this distance from an adjacent item. Lets you specify the Not applicable. distance between the POINT side or corner of a resized box and any other items around it. A box will expand only until it is this distance from an adjacent item.
PAGE 226
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct operations. If false, tracking cannot be changed during text fitting operations. operations. If false, tracking cannot be changed during text fitting operations. SCALEBASELINESHIFT (true | false) "false" If true, baseline shift can be changed during text fitting operations. If false, baseline shift cannot be changed during text fitting operations. If true, baseline shift can Not applicable.
PAGE 227
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct JUSTIFIED | FORCED) #IMPLIED ANGLE CDATA #IMPLIED Identifies the text angle for Identifies the text angle for Not applicable. the row style. the row style. VALIGN (TOP | CENTER | BOTTOM) #IMPLIED Specifies the vertical Specifies the vertical Not applicable. alignment of the row style. alignment of the row style. COLOR CDATA #IMPLIED Specifies the background color of the row style.
PAGE 228
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Note: JUSTIFIED aligns the text in a paragraph to the left and right indentations, except for the last line. FORCED justifies every line, including the last line. Note: JUSTIFIED aligns the text in a paragraph to the left and right indentations, except for the last line. FORCED justifies every line, including the last line. Note: JUSTIFIED aligns the text in a paragraph to the left and right indentations, except for the last line.
PAGE 229
MODIFIER SCHEMA (ANNOTATED) FRAME (Modifier schema) Element type Construct Modify Deconstruct FRAME (empty) Describes a box frame. Describes a box frame. Describes a box frame. Attributes STYLE CDATA #IMPLIED Specifies a Dashes & Stripes Specifies a Dashes & Stripes Specifies a Dashes & Stripes style for a frame. style for a frame. style for a frame.
PAGE 230
MODIFIER SCHEMA (ANNOTATED) GEOMETRY (Modifier schema) Element type Construct GEOMETRY ((POSITION | Describes the geometric characteristics of a box or RELPOSITION)? | line.
PAGE 231
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct the box origin is on the right pasteboard. the box origin is on the right pasteboard. the box origin is on the right pasteboard. Note: This attribute determines where to create a box or line, regardless of which PAGE element the box or line occurs within. Note: This attribute determines where a box or line is, regardless of which PAGE element the box or line occurs within.
PAGE 232
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct STYLE CDATA #IMPLIED Identifies a Dashes & Stripes style (LINESTYLE) for a rule. Identifies a Dashes & Stripes style (LINESTYLE) for a rule. Identifies a Dashes & Stripes style (LINESTYLE) for a rule. Note: Only the name of a Dashes & Stripes style is included in this attribute.
PAGE 233
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct ANCHOREDGROUPMEMBER CDATA #IMPLIED Specifies that this group is Specifies that this group is Specifies that this group is a member of the indicated a member of the indicated a member of the indicated anchored group. anchored group. anchored group. GROUPOPACITY CDATA #IMPLIED Specifies the opacity of the Specifies the opacity of the Specifies the opacity of the group as a whole. group as a whole. group as a whole.
PAGE 234
MODIFIER SCHEMA (ANNOTATED) GROWACROSS (Modifier schema) Element type Construct Modify Deconstruct GROWACROSS (#PCDATA) Not applicable. Expands a box horizontally Not applicable. to the right by the specified number of points. Note: A box can be expanded on the same page or on other spreads and pages. GROWDOWN (Modifier schema) Element type Construct Modify Deconstruct GROWDOWN (#PCDATA) Not applicable. Expands a box vertically toward the bottom of the page by the specified number of points.
PAGE 235
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct ANGLE CDATA #IMPLIED Identifies the text angle for Identifies the text angle for Not applicable. the row style. the row style. VALIGN (TOP | CENTER | BOTTOM) #IMPLIED Specifies the vertical Specifies the vertical Not applicable. alignment of the row style. alignment of the row style. COLOR CDATA #IMPLIED Specifies the background color of the row style. Specifies the background color of the row style. Not applicable.
PAGE 236
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct data intended as hidden text matches the value of the DATALEN attribute to avoid data loss. OPCODE CDATA #REQUIRED Hidden text opcode is a four-byte field that contains ownerId, opcodeId,and hiddenTextType. The Hidden text opcode is usually the originating XTensions ID of the XTensions that owns this hidden text.
PAGE 237
MODIFIER SCHEMA (ANNOTATED) ID (Modifier schema) Element type Construct Modify Deconstruct ID (empty) Lets you specify a name for a LAYOUT, LAYER, BOX, LINKEDBOX, TABLE, GROUP, or COMPOSITIONZONE. Identifies an object by its UID or NAME. Identifies an object by its unique ID and by its name (if any). Lets you specify a unique ID for a SPREAD or PAGE. Note: QuarkXPress Server evaluates the ID element for a NAME value first and for a UID second. If a NAME is found, the UID is ignored.
PAGE 238
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Specifies the width of the box as a percentage of the width of the parent column or text box, in all supported measurement units. The default WIDTH value is 100%. Specifies the width of the Not applicable. box as a percentage of the width of the parent column or text box, in all supported measurement units. The default WIDTH value is 100%.
PAGE 239
MODIFIER SCHEMA (ANNOTATED) INLINETABLE (Modifier schema) Element type Construct Modify Deconstruct INLINETABLE (FRAME?, COLGROUP?, THEAD?, TBODY,TFOOT?,SHADOW RUNAROUND) Describes a table that is anchored in a text box. Describes a table that is anchored in a text box. Not applicable. WIDTH CDATA #IMPLIED Specifies the width of the table, in all supported measurement units. Can be specified as a percentage of the width of the parent text box. Specifies the width of the Not applicable.
PAGE 240
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct MULTIPLEINSETS (true | false | none) "none" Specifies multiple insets. Specifies multiple insets. Indicates multiple insets. TOP CDATA #IMPLIED Specifies the distance between the top inside border of a text box and the text. Specifies the distance between the top inside border of a text box and the text. Indicates the distance between the top inside border of a text box and the text.
PAGE 241
MODIFIER SCHEMA (ANNOTATED) ISBN (Modifier schema) Element type Construct Modify Deconstruct ISBN (#PCDATA) Not applicable. Part of the Specifies the ISBN code of an e-book. element. Specifies the ISBN code of an e-book. KEEPLINESTOGETHER (Modifier schema) Element type Construct Modify Deconstruct KEEPLINESTOGETHER (empty) The Keep Lines Together feature specifies whether lines in paragraphs flow together or are separated when they reach the bottoms of columns.
PAGE 242
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 243
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct the Layers pane of the the Layers pane of the the Layers pane of the Preferences dialog box Preferences dialog box Preferences dialog box (QuarkXPress/Edit menu). (QuarkXPress/Edit menu). (QuarkXPress/Edit menu). LAYOUT (Modifier schema) Element type Construct LAYOUT (ID, ARTICLE*, Describes a layout in a project.
PAGE 244
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct LAYOUT_ID CDATA #IMPLIED Not applicable. Not applicable. Specifies the internal layout UID value for the layout. This value does not change when the project gets modified — unlike the UID value, which is reset when, for example, an intermediate layout is deleted. Note that the LAYOUT/ID@UID attribute represents the index of the layout, rather than the internal UID used by QuarkXPress.
PAGE 245
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct ORIENTATION (HORIZONTAL | VERTICAL) #IMPLIED Not applicable. Not applicable. Identifies the orientation of the layout. LEFT (Modifier schema) Element type Construct Modify Deconstruct LEFT (#PCDATA) The distance between the box or lines left edge and the left edge of the page, in points. The distance between the box or lines left edge and the left edge of the page, in points.
PAGE 246
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct remaining attributes, those attribute values override the corresponding values. remaining attributes, those attribute values override the corresponding values. WIDTH CDATA #IMPLIED Specifies the width of the grid line in points. Specifies the width of the grid line in points Not applicable. COLOR CDATA #IMPLIED Specifies the color of the grid line. Specifies the color of the grid line.
PAGE 247
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct DOUBLEARROW = Arrow heads on both ends DOUBLEARROW = Arrow heads on both ends LINKEDBOX (Modifier schema) Element type Construct Modify Deconstruct LINKEDBOX (ID) Represents a box or table cell into which text flows from the parent box. The child ID element identifies the box or table. Represents a box or table cell into which text flows from the parent box. The child ID element identifies the box or table.
PAGE 248
MODIFIER SCHEMA (ANNOTATED) LIST (Modifier schema) Element type Construct Specifies a List in a LIST ((PARAGRAPH | RICHTEXT)*,OVERMATTER?) QuarkXPress project. Modify Deconstruct Specifies a List in a QuarkXPress project. Identifies a List in a QuarkXPress project. Attributes OPERATION (CREATE | DELETE) #IMPLIED Not applicable. Specifies whether to create Not applicable. a list or delete a list.
PAGE 249
MODIFIER SCHEMA (ANNOTATED) Element type Construct Specifies grid type applied GRIDTYPE (TOPLINE | BOTTOMLINE | LEFTLINE on page level or text box level grid. | RIGHTLINE | CENTERLINE | BASELINE) "BASELINE" Modify Deconstruct Specifies grid type applied on page level or text box level grid. Specifies grid type applied on page level or text box level grid. MASTERPAGESEQUENCE (Modifier schema) Element type Construct Not applicable.
PAGE 250
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify fit-box-to-content operation. fit-box-to-content operation. Deconstruct MOVEDOWN (Modifier schema) Element type Construct Modify Deconstruct MOVEDOWN (#PCDATA) Not applicable. Moves a box down by the Not applicable. specified number of points. Note: You can move a box or line onto another page. MOVELEFT (Modifier schema) Element type Construct Modify Deconstruct MOVELEFT (#PCDATA) Not applicable.
PAGE 251
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct CREATEDBY CDATA #IMPLIED Not applicable. Not applicable. The username of the creator of the note. CREATEDON CDATA #IMPLIED Not applicable. Not applicable. The creation date of the note. The background color of the note. The background color of the note. Modify Deconstruct BACKGROUNDCOLOR CDATA The background color of the note.
PAGE 252
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct SHADE CDATA #IMPLIED Specifies the background Specifies the background Not applicable. shade of the column style. shade of the column style. ORIGIN (Modifier schema) Element type Construct Modify Deconstruct ORIGIN (empty) Specifies an item's size and its position relative to the upper left corner of its page or spread. Specifies an item's size and its position relative to the upper left corner of its page or spread.
PAGE 253
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify OPERATION (CREATE | DELETE) #IMPLIED Not applicable. Specifies whether to create Not applicable. or delete the indicated page. MASTER CDATA #IMPLIED Identifies the master page from which to create a page. This value should be specified as a number, with 3 indicating the first master page. Identifies the master page from which to create a page. This value should be specified as a number, with 3 indicating the first master page.
PAGE 254
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct NEXTMASTER CDATA #IMPLIED Specifies the name of the master page to be applied to the next page. Specifies the name of the master page to be applied to the next page. Not applicable. PAGEREF (Modifier schema) Element type Construct Modify Deconstruct PAGEREF (empty) Not applicable. Not applicable. Identifies a page within the layout corresponding to a multi-page Composition Zones item. NUMBER CDATA #IMPLIED Not applicable.
PAGE 255
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct FORCEPAGECOUNT Not applicable. Imposes a condition on the Not applicable. number of pages in a PAGESEQUENCE. In the event that this constraint is not satisfied, an additiional blank page will be added to the end of the sequence.
PAGE 256
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct 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. Applies a paragraph style sheet to text. Applies a paragraph style sheet to text. Note: Only the name of a paragraph style sheet is included in this attribute.
PAGE 257
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct TEXTTAGTYPE CDATA #IMPLIED Not applicable. Indicates the label applied to a paragraph. Valid only for reflow articles and QuarkCoypDesk articles. Valid values include: Indicates the label applied to a paragraph. Valid only for reflow articles and QuarkCopyDesk articles.
PAGE 258
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify size larger than 1000%, both horizontally and vertically. size larger than 1000%, both horizontally and vertically. Deconstruct FITBOXTOPICTURE = Resizes FITBOXTOPICTURE = Resizes a box to fit its picture. a box to fit its picture. FITPICTURETOBOXPRO = Scales a picture in a picture box in such a way that the x scale and y scale of a picture remain the same.
PAGE 259
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct SHADE CDATA #IMPLIED Specifies the shade of the color applied to a grayscale picture, as an integer percentage from 0 to 100. Specifies the shade of the color applied to a grayscale picture, as an integer percentage from 0 to 100. Specifies the shade of the color applied to a grayscale picture, as an integer percentage from 0 to 100.
PAGE 260
MODIFIER SCHEMA (ANNOTATED) PLACEHOLDER (Modifier schema) Element type Construct PLACEHOLDER (#PCDATA) Not applicable. Modify Deconstruct Not applicable. Describes a placeholder inserted in QuarkXPress for use with XML Import XTensions software. Note: To replace placeholders with XML content, use XML Import XTensions software with QuarkXPress, or refer to the thexmldoc and paginate parameters. Attributes OWNER CDATA #REQUIRED Not applicable. Not applicable.
PAGE 261
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct PROJECTNAME CDATA #IMPLIED Specifies the name of the file to construct. Not applicable. Identifies the QuarkXPress project being deconstructed. JOBJACKET CDATA #IMPLIED The name and absolute path (on the server computer) of the Job Jackets file to use during construct. Not applicable. The name and path of the Job Jackets file associated with the deconstructed project.
PAGE 262
MODIFIER SCHEMA (ANNOTATED) 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. Specifies the height of the screen for layout family's target device. Not applicable. Not applicable. Specifies the width of the screen for layout family's target device.
PAGE 263
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Not applicable. Can be used to set an upper limit on the Not number of pages that may be generated applicable. using each of the CONDITIONALMASTERPAGEREFERENCE Attributes MAXREPEATS REPEATABLEMASTERPAGEREFERENCE (Modifier Schema) Element type Construct Modify Deconstruct REPEATABLEMASTERPAGEREFERENCE (NAME*, MAXREPEATS*) Not applicable. This sub-sequence is useful for Not applicable. constructing runs of identical pages.
PAGE 264
MODIFIER SCHEMA (ANNOTATED) RICHTEXT (Modifier schema) Element type Construct Modify Deconstruct RICHTEXT (#PCDATA) Describes formatting for text. Use this element to apply additional formatting besides formatting applied with a paragraph or style sheet. Describes formatting for text. Use this element to apply additional formatting besides formatting applied with a paragraph or style sheet. Describes formatting for text, other than formatting applied with a paragraph or style sheet.
PAGE 265
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct mapping functionality in mapping functionality in QuarkXPress Server). If the QuarkXPress Server). font specified in the XML is missing and if the MISSINGFONT attribute is present then this becomes the basis for applying font fallback on the particular text run if the FontFallBack preference is enabled. Otherwise this would cause an error because the required font is missing. mapping functionality in QuarkXPress Server).
PAGE 266
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct NONBREAKING (true | false | none) "none" Specifies if the text will be nonbreaking or not. Used for special character (e.g., for a hyphen: Specifies if the text will be nonbreaking or not. Used for special characters (e.g., for a thinspace: Specifies if the text will be nonbreaking or not. Used for special characters (e.g.
PAGE 267
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Specified as an integer Specified as an integer integer percentage from 25 percentage from 25 to 400. percentage from 25 to 400. to 400. TRACKAMOUNT CDATA #IMPLIED Adjusts the amount of space between characters and words. Adjusts the amount of space between characters and words. Identifies an amount of adjusted space applied between characters and words.
PAGE 268
MODIFIER SCHEMA (ANNOTATED) Element type Construct OT_NONE (true | false Removes OpenType formatting from text. | none) "none" Modify Deconstruct Removes OpenType formatting from text. Indicates the OpenType formatting has been removed from text. Applies the OpenType superscript type style to text. Identifies the OpenType superscript type style applied to text. OT_SUPERSCRIPT (true | false | none) "none" Applies the OpenType superscript type style to text.
PAGE 269
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct substituting them for the default designs. substituting them for the default designs. substituting them for the default designs. Replace default forms of OT_LOCALIZED_FORMS (true | false | none) glyphs with localized forms. "none" Replace default forms of glyphs with localized forms. Replace default forms of glyphs with localized forms.
PAGE 270
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Specifies the dictionary preference used for hyphenation. Identifies the dictionary preference used for hyphenation. Sending is a character spacing attribute used particularly in East Asian typography, similar to kerning, but applicable as a fixed value over a range of text. Sending is a character spacing attribute used particularly in East Asian typography, similar to kerning, but applicable as a fixed value over a range of text.
PAGE 271
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct glyph cannot be represented as text. OTVARIANT CDATA #IMPLIED Specifies which variant to use from among the multiple match found (if any). Specifies which variant to use from among the multiple match found (if any). Specifies which variant to use from among the multiple match found (if any).
PAGE 272
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct attribute identifies the anchor by name. 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.
PAGE 273
MODIFIER SCHEMA (ANNOTATED) RIGHTGRID (Modifier schema) Element type Construct Modify Deconstruct RIGHTGRID (empty) Describes a grid line on the Describes a grid line on the Not applicable. right edge of a cell in an right 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.
PAGE 274
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct ROWCOUNT CDATA #REQUIRED Specifies the index position of a row from top to bottom. For example, ROWCOUNT = 1 indicates the first row from the top, and ROWCOUNT = 2 indicates the second row from the top. Specifies the index position of a row from top to bottom. For example, ROWCOUNT = 1 indicates the first column from the top, and ROWCOUNT = 2 indicates the second row from the top.
PAGE 275
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct AUTOFIT (true | false Specifies whether the rows Specifies whether the rows Specifies 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 276
MODIFIER SCHEMA (ANNOTATED) Element type Construct This attribute specifies PLACEMENT (ABOVE | BELOW | RIGHT | LEFT) whether rubi text displays above or below the base "ABOVE" text (in a horizontal story) or to the left of or right of the base text (in a vertical story). Modify Deconstruct This attribute specifies whether rubi text displays above or below the base text (in a horizontal story) or to the left of or right of the base text (in a vertical story).
PAGE 277
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct of text in the paragraph (for of text in the paragraph (for of text in the paragraph (for rule below). rule below). rule below). COLUMN = Rule extends to edges of parent box or column. COLUMN = Rule extends to edges of parent box or column. COLUMN = Rule extends to edges of parent box or column. INDENTS = Rule extends from the paragraph's left indent to its right indent.
PAGE 278
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Note: Only the name of a Dashes & Stripes style is included in this attribute. The definition of the Dashes & Stripes style is stored in the projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server. Note: Only the name of a Dashes & Stripes style is included in this attribute.
PAGE 279
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct or PICTUREBOUNDS. Moves the top edge of the runaround by the specified number of points (positive=up, negative=down). or PICTUREBOUNDS. Moves the top edge of the runaround by the specified number of points (positive=up, negative=down). or PICTUREBOUNDS. Moves the top edge of the runaround by the specified number of points (positive=up, negative=down). RIGHT CDATA #IMPLIED Valid when RUNAROUND@TYPE = ITEM or PICTUREBOUNDS.
PAGE 280
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct the maximum integer percentage of darkness that should be considered white when creating a runaround path. the maximum integer percentage of darkness that should be considered white when creating a runaround path. the maximum integer percentage of darkness that should be considered white when creating a runaround path. SMOOTHNESS CDATA #IMPLIED Valid when RUNAROUND@TYPE=AUTOIMAGE, ALPHACHANNEL, or NONWHITEAREAS.
PAGE 281
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct NEWNAME CDATA #IMPLIED Specifies a name for the project being saved. Specifies a name for the Not applicable. project being saved. Can be a relative path to the document pool. PATH CDATA #IMPLIED The absolute path on the The absolute path on the Not applicable. server computer for saving server computer for saving the project. the project.
PAGE 282
MODIFIER SCHEMA (ANNOTATED) SECTION (Modifier schema) Element type Construct Modify Deconstruct SECTION (empty) Describes a section break in Describes a section break in Specifies a section in a a layout. a layout. QuarkXPress layout. Attributes PREFIX CDATA #IMPLIED The prefix to be added before each automatic page number inserted in this section. The prefix to be added before each automatic page number inserted in this section.
PAGE 283
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Identifies the color of a drop shadow. Identifies the color of a drop shadow. 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, defined using the Document Controls submenu in QuarkXPress Server, or an existing color created and saved in the project. Note: Only the name of a color is included in this attribute.
PAGE 284
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct SYNCHRONIZEANGLE (true | false) "false" Specifies whether to synchronize the angle of a drop shadow with the angles of other drop shadows in the layout. Specifies whether to synchronize the angle of a drop shadow with the angles of other drop shadows in the layout. Specifies whether to synchronize the angle of a drop shadow with the angles of other drop shadows in the layout.
PAGE 285
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct Note: A box can shrink on the same page or on other spreads and pages. SHRINKDOWN (Modifier schema) Element type Construct Modify Deconstruct SHRINKDOWN (#PCDATA) Not applicable. Shrinks a box vertically Not applicable. toward the top of the page by the specified number of points. Note: A box can shrink on the same page or on other spreads and pages.
PAGE 286
MODIFIER SCHEMA (ANNOTATED) SPINEIMAGE (Modifier schema) Element type Construct Modify Deconstruct SPINEIMAGE (#PCDATA) Not applicable. Part of the Specifies the path of the spine image (if any). element. Specifies the path of the spine image (if any). Not applicable. If true, a spine image is included with Blio eBook output. If true, a spine image is included with Blio eBook output.
PAGE 287
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct INCOMPLETE (true | false) "false" Specifies whether shape is associated with UNFINISHED box. Specifies whether shape is associated with UNFINISHED box. Specifies whether shape is associated with UNFINISHED box. VERTSELECTED (true | false) "false" Specifies whether one or more verts are selected. Specifies whether one or more verts are selected. Specifies whether one or more verts are selected.
PAGE 288
MODIFIER SCHEMA (ANNOTATED) STORY (Modifier schema) Element type Construct Describes a text story in a STORY (COPYFIT?, text box or a chain of text FITTEXT?,(PARAGRAPH boxes. | RICHTEXT | ANCHOREDBOXREF | LINKEDBOX | TEXTNODEPH | TEXTPH | HIDDEN | LIST | RUBI | CALLOUTANCHOR | INLINETABLE | INLINEBOX | PAGEBREAK)*, OVERMATTER?) Modify Deconstruct Describes a text story in a text box or a chain of text boxes. Describes a text story in a text box or a chain of text boxes.
PAGE 289
MODIFIER SCHEMA (ANNOTATED) SUPPRESSOUTPUT (Modifier schema) Element type Construct Modify Deconstruct SUPPRESSOUTPUT (#PCDATA) Specifies whether a box is included in output. Specifies whether a box is included in output. Specifies whether a box is included in output. A true value does not include the box; a false value includes the box. A true value does not include the box; a false value includes the box. A true value does not include the box; a false value includes the box.
PAGE 290
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct OPERATION (CREATE | DELETE) #IMPLIED Not applicable. Specifies whether to create Not applicable. or delete the indicated table. ROWS CDATA #IMPLIED Specifies the number of rows in a table, including the header. Specifies the number of rows in a table, including the header. Specifies the number of rows in a table, including the header. COLUMNS CDATA #IMPLIED Specifies the number of columns in a table.
PAGE 291
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct BLENDCOLOR CDATA #IMPLIED Specifies the second color of the blend. The first color of the blend is the color applied to the table, as in QuarkXPress. Specifies the second color of the blend. The first color of the blend is the color applied to the table, as in QuarkXPress. Specifies the second color of the blend. The first color of the blend is the color applied to the table, as in QuarkXPress.
PAGE 292
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct BREAKHEIGHT CDATA #IMPLIED Specifies the height at which a table is set to break. Specifies the height at which a table is set to break. Indicates the height at which a table is set to break. MAINTAINLINK (true | false) "true" Specifies whether a child table will maintain a link to its parent. Specifies whether a child table will maintain a link to its parent. Specifies whether a child table will maintain a link to its parent.
PAGE 293
MODIFIER SCHEMA (ANNOTATED) TCOL (Modifier schema) Element type Construct Modify Deconstruct TCOL (LEFTGRID?, RIGHTGRID?) Describes a column in an . Describes a column in an . Not applicable. COLINDEX CDATA #REQUIRED Identifies the position of the column, with the first column being column 1. Identifies the position of the column, with the first column being column 1. Not applicable.
PAGE 294
MODIFIER SCHEMA (ANNOTATED) TEXT (Modifier schema) Element type Construct Modify Deconstruct TEXT ((INSET)*, STORY) Container for an INSET and STORY element. Container for an INSET and STORY element. Container for an INSET and STORY element. ANGLE CDATA #IMPLIED Specifies a rotation angle for text as a floating-point value between –360 degrees and 360 degrees. Specifies a rotation angle for text as a floating-point value between –360 degrees and 360 degrees.
PAGE 295
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct OFFSET CDATA #IMPLIED Specifies the distance between the first text baseline in the text box and the top inside edge of the text box. Specifies the distance between the first text baseline in the text box and the top inside edge of the text box. Indicates the distance between the first text baseline in the text box and the top inside edge of the text box. RUNTEXTAROUNDALLSIDES Indicates text runaround on all sides of an item.
PAGE 296
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct | OVERMATTER | TEXTPH)*, METADATA?) region of text, and can contain further text node placeholders and text placeholders. region of text, and can contain further text node placeholders and text placeholders. region of text, and can contain further text node placeholders and text placeholders. NAME CDATA #REQUIRED The name of the text node placeholder. A placeholder name may not be Unique within the Box or XML Hierarchy.
PAGE 297
MODIFIER SCHEMA (ANNOTATED) TFOOT (Modifier schema) Element type Construct Modify Deconstruct TFOOT (TROW+) Identifies the footer portion Identifies the footer portion Not applicable. of an . of an . THEAD (Modifier schema) Element type Construct Modify Deconstruct THEAD (TROW+, TCONTINUED?) Identifies a header in an . Identifies a header in an . Not applicable.
PAGE 298
MODIFIER SCHEMA (ANNOTATED) Element type Construct Modify Deconstruct WIDTH CDATA #IMPLIED Specifies the width of the grid line in points. Specifies the width of the grid line in points. Not applicable. COLOR CDATA #IMPLIED Specifies the color of the grid line. Specifies the color of the grid line. Not applicable. SHADE CDATA #IMPLIED Specifies the shade of the grid line. Specifies the shade of the grid line. Not applicable.
PAGE 299
MODIFIER SCHEMA (ANNOTATED) TROWSTYLE (Modifier schema) Element type Construct Modify Deconstruct TROWSTYLE (TOPGRID?, BOTTOMGRID?) Defines a style for rows in an . Defines a style for 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 300
MODIFIER SCHEMA (ANNOTATED) VERTEX (Modifier schema) Element type Construct Modify Deconstruct VERTEX (LEFTCONTROLPOINT?, VERTEXPOINT, RIGHTCONTROLPOINT?) A single vertext (i.e. Line A single vertext (i.e. Line A single vertext (i.e. Line segment) in a bezier curve. segment) in a bezier curve. segment) in a bezier curve. Attributes SMOOTHVERTEX (true | false) "false" Specifies whether the given Specifies whether the given Specifies whether the given vertex is "straight" — i.e.
PAGE 301
MODIFIER SCHEMA (ANNOTATED) VERTICES (Modifier schema) Element type Construct Modify Deconstruct VERTICES (VERTEX+) A collection of vertexes A collection of vertexes A collection of vertexes which, combined, make up which, combined, make up which, combined, make up a contour. a contour. a contour. WIDTH (Modifier schema) Element type Construct Modify Deconstruct WIDTH (#PCDATA) Indicates the width of an item. Indicates the width of an item. Indicates the width of an item.
PAGE 302
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 303
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 304
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 305
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 306
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 307
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 308
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 309
QUARKXPRESS SERVER XTENSIONS SOFTWARE By default, convertsectionstopagestacks is false. A GUIDE TO QUARKXPRESS SERVER 10.
PAGE 310
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 311
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 312
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 313
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 314
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 315
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 316
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 317
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 318
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 319
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 320
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 321
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 322
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 323
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 324
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 325
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 326
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 327
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 328
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 329
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 330
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 331
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 332
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 333
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 334
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 335
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 336
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++. 336 | A GUIDE TO QUARKXPRESS SERVER 10.
PAGE 337
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 338
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 339
INDEX Index .
PAGE 340
INDEX creation date 149 fonts, applying 83 custom error messages 333, 334 fonts, required 151 FOOTER element type 226 D DATAPROVIDER element type 220 deconstruct 33, 106, 107 default render type 20 DEL element type 221 delete request handler 146 DELETECELLS element type 221 FOOTERTROWSTYLE element type 226 FORMAT element type 227 formatting text 97 FRAME element type 229 frames 26 G deleting files 146 geometry 88 demonstration code 175 GEOMETRY element type 230 DESCRIPTION element type 221 GET
PAGE 341
INDEX inline boxes 117 LINKEDBOX element type 247 inline tables 126 LIST element type 248 INLINEBOX element type 237 literal render type 59 INLINETABLE element type 239 load balancing 171, 324 INS element type 239 local formatting 121 INSET element type 239 LOCATION element type 248 interactive elements 136 LOCKTOGRID element type 248 INTERACTIVITY element type 240 log levels 19 ISBN element type 241 log, fatal 19 items, grouping and ungrouping 96 log, transaction 19 items, grouping and
PAGE 342
INDEX Objective-C client 176 projects 12 ODDTCOLSTYLE element type 251 proxy servers 330 ODDTROWSTYLE element type 251 PUBLICATION element type 261 ORIGIN element type 252 PUBLICATIONCHANNEL element type 262 OVERMATTER element type 252 PUBLISHER element type 262 P Q PAGE element type 252 qcddoc render type 67 page numbering 128 QContentData 41 PAGEBREAK element type 253 QException 41 PAGEREF element type 254 QLA 13 pages, manipulating with XML 112 QManagerScriptingSvc 41 pages, moving
PAGE 343
INDEX S sample code 175 SAVEAS element type 280 saving projects with a different name 85 SCALETO element type 281 scaling output 81 screenpdf render type 70 Scroll Zone interactivity 137 SECTION element type 282 sections, manipulating with XML 128 server configuration 322, 332 server information, retrieving 155 server templates 11 ServerpApp.
PAGE 344
INDEX W Web services 35, 41 Web View interactivity 139 WIDTH element type 301 WSDL 41 X XML modify 89, 112 XML, importing 86 XSLT 130 XTensions manager 19 XTensions modules, required 151 XTensions software 15, 304 XTensions software API 15 XTensions software development 336 XML 33, 306, 307 XML construct 106, 109, 110, 112 XML deconstruct 106, 107 XML Import 86, 120, 132 344 | A GUIDE TO QUARKXPRESS SERVER 10.