ARTS PDF SPLIT PRO 2.0 User Manual

4.3 (6)

ARTS PDF

Split Pro™

Version 2.0

 

 

 

ARTS PDF Split Pro™ Guide

 

 

 

Contents

 

 

Contents

 

1.

INTRODUCTION ..............................................................................................

5

1.1. New to version 2.0 ....................................................................................

5

1.2.

Demo Limitations ......................................................................................

5

2.

SETUP

..........................................................................................................

6

2.1.

System Requirements................................................................................

6

2.2.

Installation...............................................................................................

6

2.3.

Activation.................................................................................................

7

2.4.

Registration..............................................................................................

8

2.5.

Uninstall ..................................................................................................

8

3.

SPLITTING METHODS ......................................................................................

9

3.1.

Split by Bookmarks ...................................................................................

9

3.2. Split by Control File ...................................................................................

9

3.3. Split by Control File - Full Path ...................................................................

10

3.4. Split by File Size ......................................................................................

10

3.5. Split into Single Pages ..............................................................................

11

3.6. Split by Coordinate File .............................................................................

11

4.

WATCHED FOLDERS.......................................................................................

12

5.

ARTS PDF SPLIT PRO™ ASSISTANT................................................................

13

5.1. What is a Coordinate File? .........................................................................

14

5.1.1.

Inside a Coordinate File.................................................................................

14

5.2.

Managing Coordinate Files .........................................................................

16

5.2.1.

Creating a New Coordinate File ......................................................................

16

5.2.2.

Activating the Rectangle Tool .........................................................................

16

5.2.3.

Editing a Coordinate File................................................................................

18

5.2.4.

Opening a Coordinate File..............................................................................

18

5.2.5.

Saving a Coordinate File................................................................................

19

5.2.6.

Closing a Coordinate File ...............................................................................

19

5.2.7.

Viewing Text ...............................................................................................

19

5.2.8.

Viewing Text Runs........................................................................................

20

5.2.9.

Viewing Commands ......................................................................................

21

6.

ARTS PDF SPLIT PRO™ GUI ........................................................................

23

6.1.

Splitting Methods .....................................................................................

23

6.1.1.

Split by Bookmarks ......................................................................................

23

6.1.2.

Split by Control File ......................................................................................

24

6.1.3.

Split by Control File – Full Path.......................................................................

24

6.1.4.

Split by Coordinate File .................................................................................

24

6.1.5.

Split by File Size ..........................................................................................

25

6.1.6.

Split into Single Pages ..................................................................................

25

6.2.

Watched Folders ......................................................................................

26

6.2.1.

Setting up a Watched Folder ..........................................................................

26

6.2.2.

Watched Folder Splitting Methods ...................................................................

27

 

 

 

| CONTENTS |

 

Page 2 of 58

 

 

 

ARTS PDF Split Pro™ Guide

 

 

 

Contents

6.3.

Options...................................................................................................

28

6.3.1.

Logging enabled...........................................................................................

29

6.3.2.

Silent Mode .................................................................................................

30

6.3.3.

Overwrite output file.....................................................................................

30

6.3.4.

Update navigational elements ........................................................................

30

6.3.5.

Output subfolders.........................................................................................

31

7.

ARTS PDF SPLIT PRO™ CL...........................................................................

32

7.1.

Splitting Methods .....................................................................................

32

7.1.1.

Split by Bookmarks ......................................................................................

32

7.1.2.

Split by Control File ......................................................................................

32

7.1.3.

Split by Coordinate File .................................................................................

32

7.1.4.

Split into Single Pages ..................................................................................

33

7.1.5.

Split by Page Range.....................................................................................

33

7.2.

Parsing Methods.......................................................................................

33

7.2.1.

Parse a page ...............................................................................................

33

7.2.2.

Parse a page range.......................................................................................

33

7.3.

Watched Folders ......................................................................................

34

7.3.1.

Watched Folder Splitting Methods ...................................................................

34

7.4.

Options...................................................................................................

34

7.4.1.

Overwrite....................................................................................................

34

7.4.2.

Update navigational elements ........................................................................

35

7.4.3.

Run in the background..................................................................................

35

8.

ARTS PDF SPLIT PRO™ COM........................................................................

36

8.1. Registering the COM object........................................................................

36

8.2.

Class Strings/Namespaces.........................................................................

37

8.2.1.

Visual Basic.................................................................................................

37

8.2.2.

ASP............................................................................................................

37

8.2.3.

VB.NET.......................................................................................................

37

8.2.4.

C# .............................................................................................................

37

8.2.5.

Delphi ........................................................................................................

38

8.2.6.

PHP............................................................................................................

38

8.3. Permissions for Web Applications................................................................

38

8.3.1.

ASP............................................................................................................

38

8.3.2.

ASP.NET .....................................................................................................

38

8.4.

Object ARTSSplitPro .................................................................................

39

8.4.1.

GetErrorMessage..........................................................................................

39

8.4.2.

GetVersionNumber .......................................................................................

39

8.4.3.

SetLicenceKey .............................................................................................

39

8.4.4.

SetOverwriteMode........................................................................................

40

8.4.5.

SetUpdateMode ...........................................................................................

40

8.4.6.

SplitByBookmarks ........................................................................................

40

8.4.7.

SplitByControlFile.........................................................................................

41

8.4.8.

SplitByCoordFile...........................................................................................

41

8.4.9.

SplitByFileSize .............................................................................................

41

8.4.10.

SplitIntoSinglePages.....................................................................................

42

8.5.

COM Examples.........................................................................................

43

8.5.1.

Visual Basic.................................................................................................

43

 

 

 

| CONTENTS |

 

Page 3 of 58

ARTS PDF Split Pro™ Guide

Contents

 

8.5.2.

ASP............................................................................................................

44

9.

APPENDIX A – RECTANGLE COMMANDS.............................................................

46

10.

APPENDIX B – COMMAND LINE SWITCHES ........................................................

51

11.

TROUBLESHOOTING.......................................................................................

55

11.1.

Frequently Asked Questions....................................................................

55

11.2.

Forum .................................................................................................

56

11.3.

Updates ...............................................................................................

56

11.4.

Maintenance.........................................................................................

57

11.5.

Technical Support .................................................................................

58

| CONTENTS |

Page 4 of 58

ARTS PDF Split Pro™ Guide

Introduction

1. Introduction

ARTS PDF Split Pro™ is an industrial grade, stand-alone PDF splitter that allows you to split large PDF files into smaller PDF files, in many different ways. The available splitting methods include:

-Split by Bookmarks

-Split by Control File

-Split by Control File – full path

-Split by File Size

-Split into Single Pages

-Split by Coordinate File

ARTS PDF Split Pro™ is made up of four components:

with the first being ARTS PDF Split Pro™ Graphical User Interface (GUI) which performs the actual file splitting;

the ARTS PDF Split Pro™ Assistant is used to create coordinate files and gives the user the power to perform advanced splitting operations;

the ARTS PDF Split Pro™ Command Line Interface (CLI or CL) allows splitting to be utilized from the command-line;

and lastly ARTS PDF Split Pro™ COM Object (COM) enables developers to create customized applications to accommodate PDF splitting in their workflow.

Server based usage is supported by ARTS PDF Split Pro™. The watched folder function allows users on a network to drop PDF files into a directory, and then use ARTS PDF Split Pro’s engine to perform the file splitting.

1.1. New to version 2.0

ARTS PDF Split Pro™ version 2.0 includes:

support for Unicode documents.

retains bookmarks and links in output files.

1.2.Demo Limitations

An ‘ARTS PDF Split Pro’ watermark will appear on each page of every output file when using the ARTS PDF Split Pro™ demo version.

Note: No limitations are present in the full retail version. See section 2.3 of this document, Activation, for information on how to activate the full version.

| CONTENTS |

Page 5 of 58

ARTS PDF Split Pro™ Guide

Setup

2. Setup

2.1. System Requirements

Windows

Intel® Pentium® processor or equivalent

Microsoft® Windows NT® Workstation 4.0 with Service Pack 6, Windows® 2000 with Service Pack 2, Windows XP Professional or Home Edition, or Windows XP Tablet PC Edition

64MB of RAM (128MB recommended)

50MB of available hard-disk space

1,024x768 screen resolution

Note: ARTS PDF Split Pro™ Assistant requires Adobe® Acrobat® 5.0 or later.

For technical support queries, please consult the Troubleshooting section of this manual or visit our website at http://www.artspdf.com/support.asp.

2.2. Installation

You may have received this software on either CD-ROM or as a downloaded file.

Windows (CD-ROM)

To install from a CD-ROM:

1.Verify that Adobe Acrobat is not running.

2.Insert the CD-ROM.

3.If the CD-ROM does not automatically start, navigate to the CD in Windows Explorer and execute the Windows Installer.exe file.

4.Navigate to ARTS PDF Split Pro™.

5.Click Install.

6.Follow the prompts to install ARTS PDF Split Pro™.

Windows (.exe)

If you downloaded ARTS PDF Split Pro™, to install:

1.Verify that Adobe Acrobat is not running.

2.Execute the installation file provided.

3.Follow the prompts to install ARTS PDF Split Pro™.

| CONTENTS |

Page 6 of 58

ARTS PDF Split Pro™ Guide

Setup

2.3. Activation

If you have the demo version of ARTS PDF Split Pro™ installed, you can activate the full version using the following steps:

1.Open ARTS PDF Split Pro by going to ‘Start > Programs > ARTS PDF > ARTS PDF Split Pro > ARTS PDF Split Pro 2.0’.

2.Click the ‘About’ button.

3.Ensure you have a valid serial. A valid serial can only be obtained by purchasing the product. To purchase ARTS PDF Split Pro™:

a.Select the ‘Register’ tab page and click on ‘Buy Now’ to purchase the full version.

b.After your purchase has been confirmed, you will receive an email containing your serial number.

4.Select the ‘Register’ tab page and click on ‘Activate’.

5.Enter your license details, including your serial number, and click “OK”.

Alternatively you can do the following to activate the full version using ARTS PDF Split Pro™ Assistant:

1.In Acrobat select ‘Help > About 3rd Party Plug-Ins > ARTS PDF Split Pro Assistant’.

2.Ensure you have a valid serial. A valid serial can only be obtained by purchasing the product. To purchase ARTS PDF Split Pro™:

a.Select the ‘Register’ tab page and click on ‘Buy Now’ to purchase the full version.

b.After your purchase has been confirmed, you will receive an email containing your serial number.

3.Select the ‘Register’ tab page and click on ‘Activate’.

4.Enter your license details, including your serial number, and click “OK”.

| CONTENTS |

Page 7 of 58

ARTS PDF Split Pro™ Guide

Setup

2.4. Registration

ARTS PDF provide the option of registering your copy of ARTS PDF Split Pro™ online. Online registration allows you to protect your serial number. In the event you lose or misplace your serial, we can locate and provide your serial to you on request.

Registered customers will also receive important upgrade information and notification of product updates.

1.After activating your copy of ARTS PDF Split Pro™ you will be prompted to register online. Do one of the following:

Click “Now” to register your product online1.

Click “Later” to register at a later stage. After entering your license details, you can register your product anytime by clicking on the “Register Now” button of the Register tab.

2.When registering your product, complete the online form and click “Submit Registration”.

3.You only need register your product with us once.

To manually register your ARTS PDF product, please visit our online registration page, http://www.artspdf.com/register.asp.

2.5. Uninstall

Windows

To uninstall on a Windows platform:

1.Verify that Adobe Acrobat is not running.

2.Click Start > Settings > Control Panel.

3.Open Add/Remove Programs.

4.Select ‘ARTS PDF Split Pro 2.0’ from the menu.

5.Click ‘Add/Remove’.

1 You must be connected to the Internet.

| CONTENTS |

Page 8 of 58

ARTS PDF Split Pro™ Guide

Splitting Methods

3. Splitting Methods

ARTS PDF Split Pro™ can split PDFs into smaller PDF files (or fragments) using a number of different methods. ARTS PDF Split Pro™ can split PDFs by bookmarks, by control file2 , by file size, into single pages and by coordinate file. These splitting methods are explained in detail below.

3.1. Split by Bookmarks

This method will split a PDF file by its bookmarks. Each page that is bookmarked will be the start of a new fragment, and the title of the bookmark will be used as the name of the file.

All subsequent pages are added to that fragment, stopping at the next bookmarked page. You will be given a chance to choose the level of bookmarks to use. Top-level bookmarks are level 1.

You can Split By Bookmarks using either of the following ARTS PDF Split Pro™ components:

GUI

CLI

COM

3.2.Split by Control File

This method will split a PDF file as specified in a pre-defined control file. A control file is a text file that specifies which pages will be split from the document, and the names of each PDF file that will be split from the document.

An example of this is:

12 introduction.pdf

23-29 chapter3.pdf

80 conclusion.pdf

Using the above control file page 12 will be split and named introduction.pdf, pages 23 to 29 will be split and named chapter3.pdf and page 80 will be named conclusion.pdf. An error will occur if the page number specified is out of range. To avoid such errors, put ARTS PDF Split Pro™ in silent mode.

2 With control files you also have the option to specify full pathnames.

| CONTENTS |

Page 9 of 58

ARTS PDF Split Pro™ Guide

Splitting Methods

You can Split By Control File (not full path) using either of the following ARTS PDF Split Pro™ components:

GUI

CLI

COM

3.3.Split by Control File - Full Path

This method of splitting will split a PDF file as specified in a control file, with each output file (or fragment) being stored in the directory indicated by the full path in the control file. A control file with the full path is a text file that specifies which pages will be split from the document, and the storage location and name of the pdf file that will be split from the document.

An example of this is:

23,25,55 c:\splitpdf_files\project\introduction.pdf

23-30 c:\splitpdf_files\project\sports.pdf

81 c:\splitpdf_files\media\movies.pdf

Using the above example page 23, 25 and 55 will be split and named introduction.pdf and saved to “c:\splitpdf_files\project\”. Pages 23 to 30 will be split and named sports.pdf in the “c:\splitpdf_files\project\” directory whilst page 81 will be named conclusion.pdf and saved to the “c:\splitpdf_files\media” directory.

You can Split By Control File (full path) using either of the following ARTS PDF Split Pro™ components:

GUI

COM

3.4.Split by File Size

This method of splitting allows PDFs to be split based on a file size value (in kilobytes) specified by the user.

The way this works is that split pro will scan through your pdf document/s one page at a time, and check at the end of each page to see if the current fragment is equal to or greater than the specified file size.

| CONTENTS |

Page 10 of 58

ARTS PDF Split Pro™ Guide

Splitting Methods

If the fragment size is equal to or greater than the file size specified then at that point the PDF will be split. Otherwise ARTS PDF Split Pro™ will move onto the next page and perform the same check again.

You can Split By File Size using either of the following ARTS PDF Split Pro™ components:

GUI

COM

3.5.Split into Single Pages

This method of splitting will split a PDF file into fragments containing one page each in the destination folder specified by the user.

You can Split Into Single Pages using either of the following ARTS PDF Split Pro™ components:

GUI

CLI

3.6.Split by Coordinate File

This method of splitting will split a pdf file based on the text that is on each page. Coordinate files are used to perform intelligent splitting of PDF files based on page content. Coordinate files can be created using ARTS PDF Split Pro™ Assistant.

See ARTS PDF Split Pro™ Assistant for more detail.

You can Split By Coordinate using either of the following ARTS PDF Split Pro™ components:

GUI

CLI

COM

| CONTENTS |

Page 11 of 58

ARTS PDF Split Pro™ Guide

Watched Folders

4. Watched Folders

The watched folders function in ARTS PDF Split Pro™ GUI and CLI allows an automated splitting solution to be set-up and accessible from the desktop or across a network. By selecting to use Watched Folders, then specifying the folders where the files are stored during the splitting process; PDF/s can be dropped in the specified input folder, split (either into single pages, by coordinate file or control file) and moved to the specified output folder.

Making the input and output directories accessible across a network results in having a high-speed splitting solution available across a network.

The GUI Watched Folder feature allows you to perform the following splitting methods using watched folders:

split into single pages

split by control file

split by control file full path

split by coordinate file

The CLI Watched Folder feature allows you to perform following splitting methods using watched folders:

split into single pages

split by coordinate file

| CONTENTS |

Page 12 of 58

ARTS PDF Split Pro™ Guide

Assistant

5. ARTS PDF Split Pro™ Assistant

The ARTS PDF Split Pro™ Assistant is a plug-in for Adobe Acrobat that assists the user to create coordinate files of which are utilized when splitting with ARTS PDF Split Pro™. It has been designed to allow the user to create coordinate files quickly and easily without the need to directly create or edit coordinate (text) files. The ARTS PDF Split Pro™ Assistant can be accessed via the toolbar, or Plug-ins menu.

Figure 1. ARTS PDF Split Pro™ Assistant menu-item

Figure 2. ARTS PDF Split Pro™ Assistant menu-item

| CONTENTS |

Page 13 of 58

ARTS PDF Split Pro™ Guide

Assistant

5.1. What is a Coordinate File?

A coordinate file must be used when performing a ‘Split By Coordinate File’ split method. Coordinate files use a .crd file extension but they are plain text files that can be viewed or edited with any text editor. The contents of a coordinate file may contain a single line or multiple lines of commands. An example of a coordinate file is shown below:

splitontextchange 507.406555 56.816055 535.184265 24.408707 addtofilename 507.406555 56.816055 535.184265 24.408707 "pageno " providefilename 504.628784 67.001236 543.517578 21.630936

5.1.1.Inside a Coordinate File

A single line within a coordinate file starts with a rectangle command, followed by rectangle coordinates and a string parameter. The structure of a line within a coordinate file is as shown below:

rectangle command [space] left rectangle coordinate [space] top rectangle coordinate [space] bottom rectangle coordinate [space] right rectangle coordinate [space] “string“

An example of this is:

splitiftextcontainedinbox 70.093918 736.859451 141.122421 703.214371 "arts"

Where:

Rectangle Command = splitiftextcontainedinbox

Left coordinate = 70.093918

Top coordinate = 736.859451

Bottom coordinate = 141.122421

Right coordinate = 703.214371

String parameter = arts

Rectangle command

Each command line within the coordinate file has a rectangle command related to it, which indicates what is required when splitting a PDF file. Rectangle commands give the option to:

split a PDF file if the page contains specific text.

provide output filenames.

exclude or include pages from output files.

read text on a PDF file and export it to a text file.

A full list of available Rectangle Commands can be found in Appendix A of this document.

| CONTENTS |

Page 14 of 58

ARTS PDF Split Pro™ Guide

Assistant

Rectangle coordinates

Rectangle coordinates (left, top, bottom and right) are used to view the rectangle using ARTS PDF Split Pro™ Assistant. The rectangle is used to look at text on a PDF page for the splitting of PDFs. Text within a rectangle area can be compared against the specified string parameter passed.

Example:

splitiftextcontainedinbox 70.093918 736.859451 141.122421 703.214371 "arts"

The coordinates, 70.093918 736.859451 141.122421 703.214371, form a rectangle. The rectangle area is viewable on a PDF page using ARTS PDF Split Pro™ Assistant. A rectangle can be viewed on each page of the PDF document. Depending on where the text run begins on the page, this rectangle may have text inside it. Using the splitIfTextContainedInBox command, if ARTS PDF Split Pro™ finds that the “arts” string is found inside the rectangle area then the PDF will split at that page i.e. PDF will split if the word “arts” is found within the text inside the rectangle.

String parameter

When creating coordinate files, particular rectangle commands may require a user specified text string to be entered in order to split PDFs the way the particular command is expected to. There is a text box in the rectangle tool properties window named ‘Parameters for command’ where these text strings can be entered.

An example for a parameter is when utilizing the ‘split if text contained in box’ command when creating a coordinate file. This command checks if the parameter specified by the user within the parameter text box is present within the related ARTS PDF Split Pro™ rectangle in the PDF file. If this string is present, then the file is split.

Commands that do not require a specified text string are:

SplitOnTextChange

SkipHeader

provideFilename

provideFilenameFromFirstWord

addToFilenameTextInBox

excludeIfNoTextContainedInBox

extractText

Note: Version 2 users will find that coordinate files created by ARTS PDF Split Pro™

Assistant have numeric values instead of a text string as the last parameter. This is to support Unicode. Version 2 is backwards compatible and can still support string parameters if coordinate files have been created or edited manually.

| CONTENTS |

Page 15 of 58

ARTS PDF Split Pro™ Guide

Assistant

5.2. Managing Coordinate Files

5.2.1.Creating a New Coordinate File

To create a coordinate file:

1.Open a PDF document in Adobe Acrobat.

2.Click the 'Create a new CRD file' button on the ARTS PDF Split Pro™ Assistant toolbar. You can alternatively go to 'Plug-ins > ARTS PDF Split Pro Assistant > New' in the Adobe Acrobat plug-ins menu.

The ‘Rectangle Tool’ button is now automatically activated enabling you to draw a rectangle on your PDF page.

3.With the ‘Rectangle Tool’ button activated, drag a box over the area on the page that contains the text you wish to apply a command to.

4.The 'Rectangle Tool Properties' window will now appear. Select the command you wish to use for the rectangle and enter any parameters required. A full list of available Rectangle Commands can be found in Appendix A of this document.

5.Click ‘OK’. This command is now set to the rectangle currently selected.

6.Repeat steps 3 to 5 for every command you wish to add to the coordinate file.

7.Save the coordinate file.

Figure 3. ‘Create a new CRD file’ toolbar button

Note: There is no limit to the number of rectangle commands within a coordinate file. If you wish to apply several commands to the same text on a page you can do so by creating another rectangle over the top of the existing one.

5.2.2.Activating the Rectangle Tool

ARTS PDF Split Pro™ allows the user to split PDF files based on the text that appears on the pages throughout a PDF document. The rectangle tool is used to select which text on the page will be used for splitting the file.

Figure 4. ‘Activate Rectangle Tool’ toolbar button

To activate or deactivate the rectangle tool, do one of the following:

Select ‘Activate Rectangle Tool’ from the ARTS PDF Split Pro™ Assistant menuitem,

Click on the ‘Activate the Rectangle Tool’ button located in the ARTS PDF Split Pro™ Assistant toolbar.

| CONTENTS |

Page 16 of 58

ARTS PDF SPLIT PRO 2.0 User Manual

ARTS PDF Split Pro™ Guide

Assistant

The rectangle tool will open the Rectangle Tool Properties window allowing you to:

Create a new command

Edit an existing command

Figure 5. ‘Rectangle Tool Properties’ dialog

Rectangle Command

The default command is ‘noop’ which means there is no active command selected for this rectangle. Select the command you wish to use for the rectangle you just created on your page.

A full list of available Rectangle Commands can be found in the Appendix A of this document.

Parameters

Enter any parameter that is required for your command in the ‘parameters for command‘ text box. This is where you enter the text when you wish to see if a particular/literal string is present on the page.

Rectangle Position and Page Rotation

Displays the rectangle coordinates for size and position on the page. If the page is rotated the text cannot be extracted by ARTS PDF Split Pro™ Assistant but ARTS PDF Split Pro™ will function as normal.

Text found inside rectangle

Displays the text that the rectangle reads off the current PDF page.

| CONTENTS |

Page 17 of 58

ARTS PDF Split Pro™ Guide

Assistant

5.2.3.Editing a Coordinate File

To edit a rectangle command or string parameter:

1.Open a PDF document in Adobe Acrobat.

2.Open a coordinate file to edit if one is not yet open.

3.Open the ‘Rectangle Tool Properties’ dialog by doing one of the following:

Activate the Rectangle Tool and then double click on the rectangle you wish to edit.

Open the View Commands dialog, select the command you wish to modify and click ‘Edit’.

4.Select the new rectangle command you wish to use and/or modify any parameters required.

5.Click ‘OK’.

6.Save the coordinate file.

To edit the size of a rectangle box (or rectangle coordinates):

1.Open a PDF document in Adobe Acrobat.

2.Open a coordinate file to edit if one is not yet open.

3.Activate the Rectangle Tool.

4.Click on a rectangle and move to the corner of the blue rectangle box until a double-headed arrow appears. Drag the box to the desired size.

5.Save the coordinate file.

To edit a the position of a rectangle box (or rectangle coordinates):

1.Open a PDF document in Adobe Acrobat.

2.Open a coordinate file to edit if one is not yet open.

3.Activate the Rectangle Tool.

4.Click on the rectangle and drag it to a different position.

5.Save the coordinate file.

5.2.4.Opening a Coordinate File

To open a coordinate file:

1.Open a PDF document in Adobe Acrobat.

2.Select ‘Open’ from the ARTS PDF Split Pro™ Assistant menu or click on the open button located on the ARTS PDF Split Pro™ Assistant toolbar.

3.Select the coordinate file (.crd) to open.

4.Click ‘Open’.

Figure 6. ‘Open’ toolbar button

| CONTENTS |

Page 18 of 58

Loading...
+ 40 hidden pages