From Seneca’s Tech Writing Portfolio

Meadows/BantaIM: DesignMerge Manual
[jump to writing sample]

DesignMerge is a Quark XTension that allows users to tie in image and text databases with QuarkXPress layouts to output individually customized print jobs (also known as "variable printing"). It's one of the more expensive XTensions out there and its customers are commercial print shops throughout the world. The developer, Meadows Information Systems (since acquired by Banta Integrated Media), hired Anne-Marie to write and illustrate the DesignMerge manual. (continued below…)

Meadows/Banta - DesignMerge manual - spread1

Pictured above is a a spread from one of the six 10-50 page DesignMerge tutorials written by Anne-Marie. The tutorials teach the user how to use every aspect of the program in a carefully-paced, incremental manner; each building on the one preceeding it. Anne-Marie also created or updated the ancillary files that would be required for the user to complete the tutorials, including sample QuarkXPress documents, artwork and databases.

Other sections of the DesignMerge manual that Anne-Marie wrote include stand-alone manuals for the auxiliary XTensions and print drivers included with the product (screen shot of the CopyFit XT chapter below), and of course the DesignMerge installation and troubleshooting chapters. (continued below…)

Meadows/Banta - DesignMerge manual - spread2

Company owner John Kriho was pleased with final result. After the new DesignMerge manual shipped with the next release, he reported that the number of incoming support calls decreased significantly, due at least in part to the improved documentation.

[top]

Writing sample from Chapter 5 of the DesignMerge manual, "Using CopyFit and GroupPicture"

Setting CopyFit’s Text Formatting Parameters
There are six different text formatting attributes which can be adjusted in order to copy fit a box. They are Tracking, Horizontal Scaling, Point Size, Leading, Space Before (a paragraph) and Space After (ditto):

[screen shot]

To enable a CopyFit formatting attribute, click the checkbox next to it. Then, establish the adjustment range for the attribute. Each attribute has a minimum and maximum allowable adjustment value, as well as a “step" amount (which is the amount by which a particular attribute will be adjusted — increased or decreased — in order to effect the copyfit). Enter any values you wish — up to the limits of XPress itself — but make sure to click the Update Set button so that CopyFit will remember and apply your changed settings from that point onward.

The priority of these formatting attributes — the order in which their specified adjustments are applied to text — can be set by changing the Pri column in the table. Valid priorities are from 1 to 6. Formatting attributes with a priority of 1 will be adjusted first. Attributes with a priority of 6 will be adjusted last. Formatting attributes having equal priority will be adjusted in the order in which they appear in the table, reading from top to bottom.

[....]

Out of Range Errors
When you tell CopyFit which text formatting adjustments it can make to get copy to fit in a text box (by checking/unchecking the text attributes in the palette); you also set the minimum and maximum values for each adjustment. For instance, you might check the “Point Size” attribute, and enter a minimum value of 8 pts. and a maximum value of 14 pts.

If CopyFit reaches the limit for every enabled attribute but still can’t get the text to fit — in this example, say, it’s reduced the point size of overset text to 8 points but the box is still overset — you’ll get an “Out of Range” error:

[screen shot]

To solve an “Out of Range” problem, first click the Alert box’s OK button to dismiss the dialog. Then, assuming you can’t edit the text or the size of its text box, you’ll need to enable additional attributes which CopyFit can adjust (by clicking their checkboxes in the palette), or increase the range of one or more enabled attributes (by modifying the minimum and maximum values in the palette), or a combination of the two. Remember to click the Update Set button when you’re done with your changes, and then click the Fit button again.

There is a CopyFit Preference option (enabled by default) called “Enable Faster CopyFit Checking” that, after clicking the Fit button, will make CopyFit do a preliminary check to see if the selected text box can be fixed by using the minimum/maximum adjustment(s), as appropriate. If the box can’t be made to fit you’ll get an immediate Alert. If it can be fit, CopyFit reverts the text to its original formatting and proceeds as usual.

When this Preference option is disabled, CopyFit may take quite a while to try every possible combination of your attributes before it realizes the text is impossible to fit and give you the “out of range” Alert.

[continues…]


close window