Bug 156273 - Add a "Navigate by" Help page for .uno:NavElement
Summary: Add a "Navigate by" Help page for .uno:NavElement
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
24.2.0.0 alpha0+
Hardware: All All
: medium enhancement
Assignee: Stéphane Guillou (stragu)
URL:
Whiteboard: target:24.8.0
Keywords:
Depends on:
Blocks: HelpGaps-NewFeatures Navigate-By
  Show dependency treegraph
 
Reported: 2023-07-13 14:48 UTC by sdc.blanco
Modified: 2024-04-25 23:19 UTC (History)
4 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 2023-07-13 14:48:45 UTC
.uno:NavElement appears in Navigator as a combobox labeled "Navigate By" (in the Navigator Panel at the top).  It is also available (but hidden by default) in the Find bar.

Pressing F1 in the combobox (in Navigator) provides the Navigator help page, where "Navigate By" is explained.

Many items in the combobox should probably be explained such as "Recency" (bug 155882) but also "Field by type", "Selection", "Wrong table formula" etc.    

Enhancement proposal is to make a new separate page for "Navigate By" that is associated with .uno:NavElement  (see also bug 155883), and to explain the meaning of the different options in "Navigate By"

Also add link from the "Navigate By" entry in Navigator (https://help.libreoffice.org/24.2/en-US/text/swriter/01/02110000.html) to this new page.
Comment 1 Stéphane Guillou (stragu) 2023-07-14 00:02:54 UTC
The closest help page we have is this one: https://help.libreoffice.org/7.5/en-US/text/swriter/01/02110100.html
But it obviously needs quite a bit of updating. Would recycling this one do, Seth?

Other related help pages:
- https://help.libreoffice.org/7.5/en-US/text/shared/guide/navigator.html
- https://help.libreoffice.org/7.5/en-US/text/shared/guide/navigator_setcursor.html
- https://help.libreoffice.org/7.5/en-US/text/swriter/navigate_toolbar.html
Comment 2 sdc.blanco 2023-07-15 09:53:37 UTC
(In reply to Stéphane Guillou (stragu) from comment #1)
> The closest help page we have ... obviously needs quite a bit of updating.
> Would recycling this one do,
If the question is: should this request by addressed on the "Navigator" help page (swriter/01/02110100), then I would say "no" for two reasons:

1. The .uno:NavElement also appears (hidden) on the Find toolbar (and in principle, could be customised to any toolbar), where it would be appropriate to link to a (new) help page for "Navigate By" alone. (It would be confusing then to have its help page linked to "Navigator").

2. There are many items in the "Navigate By" combobox, and it seems less optimal to add so many more items to the "Navigator" page, which already has many items, and more optimal to have one page with the many different items.
Comment 3 Stéphane Guillou (stragu) 2023-07-17 13:04:20 UTC
(In reply to sdc.blanco from comment #2)
> (In reply to Stéphane Guillou (stragu) from comment #1)
> > The closest help page we have ... obviously needs quite a bit of updating.
> > Would recycling this one do,
> If the question is: should this request by addressed on the "Navigator" help
> page (swriter/01/02110100), then I would say "no" for two reasons:

Seth, correct me if I'm wrong but I think you are still referring to the "Navigat_or_" page (swriter/01/02110000) used for the full Navigator sidebar/window, whereas I'm referring to the "Navigat_ion_" help page (swriter/01/02110100), which is shorter and refers to the Navigation button that was replaced by the Navigate By dropdown in 7.0.

Can you have another look?
Comment 4 sdc.blanco 2023-07-17 14:06:23 UTC
(In reply to Stéphane Guillou (stragu) from comment #3)
> Can you have another look?
Your analysis is correct.  I was referring to the full "Navigator" page because (a) there is a "Navigate By" control there, and (b) this is the page that F1 provides from the panel in Navigator.

But to address the "Navigation" page (swriter/01/02110100), I observe:

1. I guess this page is supposed to be the help for the Navigation toolbar (was hard to tell). (fwiw, I opened that toolbar and tried with F1, but no luck, so filed bug 156332).

2. I can follow your idea that the various options in the "Navigate By" combobox could be explained on the Navigation page (given that they are already mentioned there).  

Alternatively, the "Navigation" toolbar does not have "Navigate by", while it does appear (hidden) in the "Find" toolbar.  "Navigate by" is not mentioned in the help for Find [1], but maybe that material should be moved there?

3. In either case, it seems like a "Navigate By" heading should appear explicitly, because that is the name used in the Tools - Customize (for .uno:NavElement).

4. The list of objects that can be navigated needs to be updated (and explained better in some cases).

5. The first sentence (on the Navigation page) refers to an icon (but it is not clear where it is located, probably this icon should be added to this help page).

6.  Maybe additional improvements are appropriate on the "Navigation" page, have not inspected closely.


[1]https://help.libreoffice.org/24.2/en-US/text/shared/find_toolbar.html
Comment 5 Stéphane Guillou (stragu) 2024-04-17 05:40:46 UTC
I am looking into it now.
See also my bug 115673 comment 1.

(In reply to sdc.blanco from comment #4)
> 1. I guess this page is supposed to be the help for the Navigation toolbar
> (was hard to tell). (fwiw, I opened that toolbar and tried with F1, but no
> luck, so filed bug 156332).
The Navigation toolbar holds different commands, namely .uno:NavigateBack and .uno:NavigateForward to navigate the cursor position history, and its corresponding help page is /text/swriter/navigate_toolbar.xhp
I have reopened bug 156332 so we can correct that link. 

> 2. I can follow your idea that the various options in the "Navigate By"
> combobox could be explained on the Navigation page (given that they are
> already mentioned there).
There's enough quirks to it to have that dedicated separate page, e.g. the Repeat Search tool (documented) and the addition of Recency for bug 115817 (not documented).

> Alternatively, the "Navigation" toolbar does not have "Navigate by",
see above
> while
> it does appear (hidden) in the "Find" toolbar.
since 7.1 with your commit for bug 129471
> "Navigate by" is not
> mentioned in the help for Find, but maybe that material should be moved
> there?
As it's hidden by default, I wouldn't prioritise that.

> 3. In either case, it seems like a "Navigate By" heading should appear
> explicitly, because that is the name used in the Tools - Customize (for
> .uno:NavElement).
Agreed, I am changing it in the help page.
 
> 4. The list of objects that can be navigated needs to be updated (and
> explained better in some cases).
Agreed. Might need a follow-up commit to the one I'm working on.

> 5. The first sentence (on the Navigation page) refers to an icon (but it is
> not clear where it is located, probably this icon should be added to this
> help page).
It was changed from an icon to a listbox (and relabelled from "Navigation" to "Navigate By") in 7.0.

> 6.  Maybe additional improvements are appropriate on the "Navigation" page,
> have not inspected closely.
Certainly, e.g. the mention of the button in "lower right of the document window" - that scrollbar button is long gone.
Comment 6 Stéphane Guillou (stragu) 2024-04-18 03:55:51 UTC
Proposed patch in https://gerrit.libreoffice.org/c/help/+/166096

After looking into it, I realise that the Navigator _does_ use .uno:NavigateBack and .uno:NavigateForward (as in the "Navigation" toolbar) _when Recency is selected (the controls change, just like when it changes to a numeric control when Page is selected).
So the two are more linked than I realised.

In any case, my proposed change to text/swriter/01/02110100 goes in the direction of a help page for "the Navigate By tool when used in the Navigator".
Comments welcome.
Comment 7 Commit Notification 2024-04-25 16:13:59 UTC
Stéphane Guillou committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/help/commit/686da2a7ece1ce03db28cfba2747870c88a9ca2e

tdf#156273 tdf#155882 update Navigate By documentation