Skip to content

Commit 4c7b968

Browse files
PVQ-3930 External Actions - Unite action names, subtypes, input and output
- uniting naming in config.json and README
1 parent 517abcd commit 4c7b968

2 files changed

Lines changed: 14 additions & 4 deletions

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# PDF Accessibility Validator using PDFix
2+
23
A Java CLI tool for validating the compliance of PDF documents with accessibility standards such as WCAG, or PDF/UA.
34

45
## Introduction
6+
57
This tool validates PDF accessibility by checking for issues in tagged PDF documents. It leverages the PDFix SDK (free version) for reading and processing PDF files. Ensuring that PDFs are accessible is crucial for users with disabilities, and this tool helps identify and report potential issues.
68

79
## Table of Contents
10+
811
- [PDF Accessibility Validator using PDFix](#pdf-accessibility-validator-using-pdfix)
912
- [Introduction](#introduction)
1013
- [Table of Contents](#table-of-contents)
@@ -20,6 +23,7 @@ This tool validates PDF accessibility by checking for issues in tagged PDF docum
2023

2124

2225
## Command-Line Options
26+
2327
```yml
2428
Usage:
2529
java -jar validate-pdf-{version}.jar [operation] [arguments]
@@ -35,6 +39,7 @@ Arguments:
3539
## Run the CLI Commands
3640
3741
### Report Duplicate MCID in Tagged PDF
42+
3843
This command validates a PDF file for duplicate MCID entries, which can cause accessibility issues for screen readers.
3944
4045
```bash
@@ -58,6 +63,7 @@ Total 1 duplicate MCID(s) found
5863
```
5964

6065
## Installation into PDFix Desktop
66+
6167
PDFix Desktop supports the integration of external actions into its user interface. Follow these steps to install the Validate Duplicate MCID action:
6268

6369
1. **Download** the net.pdfix.validate-pdf ZIP file from the [Releases page](https://github.com/pdfix/action-validate-pdf-pdfix-java/releases/latest)
@@ -73,6 +79,7 @@ PDFix Desktop supports the integration of external actions into its user interfa
7379
## Build Instructions
7480

7581
### 1. Download and Install PDFix SDK for Java
82+
7683
Before building the project, you need to download and install the PDFix SDK. This SDK is used to read and process PDF files for accessibility validation. Run the following commands:
7784

7885
```bash
@@ -83,14 +90,17 @@ mvn install:install-file -Dfile=lib/net.pdfix.pdfixlib-8.4.3.jar -DgroupId=net.p
8390
```
8491

8592
### 2. Compile, Test and Package
93+
8694
```bash
8795
mvn compile
8896
mvn test
8997
mvn package
9098
```
9199

92100
## License
101+
93102
This project is licensed under the [PDFix Free License](https://pdfix.net/terms/).
94103

95104
## Have a question? Need help?
96-
If you have any questions or need assistance, feel free to reach out to us via email at [support@pdfix.net](mailto:support@pdfix.net).
105+
106+
If you have any questions or need assistance, feel free to reach out to us via email at [support@pdfix.net](mailto:support@pdfix.net).

config.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
"version": "v0.0.0",
44
"actions": [
55
{
6-
"title": "Validate Duplicate MCID",
7-
"name": "pdfix_validate_duplicate_mcid",
8-
"desc": "Validates and reports duplicate MCID in the PDF content",
6+
"title": "Generate Duplicate MCID Report to TXT",
7+
"name": "pdfix_generate_duplicate_mcid_report_to_txt",
8+
"desc": "Validates and reports duplicate MCID in the PDF content.",
99
"icon": "validate_mcid",
1010
"version": "v0.0.0",
1111
"category": "Validation",

0 commit comments

Comments
 (0)