| |
The Output Type drop-down menu contains the |
| |
Similarly, the input fields for entering the picture box name and the file to be flowed into it will display on the HTML page using the following lines of code: |
| |
This completes the UI section of the form. Next you need a button on the form that will process the request and send it to QuarkXPress Server. For this you must create a button on the form. When the button is clicked, it will call the function Submit_onclick().document.getElementById("box2File").name = ""; } document.getElementById("Page").name = "Page"; document.getElementById("Layout").name = "Layout"; url = prefix + port + renderer + file; document.getElementById("form1").action = url; } This function reads the values you input in the various fields of the HTML form (server, port, project name, scale, output type, text box name, text file to be flowed, picture box name, picture file to be flowed, page number, and layout number).
Integrating and enhancing QuarkXPress Server Manager This section is for those who want to enhance QuarkXPress Server Manager or integrate it with other software. Please refer to http://localhost:8090/qxpsmdocs/apidocs/index.html for manager API documentation. (Note that the port number used to retrieve the API documentation is 8090 by default, but you should use whatever port number you specified when installing QuarkXPress Server Manager.
configManager.setLogLevel(STANDALONE_CLIENT_LOG_LEVEL); configManager.setPingType(QPingTypeEnum.PING_SIMPLE); QConnectionInfo connInfo = new QConnectionInfo(); connInfo.setServerName(); connInfo.setServerPort(); connInfo.setUserName(); connInfo.setPassword(); QHostSummary host = new QHostSummary(); host.setConnectionInfo(connInfo); configManager.
Returns getLoadBalancerDescription Signature Description Returns useFileInfo Signature Description Returns getAvailableHost Signature Description Parameters The algorithm name used to load balance the list of hosts. public String getLoadBalancerDescription(); Gets the description of the load balancing algorithm, which will be displayed in the admin client. Description of the load balancer.
5. 5. 5. 6. 6. 7. 7. 7. 8. 8. Now define the bean id with your new bean ID above this ConfigureManager tag: Restart the Tomcat server. Log on with the admin client and select the menu option: Global Setting > Load Balancer Method > Choose Load Balancer. Locate your new Load Balancer method and select Save. Generating custom client SDK class To generate a custom client SDK class, add new classes and generate new stubs as described below.
errors. If you encounter an error, address the problem and execute "Server/utilities/stub.sh" or "Server/utilities/stub.bat" again. If the process succeeds, "managerwebservicestubs.jar" is generated in the 1. Server/utilities directory. Use these Java stubs in your Java applications that communicate with QuarkXPress Server Manager. 2. 2. If the application you are developing is in Visual Studio .NET, then you need to generate stubs again.
name generated would be "set" + CamelCase(name). For example, if the name of the property were "quality," the default mutator method would be "setQuality." It can be overridden by using this attribute (e.g., "setJPEGQuality"). Description: Description of the property. Unless it has a null value, the description would be included in variable headers and accessor and mutator headers. This information is also included in generated API docs.
Scripting support You can write server-side scripts for QuarkXPress Server Manager. These scripts are actually clients that run in the same context as QuarkXPress Server Manager in Tomcat but do not have the overhead of SOAP. QuarkXPress Server Manager ships with QuarkXPress Server Manager Scripting Environment for editing scripts, but you can use almost any script-editing application.
Keep document open (sessions) In earlier versions of QuarkXPress Server Manager, the software opened a QuarkXPress project, performed a function, and then closed the project. To avoid the delays involved in repeatedly opening and closing a QuarkXPress project, QuarkXPress Server Manager can now keep QuarkXPress projects open until they need to be closed. To keep projects open for a set period of time, you can now create a session and then open one or more projects in that session.
Function overview This section provides an overview of available functions in QuarkXPress Server. For detailed information about a specific function, click on the function name. Note: QuarkXPress Server uses case-sensitive XML code. For QuarkXPress Server Manager users This section describes the object model by including the collection of request classes that can be chained together to form compound QuarkXPress Server requests.
box boxes layer layout page pages scale spread spreads Renders a single box identified by the supplied name or item ID. Renders one or more boxes identified by the supplied names or item IDs. Renders only the layers identified by the supplied names. Renders the layout identified by the supplied name, regardless of which layout was active when the project was last saved. Renders only the identified page. Renders only the identified pages. Indicates the scale at which the project should be rendered.
XML modify The modify parameter lets you modify QuarkXPress projects using XML. Function Modifying box properties and content Creating boxes Deleting boxes Creating tables Modifying picture properties Modify text attributes Importing data QuarkXPress Server Manager object model classes Lets you modify box properties ModifierFileRequest and content. ModifierRequest ModifierStreamRequest Project Box Geometry Layout Runaround Lets you create boxes.
Content Layout XML deconstruct and construct The following namespaces let you construct, deconstruct, and reconstruct entire QuarkXPress projects using XML. QuarkXPress Server Manager Function Description object model classes xml Returns an XML representation of XMLRequest a QuarkXPress project. construct Turns an XML representation into ConstructRequest a QuarkXPress project.
setprefs saveas shutdown Sets one or more preference settings. Lets you save a copy of a file in any location available to QuarkXPress Server. Shuts down the server.
Render types The process in which a QuarkXPress project is opened in QuarkXPress Server and transformed into another file format (or another QuarkXPress project) is called Rendering . The render type is the format of the project that was rendered and returned to the user or saved to disk. By default, the project render type used by QuarkXPress Server is JPEG. Note: Bitmap-based render types display in the browser when rendered, such as JPEG and PNG.
Logs Example GET URL Note pool. If the project is successfully rendered, a transaction success message is written to the QuarkXPress Server Transaction Log file. The transaction entry consists of the date and time of the request, render type, project name, type of response produced by server, size of response returned in bytes, and client IP address. The following is a sample of a transaction entry: 8/4/2005 13:49:36 - sample.qxp - Type: image/jpeg - Size: 64002 - Client: 127.0.0.
eps Requests EPS rendering of a page or spread in a QuarkXPress project. Namespace EPS Parameters outputstyle stylename Specifies an output style for EPS output. stylename is the name of an output style in the Output Styles dialog box. For example: http://localhost:8080/eps/sample.qxp ?outputstyle=mystylename document is the name of an output style saved in the project's Captured Settings. For example: http://localhost:8080/eps/sample.
Response Alerts Logs Example GET URL QuarkXPress Server Manager Object Model Notes A QuarkXPress project previewed in EPS format. The renderer for this HTTP Error #406 image type has no way This alert is displayed when you submit a render request with of rendering the the pages or box parameter. desired objects. What to do: Do not use the pages or box parameter with an EPS render type. It does not support these parameters.
Click the Server tab in the Server Configuration dialog box. Choose EPS from the Type drop-down menu in the Default Render area. Click OK. Now submit the EPS request without using the EPS namespace. Sample URL for this type of request is: http://localhost:8080/sample.qxp You can specify an output style and set additional local parameters of that output style. For example: http://localhost:8080/eps/sample.
jpeg Returns a JPEG file of a QuarkXPress project. Namespace JPEG Parameters jpegquality 1|2|3|4 upadateimage Render Modifier boxes Parameters page scale Response Alerts Logs true | false string integer Float .1 to 6.92 for Windows .1 to 8 on Mac OS) box spread string integer layout String Sets the image quality of a rendered JPEG image. The values are: 1 (highest quality), 2 (high quality), 3 (medium quality), and 4 (lowest quality). The default value is 1.
Example GET URL Example, Object Model Notes error log file. The transaction entry in the error log contain the date and time of the request, the error code, and the error message. The following is a sample of an error log transaction entry: 8/3/2005 11:27:24 - Error - Error Code: 10008 - The renderer for this image type has no way of rendering the desired objects. http://localhost:8080/jpeg/sample.
literal Returns the contents of a file without any attempt to process it as a template. The literal namespace returns any type of project requested. Depending on the file's MIME type, the requested project can be returned within the browser (for example, JPEG) or saved to disk (for example, a Microsoft® Word document). Namespace literal Parameters Response The requested file returned in the HTTP response.
png Returns a PNG file of a QuarkXPress project. Namespace PNG Parameters pngcompression 1|2|3|4 upadateimage Render Modifier boxes Parameters page scale box spread layout Response Alerts Logs Sets the PNG compression for the PNG output. The values are: 1 (lowest compression), 2 (medium compression), 3 (high compression), and 4 (highest compression). The default value is 1. true | false Specifies whether to return modified pictures in the response or not.
Example GET URL Example, Object Model Notes If an alert is displayed, an error message is written to the QuarkXPress Server Error Log file. 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 log transaction entry: 8/3/2005 11:27:24 - Error - Error Code: 10008 - The renderer for this image type has no way of rendering the desired objects. http://localhost:8080/png/sample.
postscript Generates a PostScript file of a QuarkXPress project. Namespace PostScript Parameters prntbleed Page | asym, clip, top, bottom, left, right | sym, clip, amount Render Modifier Parameters outputstyle stylename, document page integer pages String (page range) spread integer prntbleed=asym, clip, top, bottom, left, right : Specifies asymmetric bleed values for a page.
Response Alerts Logs number 1 refers to the first page (which is the first spread) in a project. layout String Specifies the layout name or number to render. Layout numbers start with 1; layout=1 refers to the first layout in the project. You can also specify the layout name with this parameter. The QuarkXPress project is printed as PostScript. This page range is HTTP Error #500 invalid.
Notes properties sdk.QRequestContext requestCtx = new sdk.QRequestContext(); boolean responseAsURL = false; requestCtx.setDocumentName(docName); //STEP 2(SPECIFIC TO REQUESTS):Create the Post Script renderer request and embed it in the request context. PostScriptRenderRequest pscreq = new PostScriptRenderRequest(); pscreq.setPrintBleed(request.getParameter("PrintBleed")); pscreq.setPrintPPD(request.getParameter("PrintPPD")); pscreq.setPages(request.getParameter("Pages")); requestCtx.
used with the parameter outputstyle=document. Note: this will map to the Captured Settings in the Print dialog box.
pdf Returns a PDF file of a QuarkXPress project. Names PDF pace Param outputstyl stylename, document eters e Specifies an output style for PDF output. stylename is the name of an output style in the Output Styles dialog box. For example: http://localhost:8080/pdf/sample.qxp? outputstyle=stylename document is the name of an output style saved in the document's Captured Settings as defined in the Export as PDF dialog box. For example: http://localhost:8080/pdf/sample.
plates converttoprocess, processandspot, inripseps producebl 1 | 0 | true | false | yes | no ankpages useopi 1 | 0 | true | false | yes | no images includeimages, omittiff, omittiffandeps registratio off, centered, offcenter n offset 0-30 (in points) bleed pageitemsonly, symmetric offsetblee 0-6 (in inches) d spreads 1 | 0 | true | false | yes | no lowresolut 1 | 0 | true | false | yes | no ion colorimag 9-2400 edownsa mple grayscalei 9-2400 magedow nsample monochro 9-2400 meimaged ownsampl e colorc
psfile string thumbnail bw | color mode composite | separations fontdownl yes | no oad layers string transpare Integer value from 36 to 3600 ncyres verificatio pdfx1a | pdfx3 n separate yes | no producebl yes | no ankplates download Boolean 1 | 0 | true | false parameter only when "PDF to Folder" is set in PDF preferences. Saves the postscript file with the name given with the parameter. You can use this parameter only when "PostScript for later Distilling" is set in PDF preferences.
Rende page r pages Modifi er spread Param eters layout spreads integer String (page range) integer String shown as doc.qxp. Ideally, this should not be used by the customer, as giving this parameter as FALSE is the same thing as not giving this parameter at all. Specifies the single page to be rendered. Specifies the multiple pages to be rendered. Specifies which spread to render. Spread numbers start with 1; spread number 1 refers to the first page (which is the first spread) in a project.
of the request, render type, project name, type of response produced by server, size of response returned in bytes, and client IP address. The following is a sample of a transaction entry: 8/2/2005 17:17:17 - pdf/sample.qxp - Type: application/pdf - Size: 1927016 - Client: 127.0.0.1. If an alert is displayed, an error message is written to the QuarkXPress Server Error Log file. The transaction entry in the error log contains the date and time of the request, the error code, and the error message.
Choose the menu option QuarkXPress Server > Preferences to display the Preferences dialog box. Select the PDF option and choose PDF to folder from the Destination drop-down menu in the Workflow area. Click Browse and choose the destination folder. It generates a PDF file in the destination folder. To generate Postscript for later distilling Choose the menu option QuarkXPress Server > Preferences to display the Preferences dialog box.
You can specify that the project's embedded PDF settings are to be used with the parameter outputstyle=document. Note: this will map to the Captured Settings in the Export as PDF dialog box.
ppml Requests PPML rendering of a page or spread in a QuarkXPress project. Namespace PPML Parameters outputstyle stylename Lets you specify an output style for PPML output. stylename is the name of an output style in the Output Styles dialog box. For example: http://localhost:8080/ppml/sample.qx p?outputstyle=mystylename document is the name of an output style saved in the project's Captured Settings. For example: http://localhost:8080/ppml/sample.
Alerts Logs The renderer for this image type has no way of rendering the desired objects. HTTP Error #406 This alert is displayed when you submit a render request with the pages or box parameter. What to do: Do not use the pages or box parameter with a PPML render type. It does not support these parameters. This Output Style does This alert is displayed when you specify a non-existent output not exist. style.
Notes To generate an PPML image without using the PPML namespace Click the Server tab in the Server Configuration dialog box. Choose PPML from the Type drop-down menu in the Default Render area. Click OK. Now submit the PPML request without using the PPML namespace. Sample URL for this type of request is: http://localhost:8080/sample.qxp You can specify an output style and set additional local parameters of that output style.
qxpdoc Returns a QuarkXPress project. Namespace qxpdoc Parameters qxpdocver upadateimage Render Modifier layout Parameters Response Alerts 7 | 8 | korean6 | japanese6 true | false String Specifies the version in which the project is to be rendered. By default, a rendered project is returned in the same version as the installed instance of QuarkXPress Server. This parameter saves a QuarkXPress project to the same or lower version. Rendering of QXP4J/K and QXP6J/K documents is also supported.
Logs Example GET URL Example, Object Model Notes same or higher version in which it was created. If the project is successfully rendered, a transaction success message is written to the QuarkXPress Server Transaction Log file. The transaction entry consists of the date and time of the request, render type, project name, type of response produced by server, size of response returned in bytes, and client IP address. The following is a sample of a transaction entry: 8/3/2005 12:15:21 - qxpdoc/sample.
http://localhost:8080/sample.
qcddoc Returns a QuarkCopyDesk article, which is a contiguous text flow of text that can occupy one or more linked boxes in QuarkXPress. A QuarkCopyDesk article can contain multiple components, which are independent text flows. QuarkXPress Server handles QuarkCopyDesk articles as a render type and a document provider. The qcddoc namespace is the render type, which allows a QuarkCopyDesk article to be rendered.
saveastemplate Rende modify r Modifi er Param eters true | false XML bc.qxp?article= article1&forma t=fullfeatured Outputs the article file (.qcd) as an article template (.qct). Accepts well-formed XML as an input and modifies the project accordingly. Respo A QuarkCopyDesk article nse Alerts There is no box with the specified identifier. The specified box for a component in the article does not exist. What to do: Use a valid box name or ID.
screenpdf Overrides the setting in the PDF Workflow area of the PDF pane in the Preferences dialog box (PDF Direct, PDF to Folder, or PostScript File for Later Distilling ) and always returns a low-resolution PDF to the browser. Namespace Screenpdf Parameters outputstyle stylename Specifies an output style for PDF output. stylename is the name of an output style in the Output Styles dialog box. For example: http://localhost:8080/screenpdf/sampl e.
plates converttoprocess, processandspot, inripseps produceblankpages 1 | 0 | true | false | yes | no useopi 1 | 0 | true | false | yes | no includeimages, omittiff, omittiffandeps images registration off, centered, offcenter offset 0-30 (in points) bleed pageitemsonly, symmetric 0-6 (in inches) offsetbleed spreads 1 | 0 | true | false | yes | no lowresolution 1 | 0 | true | false | yes | no colorimagedownsampl 9-2400 e grayscaleimagedownsa 9-2400 mple monochromeimagedo 9-2400 wnsample color
monochromecompress true | false ion pdffile string psfile string thumbnail mode bw | color composite | separations yes | no fontdownload Render Modifier Parameters Response Alerts Specifies whether to apply ZIP compression to monochrome images. Saves the PDF file under the name given with the parameter. You can use this parameter only when PDF to Folder is selected in the PDF Workflow area of the PDF pane in the Preferences dialog box.
invalid. Logs QuarkXPress Server Error #147 This alert is displayed when you try to render a page range that exceeds the number of pages in the QuarkXPress project. What to do: Check the number of pages in the project and enter a valid page range to render. No file produced. The HTTP Error #500 document requested This alert is displayed when you try to render a blank contains only blank project. pages.
Notes QManagerSDKSvcServiceLocator serviceLocator = new QManagerSDKSvcServiceLocator(); QManagerSDKSvc service = serviceLocator.getqxpsmsdk(); sdk.QContentData data = service.processRequest(requestCtx); Please refer to the samples for further details on the use of the WIG object model. To view the PDF image in a browser on Windows The Adobe Acrobat plug-in is required to view PDF documents in a browser on Windows.
fontname Specifies the font to be applied to new text flow. When this parameter is used, QuarkXPress Server ignores the original font of the text box and inserts the new text with the font specified by the parameter. Parameters [boxid/boxname]:fo string Works with the combination of boxid ntname and boxname. Replaces the font. This parameter can also be used with dataimport: [boxname]fontname@dataimport= Response Preview of project with font applied on new text in text box.
Inserting a picture Places a new picture in an empty picture box or replaces an existing picture with a new one. Parameters string This parameter replaces the content of the box named with a new picture file. The new picture file is specified by the file: indicator. The picture file must be present in the document pool. Response The QuarkXPress project with a new picture in the picture box. Alerts File not found.
Example GET URL Example, Object Model Notes error log. The following is a sample of the error log entry: 8/10/2005 10:39:07 - Error - Error Code: 10339 - The specified file failed to load in the picture box. http://localhost:8080/sample.qxp?PictureBox=file:FrenchOpen.pdf Request Object Name: RequestParameters sdk.QRequestContext rc = new sdk.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.
is the picture box name and the picture file "Tennis.pdf" exists in the subfolder "Content" in the document pool.
Inserting text Adds new text to the text box or replaces existing content. Parameters string Response Alerts Logs Example GET URL Example, Object Model The string parameter replaces the content of the text box named with a new string value. Use the file: indicator to replace the contents of the text box with text saved in a file. The QuarkXPress project with the new contents in the text boxes. File not found.
Notes RequestParameters request = new RequestParameters(); NameValueParam nameValue1 = new NameValueParam(); nameValue1.paramName = this.boxname1.Text; if(!this.boxvalue1.Text.Equals("")) nameValue1.textValue = this.boxvalue1.Text; request.params = new NameValueParam[]{nameValue1}; rc.request = request; //Create the service and call it with QRequestContext object QManagerSDKSvcService svc = new QManagerSDKSvcService(); sdk.QContentData qc = svc.
Picture effects Applies and removes existing picture effects on images via a Web browser. Using various parameters, picture effects created in QuarkXPress (Vista effects) can be applied to or removed from the rendered images of QuarkXPress projects. QuarkVista effects work only with projects created in QuarkXPress 6.0 and later. Parameters applyvistaeffect string Lets you apply preset effects to pictures. The picture boxes on which Vista effects are to be applied are specified by the vistabox parameter.
Quarkxpress v5 format. Downsaving the document without picture effects. Invalid Preset File! Logs document. What to do: You cannot apply Vista effects on QuarkXPress 5.0 documents. HTTP Error #500 This alert is displayed if the preset file is present at the Preset location but is an invalid file. What to do: Give a valid preset file name in the request. There is no Picture HTTP Error #500 Effect with that This alert is displayed when you give a non-existent preset file name.
Example, Object Model Notes removed. Request Object Names : VistaRequest sdk.QRequestContext rc = new sdk.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.Text; //STEP 2(SPECIFIC TO REQUESTS):Create the QuarkVista request and embed it in request context VistaRequest vistareq = new VistaRequest(); vistareq.deleteVistaEffect = this.deletevistaeffect.Text; vistareq.vistaBox = this.vistabox.Text; vistareq.applyVistaEffect = this.
What happens if I open a project containing Vista effects but the XTensions software is not loaded? An error message is written to the QuarkXPress Server error logs (if error reporting is on): "Error. Vista XTensions module is not present." What is the default value for Picture Effects Preset Location? The default selection in the Picture Effects Preset Location area in the Preferences dialog box is QuarkXPress Server Preferences Folder.
saveas Lets you save modified QuarkXPress projects in any supported format to any location on the network and also in the QuarkXPress Server document pool. When this request is sent to Server Manager, either through HTTP or Web service, the document is saved in all registered QuarkXPress servers if the common doc pool has been switched off in the admin client. If the common doc pool is turned on, the document is saved in any one of the registered QuarkXPress servers.
Logs Example GET URL Example, Object Model Notes other valid path. If the project is successfully rendered, a transaction success message is written to the QuarkXPress Server Transaction Log file. The transaction entry consists of the date and time of the request, the render type, the project name, the type of response produced by the server, the size of the response returned in bytes, and the client IP address. The following is a sample of a transaction entry: 11/16/2005 15:41:42 - saveas/5mb.
XML import Imports data into text boxes and picture boxes through XML and QuarkXPress Placeholders. Parameters thexmldoc XML Accepts well-formed XML as input and applies those XML values to the rendered project . layout string Specifies the layout name or number to render. Layout numbers start with 1; layout=1 refers to the first layout in the project . You can also specify the layout name with this parameter.
Notes //STEP 2(SPECIFIC TO REQUESTS):Create the XML Import request XMLImportRequest xmlimportreq = new XMLImportRequest(); xmlimportreq.XMLDocument = this.thexmldoc.Text; 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 QManagerSDKSvcService svc = new QManagerSDKSvcService(); sdk.QContentData qc = svc.
paginate Merges XML content into a template that you have set up in QuarkXPress using XML Import XTensions software. Namespace paginate Parameters paginate XML Accepts well-formed XML as input and applies those XML values to the rendered project. Creates pages based on the number of records in the XML. Response Preview of the merged QuarkXPress project. Alerts Invalid XML String HTTP Error #500 This alert is displayed when an invalid XML string is passed as a value to the paginate parameter.
the layout (applied in QuarkXPress) is used, but you must include the paginate parameter. For example: http://localhost:8080/pdf/Sample.qxp?paginate You can specify an alternate XML file in the URL. This overrides the original XML file associated with the document.
Render modifiers Use render modifiers to control how a rendered project is previewed. Parameters page integer Specifies the single page to be rendered. pages String (page range) Specifies the multiple pages to be rendered. box string Returns a single box. boxes string Returns multiple boxes. scale Float Determines a percentage of the size of .1 to 6.92 for the page to be returned. The minimum Windows value for the scale parameter is .1 .1 to 8 for Mac (meaning 10% of size).
box Returns a single box. Parameters box overlap Response Alerts Logs Example GET URL Notes string string Returns a single box. Specifies whether to show the area overlapped by the specified box. Single box There is no box HTTP Error #500 with the specified This alert is displayed when you request a box that does identifier. not exist. What to do: Check the box name or box ID in the document and enter a correct box request. Cannot render HTTP Error #500 box.
x This request renders box name textbox present in page 3 of layout 2. When you render using the box parameter, box ID gets a higher priority than box name. When you submit a request to render a project with the box parameter using numeric box names, it first checks the internal IDs of boxes in the project and then checks for the names of the boxes. If there is a conflict between box ID and numeric box name, the box with the internal ID is rendered.
boxes Returns more than one box. Parameters boxes overlap Response Alerts Logs Example GET URL Notes string string Returns more than one box. Specifies whether to show the area overlapped by the specified boxes. The boxes requested There is no box HTTP Error #500 with the specified This alert is displayed when you request a box that does identifier. not exist. What to do: Check the box name or box ID in the document and enter a correct box request. Cannot render HTTP Error #500 box.
x This request renders box name textbox present in page 3 of layout 2. When you render using the box parameter, box ID gets a higher priority than box name. When you submit a request to render a document with the box parameter using numeric box names, it first checks the internal IDs of boxes in the document and then checks for the names of the boxes. If there is a conflict between box ID and numeric box name, the box with the internal ID is rendered.
layer Layers.qrc is a required component with QuarkXPress Server. The layers component enables you to display the contents of a layer (including hidden layers) with various parameters. By using this component, you can add, delete, and modify layers in a QuarkXPress project. Parameters layer string Specifies the name of a layer to be printed or viewed. You can specify multiple layers in one request. addlayer string Adds a new layer. You can add only one layer in one request.
keeprunaround Response Alerts 1 | 0 | true | false | yes | no conjunction with the addlayer and layerattribute parameters. This parameter overrides the locked settings done in layer preferences. Sets or changes the keeprunaround property of a layer. You can use this parameter in conjunction with the addl ayer and layerattribute parameters. This parameter overrides the keeprunaround settings done in layer preferences. Preview of QuarkXPress project This layer does not HTTP Error #500 exist.
Logs Example GET URL Example, Object Model Notes If the project is successfully rendered, a transaction success message is written to the QuarkXPress Server Transaction Log file. The transaction entry consists of the date and time of the request, the render type, the project name, the type of response produced by the server, the size of the response returned in bytes, and the client IP. The following is a sample of a transaction entry: 11/17/2005 17:19:48 - qxpdoc/layerlayout.
are set to false. How can a hidden layer be printed? A hidden layer will not be displayed in any render type unless that layer is explicitly called with the layer parameter. How can a layer with the suppressoutput property set to false be printed? A layer that has been marked in a QuarkXPress project with Suppress Output can be printed when it is specifically called with the layer parameter.
layout Renders the specified layout in the project. Parameters layout string Response Alerts Logs Example GET URL Notes Specifies the layout name or number to render. Layout numbers start with 1. Layout=1 refers to the first layout in the project. You can also specify the layout name with this parameter. Preview of project. The requested HTTP Error #500 layout does not This alert is displayed when an invalid layout value is given. exist. What to do: Give a correct layout value in the request.
page Returns a single page. Parameters page integer Specifies the single page to be rendered. Response Single page in rendered format Alerts The requested page HTTP Error #500 does not exist. This alert is displayed when you attempt to render a page that does not exist. What to do: Submit the request with a valid page number. The renderer for HTTP Error #406 this image type has This alert is displayed when you give a page parameter with no way of rendering the qxpdoc render type. the desired objects.
The following is an URL to render a page lying in a layout other than layout 1: http://localhost:8080/png/sample.qxp?layout=2&page=3 This request renders page 3, which is in layout 2 The page parameter supports the JPEG, PNG, PDF, PostScript, EPS, and PPML render types.
pages Returns multiple pages. Parameters pages Response Multiple pages Alerts This page range is invalid Logs Example GET URL Notes String (page range) Specifies the multiple pages to render. HTTP Error #500 QuarkXPress Server Error #147 This alert is displayed when you try to render a page range that exceeds the number of pages in the QuarkXPress project. What to do: Check the number of pages in the project and enter a correct page range to render.
scale Specifies the scale factor for enlarging or reducing rendered images. Used for all built-in formats that generate raster formats. Parameters scale Float Determines a percentage of the page size .1 to 6.92 for to be returned. The minimum value for Windows the scale parameter is .1 (meaning 10% .1 to 8 for Mac of size.). The maximum value for the scale parameter on Mac OS is 8 (meaning 800% of size). On Windows, the maximum scale value is 6.92 (692%). Response Preview of the project with scale applied.
spread Specifies which spread to render. Parameters spread Response Alerts Logs Example GET URL Example, Object Model Notes integer Specifies the spread number to render. Spread numbers start with 1. Spread number 1 refers to the first spread in the project. Preview of a project in a spread format. The requested HTTP Error #500 spread does not This alert is displayed when you use an invalid spread value. exist What to do: Enter a valid spread value.
spreads Specifies which spreads to render. Parameters spreads Response Alerts Logs Example GET URL Notes Boolean Generates the preview in spreads. 1 | 0 | true | false | yes | no Preview of the project in spread format. If the project is successfully rendered, a transaction success message is written to the QuarkXPress Server Transaction Log file.
About XML modify Modifies a QuarkXPress project using XML. The modify parameter has an associated DTD. The call structure required by the Modifier DTD is very similar to the call structure required in previous versions of QuarkXPress Server. Only minor modifications are necessary to upgrade solutions written for previous versions to work with this version. Note that one major change to this DTD is that it's important not to specify units when providing measurement values.
Notes If an alert is displayed, an error message is written to the QuarkXPress Server error log. The following is a sample of the error log entry: 8/10/2005 10:39:07 - Error - Error Code: 10339 - The specified file failed to load in the picture box. The xml namespace takes two arguments: The name of the project to be modified and a modify parameter that points to the XML file or string that describes how to create the project: http://QXPServer8:8080/project1.
Modifying box properties and content To modify box properties and content, use the following parameters in the Modifier DTD: BOX ID TEXT PICTURE GEOMETRY CONTENT SHADOW FRAME PLACEHOLDER METADATA Example The following XML shows how some of these parameters work.
20 30 true true 44 30 false 30 30
Logs Example GET URL What to do: Enter the correct XML file name and resubmit the request. The XML HTTP Error #500 document is not This alert is displayed when XML tags are not correctly valid or well formed. formed. What to do: Provide correct XML and resubmit the request. The XML HTTP Error #500 document contains An alert similar to this one is displayed when you enter an an invalid tag value. incorrect value for a tag. For example, you enter a string value for a tag that accepts a numeric value.
Box Geometry Runaround ModifierFileRequest : member contents is used to set the file path or send the XML itself. sdk.QRequestContext rc = new sdk.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.
outsideOnly, pathName, restrictToBox, right, smoothness, threshold, top, type Related topics: About XML modify Creating boxes Deleting boxes Modifying picture properties Modifying text attributes Page 120
Creating boxes To create a new box, use the following parameters in the Modifier DTD: BOX ID TEXT PICTURE GEOMETRY CONTENT SHADOW FRAME Example The following XML shows how some of these parameters work.
Logs Example GET URL a parameter or when you request a project that does not exist in the document pool. What to do: Enter the correct name and path of the XML file and ensure that the project given in the request exists in the document pool. Bad HTTP Error #404 filename/pathname. QuarkXPress Server Error #-37 This alert is displayed when an invalid file name is entered in the request. What to do: Enter the correct XML file name and resubmit the request.
Example, Object Model Creating a new Box: You can add a new box of a specified type to an existing spread in a QuarkXPress project at the specified position using the following code snippet with the Box object. Spread spread = new Spread(); Box box = new Box(); box.name = "textbox1"; Geometry geometry = new Geometry(); Position position = new Position(); position.top = "110"; position.left = "89"; position.bottom = "220"; position.right = "300"; geometry.position = position; geometry.
Deleting boxes To delete a box, use the following parameters in the Modifier DTD: BOX ID Example The following XML shows how these parameters work. Response Preview of the QuarkXPress project with the box deleted. Alerts File not found.
Logs Example GET URL Notes What to do: Enter a valid value in all tags of XML and resubmit the request. If the project is successfully rendered, a transaction success message is written to the QuarkXPress Server Transaction Log file. The transaction entry consists of the date and time of the request, render type, project name, type of response produced by the server, size of the response returned in bytes, and client IP address.
Creating tables To create a new table, use the following parameters in the Modifier DTD: SPREAD TABLE COLSPEC COLUMN ROW CELL Example The following XML shows how some of these parameters work.
Example GET URL Example, Object Model The following is a sample of a transaction entry: 4/10/2007 17:54:37 - tab.qxp - Type: image/jpeg - Size: 9049 - Client: 127.0.0.1 http://localhost:8080/sample.qxp?modify=file:C:\createTable.xml where the createBox.xml file exists in the C: drive of the server. On Mac OS : The URL format is: http://localhost:8080/sample.qxp?modify=file:MacHD:xml:createTable.xml where the createTable.xml file exists in the xml folder of MacHD. http://localhost:8080/sample.
the operation attribute as “DELETE” Related topics: About XML modify Modifying box properties and content Deleting boxes Modifying picture properties Modifying text attributes Page 128
Modifying text attributes You can use the modify parameter to change the attributes of text in a QuarkXPress project. All modifications are done on a text box basis. To modify text properties, use the following parameters in the Modifier DTD: BOX ID TEXT STORY PARAGRAPH FORMAT DROPCAP TABSPEC TAB RULE RICHTEXT Example The following XML shows how some of these parameters work.
This text is 12pt and right justified. This is bold text. This text is bold, red, italic, and 20pt.
Logs The text size value HTTP Error #500 is outside the valid This alert is displayed if the value given in the SIZE tag is not range. valid. What to do: Enter a correct text size value. The value of the SIZE parameter can vary between 2-720 pts. The specified color HTTP Error #500 is not available to This alert is displayed when an invalid color value is given in a the document COLOR tag. What to do: Enter a valid color value.
This is text. Example 1, Object Request Object Names : Model ModifierRequest ModifierStreamRequest Project RichText Text ID Box Layout ModifierFileRequest: member contents is used to set the file path sdk.QRequestContext rc = new sdk.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.
textReq.contents = contents; rc.request = textReq; //Create the service and call it with QRequestContext object QManagerSDKSvcService svc = new QManagerSDKSvcService(); sdk.QContentData qc = svc.processRequest(rc); Example 2, Object New text modifier attributes: To edit the properties of an existing text box in a Model QuarkXPress project, the new object linking is shown below.
Modifying picture properties You can modify the properties (such as origin, scale, angle, skew, and orientation) of pictures in a QuarkXPress project with XML. To modify picture properties, use the following parameters in the Modifier DTD: BOX ID PICTURE Example The following XML shows how some of these parameters work.
Response Alerts Preview of a QuarkXPress project with image modifier tags applied on the picture boxes. File not found. HTTP Error #404 QuarkXPress Server Error #-43 This alert is displayed when you give an incorrect XML file as a parameter or when you request a project that does not exist in the document pool. What to do: Enter the correct name and path of the XML file and ensure that the project given in the request exists in the document pool. Bad HTTP Error #404 filename/pathname.
Logs What to do: Enter a valid value in the OFFSETDOWN tag in XML and resubmit the request. The value of Picture HTTP Error #500 Angle must be This alert is displayed if the value of the child text node of the between -360 and ANGLE tag in the XML file is not within the valid range. 360 degrees. What to do: Enter a valid value in the ANGLE tag in XML and resubmit the request.
Example 1, Object Request Object Names : Model ModifierRequest ModifierStreamRequest Project Box Picture Layout ModifierFileRequest: member contents is used to set the file path QRequestContext rc = new sdk.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.
Example 2, Object New Image Modifier: To edit the properties of an existing image box in a Model QuarkXPress project, the new object linking is shown below. ModifierRequest < Project < Layout < Spread < Box < Picture The Picture object contains the properties: angle, fit, flipHorizontal, flipVertical, fullRes, mask, offsetAcross, offsetDown, opacity, picColor, scaleAcross, scaleDown, shade, skew, and supressPict. Notes You cannot change an image with the Modifier XTensions software.
Importing data Imports text or image data into a project. To import text or image data into a project, use the following parameters in the Modifier DTD: BOX ID PICTURE Note: PICTURE is not a required element when importing data. TEXT STORY CONTENT Example The following XML shows how some of these parameters work. file:c:\docs\file1.
QuarkXPress Server Error #-43 This alert is displayed when you give an incorrect file name as a parameter or when you request a document that does not exist in the document pool. What to do: Enter the correct name and path of the file and make sure the document exists in the document pool. The XML HTTP Error #500 document is not This alert is displayed when XML tags are not correctly valid or well formed. formed. What to do: Enter correct XML and resubmit the request.
Example GET URL Example, Object Model If an alert is displayed, an error message is written to the QuarkXPress Server error log file. The following is a sample of an error log entry: 8/5/2005 18:01:59 - Error - Error Code: 10343 - A locked Layer cannot be manipulated. On Windows, the URL format is: http://localhost:8080/Sample.qxp?modify=file:c:\file.xml On MAC OS, the URL format is: http://localhost:8080/Sample.qxp?modify=file:HDD:file.xml To use an XML string in the URL: http://localhost:8080/sample.
Notes embed it in request context ModifierRequest request = new ModifierRequest(); Project requestContents = new Project(); Content boxContent1 = new Content(); Box box1 = new Box(); box1.UID = txtBox1; box1.content = boxContent1; Layout layout1 = new Layout(); layout1.name = layoutText; if(!this.content1.Text.Equals("")) { boxContent1.value = this.content1.Text; Text text1 = new Text(); text1.font = this.fontname1.Text; box1.text = text1; if(this.includestylesheets1.Checked == false) boxContent1.
Exporting Job Jackets files during project deconstruction While using the xml namespace to deconstruct a QuarkXPress project, you can specify the jjname parameter in the same request to output the Job Jackets file to the document pool. For example: http://localhost:8080/xml/project.qxp?jjname=jjfilename.xml You can then use the construct namespace to create new QuarkXPress projects that are based on that Job Jackets file's resources and layout specifications.
About XML deconstruct/reconstruct Versions of QuarkXPress Server prior to 7.2 allowed you to retrieve a human-readable XML representation of a QuarkXPress project from the server using the deconstruct namespace, but these versions did not provide an easy way to turn that XML back into a QuarkXPress project.
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. This chapter provides a general introduction to working with this DTD, and goes into detail about some of the less obvious aspects of the process. The construct namespace takes two arguments: The name of the project to be created and a modify parameter that points to the XML file or string that describes how to create the project.
xml Creates an XML file from a QuarkXPress project. The XML is returned in a fixed format that adheres to the Modifier DTD. You can easily use the returned XML to create or modify a QuarkXPress document using the construct namespace or modify parameter. Namespace xml DTD Modifier DTD Parameters box Re tur ns X M L onl y for the giv en bo x ID or na me .
giv en as a co m ma se par ate d list. XSL Sp eci fies a pat h to an XS L file tha t de scr ibe s ho w to tra nsf or m the ret urn ed X M L.
layout XS L file is sp eci fie d by the file : ind ica tor . Sp eci fies the lay out na me or nu mb er to ren der .
firs t lay out in the pr oje ct. Yo u ca n als o sp eci fy the lay out na me wit h this par am ete r. Response Refer to the Modifier DTD The following XML code breaks down the page elements of a project into the XML code for the individual layers, text boxes, and picture boxes. PAGE 150 39.064 39.026 63.951 214.
0 0 800 600 false Alerts Logs Example GET URL If the project is successfully rendered, a transaction success message is written to the QuarkXPress Server Transac
construct The construct namespace lets you create a QuarkXPress project using XML. Namespace construct DTD Modifier DTD Parameters modify string Specifies the XML file or string that describes how to create the project. The XML file is specified by the file: indicator. Note: The XML file must adhere to the Modifier DTD and be present in the specified location. qxpdocver Returns a QuarkXPress document. For example: 7|8 http://QXPServer8:8080/construct/qxpd oc/project1.
Logs Example, Object Model the request. The XML HTTP Error #500 document is not This alert is displayed when XML tags are not correctly valid or well formed. formed. What to do: Provide correct XML and resubmit the request. The XML HTTP Error #500 document contains This alert is displayed when you enter an incorrect value for a an invalid tag value. tag. For example, you enter a string value for a tag that accepts a numeric value.
Notes a. Deconstruct a QuarkXPress project using the following code snippet: QManagerSDKSvcService svc = new QManagerSDKSvcService() Project proj = svc.getDOM("document.qxp"); b. Alter the project by manipulating the XML. c. Pass the modified Project instance to ConstructRequest to create a new QuarkXPress project using the following code snippet: ConstructRequest cnstrq = new ConstructRequest(); cnstrq.project = proj; QRequestContext rc = new QRequestContext(); rc.
Deconstructing a project An XML file that represents a deconstructed project does not contain all of the information necessary to reconstruct the project. The definitions of the project's resources (such as style sheets, colors, and master page definitions) are stored in a Job Jackets file. For example, you will see later in this section that you can apply a style sheet to a paragraph by indicating the style sheet’s name, like so: The sun has risen.
Constructing a project Every project created with the construct namespace must be based on a Job Ticket in a Job Jackets file. Using construct to create a project is roughly equivalent to using the File > New > Project from Ticket command in QuarkXPress. 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.
Working with pages and spreads The root element of a deconstructed QuarkXPress project is . Within each element are one or more elements. Each layout contains one or more elements, and each contains one or more elements. Each layout, spread, and page has a unique name, indicated by its element. Each layout can have a unique name, indicated by its element's NAME attribute.
190 195 Creating pages from master pages Master pages are stored in a deconstructed project’s Job Jackets file. To create a page from this master page, insert a MASTER attribute into the PAGE element and indicate the number of the target master page.
Working with layers To create a layer in XML, use the LAYER element. For example: The RGBCOLOR element defines the layer's color as displayed in the Layers palette. Assigning items to layers You can assign items to a layer using the GEOMETRY element, which is a child of the BOX and TABLE elements.
Working with boxes To add text and pictures to a project, you must add text boxes and picture boxes to the project’s element. Both are represented by elements, but text boxes have a BOXTYPE attribute of CT_TEXT, and picture boxes have a BOXTYPE attribute of CT_PICT. You can read about how elements are put together in the Modifier DTD, but for purposes of illustration, the sample XML below describes a spread that contains a text box and a picture box.
Macintosh HD:DocPool:flower1.jpg This example will work for a construct request. For a modify request, add the attribute value OPERATION="CREATE" in the BOX element. All BOX elements can contain a GEOMETRY element that indicates the position and size of the box, a FRAME element that describes the box's frame (if any), and a SHADOW element that describes the box's drop shadow. Additional BOX elements are described in the following sections.
Working with pictures The element supports a variety of new features, including the ability to specify runaround, opacity, and drop shadow characteristics. For more information, see the Modifier DTD .
Constructing a project Page 163
Working with text Every element for text contains a element, and every element contains a element. A element can contain elements, each of which contains elements. A element can also simply contain elements. A text element can also contain a element that indicates the origin of the text in that box.
The sun has risen. 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.
In deconstructed projects, a element can contain a element. The element indicates the point where text has overflowed the current box and identifies the box where the text continues. The element also contains attributes that indicate where in the text the break occurs. In a element, the element indicates where the current box overflows when there is no subsequent box for text to flow into.
Working with tables To construct tables in XML, use a structure like the following:
100 100 600 400 PAGE 168 Text goes here. Note that the element must always contain a element. A element can contain elements or simply elements. Adding picture cells To add a picture cell, use XML like the following: MacintoshHD:DocPool:flower1. |
...
...
... ...Working with Composition Zones A Composition Zones item in a deconstructed project is represented in XML by a element. Like the element type, this element type supports the , , and elements. In addition, a element includes a attribute that identifies it as an internal or external Composition Zones item. For external Composition Zones, the PATH attribute indicates the location of the associated composition layout.
Using server XSLT You can use an XSLT file to transform the XML returned by the xml namespace into other formats. You might find this feature useful if you want the xml namespace to return an XML representation that uses a different schema or a subset of the returned data. There are two ways to using this feature. The first way is to select Use Default XSLT and specify the path to an XSLT file in the preferences for QuarkXPress Server (Server/QuarkXPress Server > Preferences > Modifier pane).
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 173Related topics: The Modifier DTD About XML deconstruct and construct xml construct Deconstructing a project Constructing a project Page 173
Working with anchored boxes To create an anchored box within a text box, use a structure like the following: PAGE 17575 anchored box
Note that there are two BOX elements. One is the parent box that has the element ANCHOREDBOXREF, which points to the name of the anchored box. The anchored box itself has the attribute ANCHOREDIN, which points to the name of the parent box.
Working with placeholders Placeholders allow a region of text in a QuarkXPress project to hold non-printing metadata. You can use placeholders to store information from other systems, or to provide information to third-party XTensions software or other tools that operate on QuarkXPress projects. Placeholders are used by technologies within QuarkXPress, such as XML import.
Quark Announces Availability of QuarkXPress Server 8.0 Updater Latest Maintenance Release of QuarkXPress 8.
Related topics: The Modifier DTD About XML deconstruct and construct xml construct Deconstructing a project Constructing a project Page 178
Working with metadata You can now attach box-level metadata to a QuarkXPress project created from XML using the Modifier DTD. For example, if you populate a picture box with a picture from a content management system, you can capture the unique ID of that picture (and other information, such as the last-modified date) to the box containing that picture.
Related topics: The Modifier DTD About XML deconstruct and construct xml construct Deconstructing a project Constructing a project Page 180
Working with hidden text Hidden text, represented in Modifier XML by the HIDDEN element, allows XTensions software developers to insert custom, non-printing data into a text flow. This hidden text can be retained when QuarkXPress Server deconstructs and reconstructs QuarkXPress projects. For more information, see the Modifier DTD . The population of Iceland is 500,000,000.
opcode=*" to specify all hidden text in the XML output. This example URL outputs all of the hidden text inserted by the XTensions software with this ID. To avoid byte order issues when cross-platform rendering is enabled, the XTID is represented decimally, rather than with the usual char[4] representation.
About administrative request handlers A request handler is the most powerful way to change the behavior of QuarkXPress Server. With this method, the QuarkXPress Server XTensions software can completely handle a subset of requests received by the server. A subset of requests is identified by a namespace string. Every request handler has a namespace string associated with it.
addfile Use the addfile request handler to place a document or image file in the document pool. The addfile request is always a POST request. It cannot be a GET request because binary content is attached with the request. If you send an addfile request to Server Manager, using HTTP or the Web services interface, the file is uploaded to all registered QuarkXPress servers if the common doc pool switch is set to off in the admin client.
Example GET URL If an alert is displayed, an error message is written to the QuarkXPress Server error log file. The following is a sample of an error log entry: 8/3/2005 20:08:45 - Error - Error Code: 10100 - The file system document pool is not enabled. 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.
Notes QuarkXPress Server Manager, the best way is to use a POST request in a QuarkXPress Server Manager URL. You might use QuarkXPress Manager to add a file if you wanted to add the file to all registered QuarkXPress Server instances at one time (assuming the instances are not sharing a single document pool). This cannot be a GET request since binary content is attached. Therefore, the request has to be a POST request. The following is a sample of a post request HTML form.
The file uploads to the document pool of the specified server. After the file is successfully uploaded, the "File upload completed." alert is displayed. For example, suppose you uploaded the file Faces.pdf located on the C: drive of Windows to QuarkXPress Server running at IP 202.201.92.34 and port 8080, and you uploaded it with the name "NewFaces.pdf.
Please select the file you want to upload:
The FORM tag specifies that the method of the request is POST. This request is a "Multipart/form-data" request. When you submit the form, the UploadDocument() function is called. Use the INPUT tag to create the text box and the Browse button.
cplatform Used to handle Unicode language support in QuarkXPress Server. It tells the server that the client browser/machine is running on a specified platform (Windows or Mac OS). Note: In QuarkXPress Server Manager, this parameter is deprecated and its use is strongly discouraged. Please use UTF-8 to post data to Server Manager to avoid encoding issues. Parameters cplatform string Tells the server the client platform on which on the request was generated. The value for Windows is win.
delete Removes a specified document from the document pool. The Delete request can also delete folders. If this request is sent to Server Manager using either HTTP or Web services, the specified file is deleted from all registered QuarkXPress servers if the common doc pool has been switched off in the admin client. If the common doc pool has been turned on in the admin client, the delete request is sent to any one registered QuarkXPress server.
Example, Object Model Notes Request Object Name : DeleteRequest sdk.QRequestContext rc = new sdk.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.Text; rc.request = new DeleteRequest(); //Create the service and call it with QRequestContext object QManagerSDKSvcService svc = new QManagerSDKSvcService(); sdk.QContentData qc = svc.processRequest(rc); You cannot delete a folder that is not empty.
clang Handles Unicode® language support in QuarkXPress Server. It tells the server that the client browser/machine is running in the specified (Unicode) language. It also specifies that the values given in the HTTP request are in the specified (Unicode) language. Note: In QuarkXPress Server Manager, this parameter is deprecated and its use is strongly discouraged. Please use UTF-8 to post data to Server Manager to avoid encoding issues.
Example GET URL Example, Object Model Notes http://localhost:8080/sample.qxp?Story=abcdefghijklmnopqrstuvwxyz&clang=EL where some Greek characters are flown into the text box named Story. Request Object Names : RequestSettings sdk.QRequestContext rc = new sdk.QRequestContext(); if(!this.DocumentSettings1.documentName.Text.Equals("")) rc.documentName = this.DocumentSettings1.documentName.
from the text specified in the request. What could be the problem? This may be due to the font applied on the text box. If you create a request to import or flow Unicode text in a text box, and the font for the specific Unicode language is not applied to it, then text flowed in the text box may appear different than what was specified in the request. To get correct output, replace the font of the text box with the font for the specific Unicode language.
fileinfo Returns the creation date, modification date, and file size of the specified document in XML format. Namespace fileinfo Response The following XML code displays the creation date, modification date, and size of the document.
flush Flushes a document from the cache. Namespace flush Response QuarkXPress Server responds with the message "CACHE FLUSH COMPLETED." Alerts Incorrect HTTP Error #401 administration realm This alert is displayed when the wrong administrator user user name and name and password are specified. password. What to do: Identify the correct user name and password that were set in the Server Configuration dialog box, and then resubmit the Flush request handler with the correct user name and password.
flushall Flushes all documents from the cache. When this request is sent to Server Manager using either HTTP or Web services, the cache of all registered QuarkXPress servers is flushed. Namespace flushall Response QuarkXPress Server responds with the message "CACHE FLUSH COMPLETED" Alerts Incorrect HTTP Error #401 administration realm This alert is displayed when the wrong administrator user user name and name and password are specified. password.
The value of memory usage becomes zero in the status monitor when you issue the Flushall request.
getdocinfo Returns an information block on a specific QuarkXPress project loaded into the QuarkXPress Server document pool.
user name and password. Logs and password are specified. What to do: Identify the correct username and password that were set in the Server Configuration dialog box, and then resubmit the getdocinfo request with the correct user name and password. If the document is successfully rendered, a transaction success message is written to the QuarkXPress Server Transaction Log file.
getprefs Returns the current preference settings of the server in XML format. Namespace getprefs Response XML display of server preference settings Alerts Incorrect HTTP Error #401 administration realm This alert is displayed when an invalid administrator user name user name and and password are specified. password. What to do: Identify the correct user name and password that were set in the Server Configuration dialog box and then resubmit getprefs with the correct user name and password.
getprojinfo Returns information about a specific QuarkXPress project loaded in the QuarkXPress Server document pool. The information is returned in XML format and identifies the operating system, the QuarkXPress version in which the project was created, the size of the project, the page properties of layouts, and information about named boxes and synchronized text.
produced by the server, size of the response returned in bytes, and client IP address. The following is a sample of a transaction entry: 8/3/2005 17:38:03 - getprojinfo/sample.qxp - Type: text/xml - Size: 386 - Client: 127.0.0.1 If an alert is displayed, an error message is written to the QuarkXPress Server error log file. The following is a sample of an error log entry: 8/3/2005 17:45:02 - Error - Error Code: 10124 - The getprojinfo command can only be used for QuarkXPress 6 documents and later.
getserverinfo Returns an information block about QuarkXPress Server. The information is returned in XML format and contains the platform on which the server is running, the version of QuarkXPress Server, a list of installed fonts and server XTensions modules, the relevant XTensions software or server XTensions module IDs, and the startup parameters with which the server is running. Any disabled server XTensions modules are not returned in the response.
setprefs Sets server preferences. Namespace setprefs Response QuarkXPress Server responds with the message "Preferences successfully set." Alerts Incorrect HTTP Error #401 administration realm This alert is displayed when the wrong administrator user user name and name and password are specified. password. What to do: Identify the correct user name and password that were set in the server configuration, and then resubmit setprefs with the correct user name and password.
The setprefs request requires an administrator user name and password if those were set in the Server Configuration dialog box. When the setprefs request is submitted to the browser, it asks for a user name and password. Enter the same user name and password that were set in the Server Configuration dialog box, and click OK.
shutdown Shuts down QuarkXPress Server. When this request is sent to Server Manager using either HTTP or Web services, a shutdown request is sent to all registered QuarkXPress servers. Namespace shutdown Response QuarkXPress Server responds with the message "Shutdown request posted." QuarkXPress Server then stops accepting new requests and shuts down after completing all pending transactions.
password to be used for realm verification should be specified using the "setUserName" and "setUserPassword" methods of the QContextRequest object that contains this ShutdownRequest object.
getdocpoollist Returns an XML representation of all files names and folder names, the document type, size of the document, the modified date and time, and the absolute and relative path of the documents in the local document pool. Namespace getdocpoollist Response XML file containing folder name, absolute and relative file path, file type, modified dates, and file size. Parameters directory You can get the list of files in a specific diretory in the document pool.
Modifier DTD (annotated) This section provides the annotated version of the Modifier DTD. 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 DTD, thereby providing well-formed XML code that is compatible between each function. Note: Measurement values do not require units. For example, "25pt" should be submitted as "25".
JOBJACKET CDATA #IMPLIED The name and Not applicable. absolute path (on the server computer) of the Job Jackets(R) file to use during construct. If the Job Jackets file cannot be located, cannot be read, or contains invalid XML, an error is returned. Note: You cannot create or modify Job Jackets files using the construct namespace and the modify attribute. To create or modify Job Jackets files, use the Job Jackets Manager dialog box (Utilities menu) in QuarkXPress.
Lets you save a constructed QuarkXPress project to a specific location on the server computer. Roughly equivalent to choosing File > Save As in QuarkXPress. Save As in QuarkXPress. QuarkXPress Server 8.0. Not applicable. Specifies a name Not applicable.
location. For example, if For example, if NEWNAME = NEWNAME = file.qxp and the file.qxp and the REPLACE value REPLACE value is set to false, the is set to false, the file is saved as file is saved as file1.qxp when a file1.qxp when a file with the same file with the same name exists at the name exists at the specified location. specified location.
ZONE. a NAME value element: Lets you specify a first and for a UID Name of PAGE. the UID is box ignored. If a NAME value does not exist, the UID displays in the content of the ID element: 457 Note: If a NAME value does not exist for a box, the word Box and the box UID are concatenated and display in the XML.
spreads and pages. UID CDATA #IMPLIED> Required for The unique ID of Specifies the PAGE and the element to be unique ID of an SPREAD modified. element in the elements. Ignored QuarkXPress for all other project. element types. specifications for elements and child elements and a particular layout. attributes are only attributes are only valid for construct valid for construct requests.
elements). elements). Note: New articles should not be created in a QuarkXPress project in systems working directly with QPS. Instead, create an article only within a QuarkCopyDesk( R) file. To assign an article in QPS(R), use the QPS SDK.
automatically COMPONENT assigns a unique to be modified. ID to components. BOXNAME CDATA #IMPLIED Specifies the Specifies the name Specifies the name of the of the name of the user-assigned box user-assigned box user-assigned box to which the to which the to which the COMPONENT COMPONENT COMPONENT belongs. belongs. belongs. BOXUID CDATA #IMPLIED Not applicable.
you use the names are not GEOMETRY@P returned. AGE attribute in the BOX element.
AGE attribute. 457 Not applicable. Specifies whether Not applicable. to create or delete the indicated box. BOXTYPE (CT_NONE | The box type: The box type: The box type: CT_TEXT | CT_PICT) #IMPLIED CT_NONE = No CT_NONE = No CT_NONE = No box type box type box type specified. specified. specified.
DIAMOND | CIRCULAR | FULLCIRCULAR | none) "none" BLENDANGLE CDATA #IMPLIED BLENDCOLOR CDATA #IMPLIED BLENDSHADE CDATA #IMPLIED BLENDOPACITY CDATA #IMPLIED ANCHOREDIN CDATA #IMPLIED> to this box to this box (linear, to this box (linear, circular, circular, (linear, circular, rectangular, etc.). rectangular, etc.). rectangular, etc.). Specifies the angle Specifies the angle Specifies the angle of the blend. of the blend. of the blend.
KEY="myKey"> KEY="myKey"> ]> ]>
VERTICALALIGNMENT (TOP | CENTERED | BOTTOM | JUSTIFIED | none) "none" INTERPARAGRAPHMAX CDATA #IMPLIED Vertically aligns the text. Vertically aligns the text. Indicates the vertical alignment of text.
"none" TEXTALIGN (ASCENT | CENTER | BASELINE | DESCENT | none) "none" Specifies the part Specifies the part Indicates the part of a font to use for of a font to use for of a font being positioning positioning used for characters on a characters on a positioning line. line. characters on a line. TEXTALIGNWITHLINE (TOP | Specifies how to Specifies how to Indicates text is CENTER | BOTTOM | none) "none" align text to a line. align text to a line. aligned to a line.
ANCHOREDBOXREF | LINKEDBOX | TEXTNODEPH | TEXTPH | HIDDEN | LIST)*, OVERMATTER?)>
Jackets file or defined using the Document Controls submenu in QuarkXPress Server. Jackets file or defined using the Document Controls submenu in QuarkXPress Server. projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server. PARACHAR (HARDRETURN | Defines a Defines a breaking Defines a VTAB | BOXBREAK) breaking character for a breaking "HARDRETURN" character for a paragraph. character for a paragraph. paragraph.
RIGHTINDENT CDATA #IMPLIED FIRSTLINE CDATA #IMPLIED LEADING CDATA #IMPLIED ALIGNMENT (LEFT | RIGHT | CENTERED | JUSTIFIED | FORCED) "LEFT" HANDJ CDATA #IMPLIED amount of space amount of space amount of space in a paragraphs in a paragraphs in a paragraphs left indent. left indent. left indent. Describes the Describes the Describes the amount of space amount of space amount of space in a paragraphs in a paragraphs in a paragraphs right indent. right indent. right indent.
Controls Controls Controls submenu in submenu in submenu in QuarkXPress QuarkXPress QuarkXPress Server. Server. Server. KEEPWITHNEXT (true | false | Specifies whether Specifies whether Specifies whether none) "none" the last lines of a the last lines of a the last lines of a paragraph should paragraph should paragraph should always appear on always appear on always appear on the same page as the same page as the same page as the next the next the next paragraph. paragraph. paragraph.
in the paragraph in the paragraph in the paragraph or has a specific or has a specific or has a specific start and end. start and end. start and end. STARTLINE CDATA #IMPLIED Specifies the Specifies the Specifies the number of lines at number of lines at number of lines at the beginning of a the beginning of a the beginning of a paragraph before paragraph before paragraph before wrapping text to wrapping text to wrapping text to keep lines keep lines keep lines together. together. together.
is enabled. is enabled. is enabled. GRIDLEVEL (PAGE | TEXTBOX) Specifies whether Specifies whether Specifies whether "PAGE" GRID applies on GRID applies on GRID applies on page level or text page level or text page level or text box level. box level. box level.
ALIGNON CDATA #IMPLIED> Specifies a specific character to align a tab stop on. ENABLED (true | false) "true"> Describes a rule above or below a paragraph.
OFFSET CDATA #IMPLIED WIDTH CDATA #IMPLIED COLOR CDATA #IMPLIED SHADE CDATA #IMPLIED OPACITY CDATA #IMPLIED STYLE CDATA #IMPLIED> the right. A the right. A from the right. A positive number positive number positive number moves the moves the moves the end-point to the end-point to the end-point to the left; a negative left; a negative left; a negative number moves the number moves the number moves the end-point to the end-point to the end-point to the right. right. right.
XTensions that that are not are not designed designed to handle to handle inappropriate data inappropriate data may cause may cause QuarkXPress QuarkXPress Server to Server to unexpectedly quit. unexpectedly quit. OWNER CDATA #IMPLIED Represents the Represents the XTensions ID of XTensions ID of the XTensions the XTensions software that software that owns this hidden owns this hidden text. text.
PLAIN (true | false | none) "none" MERGE (true | false) "false" BOLD (true | false | none) "none" ITALIC (true | false | none) "none" FONT CDATA #IMPLIED Controls submenu in QuarkXPress Server. Removes existing formatting and renders text as plain text. Specifies whether the formatting from the previous RICHTEXT tag should be carried into this RICHTEXT tag. Applies the bold type style to text. Removes existing formatting and renders text as plain text.
PSFONTNAME CDATA #IMPLIED SIZE CDATA #IMPLIED COLOR CDATA #IMPLIED 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. Some fonts have Some fonts have Some fonts have different different postscript different postscript and and menu display postscript and menu display names. The menu display names. The FONTNAME names.
created and saved created and saved in the project. in the project. SHADE CDATA #IMPLIED Specifies the Specifies the Identifies the shade of text shade of text shade of text color, as an color, as an color, as an integer percentage integer percentage integer percentage from 0 to 100. from 0 to 100. from 0 to 100.
SHADOW (true | false | none) "none" Applies the Applies the shadow type style shadow type style to text. to text. Applies the Applies the strikethru type strikethru type style to text. style to text. Identifies the shadow type style applied to text. STRIKETHRU (true | false | none) Identifies the "none" strikethru type style applied to text.
LIGATURES (true | false | none) "none" OT_STANDARD_LIGATURES (true | false | none) "none" Indicates whether standard ligatures should be applied. Applies the OpenType standard ligatures type style to text. Indicates whether standard ligatures should be applied. Applies the OpenType standard ligatures type style to text. Indicates whether standard ligatures are applied. Identifies the OpenType standard ligatures type style applied to text.
to text. OT_PROPORTIONAL_FIGURES Applies the (true | false | none) "none" OpenType proportional figures type style to text. OT_LINING_FIGURES (true | false Applies the | none) "none" OpenType lining figures type style to text. OT_NONE (true | false | none) Removes "none" OpenType formatting from text. to text. Applies the OpenType proportional figures type style to text. Applies the OpenType lining figures type style to text. Removes OpenType formatting from text.
OT_ITALICS_FEATURE (true | false | none) "none" OT_HVKANA_ALTERNATES (true | false | none) "none" OT_RUBINOTATION_FORMS (true | false | none) "none" notation). May notation). May notation). May also replace also replace also replace lowercase lowercase lowercase characters with characters with characters with alphabetic alphabetic alphabetic inferiors. inferiors. inferiors.
OT_LOCALIZED_FORMS (true | Replace default Replace default Replace default false | none) "none" forms of glyphs forms of glyphs forms of glyphs with localized with localized with localized forms. forms. forms. OT_ALTERNATE_WIDTHS_NO Apply alternate Apply alternate Apply alternate NE (true | false | none) "none" widths for heights widths for heights widths for heights based on story based on story based on story direction (vertical direction (vertical direction (vertical or horizontal). or horizontal).
none) "none" designed for some designed for some designed for some OT_JIS04FORMS (true | false | Japanese Japanese Japanese none) "none" OpenType fonts. OpenType fonts. OpenType fonts.
OTVARIANT CDATA #IMPLIED OTFEATURE CDATA #IMPLIED SCRIPT (Hira | Hani | Hrkt | Hang | Yiii | Kana |Bopo | none) "none" HALFWIDTHUPRIGHT (true | false | none) "none"> not covered by not covered by not covered by the Unicode the Unicode the Unicode specification. specification. specification. These are referred These are referred These are referred to as UEG or to as UEG or to as UEG or Unencoded Unencoded Unencoded Glyphs. This Glyphs.
text. Note the text. Note the text. Note the second and second and second and subsequent subsequent subsequent children of the children of the children of the RUBI element RUBI element RUBI element (RICHTEXT | (RICHTEXT | (RICHTEXT | ANCHOREDBO ANCHOREDBO ANCHOREDBO X | HIDDEN)+ X | HIDDEN)+ X | HIDDEN)+ declare the base declare the base declare the base text to which the text to which the text to which the rubi text is to be rubi text is to be rubi text is to be applied.
| RIGHT | LEFT) "ABOVE" specifies whether specifies whether specifies whether rubi text displays rubi text displays rubi text displays above or below above or below above or below the base text (in a the base text (in a the base text (in a horizontal story) horizontal story) horizontal story) or to the left of or or to the left of or or to the left of or right of the base right of the base right of the base text (in a vertical text (in a vertical text (in a vertical story). story). story).
BASELINE) "ASCENT" whether the top of whether the top of whether the top of the anchored box the anchored box the anchored box will align with the will align with the will align with the top of the text top of the text top of the text (ascent) or the (ascent) or the (ascent) or the bottom of the text bottom of the text bottom of the text (baseline). (baseline). (baseline).
3" > Not applicable. Identifies the first character placed in the next box in a chain. Specifies the last character placed in the next box in a chain.
SCALEACROSS CDATA #IMPLIED SCALEDOWN CDATA #IMPLIED OFFSETACROSS CDATA #IMPLIED OFFSETDOWN CDATA #IMPLIED ANGLE CDATA #IMPLIED SKEW CDATA #IMPLIED vertically. vertically. FITBOXTOPICT FITBOXTOPICT URE = Resizes a URE = Resizes a box to fit its box to fit its picture. picture.
value from -75 degrees to 75 degrees. Identifies a color to be applied to a grayscale picture. Note: Only the name of a color is included in this attribute. The definition of the color is stored in the projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server. value from -75 value from -75 degrees to 75 degrees to 75 degrees. degrees. PICCOLOR CDATA #IMPLIED Identifies a color Identifies a color to be applied to a applied to a grayscale picture. grayscale picture.
from being from being from being included in output. included in output. included in output. FULLRES (true | false | none) "none" Causes imported Causes imported Causes imported pictures to display pictures to display pictures to display at full resolution in at full resolution in at full resolution in QuarkXPress if QuarkXPress if QuarkXPress if the picture files the picture files the picture files are available. are available. are available.
CLIPPING@TY CLIPPING@TY CLIPPING@TY PE = ITEM or PE = ITEM or PE = ITEM or PICTUREBOUN PICTUREBOUN PICTUREBOUN DS. Moves the DS. Moves the DS. Moves the top edge of the top edge of the top edge of the clipping path by clipping path by clipping path by the specified the specified the specified number of points number of points number of points (positive=up, (positive=up, (positive=up, negative=down). negative=down). negative=down).
EMBEDDEDPA EMBEDDEDPA EMBEDDEDPA TH, TH, TH, ALPHACHANN ALPHACHANN ALPHACHANN EL, or EL, or EL, or NONWHITEAR NONWHITEAR NONWHITEAR EAS. Specifies a EAS. Specifies a EAS. Specifies a single outset or single outset or single outset or inset integer value inset integer value inset integer value in points to be in points to be in points to be used on all sides. used on all sides. used on all sides.
"none" CLIPPING@TY CLIPPING@TY PE = PE = EMBEDDEDPA EMBEDDEDPA TH, TH, ALPHACHANN ALPHACHANN EL, or EL, or NONWHITEAR NONWHITEAR EAS. Indicates EAS. Indicates that only the outer that only the outer edges of the edges of the clipping path clipping path should be used. should be used. RESTRICTTOBOX (true | false | Valid when Valid when none) "none" CLIPPING@TY CLIPPING@TY PE = PE = EMBEDDEDPA EMBEDDEDPA TH, TH, ALPHACHANN ALPHACHANN EL, or EL, or NONWHITEAR NONWHITEAR EAS. Indicates EAS.
the shape is a the shape is a pure the shape is a pure rectangle. rectangle. pure rectangle. INVERTEDSHAPE (true | false) Specifies whether Specifies whether Specifies whether "false" the shape encodes the shape encodes the shape encodes the inverse of its the inverse of its the inverse of its area ("inside area ("inside area ("inside out"). out"). out").
shape. shape. shape.
continuous. continuous. continuous. CUSPVERTEX (true | false) "false" Specifies whether Specifies whether Specifies whether the vertex is not the vertex is not the vertex is not smooth or smooth or smooth or symmetric. symmetric. symmetric. TWISTED (true | false) "false" Specifies whether Specifies whether Specifies whether the following the following the following (splined) edge (splined) edge (splined) edge intersects itself. intersects itself. intersects itself.
shape, not the page), and the left shape, not the page), and the left and right control page), and the left and right control handles – as you and right control handles – as you would see handles – as you would see onscreen in the would see onscreen in the QuarkXPress user onscreen in the QuarkXPress environment. For QuarkXPress user environment. more information user environment.
PAGE CDATA #IMPLIED ANGLE CDATA #IMPLIED Elliptical box Elliptical box Elliptical box SH_LINE = Line SH_LINE = Line SH_LINE = Line SH_ORTHLINE SH_ORTHLINE SH_ORTHLINE = Orthogonal line = Orthogonal line = Orthogonal line (restricted to (restricted to (restricted to 45-degree 45-degree 90-degree angles) angles) angles) SH_SPLINEBO S SH_SPLINEBO X = Freehand H_SPLINEBOX X = Freehand shape = Freehand shape SH_NONE = shape SH_NONE = Available to SH_NONE = Available to define in XDK Available to define define
LAYER CDATA #IMPLIED> value between value between value between -360 degrees and -360 degrees and -360 degrees and 360 degrees. 360 degrees. 360 degrees. Identifies the layer Identifies the layer Identifies the layer where a box or where a box or that a box resides line should be line is located. on. created.
Not applicable. Not applicable. Not applicable. Not applicable.
ALLOWBOXONTOPASTEBOAR D (#PCDATA)> a box is allowed to be moved partially off of a page and onto the pasteboard by, for example, a MOVERIGHT element. Only accepts true or false values; default value is true. to be moved completely off of a page and onto the pasteboard by, for example, a MOVERIGHT element. Only accepts true or false values; default value is true.
page, in points. page, in points. page, in points. The distance The distance The distance between the box between the box between the box or lines left edge or lines left edge or lines left edge and the left edge and the left edge and the left edge of the page, in of the page, in of the page, in points. points. points.
TOP CDATA #IMPLIED RIGHT CDATA #IMPLIED See the See the See the THRESHOLD THRESHOLD THRESHOLD attribute. attribute. attribute. PICTUREBOUN PICTUREBOUN PICTUREBOUN DS = Text runs DS = Text runs DS = Text runs around the around the around the rectangular canvas rectangular canvas rectangular canvas area of the area of the area of the picture, regardless picture, regardless picture, regardless of the size and of the size and of the size and shape of the shape of the shape of the picture box. picture box.
negative=left). negative=left). negative=left). Valid when Valid when Valid when RUNAROUND RUNAROUND RUNAROUND @TYPE = ITEM @TYPE = ITEM @TYPE = ITEM or or or PICTUREBOUN PICTUREBOUN PICTUREBOUN DS. Moves the DS. Moves the DS. Moves the left edge of the left edge of the left edge of the runaround by the runaround by the runaround by the specified number specified number specified number of points of points of points (positive=left, (positive=left, (positive=left, negative=right). negative=right).
AUTOIMAGE, AUTOIMAGE, AUTOIMAGE, ALPHACHANN ALPHACHANN ALPHACHANN EL, or EL, or EL, or NONWHITEAR NONWHITEAR NONWHITEAR EAS. Specifies EAS. Specifies EAS. Specifies that areas smaller that areas smaller that areas smaller than this number than this number than this number of points should of points should of points should be ignored when be ignored when be ignored when creating a creating a creating a runaround path. runaround path. runaround path.
edges of the edges of the runaround path runaround path should be used. should be used. RESTRICTTOBOX (true | false | Valid when Valid when none) "none" RUNAROUND RUNAROUND @TYPE = @TYPE = AUTOIMAGE, AUTOIMAGE, EMBEDDEDPA EMBEDDEDPA TH, TH, ALPHACHANN ALPHACHANN EL, or EL, or NONWHITEAR NONWHITEAR EAS. Indicates EAS. Indicates whether the whether the runaround path is runaround path is restricted to the restricted to the inside of the box. inside of the box.
Visible setting in the Layers pane of the Preferences dialog box ( QuarkXPress/E dit menu). Visible setting in the Layers pane of the Preferences dialog box ( QuarkXPress/E dit menu). overrides the Visible setting in the Layers pane of the Preferences dialog box ( QuarkXPress/E dit menu).
QuarkXPress/E dit menu). Describes an RGB color that can be associated with a layer, as displayed in the Layers palette in QuarkXPress. QuarkXPress/E dit menu).
arrow tail on left arrow tail on left end end end DOUBLEARRO DOUBLEARRO DOUBLEARRO W = Arrow heads W = Arrow heads W = Arrow heads on both ends on both ends on both ends Placeholder that Placeholder that Placeholder that will contain either will contain either will contain either text or picture text or picture text or picture data from a linked data from a l
"true" INCLUDESTYLESHEETS (true | false) "true" FONTNAME CDATA #IMPLIED> quotation marks in quotation marks in an imported text an imported text file are converted file are converted to typesetter's to typesetter's quotation marks quotation marks and double and double hyphens are hyphens are converted to em converted to em dashes. dashes. If true, any style If true, any style Not applicable.
opacity of a drop opacity of a drop opacity of a drop shadow, specified shadow, specified shadow, specified as an integer as an integer as an integer percentage from 0 percentage from 0 percentage from 0 to 100. to 100. to 100. ANGLE CDATA #REQUIRED Specifies an angle Specifies an angle Specifies an angle in degrees for a in degrees for a in degrees for a drop shadow. drop shadow. drop shadow.
shadow with the shadow with the shadow with the angles of other angles of other angles of other drop shadows in drop shadows in drop shadows in the layout. the layout. the layout. RUNAROUNDSHADOW (true | Specifies whether Specifies whether Specifies whether false) "false" to include a drop to include a drop to include a drop shadow with the shadow with the shadow with the text runaround text runaround text runaround specified in the specified in the specified in the RUNAROUND RUNAROUND RUNAROUND element.
INHERITOPACITY (true | false) "false">
in the project. in the project. Specifies the Specifies the Specifies the shade of the color shade of the color shade of the color applied to a applied to a applied to a frame, as an frame, as an frame, as an integer percentage integer percentage integer percentage from 0 to 100. from 0 to 100. from 0 to 100.
software. Note: To replace placeholders with XML content, use XML Import XTensions software with QuarkXPress, or refer to thexmldoc and paginate parameters in this WIG. Not applicable.
columns. columns. columns. Identifies the color Identifies the color Identifies the color of a table. of a table. of a table. Note: Only the Note: Only the Note: Only the name of a color is name of a color is name of a color is included in this included in this included in this attribute. The attribute. The attribute.
BLENDOPACITY CDATA #IMPLIED ANCHOREDIN CDATA #IMPLIED AUTOFIT (rows | columns | all | none) "none" AUTOFITMAXLIMIT CDATA #IMPLIED>
MAINTAINLINK (true | false) "true"> Specifies whether a child table will maintain a link to its parent. Specifies a child of a parent TABLE element. Not applicable.
KEEPATTRIBUTE (true | false) "false"> Not applicable.
COLUMNWIDTH CDATA #IMPLIED COLOR CDATA #IMPLIED SHADE CDATA #IMPLIED OPACITY CDATA #IMPLIED MERGECOLSPAN CDATA #IMPLIED SPLIT (true | false) #IMPLIED the second the second column the second column from the from the left. column from the left. left. Specifies the Specifies the Specifies the width of a column. width of a column. width of a column. Identifies the color Identifies the color Identifies the color of a column. of a column. of a column.
AUTOFIT (true | false | none) "none" Specifies whether Specifies whether Indicates whether the rows or the rows or the rows or columns will columns will columns will adjust size to fit adjust size to fit adjust size to fit the content. the content. the content. AUTOFITMAXLIMIT CDATA Max limit for Max limit for Max limit for #IMPLIED> autofit. autofit. autofit. in a table. in a table. in a table.
Overrides the TABLE@COLO R attribute. Note: Only the name of a color is included in this attribute. The definition of the color is stored in the projects Job Jackets file or defined using the Document Controls submenu in QuarkXPress Server. Overrides the Overrides the TABLE@COLO TABLE@COLO R attribute. R attribute. Note: Only the Note: Only the name of a color is name of a color is included in this included in this attribute. The attribute.
Specifies if the Specifies if the Indicates if the row is to be a row is to be a row is to be a header row. header row. header row. of header row. of header row. of header row. Specifies if the Specifies if the Indicates if the row is to be a row is to be a row is to be a footer row. footer row. footer row.
applied to a cell, applied to a cell, applied to a cell, as an integer as an integer as an integer percentage from 0 percentage from 0 percentage from 0 to 100. to 100. to 100. OPACITY CDATA #IMPLIED Specifies the Specifies the Specifies the opacity of the opacity of the opacity of the color applied to a color applied to a color applied to a cell, specified as cell, specified as cell, specified as an integer an integer an integer percentage from 0 percentage from 0 percentage from 0 to 100. to 100. to 100.
output. Attribute used for Not applicable. merging cells and columns. SPLIT (true | false) #IMPLIED> Attribute used for Not applicable. splitting rows and columns. Element used for Element used for Element used for specifying a grid in specifying a grid in specifying a grid in a table. a table. a table. selecting a horizontal or vertical grid (or both).
OPACITY CDATA #IMPLIED GAPCOLOR CDATA #IMPLIED GAPSHADE CDATA #IMPLIED GAPOPACITY CDATA #IMPLIED> as an integer as an integer as an integer percentage from 0 percentage from 0 percentage from 0 to 100. to 100. to 100. Specifies the Specifies the Specifies the opacity of a line, opacity of a line, opacity of a line, specified as an specified as an specified as an integer percentage integer percentage integer percentage from 0 to 100. from 0 to 100. from 0 to 100.
PATH CDATA #IMPLIED Not applicable. Not applicable. COLOR CDATA #IMPLIED Not applicable. Not applicable. SHADE CDATA #IMPLIED Not applicable. Not applicable. OPACITY CDATA #IMPLIED Not applicable. Not applicable. ANCHOREDIN CDATA Not applicable. Not applicable. within the same project. EXTERNAL = A Composition Zones item that uses a layout in a different project. Indicates the absolute path to an external composition layout. Identifies a color applied to a Composition Zones item.
#IMPLIED> anchored Composition Zones and identifies its parent Composition Zones. project. project. project.
Sample applications: QuarkXPress Server These sample applications are available in the QuarkXPress Server installation files. Java client demo Purpose This sample client gives standard QuarkXPress Server post requests for various operations. Technology This demo uses Swing components to create the user interface. It gathers the user information, generates a Multi-part Post request, and sends that request to QuarkXPress Server.
"QXPSClientExec_C#.zip" PHP-MySQL demo This demo shows how QuarkXPress Server can be used with PHP and MySQL® to enable dynamic updating of the contents of a Web site. Use the links below for detailed documentation (a PDF file) and the necessary binary files for Mac OS(R) or Windows. "SampleAppGuide_PHP.pdf" "qxpsdemo_PHP.zip" "ScalingXT_QXPS7_PHP.
Sample applications: QuarkXPress Server Manager These sample applications are available in the QuarkXPress Server installation files. JSP samples Purpose Contain a series of Web pages demonstrating different ways the object model can be used to post QuarkXPress Server requests for various operations. Installation The samples are JSP™ pages contained in ClientSDKSamples_JSP.zip file. They need to be extracted and placed under tomcat/webapps.
"ClientSDKSamples_ASPDOTNET.
Contact Quark Quark, Inc. 1800 Grant St Denver, CO 80203 Phone: (303) 894-8888 Developer Desk Fax: (303) 894-3782 Submit technical questions about QuarkXPress Server and QuarkXPress Server Manager to Quark or e-mail QuarkXPress Server support: QuarkXPress Server Support Visit Quark's Web site: Quark Web Site Log on to the Developer Resource Site*: Developer Resource Site *The Developer Resource Site is an online support center maintained specifically for XTensions software developers.
LEGAL NOTICE ©2008 Quark, Inc. as to the content and arrangement of this material. All rights reserved. ©1986-2008 Quark, 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. Quark Products and materials are subject to the copyright and other intellectual property protection of the United States and foreign countries.
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. ALL OTHER LIMITATIONS PROVIDED UNDER APPLICABLE LAW, INCLUDING STATUTES OF LIMITATION, SHALL CONTINUE TO APPLY.
Lei Wang Chen Xiangyang Zvezdan Petkovic Rigel All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2.supporting documentation. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
cascading menus software provided that this copyright notice appears on all copies. This software is provided “AS IS,” without a warranty of any kind. Portions of this software is based on the work of Jean-loup Gailly and Mark Adler and is (C) 1995-1998 Jean-loup Gailly and Mark Adler [ZIP library] As to Sun technology, Copyright 2003-2006, Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. As to Apple technology, ©2002-2004 Apple Computer, Inc. All rights reserved.
The copyright holders and contributing author(s) will not be liable for any direct, indirect, special or consequential damages arising out of any use of the software or documentation, even if advised of the possibility of such damage. Permission is hereby granted to use, copy, modify, and distribute this source code, or portions hereof, documentation and executables, for any purpose, without fee, subject to the following restrictions: 1. The origin of this source code must not be misrepresented. 2.
3. Neither the name of the 'Jaxen' nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 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.