Skip to content

Commit 5c54fd7

Browse files
committed
docs: changelog, release notes and feature documentation #508
1 parent c67ffe4 commit 5c54fd7

File tree

4 files changed

+56
-2
lines changed

4 files changed

+56
-2
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Changed
11+
12+
- fj-doc-mod-fop, make accessibility and keep empty tags parameters configurable <https://github.com/fugerit-org/fj-doc/issues/508>
13+
1014
## [8.16.2] - 2025-09-12
1115

1216
### Changed

fj-doc-guide/src/main/docs/asciidoc/chapters/00_2_release_notes.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,21 @@
33

44
Whereas the link:https://github.com/fugerit-org/fj-doc/blob/main/CHANGELOG.md[CHANGELOG] is a detailed list of modifications to project, the release notes just refer to the most important changes.
55

6+
[#doc-release-notes-unreleased]
7+
==== Unreleased
8+
9+
- fj-doc-mod-fop, make accessibility and keep empty tags parameters configurable link:https://github.com/fugerit-org/fj-doc/issues/508[#508]
10+
11+
[#doc-release-notes-8-16-2]
12+
==== Version 8.16.2 [2025-09-12]
13+
14+
- fj-doc-maven-plugin, updated all flavours version link:https://github.com/fugerit-org/fj-doc/issues/498[#498]
15+
16+
[#doc-release-notes-8-16-1]
17+
==== Version 8.16.1 [2025-09-01]
18+
19+
- fj-doc-maven-plugin, updated all flavours version link:https://github.com/fugerit-org/fj-doc/issues/494[#494]
20+
621
[#doc-release-notes-8-16-0]
722
==== Version 8.16.0 [2025-08-22]
823

fj-doc-guide/src/main/docs/asciidoc/chapters/06_2_mod-fop.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,14 @@ For this DocHandler it is possible to customize some attributes, for instance :
6666
| *pdf-ua-mode* anchor:doc-handler-mod-fop-pdf-config-pdf-ua-mode[] | _string_ | | If present, will set pdf-ua-mode, possible values are : _PDF/UA-1_. link:https://github.com/fugerit-org/fj-doc/issues/52[Partially compatible with pdf-a-mode].
6767
| *fop-pool-min* anchor:doc-handler-mod-fop-pdf-config-fop-pool-min[] | _int_ | 0 | If present, it will create a fo user agent pool, this is the minimum size of the pool.
6868
| *fop-pool-max* anchor:doc-handler-mod-fop-pdf-config-fop-pool-max[] | _int_ | 0 | If present, it will create a fo user agent pool, this is the maximum size fo the pool.
69-
| *accessibility* anchor:doc-handler-mod-fop-pdf-config-accessibility[] | _bool_ | true | fopUserAgent.setAccessibility($value);
70-
| *keep-empty-tags* anchor:doc-handler-mod-fop-pdf-config-keep-empty-tags[] | _bool_ | false | fopUserAgent.setKeepEmptyTags($value);
69+
| *accessibility* anchor:doc-handler-mod-fop-pdf-config-accessibility[] | _bool_ | true | fopUserAgent.setAccessibility($value); (since 8.16.3)
70+
| *keep-empty-tags* anchor:doc-handler-mod-fop-pdf-config-keep-empty-tags[] | _bool_ | false | fopUserAgent.setKeepEmptyTags($value); (since 8.16.3)
7171
|========================================================================================================================================
7272

7373
NOTE: If *pdf-a-mode* is set, there will be a strict validation of the PDF (i.e. it will be checked if the font are all embedded and the images should comply to link:https://www.adobe.com/uk/acrobat/resources/document-files/pdf-types/pdf-a.html[PDF/A standard]).
7474

75+
TIP: Setting accessibility to 'false' will produce a smaller but less accessible PDF.
76+
7577
[#doc-handler-mod-fop-pdf-config-pdf-a]
7678
==== PDF/A DocHandler
7779

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
2+
[#doc-faq-reducing-fj-doc-mod-fop-pdf-size]
3+
=== Reducing fj-doc-mod-fop PDF size
4+
5+
Module fj-doc-mod-fop is based on link:https://xmlgraphics.apache.org/fop/[Apache FOP].
6+
7+
Sometimes this module can produce relatively big size PF.
8+
9+
Here are some tips to reduce the size.
10+
11+
==== Accessibility
12+
13+
By default, fop user agent has the accessibility flag active.
14+
15+
Since Venus version 8.16.3 it is possible to use the new handler :
16+
17+
[source,java]
18+
----
19+
org.fugerit.java.doc.mod.fop.PdfFopTypeNoAccessibilityHandler
20+
----
21+
22+
Which as the accessibility flag set to 'false' by default.
23+
24+
Alternatively, it is possible to use a new configuration option :
25+
26+
[source,xml]
27+
----
28+
<docHandler id="pdf-fop-config" info="pdf" type="org.fugerit.java.doc.mod.fop.PdfFopTypeHandler">
29+
<docHandlerCustomConfig charset="UTF-8" accessibility='false'/>
30+
</docHandler>
31+
----
32+
33+
Refer to xref:#doc-handler-mod-fop-pdf-config-accessibility[PDF/FO DocHandler] documentation for further info.

0 commit comments

Comments
 (0)