A Guide to QuarkXPress Server 2018

QuarkXPress Server XTensions software

Just as XTensions software provides additional functionality to QuarkXPress, XTensions software enables QuarkXPress Server to do things it can't do by default. The XTensions modules included with QuarkXPress Server allow clients to render projects as PDF files, apply QuarkVista picture effects to pictures, dynamically update pictures in picture boxes and text in text boxes (as well as boxes themselves), import data on the fly, manipulate layers in projects, and more.

CopyDeskArticle XTensions software

CopyDeskArticle XTensions software allows QuarkXPress Server to do the following things:

  • Render QuarkCopyDesk articles

  • Export QuarkCopyDesk articles from a QuarkXPress project

  • Add a QuarkCopyDesk article to an existing QuarkXPress project

  • Create and delete components in a QuarkCopyDesk article within a QuarkXPress project

Rendering articles

To render QuarkCopyDesk articles, use the copydesk namespace, as follows:

http://[server]:[port]/[render type]/copydesk/[articlename]

For example, to render "Article.qcd" as a PDF file, you could use a URL like the following:

http://QXPServer.8080/pdf/copydesk/Article.qcd

Exporting articles

To export an article from a QuarkXPress project, use the QCDDOC namespace, as follows:

http://[server]:[port]/qcddoc/[project name]?article=[article name or ID]

For example, to export the article named "Article1" from the project named "Project1.qxp," you could use a URL like the following:

http://QXPServer.8080/qcddoc/Project1.qxp?article=Article1

You cannot export an article from a QuarkXPress project unless the article has been created and named in QuarkXPress using CopyDeskArticleXT XTensions software.

To export an article in a particular format, use the format parameter.

  • To export a standard article, use format=fullfeatured.

  • To export an article in lightweight mode, use format=lightweight.This format can be useful in situations where file size is an issue. The lightweight file format includes only those items that a QuarkCopyDesk user is supposed to work on.

For example:

http://QXPServer.8080/qcddoc/Project1.qxp?article=Article1?format=lightweight

You cannot export page pictures in lightweight mode.

Adding articles to projects

You can use Modifier XTensions software to create a QuarkCopyDesk article within an existing QuarkXPress project. For example, to add an article named "New Article" to the project named "Project1.qxp," you could use XML like the following:

<PROJECT PROJECTNAME="Project1.qxp" XMLVERSION="8.0">
<LAYOUT POINTSPERINCH="72">
<ID NAME="Layout 1" UID="1"/>
<ARTICLE OPERATION="CREATE" DOCFORMAT="FULLFEATURED">
<ID NAME="New Article" UID="4"/>
<RGBCOLOR BLUE="98" GREEN="254" RED="0"/>
<COMPONENT BOXNAME="Box1" BOXUID="1" COMPONENTCLASS="CT_TEXT" 
NAME="Component 1" UID="1"/>
</ARTICLE>
</LAYOUT>
</PROJECT>

Creating and deleting components

You can use Modifier XTensions software to create and delete components in QuarkCopyDesk articles. For example, to add a component named "New Component" to the article named "Article 1" in the project named "Project1.qxp," you could use XML like the following:

<PROJECT JOBJACKET="Project1 Job Jacket" JOBTICKET="Default Job Ticket 1:Project1" 
PROJECTNAME="Project1.qxp" XMLVERSION="8.0">
<LAYOUT POINTSPERINCH="72">
<ID NAME="Layout 1" UID="1"/>
<ARTICLE DOCFORMAT="FULLFEATURED">
<ID NAME="Article 1" UID="1"/>
<COMPONENT OPERATION="CREATE" BOXUID="9" COMPONENTCLASS="CT_TEXT" 
NAME="New Component"/>
</ARTICLE>
</LAYOUT>
</PROJECT>

To delete the component named "New Component" from the article named "Article1.qcd," you could use XML like the following:

<PROJECT JOBJACKET="Project1 Job Jacket" JOBTICKET="Default Job Ticket 1:Project1" 
PROJECTNAME="Project1.qxp" XMLVERSION="8.0">
<LAYOUT POINTSPERINCH="72">
<ID NAME="Layout 1" UID="1"/>
<ARTICLE DOCFORMAT="FULLFEATURED">
<ID NAME="Article 1" UID="1"/>
<COMPONENT OPERATION="DELETE" NAME="New Component"/>
</ARTICLE>
</LAYOUT>
</PROJECT>

PDF Filter XTensions software

PDF Filter XTensions software allows QuarkXPress Server to render a QuarkXPress project as a PDF file. To render QuarkXPress projects as PDF files when PDF is not the QuarkXPress Server default render type, use the PDF namespace, as follows:

http://[server]:[port]/pdf/[projectname]

For information about PDF preferences, see "Preferences — PDF." To take advantage of more detailed preferences, create a PDF output style and use that output style when rendering projects as PDF files.

Modifier XTensions software

Modifier XTensions software lets clients perform all of the following tasks using XML:

  • Modify the properties of pictures in a QuarkXPress project

  • Modify the text in text boxes within a QuarkXPress project

  • Modify the properties of text boxes and picture boxes in a QuarkXPress project

  • Create and delete picture boxes and text boxes in a QuarkXPress project

  • Import text or text strings into text boxes within a QuarkXPress project

  • Import pictures into picture boxes within a QuarkXPress project

  • Save modified QuarkXPress projects in any supported format to any location on the network (and also in the QuarkXPress Server document pool)

  • Create and delete pages

  • Create and delete layers

  • Move items within layers

  • Create and delete tables

  • Modify tables and their contents

  • Create QuarkCopyDesk articles and components

  • Create lines, anchored boxes, and Bézier boxes

  • Create lists

  • Group and ungroup boxes

  • Divide layouts into sections

To use Modifier XTensions software, a client creates an XML file indicating the actions to be taken and sends that XML file to the QuarkXPress Server application, where Modifier XTensions software reads the XML and makes the requested changes. Clients can use a single XML file or string to manipulate multiple documents and boxes.

Modifier XTensions software supports both GET and POST functionality.

Modifier XTensions software supports XML containing code that uses Unicode UTF-8 and UTF-16 encodings. Use the encoding attribute of the XML declaration to specify an encoding, as you would with any other XML file.

Using Modifier XTensions software

To use Modifier XTensions software:

  1. Create a QuarkXPress project. Note the IDs or names of any text and picture boxes you want to manipulate.

  2. Upload the project to the QuarkXPress Server document pool.

  3. Create XML that describes the changes you want, as described in "Creating XML for Modifier XTensions software."

  4. Send the XML to the server in one of the following ways:

    • Put the XML in a file on the server and then use a URL to point to the file, as follows:

    http://server:port/namespace/path/projectname?modify=file:[absolute path to XML file on server or relative path to XML file on server relative to the document pool]

    • Put the XML in the URL, as follows:

    http://[server]:[port]/[namespace]/path/projectname?modify=[XML string]

    Clients can also send XML in the form of a POST request.

Creating XML for Modifier XTensions software

All XML used with Modifier XTensions software uses the Modifier schema. This schema is documented in full in "Modifier schema (annotated)."

In general, the structure for addressing items in a particular layout is as follows:

<PROJECT>
<LAYOUT>
<ID NAME="
[name of layout]
">
<
[Item being addressed]
>
<
[Parameters of item]
>
</
[Item being addressed]
>
</LAYOUT>
</PROJECT>

Layer XTensions software

You can use QuarkXPress Server Layer XTensions software to control the visibility of specific layers in a rendered QuarkXPress project. You can also add layers, delete layers, edit layer attributes, and control whether layers are rendered.

When you use the getdocinfo namespace, QuarkXPress Server returns information about items on all of the layers in the QuarkXPress project, including layers that are not visible.

Clients can use the layer parameter to specify a layer (even a hidden layer) to be rendered. For example, the URL http://QXPServer:8080/doc.qxp?layer=layer1 renders only the layer named "layer1" in the project named "doc.qxp."

Clients can specify more than one layer in a single URL. For example, the URL http://QXPServer:8080/doc.qxp?layer=layer1,layer2 renders the layers named "layer1" and "layer2."

For information about layer preferences, see "Preferences — Layers."

If Suppress Output is selected for a layer, QuarkXPress Server does not render that layer when producing PDF, EPS, or PostScript files.

InteractiveDesigner Server XTensions software

InteractiveDesigner XTensions software allows QuarkXPress Server to render both Print and Interactive layouts in QuarkXPress projects as SWF (Flash) files. If you render a Print layout as an SWF file, you can use the right and left arrow keys to navigate between pages in the SWF file.

To render an Interactive layout in a QuarkXPress project as a SWF file when SWF is not the QuarkXPress Server default render type, use the SWF namespace, as follows:

http://[server]:[port]/swf/[projectname]?layout="[layoutname]"

App Studio XTensions software

The App Studio XTensions modules allow QuarkXPress Server to render Print and App Studio layouts in QuarkXPress projects as AVE issue files.

In QuarkXPress 9.5.1.1, an option was added to allow the App Studio output to convert sections to page stacks. A new URL parameter convertsectionstopagestacks has been added to provide this ability.

The XML example below demonstrates how to apply sections using the ModifierXML:

<PAGESEQUENCE MASTERREFERENCE="APSMasterPages" FORCEPAGECOUNT="NOFORCE">
SECTIONNUMBERFORMAT FORMAT="NUMERIC" INITIALPAGENUMBER="1"/>

The element SECTIONNUMBERFORMAT creates a section start which applied to all pages in the page sequence. Each PAGESEQUENCE could have its own SECTIONNUMBERFORMAT.

If the modify request is sent to the server and each PAGESEQUENCE in the ModifyXML has its own SECTIONNUMBERFORMAT, creating sections, and the URL parameter contains convertsectionstopagestacks=true, the digital issue navigation would be as follows:

If the URL parameter contains convertsectionstopagestacks=false, the digital issue navigation would be as follows:

By default, convertsectionstopagestacks is false.