Bug 121601 - [NEWHELP] Sort content and result of index search in Online Help
Summary: [NEWHELP] Sort content and result of index search in Online Help
Status: RESOLVED WORKSFORME
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
Version:
(earliest affected)
6.2.0.0.beta1+
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: New-Help
  Show dependency treegraph
 
Reported: 2018-11-21 17:24 UTC by Jan-Marek Glogowski
Modified: 2024-05-28 14:20 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 Jan-Marek Glogowski 2018-11-21 17:24:51 UTC
Out of curiosity when reading the backlog of #libreoffice-doc, I had a look at the current state of the LO online help @ https://help.libreoffice.org/6.2/en-US/text/shared/05/new_help.html

1st impression was: looks really nice.
2nd was: why isn't neither the index nor the contents somehow sorted?

It seems that contents subtrees always start with a "General Information" entry, which is nice and should be preserved, even when the rest of it becomes sorted IMHO. I guess nobody searches for "general information" (there is currently one hit: "forms -- general information (Base)", FWIW).

And while at it add the outline of the content to the index.

Curious side fact: search for "label" in "Writer" I get some hits, just nothing looks like "Creating and Printing Labels and Business Cards. Actually I get more hits when I search for "labels" then "label", including some tables?!
Comment 1 Buovjaga 2019-01-05 10:38:12 UTC
We will see, how it goes after sorting the bookmarks, but the sorting of the search results comes from the decision of https://github.com/farzher/fuzzysort
Comment 2 Rafael Lima 2021-09-22 12:45:50 UTC
Hi! I ran a few tests today and the behavior originally reported is still present.

Searching for "label" returns a very different set of results than "labels". It seems the search algorithm considers the possibility of "s" belonging to a different word. For example, with "lables" one of the results are "label ranges in sheets" where "s" in "sheets" is marked as a result (bold).

Another problem with bookmark search is that it should prioritize the selected module. For example, if I select "Writer" in the "Module" drop-down list and then search for "labels", I don't see any results because they are probably at the last position. So if the user wants to see only Writer results, he/she will no be able to achieve that.

There is also another problem with bookmarks... the results are not consistent with the module they're associated with. For example, search for "tables" and one of the results will be "tables -- freezing" under Writer. However, if you position the mouse over the link, you'll see that it is linking to a Calc help page. This is just one example, but this problem happens very often.

I guess it assumes that because the page is in the "scalc" folder, then the link is targeted at Calc. But because of all <embeds> used to reuse text, this is very often not the case.
Comment 3 Buovjaga 2021-09-22 12:48:05 UTC
Btw. I'd like to switch from fuzzysearch to https://github.com/nextapps-de/flexsearch/ at some point. I already use it in the libreoffice.org prototype.
Comment 4 Rafael Lima 2021-09-22 18:21:04 UTC
(In reply to Buovjaga from comment #3)
> Btw. I'd like to switch from fuzzysearch to
> https://github.com/nextapps-de/flexsearch/ at some point. I already use it
> in the libreoffice.org prototype.

The search mechanism is only part of the problem. I believe there is some issues with how bookmarks are grouped.

Recently there was a patch that tried to fix grouping:
https://gerrit.libreoffice.org/c/help/+/122312

But it revealed some other issues. See bug 123506 comment #6 for a discussion on this topic.