Bug 152022 - Improve Help Online (main0102.xhp)
Summary: Improve Help Online (main0102.xhp)
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
7.5.0.0 alpha0+
Hardware: All All
: medium normal
Assignee: BogdanB
URL:
Whiteboard: target:7.5.0 target:7.6.0 target:7.5....
Keywords:
Depends on:
Blocks: Help
  Show dependency treegraph
 
Reported: 2022-11-13 14:17 UTC by BogdanB
Modified: 2022-12-12 19: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 BogdanB 2022-11-13 14:17:54 UTC
Description:
See https://help.libreoffice.org/latest/en-US/text/swriter/main0102.html

#1 Hyperlink needs to move above Reference, according to the order in Writer

#2 Selection Mode description: “Choose the selection mode from the submenu: normal selection mode, or block selection mode.” -> “Choose the selection mode from the submenu: standard selection mode, or block selection mode.” In Writer is “standard”, there is no “normal selection mode”. 

#3 Description of Hyperlink: “Opens a dialog that enables you to create and edit hyperlinks.” -> “Opens a dialog that enables you to edit hyperlinks.” I didn’t succeeded to create a hyperlink using this menu. Also, this menu is in Edit, not in Insert.

#4 Links to External Files: In Writer when we have the option “Break Link”, in Help is “remove link”. I consider “break” is correct, because is breaking the conection to the external file. “You can change or remove each link to external files in the current document. ” -> “You can change or break each link to the external files in the current document.”.

#5 Object is going to Ole Object, also is named in Writer OLE Object. I would change it to Object OLE. I don’t know if I need to change also the name of the link or just the text <link href="text/shared/01/02200000.xhp" name="Object">Object</link>

#6 Reference: is going to home page (wrong link). The reference here exists: text/swriter/01/edit_reference_submenu.xhp#edit_reference_head. I don’t know why it is not working. The page for Reference exists: https://help.libreoffice.org/latest/en-US/text/swriter/01/edit_reference_submenu.html 
Is the page Reference missing a <variable id="edit_reference_head">?

#7 Go to Page: no link, see if there is a page to go to, otherwise should be created.

#8 Comment: no link, see if there is a page to go to, otherwise should be created.

#9 “Select Text” is going to “Edit Mode” link; the description is ok, just the link is wrong; on the same page the last menu is Edit mode which is going also to Edit mode (the link for the first one need to be changed). It seems there is no reference for this option, should be created.

#10 Fields: is going to Edit Fields, in Writer is Fields. Should stay the same to see that is about Edit - Fields, or should be renamed to Fields?

#11 Links to External Files is going to Edit Links to External Files, which is named in Writer: External Links. I don’t know what should be changed here… Links are not external, files are external. So, the menu inside Writer should be changed.

Steps to Reproduce:
-

Actual Results:
-

Expected Results:
-


Reproducible: Always


User Profile Reset: No

Additional Info:
-
Comment 1 BogdanB 2022-11-13 14:39:26 UTC
#1 - #5 are in gerrit. #6 - #11 are open for anyone or I need help for implementing them.
Comment 2 BogdanB 2022-11-13 21:49:35 UTC
#6 now in gerrit
Comment 3 Commit Notification 2022-11-14 13:20:05 UTC
Bogdan B committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/06746717a526ff5a0b0e807c06c321e8b66ae154

tdf#152022 Correct a link for a Edit submenu
Comment 4 Commit Notification 2022-11-14 13:29:16 UTC
Bogdan B committed a patch related to this issue.
It has been pushed to "master":

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

tdf#152022 Improve Edit page for Help Online
Comment 5 Olivier Hallot 2022-11-14 14:25:44 UTC
#7 is in 2 parts:
1) The dialog needs a Help button (mostly to comply with HIG.
2) The page must be created in swriter/01/...



#8
https://help.libreoffice.org/master/en-US/text/shared/01/04050000.html?&DbPAR=CALC&System=UNIX

and the page depends on DbPAR=[WRITER CALC IMPRESS]

#9 

#10 No need to change that.

#11 Changes in UI must be approved by the UX team.
Comment 6 BogdanB 2022-11-14 18:47:15 UTC
UX Team, please analize just this point: #11
-----
#11 In Help online on Edit Menu page we have "Links to External Files" which is going to hte page "Edit Links to External Files". In Writer this option from Edit is "External Links". 

I don’t know what should be changed here… Links are not external, files are external. So, the menu inside Writer should be changed, in my opinion.

Waiting for your answer.

https://help.libreoffice.org/latest/en-US/text/swriter/main0102.html
-----
Comment 7 Heiko Tietze 2022-11-15 08:39:46 UTC
Bug 139735 renamed "Link to External Data..." to "External Links" and is still open to adjust the help content, IIUC.

Please also check this whole bug against bug 137084.
Comment 8 BogdanB 2022-11-15 16:18:43 UTC
(In reply to Heiko Tietze from comment #7)
> Bug 139735 renamed "Link to External Data..." to "External Links" and is
> still open to adjust the help content, IIUC.
> 
> Please also check this whole bug against bug 137084.

If thinks were decided like that, I will change the Help according to Writer text.
Comment 9 Commit Notification 2022-11-16 14:14:00 UTC
Bogdan B committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/98d79c65383a3cf1b9966a46896b36d404235c08

tdf#152022 Replace "Links to External Files" to "External Links" (Help)
Comment 10 BogdanB 2022-11-16 15:56:40 UTC
This are the items from this bug that still need to be solved. All others are solved.

https://help.libreoffice.org/latest/en-US/text/swriter/main0102.html

#7 If we click on "Go to Page" there is no link. We need to see if there is a page to go for this option, otherwise should be created.

#8 If we click on "Comment" there is no link. We need to see if there is a page to go for this option, otherwise should be created.

#9 The link from “Select Text” is going to “Edit Mode” page; the description is ok, just the link is wrong; on the same page the last menu is "Edit mode" which is going also to "Edit mode" page. The link for the first one need to be changed. It seems there is no reference for this option, should be created.
Comment 11 BogdanB 2022-11-18 17:03:23 UTC
-------
#7 If we click on "Go to Page" there is no link. We need to see if there is a page to go for this option, otherwise should be created.
-------
About #7 I have searched and there is no page to go to, but also I don't consider it deserve a special page because the text there is very clear and the user have enough info about this aspect.
--> so, I would close this point

-------
#8 If we click on "Comment" there is no link. We need to see if there is a page to go for this option, otherwise should be created.
-------
The subject Comments is very complex, but this menu is allowing just to reply, resolve and delete existing comments. That it self explanatory. So, I consider here just to improve the text. I tested all the options and the first one "Reply Comment" is active JUST when the comment is NOT from the current user. Maybe for others is very clear that reply is to someone else but things could be improved, like:

BEFORE:
Shows submenu that gives options to reply, resolve and delete comments.
AFTER:
Shows submenu that gives options to reply to comments from other users, resolve and delete comments.
Comment 12 BogdanB 2022-11-18 17:24:30 UTC
------
#9 The link from “Select Text” is going to “Edit Mode” page; the description is ok, just the link is wrong; on the same page the last menu is "Edit mode" which is going also to "Edit mode" page. The link for the first one need to be changed. It seems there is no reference for this option, should be created.
-------

About this problem, let’s take one by one.
The link where this two menus go is text/shared/02/07070000.xhp.
The explanation here is about Edit – Select Text, but the title/short description/image is about Edit Mode.

From my point of view:
-  text/shared/02/07070000 is about Edit – Select Text, and NOT about Edit – Edit Mode, so the first part of the page should be changed
- the Edit mode link should be removed and keep it just as text and the description to be improved to explain when is this command active
- if the page text/shared/02/07070000 would be changed to Select Text, the Select link and description are perfect and there shold be no change
Comment 13 BogdanB 2022-12-07 16:30:29 UTC
Changes for #8 and #9 are in gerrit now.
Comment 14 Commit Notification 2022-12-07 18:54:06 UTC
Bogdan B committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/8961270e4ca006146883b00c3847d88eaa5a91f9

tdf#152022 Improve comments description in Help
Comment 15 Commit Notification 2022-12-12 17:36:22 UTC
Bogdan B committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/0743da9a51f1d7733f436d0144e35e8536e56583

tdf#152022 Improve Select Text and Edit Mode
Comment 16 Commit Notification 2022-12-12 17:38:25 UTC
Bogdan B committed a patch related to this issue.
It has been pushed to "libreoffice-7-5":

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

tdf#152022 Improve Select Text and Edit Mode