Objectif Lune PlanetPress Design - 7.5 User Guide

PlanetPress Design

User Guide

www.objectiflune.com

Copyright Information

No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any other language or computer language in whole or in part, in any form or by any means, whether it be electronic, mechanical, magnetic, optical, manual or otherwise, without prior written consent of Objectif Lune Inc.

Objectif Lune Inc.disclaims all warranties as to this software, whether expressed or implied, including without limitation any implied warranties of merchantability, fitness for a particular purpose, functionality, data integrity or protection.

PlanetPress and PrintShop Mail are registered trademarks of Objectif Lune Inc.

PostScript and Acrobat are registered trademarks of Adobe Systems Inc.

Pentium is a registered trademark of Intel Corporation.

Windows is a registered trademark of Microsoft Corporation.

Adobe, Adobe PDF Library, Adobe Acrobat, Adobe Distiller, Adobe Reader, Adobe Illustrator, Adobe Photoshop, Optimized Postcript Stream, the Adobe logo, the Adobe PDF logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.

Trademarks of other companies mentioned in this documentation appear for identification purposes only and are the property of their respective companies.

Title PlanetPress Design User Guide Revision 2014-09-24

Table of Content

Table of Content 5

Overview 29

Icons used in this guide 29 Other Documentation 29

Getting Started 31

Environment Considerations 31

Terminal Server/Service 31 VMWare/ESX 31 32-Bit or 64-Bit? 31

Network Considerations 31

Mapped Drives 31

Activate Your Printers 32 The Nature of PlanetPress Design 32

The PlanetPress Design Program 33

Start PlanetPress Design 33 The PlanetPress Suite Button 33

Open a Document 34 Save a Document 35 Save and Open a Document Template 35 Change the Interface Language 35 Exit PlanetPress Design 36

The Quick Access Toolbar 36 The PlanetPress Design Ribbon 37

Undo and Redo Commands 38 Navigate Data Pages 39

Document Structure Area 39

Selecting and moving elements 40

Add a Metadata Field 40

Add a Document Page 41 Edit the Order of Pages 41 Duplicate a Page 41 Delete a Page 42 Object Layering Order 42 Group and Ungroup Objects and/or Groups 43

Data Pane 43 Object Inspector 43 Workspace Area 44

Using the Select Tool in the Workspace 44 Zoom in and out of the Workspace 45 Pan the Workspace 45 Use Guides 46

Table of Content

Right-Click Menu in the Workspace 47

Detailed Directions 47

Debug an Object or Group 48 Select Objects and/or Groups 48 Lock and Unlock Objects and Groups 48 Reposition Objects and/or Groups 49 Resize Objects and/or Groups 49 Delete Objects and/or Groups 50 Align Objects and/or Groups 51 Rotate Objects and/or Groups 51 Duplicate Objects and/or Groups 51 Snap or Unsnap Objects and/or Groups 51 Copy Values of Properties between Objects and/or Groups 54 Adding image resources to your document 54

Messages Area 55

Adding External Resources 55

PlanetPress Design Preferences 56

Notification Messages Preferences 57 Image Resources Preferences 58 Color Preferences 59 Object Duplication Preferences 59 Miscellaneous Preferences 60 Editor Preferences 61 Display Preferences 62 Color Preferences 63 Ribbon Preferences 63 Object Inspector Preferences 63 Document Structure Area Preferences 64 Rulers Preferences 64 Form Pages Preferences 65 Compiler Messages Preferences 65 Document and Pages Preferences 65 Image Resources Preferences 66 PDF Text Extraction Tolerance Factors 67 Data Selector Display Preferences 68 PlanetPress Capture Preferences 69 Dock and Undock Areas of the Program Window 70 Minimize and Customize the Ribbon 70 Show or Hide Areas of the Program Window 70 Resize the Program Window Area 71

Data in PlanetPress Design 73

Sample Data File 73 Capturing Data 75

Capture Sample Data Using the Data Capture Tool 75 LPD Input 75 Serial Input 76

Table of Content

Telnet Input 76 Windows Queue Input 77

The Data Selector 78

Metadata tab 79

Data Page 80 Emulation 80

Text-Based Emulation Properties 81 Line Printer Emulation 81 ASCII Emulation 82 Comma Separated Value (CSV) Emulation 82 Channel Skip Emulation 83 Database Emulation 83 Export or Import a Database Emulation Configuration 85 XML Emulation 86 PDF Emulation 86 User-Defined Emulation 86 Associate a Sample Data File with a Document 87

Metadata 87

Setting Up a Document 95

Set Up a Document 95

Cacheable Execution Options 100

FreeForm Caching 101 FreeForm 2 Caching 102 VPSCaching 102 VDXCaching 103 PPDSetup 104 Add or Remove PPDs 104 Refresh the PPD Lists 105 Specify Job Infos 105 Associate Attachments with a Document 105

Setting Up Pages 107

Page Properties 107

Page Types 109

Normal Page 109 Overlay Page 109 Virtual Page 110 Execution Order of Pages 110

Advanced Paper Handling 110

Associate Attachments with a Page 111 Add or Remove Overlays 111

PlanetPress Design Objects 113

View or Edit the Properties of an Object 113

Basic Attributes 113 Repeat 115 Snapping Points 116

Table of Content

Manipulation 116 PlanetPress Talk Before and PlanetPress Talk After 117 Preview options 117

Line Repeat and Data Overflow 117

Snapping Points 119 Object Preview Window 119

Fonts and Styles 121

Create a Style 121 Apply a Style 123 View or Edit the Properties of a Style 123 Delete a Style 124 Set the Default Style for New Objects and Groups 124 Create a MICR Style for Account Information on Cheques 125

Arabic Content in PlanetPress Design Documents 125 CID-Keyed Fonts 126 Double-byte Character Sets 126 Encoding Tables 126

Why have different encoding tables? 127 Encoding Tables in PlanetPress Design 127 Font Encoding Editor 127 Set a Default Encoding Table 128 Export an Encoding Table 128 Refresh the Font Lists 129 Install a PostScript Font in PlanetPress Design 129

Text and Box Object 130

Borders 130 Color 131 Text 131 Apply a Style to Text in a Text Object 133 Set Tabs 134 Adjust Alignment and Lines Per Unit settings 135 Spell Check Text in a Text Object 135 Use the Thesaurus 138 Change the Width of the Text Object in the Text Area 138 Use Variables in a Text Object 138

Data Selection Object 140

Data 140 Lines 141 Archive/Email/Fax 141 Text-Based Data Selections 142 Database Data Selections 143 XMLData Selections 144 PDFData Selections 145 Edit Text-Based Data Selection Size 146

Postal Address Object 146

Metadata 147

Table of Content

OMR Mark Object 147

PlanetPress Talk Object 148 Shape Object 149

N-Up Object 149

Picture Object 150

Barcode Object 152

Supported Barcodes 152

Australia Post 152 Aztec 153 CEPNet (Brazilian Postal Code) 153 Codabar 153 CodablockF 153 Code 11 154 Code 16k 154 Code 39 154 Code 49 155 Code 93 156 Code 128 157 Datamatrix 158 Discrete 2 of 5 159 FIM 159 GS1 Databar (RSS) 159 IMB/OneCode 159 Japan Post 159 Maxicode 159 Micro PDF417 160 Micro QR 160 MSI Plessey 160 PDF417 160 Plessey 161 USPSPostnet 161 QR Code 161 Royal Mail 162 UPC 162

Business Graphic Object 163

Excel Graphic 165

Capture Field Object 166

Considerations 168 Pidgets 169

Capture Field Masks 169

Custom Masks 170 Regular Expressions 171 Capture Field Template List 172

Document Resources 173

Image Resources 175

Location of image resources 175

Table of Content

Static and Dynamic Images 175 Supported Image Formats 175 Image Glossary 176

Scanline Orientation 177

Image Quality Settings 178

Caches 178

Host-Based Cache 179 Printer-Based Cache 179 Adding Image Resources 179

Guidelines for Optimizing Images 180

Modifying and Updating Images 180 Color Management and Matching 181

PostScript Attachments 184

Delete a Resource 184

Conditions 187

Conditions 187 Global Conditions 187 Local Conditions 187 Line Conditions 187 Create or Remove a Line Condition 188 PlanetPress Supports Global Variables in the Global Function Library Manager 189 Create a Global Condition 190 View or Edit the Properties of a Global Condition 192 Apply or Remove a Global Condition 192 Use a Global Condition as a Variable 192 Combine Global Conditions 192 Override a Global Condition 195 Delete a Global Condition 195 Create, Edit, or Delete Local Conditions 195 Verify a Condition 196 Add a Global Function 196 View or Edit a Global Function 196 Delete a Global Function 197

PlanetPress Talk 199

Variable PlanetPressTalk Properties 199

The PlanetPress Talk Editor 201 PlanetPress Talk Editor Features 202 Debugging Features 203 Code Execution in the Editor 203 Enter a New Program in the Editor 205 Import or Export a Program 205 Save a Program 205 Print a Program 205 Exit the PlanetPress Talk Editor 206 Show or Hide the Commands Area or Spy List 206 Adjust the Sizes of the Commands Area, Code Area and Spy List 206

Table of Content

Expand or Collapse Command Groups 207 Enter Commands in the Editor 207 Use Command and Variable Name Completion 208

Dynamic Images 209 PlanetPress Talk Expressions for Dynamic Images that Reference Image Resources 209 PlanetPress Talk Expressions for Dynamic Images that Reference External Images 209

Physical Location of Dynamic Images 210 Host-Based or Printer-Based Document Execution 210 Image Format 211 Summary of Execution Environments 211 Examples of PlanetPress Talk Expressions that Resolve to Pathnames 212

Image Name and Pathname Resolution in Dynamic Images 213

Custom Data Selections 213 PlanetPress Talk Before and After 213

Creating and using Runpages 214

Convert an Object to PlanetPress Talk 215

PlanetPress Talk Basics 217

Assumed Knowledge 217 PlanetPress Talk 217 PlanetPress Talk Terminology 219 The Elements of PlanetPress Talk 219 PlanetPress Talk Syntax 220 Data Types 222 Variables 224 Create a Global Variable 225 View or Edit a Global Variable 226 Delete a Global Variable 226 System Variables with Local Scope 228 System Variables with Global Scope 228 System Objects with Global Scope 229

Current System Object 229

Runpage 232 Using Foreign Language Text with PPtalk 232 Learning PlanetPress Talk 236 Integrate PlanetPress Talk into Documents 237 Define and Assign Values to Variables 237 Select Data 238 Use Functions as Arguments 238 Debug Scripts 238 Calculations and Arithmetic in PlanetPress Talk 239 Tips and Tricks 239

Code Samples 240

Print a variable number of copies of a page based on a value in the datastream 240 Store two lines of input data on one line of the data page 240 Print a line of text on odd-numbered pages 241 Determine the proper page to print based on the width of the data in the data page 242

Table of Content

Language Reference 243 Language Reference (Alphabetical) 243

% (procedure) 243 Current (system object) 243 ¤titeration (variable) 245 &Document (system object) 246 &EOJob (system variable) 246 &FirstSide (system variable) 246 &Height (system variable) 247 &iterationcount (variable) 247 lastoverflowcount (variable) 247 &Metamode (variable) 247 Physical (system object) 248 &PrinterMode (system variable) 248 Script (system object) 249 &Str (system variable) 250 &system (system object) 250 &watch (system object) 251 &Width (system variable) 251 @ (function) 251 @name (function/procedure) 252 @page (procedure) 252 $element (procedure) 253 + (operator & function) 253 – (operator) 254 Asterisk (*) operator 254 / (operator) 254 Greater than (>) operator 254 Greater or equal to (>=) operator 254 Less than (<) operator 254 Less or equal to (<=) operator 254 = (operator) 254 <> (operator) 255 Add (function) 255 And (Boolean operator function) 255 Arc and ArcN (procedures) 256 BeginDocument/EndDocument (procedure) 257 BeginGroup/EndGroup (procedure) 258 BeginParagraph … EndParagraph (procedure) 258 BeginUTF8Paragraph … EndUTF8Paragraph (procedure) 260 BitmapWidth/BitmapHeight (function) 260 Breakpoint (procedure) 261 C128 (function) 261 CallPPD (procedure) 262 Ceil (function) 262 Char (function) 263

Table of Content

CharPath (procedure) 263 ClearPage (procedure) 264 ClipPath (procedure) 264 ClosePath (procedure) 265 Cos (function) 265 CRLF (procedure) 266 CurToStr (function) 266 CurToFloat (function) 267 CurveTo/RCurveTo (procedure) 267 Date (function) 268 Define (procedure) 269 DefineData (procedure) 269 DefineImageIndex (procedure) 270 Definemeta (function) 270 Div (function) 271 DoForm (procedure) 272 endpageset (procedure) 272 EPSWidth/EPSHeight (function) 273 Eq (function) 274 ExecPage (procedure) 274 ExecScriptFile (function) 275 Exit (procedure) 276 ExpandString (function) 277 Field (function) 277 FieldCount (function) 278 FieldName (function) 278 Fill (procedure) 278 Find (function) 279 FloatToCur (function) 279 FloatToInt (function) 280 FloatToStr (function) 280 For… EndFor (procedure) 281 Function @name (procedure) 282 GE (function) 284 Get (function) 285 GetBlack (function) 286 GetCyan (function) 286 GetMagenta (function) 286 Getmeta (function) 287 Getmetacount (function) 288 GetNextDataPage(procedure) 289 GetYellow (function) 290 GRestore (procedure) 290 GSave (procedure) 290 GT (function) 291 If (function) 292 If … ElseIf… EndIf (procedure) 292

Table of Content

InStream... EndInStream (procedure) 294 IntToCur (function) 295 IntToFloat (function) 295 IntToStr (function) 296 IsNumber (function) 297 IsPageEmpty (function) 297 LE (function) 297 Left (function) 298 Length (function) 299 LineTo/RLineTo (procedure) 299 LowerCase (function) 300 LT (function) 300 MapUTF8 (function) 301 Margin (procedure) 303 Mid (function) 303 Mod (function & procedure) 304 MoveTo/RMoveTo (procedure) 305 Mul (function) 305 NE (function) 306 Neg (function) 307 Not (Boolean operator function) 307 Object $name()... EndObject (procedure) 308 Or (Boolean operator function) 310 Ord (function) 310 OutputDebugString (procedure) 311 PassThrough (procedure) 311 PDFPageCount (function) 312 PDFWidth/PDFHeight (function) 312 Pie (procedure) 313 PixelHeight (function) 314 PixelWidth (function) 314 Pos (function) 314 Put (procedure) 315 Random (function) 315 Rectangle (procedure) 316 RectFill (procedure) 317 RectFillStroke (procedure) 318 RectStroke (procedure) 318 Region (function) 319 Regionline (function) 320 Repeat... Until (procedure) 320 ResourceType (function) 321 Right (function) 322 RunPS (procedure) 323 Scale (procedure) 323 Search … EndSearch (procedure) 323 SelectMedia (procedure) 324

Table of Content

SelectPrinter (procedure) 325 Set (procedure) 325 SetAngle (procedure) 326 SetBodyText (procedure) 327 SetDash(procedure) 327 SetDataPage(procedure) 328 SetEmailAddress (procedure) 328 SetEmailSubject (procedure) 328 SetEmulation(procedure) 328 SetUserCRLF (procedure) 329 SetFaxInformation (procedure) 329 SetFaxNumber (procedure) 330 SetFillColor (procedure) 330 SetImageIndex (procedure) 331 SetLineWidth (procedure) 331 SetLPP(procedure) 332 SetPDFBookmark (procedure) 332 SetStrokeColor (procedure) 333 SetStyle (procedure) 333 SetStyleExt (procedure) 334 Show / ShowCenter / ShowRight (procedure) 335 ShowBarCode (procedure) 335 ShowBarcode2of5(procedure) 337 ShowBarcodeAustPost (procedure) 337 ShowBarcodeAztec (procedure) 337 ShowBarcodeCodabar (procedure) 338 ShowBarcodeCodablockF (procedure) 339 ShowBarcodeCode11 (procedure) 340 ShowBarcodeCode128 (procedure) 340 ShowBarcodeCode16k (procedure) 341 ShowBarcodeCode39 (procedure) 341 ShowBarcodeCode49 (procedure) 342 ShowBarcodeCode93 (procedure) 342 ShowBarcodeDatamatrix (procedure) 343 ShowBarcodeEAN8 (procedure) 344 ShowBarcodeEAN13 (procedure) 344 ShowBarcodeFIM (procedure) 345 ShowBarcodeI2of5 (procedure) 345 ShowBarcodeISBN (procedure) 346 ShowBarcodeJapanpost (procedure) 347 ShowBarcodeMaxicode (procedure) 347 ShowBarcodeMicroPDF (procedure) 348 ShowBarcodeMicroQR (procedure) 348 ShowBarcodeMSI (procedure) 349 ShowBarcodeOnecode (procedure) 349 ShowBarcodePDF417 (procedure) 350 ShowBarcodePlessey (procedure) 351

Table of Content

ShowBarcodePostnet (procedure) 351 ShowBarcodeQRCode (procedure) 352 ShowBarcodeRoyalMail (procedure) 352 ShowBarcodeRSS (procedure) 353 ShowBarcodeUPCA (procedure) 353 ShowBarcodeUPCE (procedure) 354 ShowBitmap (procedure) 355 ShowCaptureUserArea (procedure) 356 ShowEPS (procedure) 357 ShowLeftRight (procedure) 358 ShowPage (procedure) 359 ShowPDF (procedure) 359 ShowUTF8 (procedure) 360 ShowUTF8Left / ShowUTF8Right / ShowUTF8Center (procedure) 361 Sin (function) 362 StopJob (procedure) 363 Store (procedure) 363 StringReplace (function) 364 StringWidth (function) 364 StringWidthUTF8 (function) 365 Strip (function) 365 Stroke (procedure) 366 StrokeAndFill (procedure) 366 StrToCur (function) 367 StrToFloat (function) 367 StrToInt (function) 368 Sub (function) 368 SubRecCount (function) 369 Time (function) 370 Translate (procedure) 371 Trim (function) 372 TrimLeft (function) 372 TrimRight (function) 372 UpperCase (function) 373 xmlCount() 373 xmlGet() 374 XOr (Boolean operator function) 375

Language Reference (by element type) 375

System Variables 376 &EOJob (system variable) 376 &FirstSide (system variable) 376 &Height (system variable) 376 &PrinterMode (system variable) 377 &Str (system variable) 377 &Width (system variable) 378 System Objects 378 Current (system object) 378

Table of Content

Physical (system object) 380 &system (system object) 380 Assignment Operator 381 = (operator) 381 Mathematical Operators and Operator Functions 381 + (operator & function) 381 Add (function) 382 – (operator) 382 Sub (function) 382 Asterisk (*) operator 383 Mul (function) 383 / (operator) 383 Div (function) 383 Neg (function) 384 Cos (function) 384 Sin (function) 385 Random (function) 386 Ceil (function) 386 String Operator 387 + (operator & function) 387 Boolean Operator Functions 387 And (Boolean operator function) 387 Not (Boolean operator function) 388 Or (Boolean operator function) 388 XOr (Boolean operator function) 389 Comparison Operators and Operator Functions 390 GT (function) 390 Greater than (>) operator 391 GE (function) 391 Greater or equal to (>=) operator 391 LT (function) 391 Less than (<) operator 392 LE (function) 392 Less or equal to (<=) operator 393 Eq (function) 393 = (operator) 393 NE (function) 394 <> (operator) 394 Conversion Operator Functions 394 FloatToCur (function) 395 FloatToInt (function) 395 FloatToStr (function) 395 IntToCur (function) 396 IntToFloat (function) 396 IntToStr (function) 397 StrToCur (function) 398 StrToFloat (function) 398

Table of Content

StrToInt (function) 398 Loop Structures 399 For… EndFor (procedure) 399 Repeat... Until (procedure) 400 Search … EndSearch (procedure) 401 Exit (procedure) 402 Condition Structures 402 If … ElseIf… EndIf (procedure) 402 If (function) 404 Procedures 405 % (procedure) 405 @name (function/procedure) 405 @page (procedure) 406 $element (procedure) 406 Arc and ArcN (procedures) 407 BeginDocument/EndDocument (procedure) 408 BeginGroup/EndGroup (procedure) 409 BeginParagraph … EndParagraph (procedure) 409 BeginUTF8Paragraph … EndUTF8Paragraph (procedure) 411 Breakpoint (procedure) 412 CallPPD (procedure) 412 CharPath (procedure) 413 ClearPage (procedure) 413 ClipPath (procedure) 414 ClosePath (procedure) 414 CRLF (procedure) 415 CurveTo/RCurveTo (procedure) 415 Define (procedure) 416 DefineData (procedure) 417 DefineImageIndex (procedure) 418 DoForm (procedure) 418 endpageset (procedure) 419 ExecPage (procedure) 419 Exit (procedure) 420 Fill (procedure) 421 For… EndFor (procedure) 421 Function @name (procedure) 422 GetNextDataPage(procedure) 425 GRestore (procedure) 425 GSave (procedure) 425 If … ElseIf… EndIf (procedure) 426 InStream... EndInStream (procedure) 428 LineTo/RLineTo (procedure) 429 Margin (procedure) 430 MoveTo/RMoveTo (procedure) 430 Object $name()... EndObject (procedure) 431 OutputDebugString (procedure) 432

Table of Content

PassThrough (procedure) 433 Pie (procedure) 433 Put (procedure) 434 Rectangle (procedure) 435 RectFill (procedure) 435 RectFillStroke (procedure) 436 RectStroke (procedure) 437 Repeat... Until (procedure) 437 RunPS (procedure) 438 Scale (procedure) 439 Search … EndSearch (procedure) 439 SelectMedia (procedure) 440 SelectPrinter (procedure) 441 Set (procedure) 441 SetAngle (procedure) 442 SetBodyText (procedure) 442 SetDash(procedure) 443 SetDataPage(procedure) 443 SetEmailAddress (procedure) 443 SetEmailSubject (procedure) 444 SetEmulation(procedure) 444 SetUserCRLF (procedure) 444 SetFaxInformation (procedure) 445 SetFaxNumber (procedure) 445 SetFillColor (procedure) 446 SetImageIndex (procedure) 446 SetLineWidth (procedure) 447 SetLPP(procedure) 448 SetPDFBookmark (procedure) 448 SetStrokeColor (procedure) 449 SetStyle (procedure) 449 SetStyleExt (procedure) 450 Show / ShowCenter / ShowRight (procedure) 451 ShowBarCode (procedure) 451 ShowBarcode2of5(procedure) 452 ShowBarcodeAustPost (procedure) 453 ShowBarcodeAztec (procedure) 453 ShowBarcodeCodabar (procedure) 454 ShowBarcodeCodablockF (procedure) 455 ShowBarcodeCode11 (procedure) 455 ShowBarcodeCode128 (procedure) 456 ShowBarcodeCode16k (procedure) 457 ShowBarcodeCode39 (procedure) 457 ShowBarcodeCode49 (procedure) 458 ShowBarcodeCode93 (procedure) 458 ShowBarcodeDatamatrix (procedure) 459 ShowBarcodeEAN8 (procedure) 459

Table of Content

ShowBarcodeEAN13 (procedure) 460 ShowBarcodeFIM (procedure) 461 ShowBarcodeI2of5 (procedure) 461 ShowBarcodeISBN (procedure) 462 ShowBarcodeJapanpost (procedure) 462 ShowBarcodeMaxicode (procedure) 463 ShowBarcodeMicroPDF (procedure) 463 ShowBarcodeMicroQR (procedure) 464 ShowBarcodeMSI (procedure) 465 ShowBarcodeOnecode (procedure) 465 ShowBarcodePDF417 (procedure) 466 ShowBarcodePlessey (procedure) 466 ShowBarcodePostnet (procedure) 467 ShowBarcodeQRCode (procedure) 467 ShowBarcodeRoyalMail (procedure) 468 ShowBarcodeRSS (procedure) 468 ShowBarcodeUPCA (procedure) 469 ShowBarcodeUPCE (procedure) 470 ShowBitmap (procedure) 470 ShowCaptureUserArea (procedure) 472 ShowEPS (procedure) 473 ShowLeftRight (procedure) 474 ShowPage (procedure) 474 ShowPDF (procedure) 475 ShowUTF8 (procedure) 475 ShowUTF8Left / ShowUTF8Right / ShowUTF8Center (procedure) 476 StopJob (procedure) 478 Store (procedure) 478 Stroke (procedure) 479 StrokeAndFill (procedure) 479 Translate (procedure) 480 Functions 481 @ (function) 481 @name (function/procedure) 481 BitmapWidth/BitmapHeight (function) 482 C128 (function) 482 Ceil (function) 483 Char (function) 483 Date (function) 484 Definemeta (function) 484 EPSWidth/EPSHeight (function) 485 ExecScriptFile (function) 486 ExpandString (function) 487 Field (function) 487 FieldCount (function) 488 FieldName (function) 488 Find (function) 489

Table of Content

Get (function) 489 GetBlack (function) 490 GetCyan (function) 490 GetMagenta (function) 491 Getmeta (function) 491 Getmetacount (function) 493 GetYellow (function) 494 IsNumber (function) 494 IsPageEmpty (function) 494 Left (function) 495 Length (function) 495 LowerCase (function) 496 MapUTF8 (function) 496 Mid (function) 498 Mul (function) 499 Ord (function) 499 PDFPageCount (function) 500 PDFWidth/PDFHeight (function) 500 PixelHeight (function) 501 PixelWidth (function) 501 Pos (function) 501 Random (function) 502 Region (function) 502 Regionline (function) 503 ResourceType (function) 504 Right (function) 505 StringReplace (function) 505 StringWidth (function) 506 StringWidthUTF8 (function) 507 Strip (function) 507 Sub (function) 507 SubRecCount (function) 508 Time (function) 509 Trim (function) 510 TrimLeft (function) 510 TrimRight (function) 511 UpperCase (function) 511 xmlCount() 511 xmlGet() 512

System Variables (by data type) 513

Integer 513 Measure 513 String 514 Boolean 514

Functions (by return value data type) 514

Currency 514

Table of Content

Add (function) 514 FloatToCur (function) 515 IntToCur (function) 515 StrToCur (function) 515 Integer 516 Add (function) 516 Ceil (function) 516 Div (function) 517 FieldCount (function) 517 FloatToInt (function) 517 Get (function) 518 GetBlack (function) 518 GetCyan (function) 519 GetMagenta (function) 519 GetYellow (function) 520 Getmetacount (function) 520 If (function) 521 Length (function) 522 Mod (function & procedure) 522 Mul (function) 523 Neg (function) 524 Ord (function) 524 PDFPageCount (function) 525 PixelHeight (function) 525 PixelWidth (function) 525 Pos (function) 526 ResourceType (function) 526 StrToInt (function) 527 Sub (function) 528 SubRecCount (function) 528 xmlCount() 529 Measure 530 Add (function) 530 BitmapWidth/BitmapHeight (function) 531 Cos (function) 531 CurToFloat (function) 532 Div (function) 532 EPSWidth/EPSHeight (function) 532 Get (function) 533 If (function) 533 IntToFloat (function) 534 Mul (function) 535 Neg (function) 535 PDFWidth/PDFHeight (function) 536 Random (function) 536 Sin (function) 537 StringWidth (function) 537

Table of Content

StringWidthUTF8 (function) 538 StrToFloat (function) 538 Sub (function) 539 String 540 @ (function) 540 C128 (function) 540 Char (function) 541 CurToStr (function) 541 ExpandString (function) 541 Field (function) 542 FieldName (function) 542 FloatToStr (function) 543 Get (function) 543 If (function) 544 IntToStr (function) 544 Left (function) 545 LowerCase (function) 546 Mid (function) 546 Right (function) 547 StringReplace (function) 548 Strip (function) 548 Trim (function) 549 TrimLeft (function) 549 TrimRight (function) 550 UpperCase (function) 550 xmlGet() 550 Boolean 551 Add (function) 551 Eq (function) 552 Find (function) 553 GE (function) 553 GT (function) 554 If (function) 554 IsNumber (function) 555 IsPageEmpty (function) 555 LE (function) 556 LT (function) 556 NE (function) 557 Not (Boolean operator function) 558 Or (Boolean operator function) 558 XOr (Boolean operator function) 559

Procedures (by category) 560

Debugging 560 Breakpoint (procedure) 561 OutputDebugString (procedure) 561 Variables 561 Define (procedure) 561

Table of Content

Put (procedure) 562 Set (procedure) 563 Global Functions 563 @name (function/procedure) 563 Function @name (procedure) 564 Comments 566 % (procedure) 566 Graphics State 567 GRestore (procedure) 567 GSave (procedure) 567 Scale (procedure) 568 SetAngle (procedure) 569 SetDash(procedure) 569 SetFillColor (procedure) 570 SetLineWidth (procedure) 571 SetStrokeColor (procedure) 571 Translate (procedure) 571 Path 572 Arc and ArcN (procedures) 573 ClosePath (procedure) 574 CurveTo/RCurveTo (procedure) 574 Fill (procedure) 575 LineTo/RLineTo (procedure) 576 MoveTo/RMoveTo (procedure) 577 Pie (procedure) 577 Rectangle (procedure) 578 RectFill (procedure) 579 RectFillStroke (procedure) 580 RectStroke (procedure) 580 Stroke (procedure) 581 StrokeAndFill (procedure) 582 Paragraphs and Text 582 BeginParagraph … EndParagraph (procedure) 582 BeginUTF8Paragraph … EndUTF8Paragraph (procedure) 584 CRLF (procedure) 585 Margin (procedure) 585 ShowLeftRight (procedure) 586 Show / ShowCenter / ShowRight (procedure) 586 Styles 587 SetStyle (procedure) 587 SetStyleExt (procedure) 588 Objects 589 Object $name()... EndObject (procedure) 589 Bar Codes 590 ShowBarCode (procedure) 590 ShowBarcode2of5(procedure) 591 ShowBarcodeAustPost (procedure) 592

Table of Content

ShowBarcodeAztec (procedure) 592 ShowBarcodeCodabar (procedure) 593 ShowBarcodeCodablockF (procedure) 594 ShowBarcodeCode11 (procedure) 594 ShowBarcodeCode128 (procedure) 595 ShowBarcodeCode16k (procedure) 596 ShowBarcodeCode39 (procedure) 596 ShowBarcodeCode49 (procedure) 597 ShowBarcodeCode93 (procedure) 597 ShowBarcodeDatamatrix (procedure) 598 ShowBarcodeEAN8 (procedure) 598 ShowBarcodeEAN13 (procedure) 599 ShowBarcodeFIM (procedure) 600 ShowBarcodeI2of5 (procedure) 600 ShowBarcodeISBN (procedure) 601 ShowBarcodeJapanpost (procedure) 601 ShowBarcodeMaxicode (procedure) 602 ShowBarcodeMicroPDF (procedure) 602 ShowBarcodeMicroQR (procedure) 603 ShowBarcodeMSI (procedure) 604 ShowBarcodeOnecode (procedure) 604 ShowBarcodePDF417 (procedure) 605 ShowBarcodePlessey (procedure) 605 ShowBarcodePostnet (procedure) 606 ShowBarcodeQRCode (procedure) 607 ShowBarcodeRoyalMail (procedure) 607 ShowBarcodeRSS (procedure) 608 ShowBarcodeUPCA (procedure) 608 ShowBarcodeUPCE (procedure) 609 Resources 610 InStream... EndInStream (procedure) 610 ShowBitmap (procedure) 611 ShowEPS (procedure) 612 ShowPDF (procedure) 613 Elements 613 $element (procedure) 613 Emulation, Data File, and Data Pages 614 ClearPage (procedure) 614 DefineData (procedure) 615 DoForm (procedure) 615 GetNextDataPage(procedure) 616 SetDataPage(procedure) 616 SetEmulation(procedure) 616 SetLPP(procedure) 617 Store (procedure) 617 Data Destined for PlanetPress Image, PlanetPress Fax and PlanetPress Search 618 DefineImageIndex (procedure) 618

Table of Content

SetBodyText (procedure) 618 SetEmailAddress (procedure) 618 SetEmailSubject (procedure) 619 SetFaxInformation (procedure) 619 SetFaxNumber (procedure) 619 SetImageIndex (procedure) 620 SetPDFBookmark (procedure) 620 Document Pages 621 @page (procedure) 621 ExecPage (procedure) 622 ShowPage (procedure) 622 PPDs and PostScript 623 CallPPD (procedure) 623 PassThrough (procedure) 624 RunPS (procedure) 624 SelectMedia (procedure) 624 Program Control 625 Exit (procedure) 625 For… EndFor (procedure) 626 If … ElseIf… EndIf (procedure) 627 Repeat... Until (procedure) 629 Search … EndSearch (procedure) 630 StopJob (procedure) 630

Conversion Tables 631 ASCII Conversion Table 632 Points to Inches or Centimeters 634

Points to Inches 635 Points to Centimeters 637

Line Height as a Function of Lines Per Unit (LPU) 638

Line Height as a Function of Lines Per Inch 638 Line Height as a Function of Lines Per Centimeter 638

Tools and Utilities 641

The Image Downloader 641 Adjust the Image Quality Options 643 Virtual Drive Manager 645

Managing Documents and Printers 647

Obtain Information from a Printer 647 Delete Documents or Files on the Printer 647 Printer Firmware Version 648 Control Versions of a Document 648 Adjust Printer Settings 649 Form Cache 650 Remove Background Color 650 Named Colors 651 Create a Graybar Report 652 The Hex Viewer 654

Table of Content

Date and Time Format 656

Document Output and Preview 659

About Previewing and Printing 659

Preview a Document On Screen 659 Previews of Documents that Use ASCII Emulation 661 Preview a Capture-Ready document 662 Print a Document Preview 663 Print Using a Windows Driver 664 Printing Using a Windows Driver 665 Generate a Soft Proof 665 Convert a Document and Save It to a File 667

Install a Document 669

Install a document on one or more printers 669 Send the document to one or more local PlanetPress Workflow servers 669 Save a PTK or PTZfile to send to a remote PlanetPress Workflow installation 670 Send a document to PlanetPress iWatch or a UNIX or Linux CodeHost BrightQ print spooler system: 670

Perform a Batch Conversion and/or Installation 671

To use the Batch Send To wizard 671 Move a Document between PlanetPress Design Installations 672 Trigger 672

How a Variable Content Document Runs on a Printer 672

Phase 1: Data Reading 672 Phase 2: Global Condition Resolution 673 Phase 3: Document Page Printing 673

Techniques for Inserting Triggers 673 Trigger Syntax 674

Trigger Syntax for Documents Installed on a Hard Disk 674 Trigger Syntax for Documents Installed in RAM 674 Trigger Syntax for Documents Installed in Flash Memory 675 Run a Document Installed on a Printer 675 Run a Document Installed in a PlanetPress Suite Workflow Tool 675 Run a Document that Uses a Database Emulation 676 Run Several Documents as a Single Job 676 Troubleshoot Execution Problems 676

Keyboard Shortcuts 681

PlanetPress Design General 681

Exit PlanetPress Design 681 Use the Help System 681 Show or Hide Areas of the Program Window 682 Work with Hierarchies 682 Work in the Document Structure Area 682 Work with Documents 682 Preview and Install Documents 683 Work with Pages 683 Adjust the Zoom 684 Use Basic Editing Commands 684

Table of Content

Work in the Data Pane 684 Work with the Data File 685 Work with Data Selections 685 Use the Hex Viewer 686 Work with Objects 687 Work in the Text Properties of a Text Object 688

PlanetPress Talk Editor 688

General 689 Show or Hide Areas of the Editor 689 Expand or Collapse Groups in the Commands Area 689 Work in the Code Area 690 Use Command Name Completion/Argument Insertion 690 Undo Commands 690 Work with Selections 690 Add/Remove Comments 691 Indent Code 691 Search 691 Jump to a Specific Line 691 Use Bookmarks 691 Execute a Program 691 Debug Code 692 Print the Script 692 Converted Document 692

About Documents 692

About Document Elements 693

About Data Selections 694 About Objects 694 PPD File 694

PP7 File 694 PTZ File 695 PTK File 695 About Resources 695

Overview

This documentation covers PlanetPress Suite version 7.5. To view the documentation of previous versions please refer to the PDF files available in the Downloads section of our website:

http://www.objectiflune.com/OL/en-CA/Download/DownloadCenter.

Icons used in this guide

Some icons are used throughout this guide in order to catch your attention to certain particular information.

Notes: This icon shows you something thatcomplements the information around it. Understanding notes is not critical but may be helpful when using PlanetPress Design.

Warnings: This icon shows information that may be critical when using PlanetPress Design. It is importantto pay attention to these warnings.

Technical: This icon shows technical information that may require some technical knowledge to understand.