Document Index

<< Click to Display Table of Contents >>

Navigation:  Appendix > Macros >

Document Index


 

welcome.icon.pdftools Document Index

 


 

The Document Index macro inserts the index value of pages, which is the input/output order of the content in the context of a group of input/output content items.

 

The syntax for this macro is %[DocNumber] and a parameter is available for the specification of the minimum amount of digits used for numbering output. This value can be any positive integer from 1 to 12. If the parameter is not used then the output is numbered with the default settings, which uses the page number of source files as the output number.

 

The syntax for this macro when parameters are used is %[DocNumber:<Parameter>] - for example %[DocNumber:4] starts the numbering as "0001, 0002, 0003...".

 

Example

 

If the %[DocNumber:4] macro is used in the Filename text box when the Export PDF to Microsoft Excel Spreadsheet tool is used to convert multiple documents to MS Excel format, then the name of each output file will be its order (index value) in the input sequence, and each file name will contain four digits:

 

The first step is to specify the macro in the Filename text box of the Tool Actions Sequence:

 

document.index.example1

Figure 1. Export PDF to Microsoft Excel Spreadsheet Tool Actions Sequence, %[DocNumber:4] Macro Specified

 

The second step is to run the tool and add the desired files for conversion:

 

document.indew.example2

Figure 2. Choose Input Files Dialog Box, Files Added For Conversion

 

After the files are converted, the name of each output file is its order (index value) in the input sequence, and each file name will contain four digits, as specified in the macro entered during the first step of the process:

 

input.output

Figure 3. Output Files