Bug 133403 - [UI] PDF export options dialog: Usage of term "bookmark" confusing
Summary: [UI] PDF export options dialog: Usage of term "bookmark" confusing
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: UI (show other bugs)
Version:
(earliest affected)
6.4.4.1 rc
Hardware: All All
: medium minor
Assignee: Ayhan Yalçınsoy
URL:
Whiteboard: target:7.1.0
Keywords: difficultyBeginner, easyHack, skillDesign, topicUI
Depends on:
Blocks: PDF-Export-Options-Dialog
  Show dependency treegraph
 
Reported: 2020-05-26 10:30 UTC by Liaison to zh-CN User Community
Modified: 2023-02-16 23:26 UTC (History)
3 users (show)

See Also:
Crash report or crash signature:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Liaison to zh-CN User Community 2020-05-26 10:30:57 UTC
This report is forwarded from a complaint in a Chinese LO user chat group.

In the PDF Export Options dialog (File > Export as > Export as PDF... in Writer, perhaps other modules as well), User Interface tab, there is a section talking about "Bookmarks", with options about "bookmark levels".

This is presumably using the term "bookmark" as PDF defines it, i.e. the links in the side pane that can be clicked and jumped to.  However, in the context of LO, the exported bookmark structure is mainly from various "headings" style, especially the "levels" these options are referring to.

To make it worse, Writer also has its own "bookmarks" that can be seen in the navigator, which makes the decriptions of these options even harder to understand for users not familiar with the PDF "bookmarks".

The original reporter asked the Chinese translation to be clarified, but I feel the original English wording is worth discussion.

Reproduced with 6.4.4 but likely existed for quite a few versions:
Version: 6.4.4.2 (x64)
Build ID: 3d775be2011f3886db32dfd395a6a6d1ca2630ff
CPU threads: 2; OS: Windows 10.0 Build 18363; UI render: default; VCL: win; 
Locale: zh-CN (zh_CN); UI-Language: en-US
Calc: threaded
Comment 1 Mike Kaganski 2020-05-26 14:11:08 UTC
(In reply to zh_CN User Community Liaison from comment #0)
> In the PDF Export Options dialog (File > Export as > Export as PDF... in
> Writer, perhaps other modules as well), User Interface tab, there is a
> section talking about "Bookmarks", with options about "bookmark levels".
> 
> This is presumably using the term "bookmark" as PDF defines it, i.e. the
> links in the side pane that can be clicked and jumped to.  However, in the
> context of LO, the exported bookmark structure is mainly from various
> "headings" style, especially the "levels" these options are referring to.

The tab "User Interface" relates to how the generated PDF opens in the PDF reader application; so it necessarily operates PDF terms. The "bookmarks" there is necessarily PDF bookmarks. But of course, this group could be renamed to "Bookmarks window", thus clarifying that that's specific PDF stuff... but do all PDF readers use "window" for that? Maybe "Bookmarks list"?

Note that there is also Help clarifying that [1] (so that improvement could possibly go there instead of modifying dialog text).

[1] https://help.libreoffice.org/latest/en-US/text/shared/01/ref_pdf_export_user_interface.html#hd_id9053926
Comment 2 Liaison to zh-CN User Community 2020-05-27 08:58:47 UTC
Hi Mike,

Thanks for your comments.

(In reply to Mike Kaganski from comment #1)
> The tab "User Interface" relates to how the generated PDF opens in the PDF
> reader application; so it necessarily operates PDF terms. The "bookmarks"
> there is necessarily PDF bookmarks.
Sure, with context I agree we should use PDF terms.

> But of course, this group could be
> renamed to "Bookmarks window", thus clarifying that that's specific PDF
> stuff... but do all PDF readers use "window" for that? Maybe "Bookmarks
> list"?
I don't know either.

Personally I'm more unhappy about the "bookmark levels" wording.  If it were up to me (and the Chinese translation will look like this if the English stays the same), I'll use "All heading levels exported as bookmarks" and "Heading levels exported as visible bookmarks" for the two options in the "Bookmarks" section.

Of course, this is assuming what the Chinese user told me is correct - these two options change which heading styles are exported as PDF bookmarks, and also that they don't change other "levels" I am not aware of.
Comment 3 Liaison to zh-CN User Community 2020-05-27 09:07:23 UTC
Just found out that the PDF export options dialog in Calc has the same "bookmark levels" options.  I don't know what they do (and have asked the original reporter in chat group), but "heading levels" for either English or Chinese likely won't work.

Will investigate later.
Comment 4 BogdanB 2020-05-27 10:16:34 UTC
In Word there is
Export Bookmark:
-as headings
-as Word bookmarks

More clear like this.

I tried some weeks ago for minutes to export "bookmarks" and it didn't work and never will... Because in fact was exporting headings...
Comment 5 Heiko Tietze 2020-05-27 10:53:25 UTC
My PDF viewer on Linux/KDE is Okular. This tool opens "bookmarks" in a Content view (or not if General > [ ] Export Bookmarks is off; which btw. has no effect on the UI setting). Okular can set bookmarks and go to next/previous as bookmarks are known.

So let's rename:

General: [ ] Export outlines
Pane: Outline and page
UI: Collapse Outlines (o) Show All ( ) Visible levels <1> (and disable these radio buttons depending on the general option)
Links: [ ] Export outlines as named destinations (checking this option results in no visible output, ~1kB size instead of 100; needs also to be disabled)
Comment 6 Heiko Tietze 2020-07-06 09:51:38 UTC
UX input in comment 5, removing the keyword. Renaming is an easyhack.

(Quick) code pointer: /filter/uiconfig/ui/pdflinkspage.ui
Comment 7 Commit Notification 2020-10-05 10:16:10 UTC
Ayhan Yalçınsoy committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/c42dc1be0c3161e621ed0a667ae6b047f8bb23d4

tdf#133403: PDF export options dialog:(bookmarks) is replaced with (outlines)

It will be available in 7.1.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 8 Commit Notification 2020-10-05 11:52:18 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/b321b72559eb3db281a5a89909ee725c19bf03bb

tdf#133403 update PDF export help pages
Comment 9 sdc.blanco 2020-10-05 12:03:25 UTC
(In reply to Commit Notification from comment #8)
> tdf#133403 update PDF export help pages
Updated help pages for label changes in the dialog boxes.
Also changed tooltips in "User interface" tab.  (but maybe takes a few days
before it is visible.) Here is link to one of the affected pages (links to the others are at the bottom of that page).

https://help.libreoffice.org/7.1/en-US/text/shared/01/ref_pdf_export_links.html

Rare offer: Text on these help pages are used as "tooltips".  If there are improvements to the "tooltips" for the dialog tabs in PDF export, then let me know now, and I will change them.
Comment 10 Liaison to zh-CN User Community 2020-10-05 14:54:49 UTC
Thanks for fixing this, Ayhan and Seth!

However, as a l10n translator, I noticed that while the UI strings are changed, the accompanying context for translators are not.  For example:

> - <property name="label" translatable="yes" context="pdfgeneralpage|bookmarks">Export _bookmarks</property>
> + <property name="label" translatable="yes" context="pdfgeneralpage|bookmarks">Export _outlines</property>

Maybe context="pdfgeneralpage|outlines"?

> - <property name="label" translatable="yes" context="pdfuserinterfacepage|allbookmarks">_All bookmark levels</property>
> + <property name="label" translatable="yes" context="pdfuserinterfacepage|allbookmarks">Show _All</property>

Maybe context="pdfuserinterfacepage|alloutlines" or context="pdfuserinterfacepage|showall"?

> - <property name="label" translatable="yes" context="pdfuserinterfacepage|visiblebookmark">_Visible bookmark levels:</property>
> + <property name="label" translatable="yes" context="pdfuserinterfacepage|visiblebookmark">_Visible levels:</property>

Maybe context="pdfuserinterfacepage|visibleoutline" or context="pdfuserinterfacepage|visiblelevels"?

@Ayhan, would you please submit a patch to fix these contexts as well?  Thanks again.
Comment 11 Liaison to zh-CN User Community 2020-10-05 15:12:07 UTC
(In reply to Commit Notification from comment #7)
> Ayhan Yalçınsoy committed a patch related to this issue.
> It has been pushed to "master":
> 
> https://git.libreoffice.org/core/commit/
> c42dc1be0c3161e621ed0a667ae6b047f8bb23d4
> 
> tdf#133403: PDF export options dialog:(bookmarks) is replaced with (outlines)
This patch also introduced new mnemonic (keyboard accelerater) clashes, for example:

> - <property name="label" translatable="yes" context="pdfgeneralpage|bookmarks">Export _bookmarks</property>
> + <property name="label" translatable="yes" context="pdfgeneralpage|bookmarks">Export _outlines</property>
Here the mnemonic was change from Alt+B to Alt+O, but Alt+O was already used, in line 869 of filter/uiconfig/ui/pdfgeneralpage.ui:

> <property name="label" translatable="yes" context="pdfgeneralpage|emptypages">Exp_ort automatically inserted blank pages</property>

Similarly for filter/uiconfig/ui/pdfviewpage.ui,

> - <property name="label" translatable="yes" context="pdfviewpage|outline">_Bookmarks and page</property>
> + <property name="label" translatable="yes" context="pdfviewpage|outline">_Outline and page</property>
Alt+O was also already used by:

> <property name="label" translatable="yes" context="pdfviewpage|contfacinglayout">C_ontinuous facing</property>
Comment 12 Heiko Tietze 2020-10-05 15:17:26 UTC
(In reply to zh_CN User Community Liaison from comment #11)
> This patch also introduced new mnemonic (keyboard accelerater) clashes...

That's unfortunate but you can press alt+O again to jump to the next hotkey. My fault to not have checked this in advance.
Comment 13 Liaison to zh-CN User Community 2020-10-10 01:13:23 UTC
(In reply to Heiko Tietze from comment #12)
> (In reply to zh_CN User Community Liaison from comment #11)
> > This patch also introduced new mnemonic (keyboard accelerater) clashes...
> 
> That's unfortunate but you can press alt+O again to jump to the next hotkey.
> My fault to not have checked this in advance.
It's good to know that pressing Alt+O multiple times can alternate between items with clashing mnemonics, but wouldn't it be nice to avoid clashes in the first place?

Looking at the dialogs in version 6.4, it seems both Alt+I and Alt+N are unused, for either the General tab or Initial View tab.  So maybe change these two strings to "Export outli_nes" and "Outli_ne and page"?
Comment 14 Liaison to zh-CN User Community 2020-11-02 18:15:18 UTC
I've now submitted a patch in Gerrit for the proposed mnemonic key changes:

https://gerrit.libreoffice.org/c/core/+/105209