Bug 106421 - Help article 02010000.xhp -- notation of "Apply Style" should read "Set Paragraph Style"
Summary: Help article 02010000.xhp -- notation of "Apply Style" should read "Set Parag...
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
5.3.0.3 release
Hardware: All All
: low trivial
Assignee: Olivier Hallot
URL:
Whiteboard: target:6.0.0.1 target:6.1.0
Keywords:
Depends on:
Blocks: HelpGaps-NewFeatures
  Show dependency treegraph
 
Reported: 2017-03-07 21:13 UTC by V Stuart Foote
Modified: 2017-12-17 02:12 UTC (History)
4 users (show)

See Also:
Crash report or crash signature:


Attachments
The tool-tip for the Formatting toolbar paragraph style drop list control (490.81 KB, image/png)
2017-04-24 13:17 UTC, V Stuart Foote
Details
The tool-tip and Help articles for the Formatting toolbar paragraph style control (162.75 KB, image/png)
2017-04-24 13:34 UTC, V Stuart Foote
Details
The tool-tip and Help articles for the Formatting toolbar paragraph style control (164.24 KB, image/png)
2017-04-24 13:37 UTC, V Stuart Foote
Details

Note You need to log in before you can comment on or make changes to this bug.
Description V Stuart Foote 2017-03-07 21:13:05 UTC
Description:
The 02010000.xhp help article [1] for the .uno:StyleApply and SVX_HID_STYLE_LISTBOX should be rewritten to bring it in line with actual function. It now reads "Apply Style" but for clarity and consistency of the UI it should match the tool-tip assigned to this droplist combobox. The article should be edited to refer to "Set Paragraph Style".

Additionally not clear that an UNO command still exists for the .uno:StyleApplyState stanza linked to this help article. If not, that should probably be removed.

Steps to Reproduce:
n/a

Actual Results:  
n/a

Expected Results:
n/a


Reproducible: Always

User Profile Reset: n/a

Additional Info:
=-ref-=
[1] http://opengrok.libreoffice.org/xref/help/source/text/shared/02/02010000.xhp


User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:51.0) Gecko/20100101 Firefox/51.0
Comment 1 V Stuart Foote 2017-03-07 21:36:59 UTC
The referring Help main for the two sections in the 02010000.xhp article is the Formatting Bar entry: 
http://opengrok.libreoffice.org/xref/help/source/text/swriter/main0202.xhp#38

It looks like just the article needs to be adjusted, but the help image--img_id3152801, "zellvor.png"--has not been correct, i.e. matched the tooltip, for some time. Rather than its Apply Style label it should also read Set Paragraph Style.
Comment 2 V Stuart Foote 2017-03-07 21:41:38 UTC
(In reply to V Stuart Foote from comment #1)
> It looks like just the article needs to be adjusted, but the help
> image--img_id3152801, "zellvor.png"--has not been correct, i.e. matched the
> tooltip, for some time. Rather than its Apply Style label it should also
> read Set Paragraph Style.

Sorry, the zellvor.png image is fine--just shows Default from the combo box list. Just the text label needs a tweak.
Comment 3 Yousuf Philips (jay) (retired) 2017-04-23 23:26:02 UTC
(In reply to V Stuart Foote from comment #0)
> Additionally not clear that an UNO command still exists for the
> .uno:StyleApplyState stanza linked to this help article. If not, that should
> probably be removed.

The UNO command is available but isnt used anywhere but
http://opengrok.libreoffice.org/xref/core/sfx2/sdi/sfx.sdi#4240

@Stuart, @Foote, @Heiko: Is 'Set' or 'Apply' better for the tooltip? It would be good to get a set of words that we stick to when writing descriptive tooltips, so they are consistent everywhere.
Comment 4 Heiko Tietze 2017-04-24 07:07:47 UTC
(In reply to Yousuf Philips (jay) from comment #3)
> @Stuart, @Foote, @Heiko: Is 'Set' or 'Apply' better for the tooltip?

As a non-native speaker the term "set" sounds to me like changing properties (German: "ändern") and "apply" to make it effective (German: "anwenden"). So my take is "Apply paragraph style" (title style capitalization makes no sense in tooltips).
Comment 5 V Stuart Foote 2017-04-24 13:17:02 UTC
Created attachment 132781 [details]
The tool-tip for the Formatting toolbar paragraph style drop list control

Attaching clips so the issue needing attention is clear. Image shows both the tool-tip from the .xcu and the extended tip from the .xhp

The role of the drop list is modal, it shows what is in use but also what would be applied. So believe either action verb is correct. I am neutral as long as it is consistent.

Or we could make it neutral and remove the action verb to read "Paragraph Style" as with the font and color controls--and the tool-tip/extended tool-tip could be adjusted for that. 

The "Set Paragraph Style" tool-tip was assigned in source with:

http://opengrok.libreoffice.org/xref/core/officecfg/registry/data/org/openoffice/Office/UI/WriterCommands.xcu#2889

While the extended tool-tip with the old "Apply Style" annotation is picked up from the .xhp Help articles noted.
Comment 6 V Stuart Foote 2017-04-24 13:34:46 UTC
Created attachment 132782 [details]
The tool-tip and Help articles for the Formatting toolbar paragraph style control
Comment 7 V Stuart Foote 2017-04-24 13:37:23 UTC
Created attachment 132783 [details]
The tool-tip and Help articles for the Formatting toolbar paragraph style control
Comment 8 Yousuf Philips (jay) (retired) 2017-04-25 16:46:32 UTC
(In reply to V Stuart Foote from comment #5)
> Or we could make it neutral and remove the action verb to read "Paragraph
> Style" as with the font and color controls--and the tool-tip/extended
> tool-tip could be adjusted for that. 

Stupid me, i think we must have had this discussion before as we changed it from "Apply Paragraph Style" in 5.1 to "Set Paragraph Style". Removing the verb would be a step back in my view, as i've been adding them to as many tooltips as possible.
Comment 9 Commit Notification 2017-12-17 00:33:03 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "libreoffice-6-0":

http://cgit.freedesktop.org/libreoffice/help/commit/?id=9b8cedbb0cb1b996c508eb9ae0635228ee919307&h=libreoffice-6-0

tdf#106421 Terminology change Set Paragraph Style
Comment 10 Commit Notification 2017-12-17 00:33:12 UTC
Olivier Hallot committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/help/commit/?id=f583ac513198a3aa70840f63aa26d766e5f9daf3

tdf#106421 Terminology change Set Paragraph Style