Skip to content

Commit 88d2e9c

Browse files
bdoubrovbdoubrov
authored
Merge pull request #62 from veraPDF/rel1.28
REL 1.28 - Update documentation
2 parents d55151c + c664ccb commit 88d2e9c

9 files changed

Lines changed: 48 additions & 42 deletions

File tree

‎_config.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ gems:
33
# Google services
44
vera_google_analytics: UA-64476051-2
55
preforma_google_analytics: UA-25697327-3
6-
verapdf_version_number: 1.26.1
6+
verapdf_version_number: 1.28.1

‎cli/config/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The default validation config file contains:
9999
### <a name="validatorConfig"></a> The validatorConfig element
100100
The `validatorConfig` element defines the following attributes:
101101

102-
- `flavour` the default flavour to use when none is specified by the user, can be PDF_A_1A, PDF_A_1B, PDF_A_2A, PDF_A_2B, PDF_A_2U, PDF_A_3A, PDF_A_3B, PDF_A_3U, PDF_A_4, PDF_A_4E, PDF_A_4F, PDF_UA1, PDF_UA2 or NO_FLAVOUR (for automatic detection).
102+
- `flavour` the default flavour to use when none is specified by the user, can be PDF_A_1A, PDF_A_1B, PDF_A_2A, PDF_A_2B, PDF_A_2U, PDF_A_3A, PDF_A_3B, PDF_A_3U, PDF_A_4, PDF_A_4E, PDF_A_4F, PDF_UA1, PDF_UA2, WTPDF_1_0_ACCESSIBILITY, WTPDF_1_0_REUSE or NO_FLAVOUR (for automatic detection).
103103
- `recordPasses` set `true` to report passed validation checks, `false` to report failures only.
104104
- `maxFails` specifies the maximum number of failed checks before validation is terminated, the default value of -1 means report all failures.
105105
- `maxNumberOfDisplayedFailedChecks` specifies how many failed tests are reported per validation rule.

‎cli/help/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Usage: veraPDF [options] FILES
2626
flavour will be applied if automatic flavour detection based on a file`s
2727
metadata doesn`t work.
2828
Default: 1b
29-
Possible Values: [1a, 1b, 2a, 2b, 2u, 3a, 3b, 3u, 4, 4f, 4e, ua1, ua2]
29+
Possible Values: [1a, 1b, 2a, 2b, 2u, 3a, 3b, 3u, 4, 4f, 4e, ua1, ua2, wt1r, wt1a]
3030
--disableerrormessages
3131
Disable detailed error messages in the validation report.
3232
Default: false
@@ -41,7 +41,7 @@ Usage: veraPDF [options] FILES
4141
supply '0' or no argument for automatic flavour detection based on a
4242
file`s metadata.
4343
Default: 0
44-
Possible Values: [0, 1a, 1b, 2a, 2b, 2u, 3a, 3b, 3u, 4, 4f, 4e, ua1, ua2]
44+
Possible Values: [0, 1a, 1b, 2a, 2b, 2u, 3a, 3b, 3u, 4, 4f, 4e, ua1, ua2, wt1r, wt1a]
4545
--format
4646
Chooses output format.
4747
Default: xml

‎cli/validation/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ veraPDF supported PDF/A and PDF/UA profiles:
2727
4f - PDF/A-4F validation profile
2828
ua1 - PDF/UA-1 validation profile
2929
ua2 - PDF/UA-2 validation profile
30+
wt1r - WTPDF 1.0 Reuse validation profile
31+
wt1a - WTPDF 1.0 Accessibility validation profile
3032
```
3133

3234
### <a name="choose-profile"></a>Choosing a built-in profile

‎develop/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To include veraPDF's greenfield parser and validation model add:
4444
<dependency>
4545
<groupId>org.verapdf</groupId>
4646
<artifactId>validation-model</artifactId>
47-
<version>1.26.1</version>
47+
<version>1.28.1</version>
4848
</dependency>
4949
```
5050

@@ -57,7 +57,7 @@ This can be included in your project with this Maven dependency:
5757
<dependency>
5858
<groupId>org.verapdf</groupId>
5959
<artifactId>pdfbox-validation-model</artifactId>
60-
<version>1.26.1</version>
60+
<version>1.28.1</version>
6161
</dependency>
6262
```
6363

@@ -68,7 +68,7 @@ Both implementations above depend on javax. If your project uses jakarta, you sh
6868
<dependency>
6969
<groupId>org.verapdf</groupId>
7070
<artifactId>validation-model-jakarta</artifactId>
71-
<version>1.26.1</version>
71+
<version>1.28.1</version>
7272
</dependency>
7373
```
7474

@@ -78,7 +78,7 @@ for Greenfield implementation and
7878
<dependency>
7979
<groupId>org.verapdf</groupId>
8080
<artifactId>pdfbox-validation-model-jakarta</artifactId>
81-
<version>1.26.1</version>
81+
<version>1.28.1</version>
8282
</dependency>
8383
```
8484

‎gui/index.md‎

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -41,23 +41,25 @@ The Choose Profile button and the dropdown immediately below it determine the va
4141

4242
The options are as follows:
4343

44-
| Option | Description |
45-
|----------------|---------------------------------------------------------------------------------------------------------------------|
46-
| Auto-detect | The veraPDF software will detect the PDF/A or PDF/UA flavour when parsing the file and use the appropriate profile. |
47-
| PDF/A-1a | Use the PDF/A-1a validation profile, i.e. assume that the file is a PDF/A-1a. |
48-
| PDF/A-1b | Use the PDF/A-1b validation profile, i.e. assume that the file is a PDF/A-1b. |
49-
| PDF/A-2a | Use the PDF/A-2a validation profile, i.e. assume that the file is a PDF/A-2a. |
50-
| PDF/A-2b | Use the PDF/A-2b validation profile, i.e. assume that the file is a PDF/A-2b. |
51-
| PDF/A-2u | Use the PDF/A-2u validation profile, i.e. assume that the file is a PDF/A-2u. |
52-
| PDF/A-3a | Use the PDF/A-3a validation profile, i.e. assume that the file is a PDF/A-3a. |
53-
| PDF/A-3b | Use the PDF/A-3b validation profile, i.e. assume that the file is a PDF/A-3b. |
54-
| PDF/A-3u | Use the PDF/A-3u validation profile, i.e. assume that the file is a PDF/A-3u. |
55-
| PDF/A-4 | Use the PDF/A-4 validation profile, i.e. assume that the file is a PDF/A-4. |
56-
| PDF/A-4e | Use the PDF/A-4e validation profile, i.e. assume that the file is a PDF/A-4e. |
57-
| PDF/A-4f | Use the PDF/A-4f validation profile, i.e. assume that the file is a PDF/A-4f. |
58-
| PDF/UA-1 | Use the PDF/UA-1 validation profile, i.e. assume that the file is a PDF/UA-1. |
59-
| PDF/UA-2 | Use the PDF/UA-2 validation profile, i.e. assume that the file is a PDF/UA-2. |
60-
| Custom Profile | Enables the Choose Profile button allowing the user to load an external validation profile. |
44+
| Option | Description |
45+
|-------------------------|---------------------------------------------------------------------------------------------------------------------|
46+
| Auto-detect | The veraPDF software will detect the PDF/A or PDF/UA flavour when parsing the file and use the appropriate profile. |
47+
| PDF/A-1a | Use the PDF/A-1a validation profile, i.e. assume that the file is a PDF/A-1a. |
48+
| PDF/A-1b | Use the PDF/A-1b validation profile, i.e. assume that the file is a PDF/A-1b. |
49+
| PDF/A-2a | Use the PDF/A-2a validation profile, i.e. assume that the file is a PDF/A-2a. |
50+
| PDF/A-2b | Use the PDF/A-2b validation profile, i.e. assume that the file is a PDF/A-2b. |
51+
| PDF/A-2u | Use the PDF/A-2u validation profile, i.e. assume that the file is a PDF/A-2u. |
52+
| PDF/A-3a | Use the PDF/A-3a validation profile, i.e. assume that the file is a PDF/A-3a. |
53+
| PDF/A-3b | Use the PDF/A-3b validation profile, i.e. assume that the file is a PDF/A-3b. |
54+
| PDF/A-3u | Use the PDF/A-3u validation profile, i.e. assume that the file is a PDF/A-3u. |
55+
| PDF/A-4 | Use the PDF/A-4 validation profile, i.e. assume that the file is a PDF/A-4. |
56+
| PDF/A-4e | Use the PDF/A-4e validation profile, i.e. assume that the file is a PDF/A-4e. |
57+
| PDF/A-4f | Use the PDF/A-4f validation profile, i.e. assume that the file is a PDF/A-4f. |
58+
| PDF/UA-1 | Use the PDF/UA-1 validation profile, i.e. assume that the file is a PDF/UA-1. |
59+
| PDF/UA-2 | Use the PDF/UA-2 validation profile, i.e. assume that the file is a PDF/UA-2. |
60+
| WTPDF 1.0 Accessibility | Use the WTPDF 1.0 Accessibility validation profile, i.e. assume that the file is a WTPDF 1.0 Accessibility. |
61+
| WTPDF 1.0 Reuse | Use the WTPDF 1.0 Reuse validation profile, i.e. assume that the file is a WTPDF 1.0 Reuse. |
62+
| Custom Profile | Enables the Choose Profile button allowing the user to load an external validation profile. |
6163
{:.table .table-striped .table-bordered}
6264

6365
### <a name="report-drop"></a>Report Type dropdown, Choose Policy button, and Fix Metadata checkbox
@@ -108,18 +110,18 @@ The additional `Settings` dialog allows the user to configure the advanced setti
108110

109111
The advanced settings are described in the table below:
110112

111-
| Setting | Description |
112-
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
113-
| Include passed rules | If checked, the passed validation rules are included into the resulting Validation Report in addition to the failed rules. This setting is unchecked by default to reduce the size of the resulting Report. |
114-
| Add logs to xml and html reports | Specifies, if the logs generated during processing will be added into the Report. |
115-
| Add detailed errors to report | If checked, the detailed error message for every failed rule will be shown in the resulting Validation Report. |
116-
| Halt validation after failed checks | Specifies the maximum number of failed checks to be performed for all rules in the Validation Profile. Validation is halted once the number of failed checks is reached in order to speed up validation. |
117-
| Display failed checks for rule | Specifies the maximum number of failed checks to be reported for each rule from the Validation Profile. The specified value is used as the limit for the number of failed checks that shall be included into the resulting Report to reduce the size of the Report. |
118-
| Save repaired files with prefix | Specifies the prefix that is added to the name of the original PDF document when saving it after automatic metadata fixing was performed. This setting is used only when `Fix metadata` option is enabled. |
119-
| Save repaired files into the folder | Specifies the output folder for saving the PDF Documents after automatic metadata fixing was performed. Again this setting is relevant only when `Fix metadata` option is enabled. |
120-
| Validation Profiles wiki root | Specifies the base URL of the veraPDF validation profiles wiki. This provides contextual information about validation issues. |
121-
| Default flavour | Specifies built-in Validation Profile default flavour, e.g. `1b`. This flavour will be applied if automatic flavour detection based on a file's metadata doesn't work. Possible Values: `[PDF/A-1A, PDF/A-1B, PDF/A-2A, PDF/A-2B, PDF/A-2U, PDF/A-3A, PDF/A-3B, PDF/A-3U, PDF/A-4, PDF/A-4F, PDF/A-4E, PDF/UA-1, PDF/UA-2].` |
122-
| Logging level | Enables logs with level: `OFF; SEVERE; WARNING, SEVERE (default); CONFIG, INFO, WARNING, SEVERE; ALL.` |
113+
| Setting | Description |
114+
|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
115+
| Include passed rules | If checked, the passed validation rules are included into the resulting Validation Report in addition to the failed rules. This setting is unchecked by default to reduce the size of the resulting Report. |
116+
| Add logs to xml and html reports | Specifies, if the logs generated during processing will be added into the Report. |
117+
| Add detailed errors to report | If checked, the detailed error message for every failed rule will be shown in the resulting Validation Report. |
118+
| Halt validation after failed checks | Specifies the maximum number of failed checks to be performed for all rules in the Validation Profile. Validation is halted once the number of failed checks is reached in order to speed up validation. |
119+
| Display failed checks for rule | Specifies the maximum number of failed checks to be reported for each rule from the Validation Profile. The specified value is used as the limit for the number of failed checks that shall be included into the resulting Report to reduce the size of the Report. |
120+
| Save repaired files with prefix | Specifies the prefix that is added to the name of the original PDF document when saving it after automatic metadata fixing was performed. This setting is used only when `Fix metadata` option is enabled. |
121+
| Save repaired files into the folder | Specifies the output folder for saving the PDF Documents after automatic metadata fixing was performed. Again this setting is relevant only when `Fix metadata` option is enabled. |
122+
| Validation Profiles wiki root | Specifies the base URL of the veraPDF validation profiles wiki. This provides contextual information about validation issues. |
123+
| Default flavour | Specifies built-in Validation Profile default flavour, e.g. `1b`. This flavour will be applied if automatic flavour detection based on a file's metadata doesn't work. Possible Values: `[PDF/A-1A, PDF/A-1B, PDF/A-2A, PDF/A-2B, PDF/A-2U, PDF/A-3A, PDF/A-3B, PDF/A-3U, PDF/A-4, PDF/A-4F, PDF/A-4E, PDF/UA-1, PDF/UA-2, WTPDF 1.0 Accessibility, WTPDF 1.0 Reuse].` |
124+
| Logging level | Enables logs with level: `OFF; SEVERE; WARNING, SEVERE (default); CONFIG, INFO, WARNING, SEVERE; ALL.` |
123125
{:.table .table-striped .table-bordered}
124126

125127
## Processing and Reporting

‎plugins/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Maven shade plugin.
113113
<dependency>
114114
<groupId>org.verapdf</groupId>
115115
<artifactId>core</artifactId>
116-
<version>[1.26.0,1.27.0)</version>
116+
<version>[1.28.0,1.29.0)</version>
117117
</dependency>
118118
</dependencies>
119119
<build>

‎policy/info-dict/report.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<report>
33
<buildInformation>
4-
<releaseDetails id="core" version="1.26.1" buildDate="2024-01-10T02:34:00Z"/>
5-
<releaseDetails id="gui" version="1.26.1" buildDate="2024-01-13T11:30:00Z"/>
6-
<releaseDetails id="validation-model" version="1.26.1" buildDate="2024-01-10T02:39:00Z"/>
4+
<releaseDetails id="core" version="1.28.1" buildDate="2024-01-10T02:34:00Z"/>
5+
<releaseDetails id="gui" version="1.28.1" buildDate="2024-01-13T11:30:00Z"/>
6+
<releaseDetails id="validation-model" version="1.28.1" buildDate="2024-01-10T02:39:00Z"/>
77
</buildInformation>
88
<jobs>
99
<job>

0 commit comments

Comments
 (0)