Bug 95405 (Sidebar-Find-and-Replace) - Sidebar deck for find/search and replace
Summary: Sidebar deck for find/search and replace
Status: ASSIGNED
Alias: Sidebar-Find-and-Replace
Product: LibreOffice
Classification: Unclassified
Component: UI (show other bugs)
Version:
(earliest affected)
Inherited From OOo
Hardware: All All
: high enhancement
Assignee: Khushi Gautam
URL:
Whiteboard:
Keywords:
: 45095 87998 96394 124634 147033 158422 (view as bug list)
Depends on:
Blocks: Find-Search Sidebar-New-Decks
  Show dependency treegraph
 
Reported: 2015-10-28 23:53 UTC by Björn Michaelsen
Modified: 2024-01-21 07:54 UTC (History)
26 users (show)

See Also:
Crash report or crash signature:


Attachments
search results in evince 3.16.1 (135.27 KB, image/png)
2015-10-28 23:53 UTC, Björn Michaelsen
Details
Find panel in MS Office (252.10 KB, image/png)
2016-03-09 19:24 UTC, Yousuf Philips (jay) (retired)
Details
Screenshot of string search window in OSX productivity apps (457.82 KB, image/png)
2016-03-11 09:39 UTC, Alex Thurgood
Details
Cog dropdown menu (search options) (59.01 KB, image/png)
2016-03-11 09:41 UTC, Alex Thurgood
Details
Find and replaec dialog (84.19 KB, image/png)
2016-03-18 15:22 UTC, Alex Thurgood
Details
Mockup (369.12 KB, image/png)
2023-01-24 08:45 UTC, Heiko Tietze
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Björn Michaelsen 2015-10-28 23:53:21 UTC
Created attachment 120066 [details]
search results in evince 3.16.1

Steps to reproduce:
1/ open writer, type dt<F3> to get some text
2/ Open menu Edit->Find and Replace

Expected result:
A workflow that allow interacting with the content (the text document) without a stolen focus and window popping up in from of the content.

Actual result:
A dialog pops up directly over the document that we want to edit/search/work on and steal the focus. As a bonus, this dialog has to be moved out of the way almost every time as it blocks the view to the document it operates on.

Suggested solution:
Make the whole search and replace dialog a deck in the sidebar, for a start just containing the controls of the current dialog. This would open by clicking the menu entry, but ensure the find and replace UI would not block the view on the document it operates on, neither needing to steal focus.

Optional further extensions:
Make the sidebar contain matches of the search below the controls as e.g. the PDF-viewer "evince" does. An example screenshot is attached.
Comment 1 Heiko Tietze 2015-10-29 00:04:36 UTC
Find (ctrl+F) is non-modal via toolbar. Find & Replace should work similar, maybe like the stacked/expanded input in Kate (https://docs.kde.org/trunk4/en/kde-runtime/fundamentals/find.html). Of course we could also move the search functionality completely into the sidebar, which would affect all components.
Comment 2 Cor Nouws 2015-10-29 07:37:07 UTC
Hi Björn,

I like this one with only one condition: that short cuts keep working as we know now.
Thanks!
Cot
Comment 3 Berk Gureken 2015-10-30 10:09:05 UTC
Are there any code pointers for this bug?
Comment 4 Björn Michaelsen 2015-10-31 03:10:31 UTC
Code Pointers:
The current Find and Replace Dialog is SvxSeachDialog in svx/source/dialog/srchdlg.cxx:
 http://docs.libreoffice.org/svx/html/classSvxSearchDialog.html

As for making an existing dialog into a sidebar panel, the navigator panel might give some orientation:
 http://opengrok.libreoffice.org/search?q=NavigatorPanel&project=core&defs=&refs=&path=&hist=
Comment 5 Robinson Tryon (qubit) 2015-12-14 05:00:13 UTC Comment hidden (obsolete)
Comment 6 Samuel Mehrbrodt (allotropia) 2016-02-02 16:00:07 UTC
*** Bug 96394 has been marked as a duplicate of this bug. ***
Comment 7 Robinson Tryon (qubit) 2016-02-18 14:51:21 UTC Comment hidden (obsolete)
Comment 8 Yousuf Philips (jay) (retired) 2016-02-24 01:30:22 UTC
So i do agree that we should have find & replace as a section in the sidebar, i dont think killing off the existing dialog is a good thing, especially for users who cant use the sidebar due to screen size limitations.
Comment 9 Steven Guo 2016-03-09 08:15:40 UTC
Just wondering if the following is a correct interpretation of the task:

1) Create find/replace section in sidebar.
2) Leave current find/replace dialogue in place.

Thanks!
Comment 10 Yousuf Philips (jay) (retired) 2016-03-09 08:33:45 UTC
Hi Steven,

Yes having the functionality in both places are ideal at the moment, so they both should be running off the same code, just like we have now for Navigator. The design team would need to work on a mockup for it.
Comment 11 Cor Nouws 2016-03-09 10:01:11 UTC
(this already was filed in issue 45095)
Comment 12 Cor Nouws 2016-03-09 10:01:58 UTC
*** Bug 45095 has been marked as a duplicate of this bug. ***
Comment 13 Yousuf Philips (jay) (retired) 2016-03-09 15:03:18 UTC
(In reply to Cor Nouws from comment #11)
> (this already was filed in issue 45095)

Wouldnt say docking the find and replace is equivalent to having a deck in the sidebar, but whatever. :D
Comment 14 V Stuart Foote 2016-03-09 15:26:51 UTC
(In reply to Yousuf (Jay) Philips from comment #10)
> Yes having the functionality in both places are ideal at the moment, so they
> both should be running off the same code, just like we have now for
> Navigator. The design team would need to work on a mockup for it.

Yes and the "at the moment" means that like the Navigator dialog (<F5>), the Find & Replace dialog (<Ctr>+H) will need to continue to be available independent of the Sidebar instance.  Unlike the old Styles & Formatting dialog (<F11>) that was bound into the Sidebar.

But this resolves with implementation of bug 85905 -- Allow undocking of Sidebar Decks. With that any of the Content panels could be detached to function as floating dialogs or be attached to additional docking points (as is done for independent Navigator dialog now).  An implementation issue, but functionally there would only be one of each Content panel set (as controlled from the Button bar) with multiple Deck containers to hold each as detached.

So for now, the task is implementing the Find & Replace .ui dialog into a Sidebar Content panel context. And providing it with the same handling as the independent Navigator Content panel.
Comment 15 Yousuf Philips (jay) (retired) 2016-03-09 19:24:59 UTC
Created attachment 123443 [details]
Find panel in MS Office

So here is a screenshot of the Find/Navigate panel in MS Word 2013, it is what you get when you click the find button in the ribbon, as the panel has limited find functionality, so they still retain the find/replace/goto dialog.

http://2.bp.blogspot.com/-I-3zFgVtWXU/UXkhWWCfZ9I/AAAAAAAABJ8/4savFViARIs/s1600/01-Find+&+Replace+Dialog+Box+with+Find+tab+selected.png
Comment 16 Alex Thurgood 2016-03-11 09:38:19 UTC
In Keynote, Pages and Numbers, the Search window appears floating over the document being edited, it never appears in the sidebar. See enclosed screenshot.
Comment 17 Alex Thurgood 2016-03-11 09:39:16 UTC
Created attachment 123488 [details]
Screenshot of string search window in OSX productivity apps
Comment 18 Alex Thurgood 2016-03-11 09:41:55 UTC
Created attachment 123489 [details]
Cog dropdown menu (search options)

As one can see from the screenshot, the search options are hidden in a dropdown menu to the left of the window
Comment 19 Alex Thurgood 2016-03-11 09:44:55 UTC
The OSX search dialog remembers the option last chosen when it is next opened. In other words, if the dialog was displayed as search and replace, it will do so again after dismissal and re-opening.
Comment 20 Alex Thurgood 2016-03-18 15:22:32 UTC
Created attachment 123694 [details]
Find and replaec dialog
Comment 21 Yousuf Philips (jay) (retired) 2016-03-22 13:36:24 UTC
*** Bug 87998 has been marked as a duplicate of this bug. ***
Comment 22 Heiko Tietze 2019-04-10 08:21:50 UTC
*** Bug 124634 has been marked as a duplicate of this bug. ***
Comment 23 Xisco Faulí 2020-03-09 13:28:38 UTC
Please add keyword 'needsUXEval' and CC 'libreoffice-ux-advise@lists.freedesktop.org' if input from UX is needed.
Comment 24 Heiko Tietze 2022-01-28 11:48:17 UTC
Interesting topic for GSoC.
Comment 25 Timur 2022-01-28 16:42:15 UTC
*** Bug 147033 has been marked as a duplicate of this bug. ***
Comment 26 Heiko Tietze 2023-01-24 08:45:36 UTC
Created attachment 184862 [details]
Mockup
Comment 27 Heiko Tietze 2023-01-24 08:55:37 UTC
To summarize the requirements:
a) move the "find all" functionality from the quickfind bar into a new sidebar deck
b) show some words before/after the reference
c) jump to the place on click
d) clearly identify the currently selected reference

Some questions remain open resp. needs discussion:
a) The ticket requests "find & replace" but I believe the competitors decided to have replacement functionality for good reasons in an extra dialog. My take here is to keep it simple and just replicate the quick find bar into a sidebar deck.
b) What happens if a words occurs multiple time in a range? We could show every single item (MSO does this) or summarize into one result (as shown in the mockup).
c and d) The current quickfind function highlights all places until one iterates over it via next/previous; MSO uses a different shading for the currently active result, the mockup has a frame in highlight color / blue around the find result.

a) The quickfind has the option to run a case sensitive search (and users asked repeatedly for more options). If we decide to add this option/s to the sidebar deck, it should remain simple. Could imagine a toggle button next to the search field.

The competitors allow to search for headings (limits the search to outlines), pages (shows thumbnail of pages where the item was found), and results. I think this is not needed.
Comment 28 V Stuart Foote 2023-01-24 16:10:54 UTC
@Jim, Samuel, Heiko -- using the SB framework would need to pick a target Deck to place a new Content panel for the "Quick find" results. 

So, place it into an existing SB Deck, or should this be a new "Search" Deck that would hold find related Content panels? Starting with a Content panel showing result of "Quick find" Find Bar as in attachment 184862 [details]

Regards layout on the content panel, would the "results" being shown be "clipped" from the document (with full styling/formatting) --or should result be more simple unformatted text runs for a cleaner UI?  Personally, I'd prefer no formatting.

And could the hyperlinking to the results be available to manipulate (e.g. turn a selected search result into a reference or a bookmark).

But also what would a content panel holding elements for the full "Find and Replace" dialog provide? Could the full dialog be eliminated? Or the Content panel would just show results?

Likewise, would this new SB work--Deck and Content Panel(s)-- to also enter and display find/search result for the HUD for the "Command search" (bug 91874 and bug 151228)
Comment 29 Jim Raykowski 2023-01-26 03:09:51 UTC
(In reply to Heiko Tietze from comment #27)
> b) What happens if a words occurs multiple time in a range? We could show
> every single item (MSO does this) or summarize into one result (as shown in
> the mockup).
Having individual listings for all finds would be better for context menu actions like the hyperlinks to results enhancement Stuart has suggested. 

> c and d) The current quickfind function highlights all places until one
> iterates over it via next/previous; MSO uses a different shading for the
> currently active result, the mockup has a frame in highlight color / blue
> around the find result.
Perhaps like what has been done for enhancement bug 152029, find results could have an inverted overlay if in the visible display area when the mouse is placed over entries in the content list. Navigating to an entry could be made to not clear all find selections as opposed to how the find bar clears the selections when stepping through results. 

> a) The quickfind has the option to run a case sensitive search (and users
> asked repeatedly for more options). If we decide to add this option/s to the
> sidebar deck, it should remain simple. Could imagine a toggle button next to
> the search field.
Check buttons could be placed under the search term input box like the find and replace dialog has for 'match case' and 'whole words only options'.

(In reply to V Stuart Foote from comment #28)
> So, place it into an existing SB Deck, or should this be a new "Search" Deck
> that would hold find related Content panels? Starting with a Content panel
> showing result of "Quick find" Find Bar as in attachment 184862 [details]
One deck that contains a quick find panel and find and replace panel seems like a good idea to me. Someday it might be possible for users to create custom decks with any panels they want to place in them ;-)

> Regards layout on the content panel, would the "results" being shown be
> "clipped" from the document (with full styling/formatting) --or should
> result be more simple unformatted text runs for a cleaner UI?  Personally,
> I'd prefer no formatting.
A checkbox for how to display results might work for this. 

> And could the hyperlinking to the results be available to manipulate (e.g.
> turn a selected search result into a reference or a bookmark).
If I'm following, this would be done through a context menu. Sounds like a nice enhancement.
 
> But also what would a content panel holding elements for the full "Find and
> Replace" dialog provide? Could the full dialog be eliminated? Or the Content
> panel would just show results?
The full find and replace dialog can be placed in the sidebar. Some ui changes could be done to make it more panel appropriate. The dialog version could be eliminated but it wouldn't be required to for the panel version to exist.   

> Likewise, would this new SB work--Deck and Content Panel(s)-- to also enter
> and display find/search result for the HUD for the "Command search" (bug
> 91874 and bug 151228)
Nice! I didn't know about the command search HUD. Seems like it would be appropriate as a panel in a find deck.
Comment 30 MoazAlaa 2023-03-19 21:23:42 UTC
Hi, I want to work on this bug as my GSoC project but i'm lacking some knowledge about how to implement the idea like how to make a dialog into a sidebar deck/panel. could you please provide some guidance ?                                       thanks.
Comment 31 Buovjaga 2023-03-20 06:45:57 UTC
(In reply to MoazAlaa from comment #30)
> Hi, I want to work on this bug as my GSoC project but i'm lacking some
> knowledge about how to implement the idea like how to make a dialog into a
> sidebar deck/panel. could you please provide some guidance ?                
> thanks.

Please contact the mentors listed on the ideas page. Before you contact them, however, do your research and in your email explain what you have learned and where you are stuck. Your current question is not in good style.
Comment 32 Stéphane Guillou (stragu) 2023-12-12 20:44:20 UTC
*** Bug 158422 has been marked as a duplicate of this bug. ***
Comment 33 Stéphane Guillou (stragu) 2023-12-12 20:57:09 UTC
Upping priority since there are 6 duplicates.
Comment 34 stephenboston 2023-12-12 23:03:42 UTC
(In reply to Heiko Tietze from comment #26)
> Created attachment 184862 [details]
> Mockup

As someone who prefers an uncluttered document space, I prefer a dialog solution. Some close sibling of the Navigator window would be perfect.