Bug 127959 - PDF/A options in PDF export dialog are not explained
Summary: PDF/A options in PDF export dialog are not explained
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: All All
: medium normal
Assignee: sdc.blanco
URL:
Whiteboard: target:7.1.0
Keywords:
Depends on:
Blocks: Help-Changes-Features
  Show dependency treegraph
 
Reported: 2019-10-04 08:55 UTC by Thomas Lendo
Modified: 2020-10-20 20:31 UTC (History)
5 users (show)

See Also:
Crash report or crash signature:


Attachments
Little test document to see effects of transparency in PDF export (10.12 KB, application/vnd.oasis.opendocument.text)
2020-10-16 00:16 UTC, sdc.blanco
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Thomas Lendo 2019-10-04 08:55:17 UTC
If you export a document to PDF, the general options in the PDF export dialog shows a checkbox with PDF/A compatibility and secondary options for PDF/A-2b and PDF/A-1b.

These options are not explained in the help files. There is only 'Archive PDF/A-1a (ISO 19005-1)' mentioned.

See https://help.libreoffice.org/latest/en-US/text/shared/01/ref_pdf_export.html from today.

"Archive PDF/A-1a (ISO 19005-1)
Converts to the PDF/A-1a format. This is defined as an electronic document file format for long term preservation. All fonts that were used in the source document will be embedded into the generated PDF file. PDF tags will be written."
Comment 1 Timur 2019-12-02 11:01:14 UTC Comment hidden (obsolete)
Comment 2 sdc.blanco 2020-10-11 22:05:02 UTC Comment hidden (obsolete)
Comment 3 Thomas Lendo 2020-10-13 19:43:30 UTC
(In reply to sdc.blanco from comment #2)
> I am willing to update the webpage (e.g., format PDF/A-3b needs to be
> added), but
> could not figure out what is missing exactly?
On the page https://help.libreoffice.org/latest/en-US/text/shared/01/ref_pdf_export_general.html?&DbPAR=WRITER&System=UNIX the screenshot is outdated (third PDF/A option is missing).

Following text seems to be changed since my bug report, but must still be enhanced:
"Archive (PDF/A ISO 19005)
Converts to the PDF/A-2b or PDF/A-1b format. This is defined as an electronic document file format for long term preservation. All fonts that were used in the source document will be embedded into the generated PDF file. PDF tags will be written."

* All 3 archive settings should be mentioned, not the two already existing.
* The comma in the setting title between PDF/A and ISO is missing.
* In short it could be explained what the main features/differences of the 3 settings are.

As a bonus (and because I didn't find an own bug for it), the next setting on this dialog with "Universal Accessibility (PDF/UA)" heading could be added with a short description.
Comment 4 Thomas Lendo 2020-10-13 19:45:26 UTC
PDF/UA was explained in blog post https://tomazvajngerl.blogspot.com/2020/01/accessibility-checker-and-support-for.html and implemented with bug 45636.
Comment 5 sdc.blanco 2020-10-13 22:49:38 UTC
(In reply to Thomas Lendo from comment #3)

Thanks for following up.

> On the page
> https://help.libreoffice.org/latest/en-US/text/shared/01/
> ref_pdf_export_general.html?&DbPAR=WRITER&System=UNIX the screenshot is
> outdated (third PDF/A option is missing).
Please file a new report. And classify it as Blocks: Screenshot
(there are several divergences, compared to 7.1)

> * In short it could be explained what the main features/differences of the 3
> settings are.
How about a <note> (i.e., in a separate box, under the description for Archive)

"PDF/A-2b is recommended for most users, because it allows for transparencies and has better compression (JPEG 2000) than PDF/A-1b, usually producing smaller files. PDF/A-3b is identical to PDF/A-2b, but allows embedding of other file formats."

And maybe a link to Tomaz's blog under Related Topics (see "7.1" instead of "latest")?
At least until a help page could be made to list the relevant reference information from that page(i.e., mainly what is implemented)?
Comment 6 Thomas Lendo 2020-10-15 21:35:22 UTC
(In reply to sdc.blanco from comment #5)
> > * In short it could be explained what the main features/differences of the 3
> > settings are.
> How about a <note> (i.e., in a separate box, under the description for
> Archive)
> 
> "PDF/A-2b is recommended for most users, because it allows for
> transparencies and has better compression (JPEG 2000) than PDF/A-1b, usually
> producing smaller files. PDF/A-3b is identical to PDF/A-2b, but allows
> embedding of other file formats."

Suggestion:
"... because it allows transparent objects and layers and has better ..." instead of "... because it allows for transparencies and has better ..."

> And maybe a link to Tomaz's blog under Related Topics (see "7.1" instead of
> "latest")?
> At least until a help page could be made to list the relevant reference
> information from that page(i.e., mainly what is implemented)?

I don't know if such links to external sources are allowed. Related topics are restricted to other internal help pages. And Tomaz' blog post is for "Universal Accessibility (PDF/UA)", not for PDF/A.

I also suggest changing
"Converts to the PDF/A-2b or PDF/A-1b format. This is defined as an electronic document file format for long term preservation. All fonts that were used in the source document will be embedded into the generated PDF file. PDF tags will be written."
to something like
"Converts the file to a PDF version for long term preservation. All fonts that were used in the source document will be embedded into the generated PDF file. PDF tags will be written."
Comment 7 sdc.blanco 2020-10-16 00:16:02 UTC
Created attachment 166396 [details]
Little test document to see effects of transparency in PDF export

(In reply to Thomas Lendo from comment #6)
> Suggestion:
> "... because it allows transparent objects and layers and has better ..."
> instead of "... because it allows for transparencies and has better ..."
Technically this is correct.  But I am concerned that the formulation should correspond to the UI, which uses a "Transparency" tab, and accepts values between 0 and 100 (while "transparent objects" might be read as 100% only).  
Also, in LO, one speaks about Shapes and Images, both of which can be given a transparency value. How about saying it this way:

"...because it allows for layers and transparency with shapes and images ..." 

Meanwhile -- I made some experiments -- because it is also possible to set "transparency" on paragraphs with direct formatting. It did not trigger any warning message -- but I do not know what should be expected there.  

But a shape with a transparency did give a warning (as expected) with PDF/A-1b, but not with PDF/A-2b (as expected).  
(but I could not really see much difference visually in the result).
Have attached a little test file (with instructions inside) if you want to experience the differences. 

I also made a Draw file with two layers, but did not get any warning messages with PDF/A-1b.  Again, I do not know if this is expected or not (or did something wrong in making the layers).  

I guess, for now, the documentation should say the "expected" behavior. 
 
> I don't know if such links to external sources are allowed. 
On the regex page, there is an external link to regex documentation

>And Tomaz' blog post is for "Universal Accessibility (PDF/UA)", not for PDF/A
Correct, but the Archive help appears on the same page as the PDF/UA help.

> I also suggest changing
> "Converts to the PDF/A-2b or PDF/A-1b format. This is defined as an
> electronic document file format for long term preservation. All fonts that
> were used in the source document will be embedded into the generated PDF
> file. PDF tags will be written."
> to something like
How about:

Converts to the PDF/A-1b, PDF/A-2b or PDF/A-3b standard.  All fonts
used in the source document are embedded in the generated PDF file, and PDF tags are written. The primary purpose is to create an electronic document whose appearance is device and application independent, making it suitable for long-term preservation.
Comment 8 sdc.blanco 2020-10-16 00:24:29 UTC
(In reply to Thomas Lendo from comment #6)
> I don't know if such links to external sources are allowed. Related topics
> are restricted to other internal help pages. 
Forgot to mention that I was planning to ask Olivier first.  Also, this is meant only as a "temporary measure" -- until an internal help page is made (using relevant information from the blog), then the link from "Related topics" could be dropped.
Comment 9 Commit Notification 2020-10-20 18:46:04 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/73e6149de3f0eeb1be5b24e111995be34a7cb0d6

Resolves: tdf#127959 and tdf#135196 - updating help for PDF export - General tab
Comment 10 sdc.blanco 2020-10-20 19:00:04 UTC
(In reply to Commit Notification from comment #9)
> Resolves: tdf#127959 and tdf#135196 - updating help for PDF export - General
> tab
I made a a new (internal) help page for PDF/UA (which was bug 135196), and made more adjustments in the formulations we discussed.

It usually takes a few days before the online help gets updated from the master, but the result should appear here:
https://help.libreoffice.org/7.1/en-US/text/shared/01/ref_pdf_export_general.html

I will close this bug as FIXED, but you are welcome to send additional comments about that page to this ticket.  Thanks for the dialogue.