xPDFSearch

xPDFSearch is a content plugin for Total Commander.

Content

1. Plugin description
2. Field descriptions
3. System requirements
4. Use
5. Configuration
6. Author contact
7. License
8. History

1. Plugin description

xPDFSearch can be used to perform full text search in PDF files.
In addition xPDFSearch provides meta data information from PDF files.
It's possible to display title, subject, keywords, author, application, PDF producer, number of pages, PDF version, created and modified.

Plugin can be used in Synchronize Directories to compare content of PDF files.

2. Field descriptions

Title	The document title.
Subject	The document subject.
Keywords	Keywords describing the document.
Author	The document author.
Application	The application which has been used to create the document.
PDF Producer	The component which has been used to perform the conversion to PDF.
Document Start	The first approximately 1000 characters of the PDF document.
First Row	First row of the PDF document.
Extensions	List of declared PDF extensions, semicolon separated.
Number Of Pages	The number of pages of the document.
Number Of Fontless Pages	The number of pages without Font resource. It might indicate that page does not have text.
Number Of Pages With Images	The number of pages with Image XObjects. Does not detect inline images.
PDF Version	The PDF version of the document.
Page Width	The width of the first page.
Page Height	The height of the first page.
Copying Allowed	Indicates if copying text from the PDF document is allowed.
Printing Allowed	Indicates if it's allowed to print the PDF document.
Adding Comments Allowed	Indicates if adding comments to the PDF document is allowed.
Changing Allowed	Indicates if changing the PDF document is allowed.
Encrypted	Indicates if the PDF document is encrypted.
Protected	Indicates if the PDF document is protected and cannot be open without password.
Tagged	Indicates if the PDF document is tagged.
Linearized	Indicates if the first page of the PDF can be displayed without loading the whole file.
Incremental	Indicates if the PDF document has been modified by appending data.
Signature field	Indicates if the PDF document has Signature field set. This may indicate that the document is digitally signed.
Outlined	Indicates if the PDF document has Outlines (bookmarks).
Embedded Files	Indicates if the PDF document has embedded files in Catalog directory. It is not checked for files in pages annotations.
Created	The creation date of the document.
Modified	The date when the document has been modified.
Metadata Date	The XMP metadata date from http://ns.adobe.com/xap/1.0/ namespace.
ID	The PDF document ID
PDF Attributes	PDF indicators displayed as attributes P Printing allowed C Copying allowed M Changing (Modifying) allowed N Adding Comments (Notes) Allowed I Incremental T Tagged L Linearized E Encrypted X Protected S Signature O Outlines/Bookmarks F Embedded Files
Conformance	Indicates conformances of the document to the PDF/A, PDF/E PDF/X, PDF/UA or PDF/R standards. Multiple conformances are semicolon separated, e.g. "PDF/A-1a;PDF/R-1.0".
Encryption	Indicates PDF encryption type.
Created Raw	The creation date of the document without conversion to FILETIME.
Modified Raw	The date when the document has been modified without conversion to FILETIME.
Metadata Date Raw	The XMP metadata date from http://ns.adobe.com/xap/1.0/ namespace without conversion to FILETIME.
Outlines	The Outlines (bookmarks) search is available in the search and compare functions of Total Commander.
Text	The fulltext search is available in the search and compare functions of Total Commander.

PDF 2.0 has deprecated usage of Document Info Directory. If PDF file does not have Document Info Directory, fields are read from PDF metadata:

Title	dc:title
Subject	dc:description
Keywords	pdf:Keywords
Author	dc:creator
Producer	pdf:Producer
Creator	xap:CreatorTool
Created	xap:CreateDate
Modified	xap:ModifyDate
Metadata Date	xap:MetadataDate

3. System requirements

Total Commander 6.50 or higher is required for this plugin.
To use the Created, Modified and Metadata Date fields Total Commander 6.53 or higher is required.

4. Use

Start a full text search

1. In menu click Commands/Search.
2. Now activate the tab "Plugins".
3. Select Plugin in the Plugin combobox. The other comboboxes Property (=Text) and OP (=contains) are already set to appropriate values for full text search.
4. Enter the search text in the value field.
5. Press start search button.

Of course it's possible to search for the other fields as well.

Search for all PDF documents containing the word bicycle

The other fields can be additionally used in files by file type, custom columns, tooltips, and thumbnail view.

Compare two or more files

1. Open "Synchronize Directories"
2. Click on a small >> button to activate "User-defined compare functions by file type"
3. Check "Use plugin compare functions"
4. Click Add... to add PDF file type
5. Specify *.pdf as file type and click OK
6. Select "xPDFSearch" plugin and one of its properties, e.g. "Compare Text"
7. Close dialogs with OK , OK , OK
8. Click Compare

Define xPDFSearch as compare plugin

5. Configuration

xPDFSearch plugin can be configured in xPDFSearch.ini file:

[xPDFSearch]
•  NoCache=0
   ◦  0=file caching disabled, fast reading of fields, unable to rename or alter attributes of the open PDF file
   ◦  1=disables file caching, slower reading of fields, allows renaming PDF file with values form xPDFSearch and changing PDF file attributes (not content of PDF file)
•  DiscardInvisibleText=1 discard all invisible characters
•  DiscardDiagonalText=1 discard all text that's not close to 0/90/180/270 degrees
•  DiscardClippedText=1 discard all clipped characters
•  MarginLeft=0 discard all characters left of mediaBox + marginLeft
•  MarginRight=0 discard all characters right of mediaBox - marginRight
•  MarginTop=0 discard all characters above of mediaBox - marginTop
•  MarginBottom=0 discard all characters bellow of mediaBox + marginBottom
•  PageContentsLengthMin=32 Minimal value of page stream length so page is not considered empty. Used Used for "Number of Fontless pages"  and "Number of pages with images" fields.
•  TextOutputMode=0 text formatting mode:
   ◦  0=reading order
   ◦  1=original physical layout
   ◦  2=simple one-column
   ◦  3=simple one-column2
   ◦  4=optimized for tables
   ◦  5=fixed-pitch/height layout
   ◦  6=keep text in content stream order
•  AppendExtensionLevel=0 append PDF Extension Level to PDF Version (PDF 1.7 Ext. Level 3 = 1.73)
•  RemoveDateRawDColon=0 remove D: from CreatedRaw and ModifiedRaw fields
•  AttrPrintingAllowed=P symbol for "Printing Allowed" attribute
•  AttrCopyingAllowed=C symbol for "Copying Allowed" attribute
•  AttrChangingAllowed=M symbol for "Changing Allowed" attribute
•  AttrAddingCommentsAllowed=N symbol for "Adding Comments Allowed" attribute
•  AttrIncremental=I symbol for "Incremental" attribute
•  AttrTagged=T symbol for "Tagged" attribute
•  AttrLinearized=L symbol for "Linearized" attribute
•  AttrEncrypted=E symbol for "Encrypted" attribute
•  AttrProtected=X symbol for "Protected" attribute
•  AttrSignatureField=S symbol for "Signature Field" attribute
•  AttrOutlined=O symbol for "Outlined" attribute
•  AttrEmbeddedFiles=F symbol for "Embedded Files" attribute

To omit specific PDF Attribute field, clear attribute symbol, e.g. AttrEmbeddedFiles=

If there is no xPDFSearch.ini file located in plugin directory, plugin uses options from TC content ini file.
Default location of TC content ini file is %COMMANDER_PATH%\contplug.ini .
Location of the [xPDFSearch] section in TC content ini file can be changed in wincmd.ini file, e.g.:

[ReplaceIniLocation]
•  xPDFSearch.wdx=%COMMANDER_PATH%\Plugins\WDX\xPDFSearch\relocated.ini

xPDFSearch plugin uses slightly modified Xpdf library. Xpdf can be configured via xpdfrc file.

6. Author contact

There is a thread in the Total Commander forum which can be used to discuss problems, bugs and suggestions.

7. License

This Total Commander Plugin is licensed under the General Public License (GPL). The license can be found in the LICENSE.md.