[Tool] Generate a report summary of markups SOLVED

[Mathew]

For markups in pdfs I don't know of a built-in tool to generate a simple text summary of the markups. This tool will generate a text report, summarized by any of the markup parameters. It can either output the text (contents property) of the markup, or count them (and for the dimension, perimeter, and area tools, or if it recognizes numbers or currency, add up the totals).

image(4).png

This tool is inspired by forum posts viewtopic.php?t=45812 and viewtopic.php?t=27327

Usage
If you only want to summarize select markups, first select the markups, and run the tool (Comments > Report Comments...)

image(2).png

It will open a dialog:

image.png

Markups to include
Select whether to use all markups, or only enter pages to get markup from. If you have markups selected when the tool is started, you can apply the tool to current selection.
Report Organization

• You can add or remove the summary levels. In the picture above, the summary will be first by page number, then by the strokeColor of the markup.

Action

• Sum values will add up areas, lengths, numbers, currency, or concatenate text.
  Count values will just count the number of areas, lengths, numbers, currency, or text annotations found.
  Output values will list each markup value.

image(1).png

Options The Options... button opens up a separate dialog to change settings for the report:

• Contents to Include in Report: It can skip Blank, Text-only or Currency values in the report
  If numbers are interspersed inside text, it can find the numbers and add them up; or it can treat this comment as text.
  Use Color Names: If checked, it tries to get a plain-text description of the color (ie "Orange"). Otherwise it will output the color in hexadecimal (web) format.
  You can also adjust the amount each level of the summary indents, and the relative text size. I think this is a multiplier on 11pt text.
  Decimal and Thousands separators: If your locale uses different separators, change them here. The script needs to change the text of the dimensions to a number, so if these are wrong, it won't know that 1.000 = 1000 not 1 for instance.
  Accounting/Currency Format: There are some predefined accounting and currency formats in the drop down list at the top left; or change the RegExp, RE group and prinf options:
  • RegExp is a regular expression that has the numerical portion of the currency in capture groups. It's set up as (negative numbers) | (positive numbers)
  • -,+ RE group is the capture group for negative,positive in the regular expression
  • -,+ printf is the formatting string to output the result in the report. Its set up as "negative formatting string","positive formatting string" and uses util.printf to format the number (there's information about the parameters in a pop-up alert if you press the button i on the right).
  It's probably easiest to pick one of the predefined formats and then modify the regular expression and formatting string for your use (ie for different currencies, etc).

Installation
Extract (unzip) the zip file and save the files into the JavaScript folder (either in %APPDATA%\Tracker Software\PDFXEditor\3.0\JavaScripts or in the application folder). After restarting PDF XChange it will add a menu item "Report Comments…" to the Comment ribbon and to the Comment menu (in the classic UI)

image(3).png

If you want to minimize the number of files: At an absolute minimum, you need "annotReport.js". "1ang.js" enables translation files, and "xutil.colorUtils.js" enables the text version of colors.

annotReport v1.1.zip

Translations
This tool can be translated into other languages. Here's the language file (the tool at viewtopic.php?p=186101#p186101 will help editing it)

translationData.annotReport.json.zip

[Daniel - PDF-XChange]

[PHK]

As a Java neophyte, I am having a problem getting the tool operative.

I have downloaded and saved the zipped files as instructed but when I try to open the main file, I get this:

image.png

Advice?

[Mathew]

Don’t open the file inside the .zip file. Copy it to the JavaScripts folder. You may need to create it. See the instructions at the end of the first post

[PHK]

Right! I got it working and it looks great. From this the user can use the Accounting Calculator (cutting and pasting) to sum up the data. Again, thank you, Mathew!

[Daniel - PDF-XChange]

[PHK]

Right! I got it working and it looks great. From this the user can use the Accounting Calculator (cutting and pasting) to sum up the data. Again, thank you, Mathew!
[/quote/]

...or perhaps even better yet, convert to an spreadsheet (Excel or other) format and use the Sum function to calculate.

[Mathew]

Right! I got it working and it looks great. From this the user can use the Accounting Calculator (cutting and pasting) to sum up the data. Again, thank you, Mathew!

I’m thinking the tool should be able to do the summing and eliminate the second step. Let me stew on this a bit: there should be a way to recognize currency as well as just plain numbers in the content. What else?

[PHK]

...
I’m thinking the tool should be able to do the summing and eliminate the second step. Let me stew on this a bit: there should be a way to recognize currency as well as just plain numbers in the content. What else?

Gosh, man, that's a bit ambitious! There are so many possible input variables, I would be amazed if you could produce something with the flexablility to do that. I find that even dumping the output into an Excel file requires a fair amount of fine-tuning depending on the nature of the content. For instance, summing linear feet (of OP's original example) will be a great deal different from summing square footage or, heaven forbid, currency amounts. Fortunately, that is doable with Excel formulae.

[Mathew]

I made a new version with quite a few changes. I won't update the first post yet, just in case there are problems with this -- I've not had time to test it much. It now has a lot of options, so I moved them to a separate dialog:

image.png

Briefly:

• You can pick whether to include blank, text or currency in sums, and whether any text inside a comment disqualifies it as a number. "Summing" text just makes a long string of all the text items.
• For Accounting/Currency format, there's a dropdown menu at the left with some presets that will load into the three settings. Easiest is to find one that's closest to what you use, and modify the regular expression. The currency is found in text using the regular expression shown, with two matching groups, one for negative numbers | another for positive numbers. RE group is the index on the array returned by RegExp.exec(). When the total is output, it uses util.printf() and the format strings for negative,positive numbers is in the lower right corner.

annotReport v1.0.zip

changes since v0.1

• add a separate dialog for settings;
• separate sum, count and output actions;
• sum currency & numbers;
• enter page numbers to include in report;
• sort properties list alphabetically;
• separate sums by length, area, number, text, blank;
• add newline when combining text;
• get text from richContents if there is any;
• option whether to include blank, text, currency contents in sums;
• get multiple numbers or currency inside a single comment;
• user editable regex for currency and some presets

[Daniel - PDF-XChange]

Hello, Mathew

Thank you once again for a hard work you put into these areas. It is muchly appreciated!

Kind regards,

[Mathew]

Another update v1.1 here -- I'll also update the first post.

Changes since v1.0

• fix missing domain for string "points";
• add preview & check of currency;
• fix bugs with comma decimal point;
• add info dialog for printf options

annotReport v1.1.zip

The translation strings also changed.

translationData.annotReport.json.zip

[Stefan - PDF-XChange]