Bug 137236 - Chapter, Filename and Template should be be shown in "Select" frame not "Format" frame in Fields dialog - Document tab
Summary: Chapter, Filename and Template should be be shown in "Select" frame not "Form...
Status: RESOLVED NOTABUG
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Writer (show other bugs)
Version:
(earliest affected)
Inherited From OOo
Hardware: All All
: medium minor
Assignee: Not Assigned
URL:
Whiteboard:
Keywords: difficultyInteresting, easyHack, needsUXEval, skillCpp
Depends on:
Blocks: Fields-Dialog Document_Field_Help
  Show dependency treegraph
 
Reported: 2020-10-03 21:44 UTC by sdc.blanco
Modified: 2021-06-21 12:46 UTC (History)
6 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 sdc.blanco 2020-10-03 21:44:30 UTC
1. Insert - Fields - More Fields (Ctrl-F2)
2. Document tab
3. Under Type, choose {Chapter, Page, Template}

Actual result:  choices shown in Format

Proposed result:  choices shown in Select

Reasons:  
1.  All other Types are shown in Select, where Format modifies how the Selection is presented. 
2.  Makes it easier to explain on Help page.

Have filed as enhancement, but could be considered bug from UI POV.
Comment 2 sdc.blanco 2020-10-06 15:51:29 UTC
Maybe an Easy Hack?  adding needsUXeval and cc: Ayhan

Would be useful for UI consistency and simplifying help page.
Comment 3 Heiko Tietze 2020-10-07 08:15:39 UTC
Issue is clear. Guess it has been done because of the input control below the right column. Adding/moving this to the middle column would make the UI jump; and keeping it there divides the configuration. We could list the 1..10 levels under Format instead of the spinner, not really nice though.
Comment 4 sdc.blanco 2020-10-07 16:19:40 UTC
(In reply to Heiko Tietze from comment #3)
> Adding/moving this to the middle column would make the UI jump; 
It already jumps.  Try between "Chapter" and "Template".

Change would make "less" jumping.

Try "Statistics" and "Template"  currently gives bigger jump than if moved.

Try "Date" vs. "Chapter"
Comment 5 Heiko Tietze 2020-10-09 07:56:53 UTC
(In reply to sdc.blanco from comment #4)
> It already jumps.  Try between "Chapter" and "Template".

Don't see it jumping. The "details" input below the format list shows up or is hidden, sometimes it's a spinner sometimes a checkbox. But it never moves to the middle column.
Comment 6 sdc.blanco 2020-10-09 09:08:12 UTC
(In reply to Heiko Tietze from comment #5)
> Don't see it jumping. The "details" input below the format list shows up or
> is hidden, sometimes it's a spinner sometimes a checkbox. But it never moves
> to the middle column.
Clarification of misunderstanding:
For Types: Chapter, Filename, Template, moving what is currently shown in "Format" to "Select" does not entail moving the control under the Format box (i.e., "Fixed content", "levels", etc.)  (That was not meant to be part of the OP).
In short, no "jump" with that part (if that was what you meant).
Comment 7 Heiko Tietze 2020-10-15 07:39:09 UTC
We discussed the topic in the design meeting and decided to show the list in the middle column.

Might be an easyhack yet somewhat tricky. UI is sw/uiconfig/swriter/ui/flddocumentpage.ui code at sw/source/ui/fldui/flddok.cxx
Comment 8 Mike Kaganski 2020-10-15 09:27:59 UTC
Hmm. This is not a bug actually, and should not be fixed.

The "Type" and "Select" lists together define *which* data to display. "Format" tells *how* to display it.

E.g., for "Author" type, we see the choice of *two different* pieces of information available in Options|LibreOffice|General: Name and Initials. They are not different representations of some single information: they may happen to be present both, or none, or only one present. So choosing this in "Select" list defines which information to display.

Or for Date: depending on the choice (fixed or not), the field will display one date value or the other.

But in case of chapter, the data being displayed is the same (the paragraph with non-0 outline level). There's no choice where to take the information from; only how to present it (you may choose to display the text, or the number, or both; just the same way as you may choose to display year, or year plus month, or year, month, day, and time for datetimes).

Please review.
Comment 9 Heiko Tietze 2020-10-21 13:29:00 UTC
(In reply to Mike Kaganski from comment #8)
> Please review.

Author > Name != Chapter > Name is at least surprising for ordinary users. Sascha, rather keep the current implementation?
Comment 10 S.Zosgornik 2020-10-21 20:01:56 UTC
Well, not all that is inside the Format-list is actually a format-variation. So we have to chose one-by-one. My suggestion so far:

Document >
Chapter > Chapter name
            > Chapter number > number and name
                                       > number without separator

File name > File name       > File name with extension
                                       > File name without extension
               > File Path        > Path with file name
                                       > Path without file name

Templates > Category
                > File name     > File Name with extention
                                      > File name without extention
                > Path            > Path with File name
                                      > Path without File Name
                > Style

Variables >
Set variable > Text           > Character 
                  > Number      > Integer
                                      > Floating Point
                                      > Additional Formats

User Field   > Text           > Character
                 > Formula      > Integer
                                      > Floating Point
                                      > Additional formates
                 > Standard     > Integer
                                      > Floating Point
                                      > Additional formates

In this order we rather create some placeholder entries in the current empty Selection-lists, namely Total editing time, DDE field, Insert Formula, Show page variable, User Field
Comment 11 sdc.blanco 2020-10-26 21:18:56 UTC
BTW -- just an observation for those who care -- 

isn't "Chapter" a terminological dinosaur (i.e., a relic from a bygone era)?

"Paragraph with non-zero Outline Level" describes more accurately the actual behavior of the inserted "type".

Perhaps something like "Heading" is closer to what a user might comprehend (or expect with such a label).
Comment 12 sdc.blanco 2020-10-27 00:13:42 UTC Comment hidden (obsolete)
Comment 13 Mike Kaganski 2020-10-27 04:26:29 UTC
(In reply to sdc.blanco from comment #12)

It's up to design team to restructure it here. I only pointed out that currently LibreOffice consistently follows *its* design - wherever something is entered in one box, like filepath, it's one piece of information. If it's entered in different boxes in the application, it's different pieces.

You are breaking the consistency, and instead trying to make "psychological" decisions - thus necessarily becoming subjective: neither consistent, nor covering everyone's PoV.

But no objection from *my* side - I can always look into the code to know, and into the git log to blame ;-P
Comment 14 sdc.blanco 2020-10-27 06:32:57 UTC
(In reply to Mike Kaganski from comment #13)
> You are breaking the consistency, and instead trying to make "psychological"
> decisions - thus necessarily becoming subjective: neither consistent, nor
> covering everyone's PoV.
But being consistent does not cover everyone's POV either. (-: 

> It's up to design team to restructure it here. 
Thanks for clarification.  To design team:  please consider consequences of the UI design for writing clear documentation (which is what motivated the OP).
Comment 15 Mike Kaganski 2020-10-27 06:56:48 UTC
(In reply to sdc.blanco from comment #14)
> > thus necessarily becoming subjective: neither consistent, nor
> > covering everyone's PoV.
> But being consistent does not cover everyone's POV either. (-: 

Currently it has one of two - not covering everyone's PoV, *but* *is* consistent; proposal looses that property ;-P
Comment 16 Mike Kaganski 2020-10-27 07:03:27 UTC Comment hidden (off-topic)
Comment 17 Heiko Tietze 2020-10-27 10:44:15 UTC Comment hidden (off-topic)
Comment 18 sdc.blanco 2020-10-28 07:49:34 UTC
(In reply to Mike Kaganski from comment #16)
> that don't take overall architectural picture into account; e.g. here, I
> don't see an analysis like "This will change this from consistent into
> inconsistent; yet, we estimate that about 60% users who currently use this
> feature have problems, and the suggestion is expected to lower that number
> to 35%".
[avoiding politely the question of whether the possible change in consistency is "logical" or "subjective" (-: and completely oblivious of the overall architectural picture - but without disputing the general validity and importance of doing so ]

How about an analysis like this (seriously meant):

This change will guarantee with 100% that it will be possible to write a simpler, more comprehensible help page:

https://help.libreoffice.org/7.1/en-US/text/swriter/01/04090001.html

where (on this help page) all Types and Select items can be placed in a single table (so their relationship can be clearly indicated), rather than the current hybrid with a separate "Select" section,

and where the instruction to the user is -- as the page currently says -- to insert a field, choose an item in the select list and press insert.  

(At present, the current help page is wrong, when some items to insert are in the Format frame. This change will also avoid having to find a way to explain these alternatives.)

With all that in place, then it is easy to indicate that "Format" applies only Types "Date", "Page" "Statistics" and "Time", where format can be used to choose how dates, times, and numbers are displayed.

Based on these potential improvements in the help page, we estimate that 3% of the users might read it, with 85% of them being able to successfully achieve (and/or) expand their possibility to use Document Field Types, with satisfaction.  (ok, maybe this paragraph is only half-serious) 

Furthermore, it is predicted that with a consistent relation between Type and Select, and useful explanations of Field Types and Select in the Document Fields help, then users will gain advantage in understanding the DocInformation tab and the Variables tab, where all fields are inserted from the "Select" frame, and where Format is used (in DocInformation) like in Document to control dates and times (no numbers there) and roughly the same in Variables (now with numbers, and with greater numerical display variations (plus text) because of "Additional formats").

I suspect there already exist usability studies that show the advantage of a consistency across the tabs of the UI -- even if there are not studies of this particular Insert Fields dialog (with its different tabs).

---Please -- no reply to this analysis is needed -- but I wanted to lay out the main issue that motivated the OP and comment 14 ----
Comment 19 Heiko Tietze 2021-06-21 12:46:11 UTC
Apparently a delicate subject. And since no further comments have been made, I'll resolve as NAB.

Request is not based on actual user mistakes but comes from a documentation problem. Current implementation is consistent and has proven to work. Any change might cause other trouble and new inconsistencies.