Specification search toolbar
This page is the current design of a search toolbar for OOo. (The specifications can be created using the Specification template)
The Search tool bar is a tool bar which will provide quick text searching. It includes highlighting all search occurrences, backwards searching, forward searching, case-matching, whole word matching, and a close button. It can be closed via the close button or by pressing a keyboard shortcut.
Any discussion of the specification should happen in the maillist(discuss@ux.openoffice.org), or on the discussion pages.
Contents
- 1 Search toolbar
- 2 Writer
- 2.1 Abstract
- 2.2 i-Team Members (The specification owner is part of the i-Team)
- 2.3 Approved for Implementation
- 2.4 Document Change History
- 2.5 Glossary
- 2.6 Motivation
- 2.7 User Scenarios
- 2.8 Goals
- 2.9 Requirements and Dependencies
- 2.10 Competitive Analyses
- 2.11 Detailed Specification
- 2.12 Future Tasks
- 2.13 Notes
- 2.14 References
- 3 Time schedule
Search toolbar
Writer
| Document - ID | Specification Owner | Last Change - 2009-10-09 | Status |
| Carsten Driesner / Stefan Baltzer | 2009-09-10 | Late draft | |
| Conforms to | |||
| Applies to | Writer | ||
| Task ID(s) | None | ||
| Category | Feature |
Abstract
The Search tool bar is a tool bar which will provide quick text searching. It includes highlighting all search occurrences, backwards searching, forward searching, case-matching, whole word matching, and a close button. It can be closed via the close button or by pressing a Keyboard shortcut.
i-Team Members (The specification owner is part of the i-Team)
| Name | E-mail Address | |
| User Experience | Jaron Kuppers (Jaron) | jaronbaron@gmail.com |
| Development | shizhoubo(robertzhou),Carsten Driesner | robertzhou@openoffice.org, cd@openoffice.org |
| Quality Assurance | Li Meiying,Zhu Lihua,Stefan Baltzer | limeiying@redoffice.com,zhulihua@redoffice.com,sba@openoffice.org |
| Documentation |
Approved for Implementation
| Approved by | Date | |
| User Experience | <Name> | <Date> |
| Development | Carsten Driesner | 2009-10-09 |
| Quality Assurance | Stefan Baltzer | 2009-10-09 |
| Documentation | <Name> | <Date> |
| String Review | <Name> | <Date> |
Document Change History
| Rev. Level | Change | Initials | Date |
| 1.0 | First incomplete version | 2009-04-23 | |
| 1.1 | Initial specification draft | JK | 2009-07-23 |
| 1.2 | Edit | SBA | 2009-09-14 |
| 1.3 | Edit | SBA+CD | 2009-10-08 |
Glossary
| Term | Description |
| Search Tool bar | The Search Tool bar is a locked bar (similar to the status bar) and resides above the status bar |
| Title Label | It describes what the search action is, in this case essentially “find” |
| Search text field | A text field where users input the string that will be searched within the document |
| Search text | The text entered in the search text field |
| Next Button | A button which executes searching forward through the document |
| Previous Button | A button which executes searching backward through the document |
| Search All Button | A radio button which searches all the content of the document and highlights the search text |
| Match Case Check Box | A check box that makes text searches case-sensitive |
| Whole Words Check Box | A check box that matches the search text to entire words within the document (aka the search text must match delimited strings) |
| Dynamic Text Info | A text label that gives different text information about the current search status |
Motivation
The motivation for this feature is to enhance the speed of searching text and to avoid a dialog window hiding the content of the document.
User Scenarios
Currently OpenOffice.org users must use the "Find & Replace" dialog to search text. When this dialog obscures the document content, the user must move it away with the mouse.
Goals
The goal for OpenOffice.org 3.x is to provide a tool bar which will provide quick text searching without hiding document content. It shall include forward and backwards searching, highlighting all search occurrences, case matching and whole word match
Requirements and Dependencies
Requirements
Provide a tool bar which gives users the possibility to apply frequently used search commands without using the Find & Replace dialog.
Technical Dependencies
Implementation of the search tool bar depends on the default search algorithms of the current Find & Replace dialog. It won't interfere with that dialog.
Competitive Analyses
Google Chrome Browser
The Google Chrome Search tool bar (Figure 1) is located below the address tool bar and can't be moved. The search tool bar can made visible by pressing Ctrl+F. It is very simple and only provides text searching and no case matching or whole word matching functionality. It includes backward and forward searching and a count of the found search text. The Search tool bar is organized into a number of buttons or labels which are horizontally arranged.
Mozilla Firefox Browser
Mozilla's Search Tool bar (Figure 2) is located above the status bar and can't be moved. The Search tool bar can be made visible by pressing Ctrl+F. It is is organized into a number of buttons which are arranged horizontally. The mouse can be used to click the buttons and every button has a state.
Detailed Specification
The OpenOffice Search Tool Bar (Figure3) shall be located above the status bar and will be immovable. It can made visible by pressing Ctrl+F1. It contains the common tool bar items including BUTTON_SYMBOLTEXT or BUTTON_SYMBOL.
| Property | State | Comment |
| Toolbar Name: | Search toolbar | |
| 搜索工具栏 | ||
| Has Closer: | No | |
| Style: | Icon/Text | |
| Initial State: | Docked | |
| Initial Docking Position: | Bottom, above the status bar | |
| Initial Floating Position: | None | |
| List in "View/Toolbars": | Yes | |
| Is Context Sensitive: | No | |
| Toolbar Items: | ||
| Item Name: | <EN-US> | |
| <Other Language (Optional)> | ||
| Item Icon: | <Link to Image here> | |
| Action: | <Specify action here. E.g. Finding> | |
| Other Properties: | <Specify properties here> | |
1. "Find" Label
| Property | Label | Comment |
| Label: | Find | EN-US |
The static text info only describes what the purpose of the tool bar is and what should be entered into the Search Text Field. The static text label is “Find.” It should support multilingual properties.
2. Search Text Field
| Property | State | Comment |
| Enabled: | When the search toolbar is enabled, it is always enabled | |
| Disabled: | None | |
| Read Only: | No | |
| Initial String: | Blank space string | |
| String Preselected: | Yes | |
| Caret Position: | <0> | |
| Characters Not Allowed | None | |
| Echo characters (Password Field) | None | |
| TextField Label: | <EN-US> | Here is "Find" label |
The Search Text Field is a text box where users input their search text string. If the search text does not match any strings in the document as defined by the search criteria, the text box background color should be set to gray as shown (circled) in the following figure.
3. "Next" Button
| Property | State | Comment |
| Enabled: | if there is any text in the Search Text Field | |
| Disabled: | if there is no text in the Search Text Field | |
| On Click: | Forward searches the current document for the search text | |
| Other: | None | |
| Button Label: | <EN-US> |
The is a simple tool bar item with BUTTON_SYMBOLTEXT type. When triggered, the button forward searches the current document for the search text. To inform the user that the last instance of search text within the document is found, the Dynamic Text Info2 changes to “reached end of document, continue from top” as shown (circled) in the following figure.
4. "Previous" Button
| Property | State | Comment |
| Enabled: | if there is any text in the Search Text Field | |
| Disabled: | if there is no text in the Search Text Field | |
| On Click: | Backward searches the current document for the search text | |
| Other: | None | |
| Button Label: | <EN-US> |
The is a simple tool bar item with BUTTON_SYMBOLTEXT type. When triggered, the button backward searches the current document for the search text. To inform the user that the last instance of search text within the document is found, the Dynamic Text Info2 changes to “reached end of document, continue from end” as shown (circled) in the following figure.
5. "Search All" Button
| Property | State | Comment |
| Enabled: | if there is any text in the Search Text Field | |
| Disabled: | if there is no text in the Search Text Field | |
| On Click: | All instances of the search text, within the document, will be shown highlighted and selected | |
| Other: | None | |
| Button Label: | <EN-US> |
The Button is a tool bar item with BUTTON_SYMBOLTEXT type. When triggered, all instances of the search text, within the document, will be shown highlighted and selected (as demonstrated in Figure 7). The “search all button” will not need to change states.
6. "Match Case" CheckBox
| Property | State | Comment |
| Enabled: | When the search toolbar is enabled, it is always enabled | |
| Disabled: | None | |
| Tristate: | ||
| Checked: | Future text searches via the are case-sensitive | |
| Other: | None | |
| CheckBox Label: | <EN-US> |
The Match Case Check Box is a check box button. When the check box is in a true state, text searches are case-sensitive. If no instance of the search text exists in the document, the Dynamic Text Info2 will show “phrase not found” as shown (circled) in the following figure.
7. "Whole Word" CheckBox
| Property | State | Comment |
| Enabled: | When the search toolbar is enabled, it is always enabled | |
| Disabled: | None | |
| Tristate: | None | |
| Checked: | searching text will match the whole word to find in the current document. | |
| Other: | None | |
| CheckBox Label: | <EN-US> |
The Whole Word Button is a check box button. When the check box is in a true state, text searches match the search text to delimited strings, as opposed to any occurrence of the search text string. If no instance of the search text exists in the document, the Dynamic Text Info2 will show “phrase not found” as shown (circled) in the following figure.
8. "Count information" Label
| Property | Label | Comment |
| Label: | Show count information of the searching text in the current document | <Comment> |
The "Count Message" label is a dynamic string, is show information which means to show count of searching text in the current documents. When user use only “Search all” to find string, the "Count information" Label will be shown , and tell user count of the searching text in the current document.
9. "feedback" Label
| Property | Label | Comment |
| Label: | None, it is dynamic stirng, it show different message according to result of searching text |
The feedback is a dynamic string, is show information which remain following informations to users. “phrase not found “, “ reached top of document,continue form end”, “reached end of document,continue form top” . What the dynamic text is depend to result of searching text.
But the 9."feedback " Label and 8."Count information" Label would support multilingual property.
Close Button
The is tool bar item with only BUTTON_SYMBOL type, it can close the search tool bar.
Future Tasks
None at this time.
Notes
None
References
The current searching dialog in the OOo. The search toolbar of the Mozilla firefox.
Time schedule
| Milestone | Goal | Planned | Achieved |
|---|---|---|---|
| 1 | First specification ready | 31.05.2009 | --- |
