Bug 126658 - Arrow Style modification workflow is unclear
Summary: Arrow Style modification workflow is unclear
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: UI (show other bugs)
Version:
(earliest affected)
6.4.0.0.alpha1+
Hardware: All All
: medium enhancement
Assignee: Not Assigned
URL:
Whiteboard: target:7.4.0
Keywords: difficultyBeginner, easyHack, skillDesign, topicUI
Depends on:
Blocks: Arrow_Style
  Show dependency treegraph
 
Reported: 2019-08-01 10:57 UTC by andreas_k
Modified: 2022-06-09 11:08 UTC (History)
10 users (show)

See Also:
Crash report or crash signature:


Attachments
proposals and questions about arrow styles dialog (125.95 KB, image/png)
2022-04-10 15:30 UTC, sdc.blanco
Details

Note You need to log in before you can comment on or make changes to this bug.
Description andreas_k 2019-08-01 10:57:42 UTC
Draw a line, go to line dialog tab arrow there is modification, click on it you get a new name, but no configuration window.
Comment 1 Julien Nabet 2019-08-02 09:40:52 UTC
Perhaps I wrongly understood but when you click modify, you have several options below the default name of the line.
So I think you should just change these options then click Modify and choose the new name.
Comment 2 andreas_k 2019-08-02 10:58:40 UTC
I think I don't know how the workflow is to make new one with the GUI.
Comment 3 Roman Kuznetsov 2019-08-02 17:43:54 UTC
Andreas, do you want change label of "Modify" button to "Rename"?

And you can't change shape for existing arrow types, but you can add some new type: draw your shape, open Line dialog, go to Arrow styles tab, pres Add button, type new name and press OK. Your shape will be a new arrow style
Comment 4 Regina Henschel 2019-08-09 12:40:50 UTC
The problem is, that with button Modify the same box opens as for Add. Only if you compare the pre filled text, you notice, that in case of Add, it is filled with a new default name, and in case of Modify, with the current name.

It might be clearer, if in case of Modify the naming box is not opened at all, and instead an explicit button Rename is provided.

Or the info text in the box can be different for Modify and Add.
Comment 5 Heiko Tietze 2019-08-12 08:27:28 UTC
Modify is Rename (if we make the title control readonly - or change into a label, and drop the weird dialog). But what is Add good for? I don't have any option and always get a straight line.
Comment 6 Regina Henschel 2019-08-12 11:09:07 UTC
(In reply to Heiko Tietze from comment #5)
> Modify is Rename

You are right. I had looked at the "Line Styles" tab, not at the "Arrow Styles" tab.

> But what is Add good for?

Draw a closed shape, but not a custom shape. Keep it selected and open the Line dialog on "Arrow Styles" tab. Now the Add button is enabled. Click it and enter a name. Close dialog. Draw a line and open the line arrow drop-down list. Find your new marker at the bottom of the list.
Adding a dash style or an "arrow" will copy the common current set from share to the user directory and add the new item there.

 I don't have
> any option and always get a straight line.

My proposal would be, to divide the dialog in two parts. One part for applying settings to a selected line (in menu Format) and a second part for defining dash styles, marker styles and managing their sets (in menu Tools). I have no strong opinion whether selecting a set would be better in the part in menu Format (similar to the selecting drop-down for colors in the Area dialog) or in menu Tools.
Comment 7 Heiko Tietze 2019-08-12 15:26:55 UTC
(In reply to Regina Henschel from comment #6)
> > But what is Add good for?
> 
> Draw a closed shape, but not a custom shape. Keep it selected and open...

One of the most important features of an office suite. If we keep it a simple renaming of "Add" into "Add selected shape" or just "Add Selection" could help.

> My proposal would be, to divide the dialog in two parts. One part for
> applying settings to a selected line (in menu Format) and a second part for
> defining dash styles, marker styles and managing their sets (in menu Tools).

I would remove this far-fetched corner case feature and let users install new arrows per extension, which in turn have to be defined manually. The XML shouldn't be too difficult.
Comment 8 Heiko Tietze 2019-09-25 09:08:25 UTC
We got help https://help.libreoffice.org/6.3/en-US/text/shared/guide/lineend_define.html?DbPAR=SHARED#bm_id3146117 (the dialog is not properly linked, I had to use the search)

So how about to keep Add and show a tooltip "Add the selected object as a new line ending."
Comment 9 Heiko Tietze 2021-06-14 08:41:50 UTC
No more input, let's rename (Modify -> Rename) and add a tooltips.

Code pointer: cui/uiconfig/ui/lineendstabpage.ui
Comment 10 sdc.blanco 2022-04-10 15:30:55 UTC
Created attachment 179441 [details]
proposals and questions about arrow styles dialog

(In reply to Heiko Tietze from comment #9)
> No more input, let's rename (Modify -> Rename) and add a tooltips.
I am considering to attempt this task, but have a few questions and suggestions, beyond "Rename". Everything is shown on a screenshot of the current dialog (see attachment), but to summarize:

1. "Organize Arrow Styles" -> "Manage Arrow Styles"
    Reason:  nothing is getting organized. More like Template Manager (i.e., add,
             rename, delete)
2. "Title" -> "Style name"
    Reason:  gives connection with "Rename" and with "Arrow Style"

3. Maybe one line in dialog box should be tooltip.

4. Maybe part of "preview" should be removed, or is broken.
Comment 11 sdc.blanco 2022-04-10 22:53:53 UTC
(In reply to sdc.blanco from comment #10)
> 3. Maybe one line in dialog box should be tooltip.
https://opengrok.libreoffice.org/xref/core/solenv/sanitizers/ui/cui.suppr?r=3455ef6e#83
Comment 12 Heiko Tietze 2022-04-11 07:58:21 UTC
(In reply to sdc.blanco from comment #10)
> 1. "Organize Arrow Styles" -> "Manage Arrow Styles"
Manage sounds better to me too.

> 2. "Title" -> "Style name"
How about simply "Name:"? Don't forget the colons for labels with relation to a buddy control.

> 3. Maybe one line in dialog box should be tooltip.
You mean this "Add a selected object to create..."? This sentence has actually no additional information like what exactly I have to select to be able to select via Add button. And yes, it should be a tooltip.

> 4. Maybe part of "preview" should be removed, or is broken.
The cap style at the Line tab work well,. yet settings are not taken into the other tab. The preview is carelessly slapped together, but hiding it in one view makes it not really better.
Comment 13 sdc.blanco 2022-04-12 09:08:04 UTC
(In reply to Heiko Tietze from comment #12)
> > 2. "Title" -> "Style name"
> How about simply "Name:"? 
I assume your reason for "name" is along the lines of "use as few words as possible".  But here is why "Style name is better".

1. Name is (also) used for shapes and images, where "Name" is identifying a unique individual shape/image, but otherwise (afaik), it is not used for any other purpose.  Largely, it gives better names in Navigator.

2. In this case, you are defining an Arrow Style, where the "name" that you assign is what will appear in the dropdown box under Arrow Styles (in the Line tab).   "Style name", emphasizes that this is the "Arrow Style name" (which I also considered proposing, but assumed it would be rejected as too long).  I tried to refer to this idea briefly in Comment 10 by saying that it "gives connection" with the "Rename" and the idea that it is the Arrow Style name that is being renamed.
Comment 14 sdc.blanco 2022-04-12 09:10:52 UTC
(In reply to Heiko Tietze from comment #12)
> You mean this "Add a selected object to create..."? 
Yes.  And to be clear -- now that we agree that it is not an informative line -- this sentence should be deleted from the UI and an improved version added as a tooltip for the Add button. Isn't that right?
Comment 15 sdc.blanco 2022-04-12 09:22:22 UTC
(In reply to Heiko Tietze from comment #12)
> > 4. Maybe part of "preview" should be removed, or is broken.
> The cap style at the Line tab work well,. yet settings are not taken into
> the other tab. The preview is carelessly slapped together, but hiding it in
> one view makes it not really better.
To expand my initial brief comment about Preview.

1. Not suggesting to hide or completely remove the Preview on Arrow Styles tab.

2. The cap style works just as well in the Arrow Styles tab as in the Line tab.

3. But what are those two "carets" on right side of the Preview -- for the Line, Line Styles and Arrow Styles tabs in the Line dialog.  For Line and Arrow Styles, the carets do not seem to change. For Line Styles, the carets take the selected Line Styles.  

iow -- the carets seem to be visual noise (i.e., not informative).  It was that "part" that I was asking about, and suggesting that they might be profitably removed (or repaired).
Comment 16 Heiko Tietze 2022-04-12 10:14:21 UTC
(In reply to sdc.blanco from comment #13)
> But here is why "Style name is better".
No objection

(In reply to sdc.blanco from comment #14)
> ...this sentence should be deleted from the UI and an improved version
> added as a tooltip for the Add button. Isn't that right?
Yes, I agree on removing(In reply to sdc.blanco from comment #15)

> (In reply to Heiko Tietze from comment #12)
> 3. But what are those two "carets" on right side of the Preview...
As I tried to explain in c12 it's the cap style.
Comment 17 sdc.blanco 2022-04-12 12:40:36 UTC
Tooltip proposals for:

Rename (previously Modify):   "Applies changes to the Style name."

Add:  "Adds selected shape as Arrow Style."

      Extended tooltip:  

         "To add a new Arrow Style, first select the shape in the document to be
          added, then open this dialog and press Add. If the Add button is not
          active, then the selected shape cannot be added."

Especially the extended tooltip is meant to resolve the OP.

Most of the other controls have tooltips or extended tooltips. These proposed additions might be enough for this tab.
Comment 18 Heiko Tietze 2022-04-12 14:52:18 UTC
(In reply to sdc.blanco from comment #17)
> Add:  "Adds selected shape as Arrow Style."
+1

>"To add a new Arrow Style, first select the shape in the document to be
> added, then open this dialog and press Add. If the Add button is not
> active, then the selected shape cannot be added."

Sounds good but leaves open why adding is not possible. The fact is clear from the disabled state.
Comment 19 sdc.blanco 2022-04-12 15:56:14 UTC
(In reply to Heiko Tietze from comment #18)
> Sounds good but leaves open why adding is not possible. 
Yeah. This can/should be improved.

>"To add a new Arrow Style, first select the shape in the document to be
> added, then open this dialog and press Add. 
Just to be sure.  The first sentence is ok?

The second sentence was motivated by the following facts:
   (a) "Draw a closed shape, but not a custom shape" in comment 6, which implies that not all shapes can be added, and 
   (b) the empirical observation that the "smiley face" and "octagon bevel" could not be added, but 
   (c) many unexpected shapes could be added as, including "heart", "lightning bolt", a freehand drawing using "Freeform Line", a line itself, even an image (or more precisely, its form), etc.

==> might be nice to give some indication that under some circumstances, "Add" is not possible.

But I do not know the circumstances under which adding is not possible.  [e.g., could not understand meaning of "custom shape" in (a) and experiments, such as in (b) and (c) did not yield a satisfying hypothesis.]

If someone can explain why (@Regina?), then I will be happy to mention in the extended tooltip. Otherwise, as an alternative, I propose to include the following (now rewritten) sentence:

   For selected shapes that cannot be added, the Add button is not active.

Reason:  Even if it does not explain why (and so far it seems that only a few cases do not work), it at least indicates that it is expected that some shapes cannot be added as an arrow style, which may enable/motivate some users to try another shape, and/or reduce suspicion that something is broken.
Comment 20 Heiko Tietze 2022-04-13 07:09:23 UTC
(In reply to sdc.blanco from comment #19)
> >"To add a new Arrow Style, first select the shape in the document to be
> > added, then open this dialog and press Add. 
> Just to be sure.  The first sentence is ok?

Yes, perfect.

> But I do not know the circumstances under which adding is not possible...
> If someone can explain why (@Regina?), then I will be happy to mention...

Regina, what exactly hinders the shape to be an arrow cap?
Comment 21 Regina Henschel 2022-04-13 09:48:45 UTC
(In reply to Heiko Tietze from comment #20)
 
> Regina, what exactly hinders the shape to be an arrow cap?

You surely cannot use a 3D-Scene or ashape in 3D-extrusion mode or a group. For others I would have to investigate in the code, what "exactly" hinders using the shape. But I would see it more from the practical side. If the "Add" button is activated, you can use the selected object as an arrow head.
Comment 22 sdc.blanco 2022-04-20 07:29:01 UTC
(In reply to Regina Henschel from comment #21)
> I would see it more from the practical side.
That is also what I proposed in comment 19.  

Have made a new version of that sentence now:

"If the selected shape is not permitted as an Arrow Style, then the Add button is not active."

Reason:  "not permitted" is meant to make it sound like there was actually some intention (i.e.,  explicitly-known reason/choice) for not making the "Add" active, where the main interest here is to give some indication that it is all right that "Add" is not active in some cases.

https://gerrit.libreoffice.org/c/core/+/133036
Comment 23 sdc.blanco 2022-04-26 06:06:48 UTC
(In reply to andreas_k from comment #2)
> I think I don't know how the workflow is to make new one with the GUI.
https://help.libreoffice.org/7.4/en-US/text/shared/guide/lineend_define.html?&DbPAR=WRITER&System=WIN 

This help page gives an explanation of the workflow. Maybe that guide page can be improved? For example, presumably the title of the page should be changed to mention ”arrow styles”. 

And a link to this guide page could be added to the help page for the arrow styles tab, found here: https://help.libreoffice.org/7.4/en-US/text/shared/01/05200300.html
Comment 24 Commit Notification 2022-04-27 08:16:48 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/7fbfefaedec93d7b49d1f53e23aed3cbbb55b315

tdf#126658 UI improvements to Arrow Styles tab in Line dialog

It will be available in 7.4.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 25 Commit Notification 2022-06-09 09:17:11 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

(Related) tdf#126658 update Arrow styles help to reflect UI change
Comment 26 Commit Notification 2022-06-09 10:55:03 UTC
Seth Chaiklin committed a patch related to this issue.
It has been pushed to "master":

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

tdf#126658 update "defining line ends"
Comment 27 sdc.blanco 2022-06-09 11:08:38 UTC
The patches in comment 25 and comment 26 update the help pages for Arrow Styles.
Now when the "Help" button is clicked in the Arrow Style dialog, the "Arrow Style" help page will include a link to the "guide" page about how to add an arrow style. That, along with the adjustments in the Arrow Style tab UI can be considered to be a resolution to this ticket.

Not mentioned in "help" is the empirical observation that selected shapes are added as arrowheads with a 90 degree rotation (i.e., the selected shape is rotated -90 degrees for the start arrowhead and +90 degrees for the end arrowhead).  

Have not filed a ticket to check whether that behavior is intended design or bug.