Difference between revisions of "Specification search toolbar"

From Apache OpenOffice Wiki
Jump to: navigation, search
Line 1: Line 1:
 
This page exists to implemente a search toolbar for OOo. (The specifications can be created using the [[Specification template]])
 
This page exists to implemente a search toolbar for OOo. (The specifications can be created using the [[Specification template]])
  
−
The Search tool bar is tool bar which will provider search quickly text feature(like firfox search toolbar), it includes searching text, backwards searching, forward searching, Match of lowercase  or uppercase, Match the Whole word and Closer button. It can be closed by mouse or pressing a Keyboard shortcut.
+
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.
 
Any discussion of the specification should happen in the maillist(discuss@ux.openoffice.org), or on the discussion pages.
Line 12: Line 12:
 
| Document - ID
 
| Document - ID
 
| Specification Owner
 
| Specification Owner
−
| Last Change
+
| Last Change - 2009-05-18
 
| Status
 
| Status
 
|-
 
|-
Line 42: Line 42:
  
 
=== Abstract ===
 
=== Abstract ===
−
The Search tool bar is tool bar which will provider search quickly text feature(like fireforx toolbar), it includes searching text, backwards searching, forward searching, Match of lowercase  or uppercase, Match the Whole word and Closer button. It can be closed by mouse or pressing a Keyboard shortcut.
+
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) ===
 
=== i-Team Members (The specification owner is part of the i-Team) ===
Line 126: Line 126:
  
 
== Motivation ==
 
== Motivation ==
−
The motivation for this feature is to enhance the speed of searching text ,and the search tool bar does not hid the content of the document.
+
The motivation for this feature is to enhance the speed of searching text, and to avoid a window hiding the content of the document.
  
 
== User Scenarios ==
 
== User Scenarios ==
−
In current OpenOffice.org ,users use the search dialog to search text, when the users want to see content which the search dialog hid, the uses have to move the search dialog via mouse,because the search dialog always display.
+
Currently OpenOffice.org users must use the search dialog to search text.  When the search dialog obscures the document content, the user must move the search dialog via the cursor.
  
 
== Goals ==
 
== Goals ==
−
The goal for OpenOffice.org 3.x is to provide a tool bar which gives uses the possibility to apply frequently uesed for searching text. The search tool bar will provide a simple, shortcut way to searching text, without the users not have to open the search dialog.
+
The goal for OpenOffice.org 3.x is to provide a tool bar which provides quick search functionality without obscuring user content, as an alternative (NOT a replacement) for the existing search dialog.
  
 
== Requirements and Dependencies ==
 
== Requirements and Dependencies ==
Line 140: Line 140:
  
 
=== Technical Dependencies ===
 
=== Technical Dependencies ===
−
Implementation of the search tool bar depend on these searching codes which the current search dialog is using the searching codes , but it has nothing to do with the search dialog.
+
Implementation of the search tool bar depend on these searching algorithms of the current search dialog. It won't  interfere with the search dialog.
  
 
== Competitive Analyses ==
 
== Competitive Analyses ==
 
=== Google Chrome Browser===
 
=== Google Chrome Browser===
−
The Google Chrome Search tool bar (Figure 1,marked by the redline). it is located on the below of  the address Tool bar and can't be moved. The Search tool bar can made visible by pressing Ctrl+F. The search toolbar is very simple , it only provide searching text and not match Match Case. It includes backwards searching , forwards searching text and count of the searching text. The Search tool bar organized into a number of buttons or lable which are arranged from the left to the right with it.
+
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.  
 
[[Image:Chrome_Browser_1.JPG]]
 
[[Image:Chrome_Browser_1.JPG]]
  
 
=== Mozilla Firefox Browser ===
 
=== Mozilla Firefox Browser ===
  
−
Mozillas Search Tool bar(Figure 2) , It is located at the above of the staus bar and can't be moved .The Search tool bar can made visible by pressing Ctrl+F.  
+
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.
−
The Search tool bar organized into a number of buttons which are arranged from the left to the right with it. The mouse can opterator any button and every button has states.
+
 
[[Image:Mozilla_browser_1.JPG]]
 
[[Image:Mozilla_browser_1.JPG]]
  
 
== Detailed Specification ==
 
== Detailed Specification ==
−
The OpenOffice Search Tool Bar(Figure3) shall be located at the above of the status bar. And it can't be moved.  It can made visible by pressing Ctrl+F1.  It is make up of the tool bar item , of course , these tool bar item  can be BUTTON_SYMBOLTEXT or BUTTON_SYMBOL.
+
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.
  
 
[[Image:SpecSearc_Toolbar1.JPG]]
 
[[Image:SpecSearc_Toolbar1.JPG]]
Line 229: Line 228:
 
|}
 
|}
  
−
The static text info only describe information to explain what the edit controller input. It name “Find”, it only is static text and showed in the searching tool bar. It should support multilingual property.
+
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. Input for searching TextField ===
+
=== 2. Search Text Field ===
  
 
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"
 
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"
Line 238: Line 237:
 
|-
 
|-
 
| '''Enabled:'''
 
| '''Enabled:'''
−
| during one of documents is opening
+
| When the search toolbar is enabled, it is always enabled
−
| these documents is only swriter,scalc,impress or drawing
+
 
|-
 
|-
 
| '''Disabled:'''
 
| '''Disabled:'''
Line 274: Line 272:
 
|}  
 
|}  
  
−
 
+
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.
−
 
+
−
The Edit Controller is TextField Controller, users can input searching text in the edit Text, and it always is showed in the searching tool bar. When users did not find searching text in current document, the edit text background color should be set gray which mean  not find searching text.
+
  
 
=== 3. "Next" Button ===
 
=== 3. "Next" Button ===
Line 285: Line 281:
 
|-
 
|-
 
| '''Enabled:'''
 
| '''Enabled:'''
−
| if there is any text content in the TextField Controller, it will be always enabled
+
| if there is any text in the Search Text Field
 
|
 
|
 
|-
 
|-
 
| '''Disabled:'''
 
| '''Disabled:'''
−
| if there is nothing text content in the TextField Controller, it will be disabled
+
| if there is no text in the Search Text Field
 
|
 
|
 
|-
 
|-
 
| '''On Click:'''
 
| '''On Click:'''
−
| find backward searching text in the current document
+
| Forward searches the current document for the search text
 
|  
 
|  
 
|-
 
|-
Line 305: Line 301:
 
|}  
 
|}  
  
−
The is a simple tool bar item with BUTTON_SYMBOLTEXT type. Users can use to find backward searching text in the current document. When the searching text is showed at end of the document, the The Dynamic Text Info2 will shown “ reached end of  document,continue form top” information.
+
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 ===
 
=== 4. "Previous" Button ===
Line 313: Line 309:
 
|-
 
|-
 
| '''Enabled:'''
 
| '''Enabled:'''
−
| if there is any text content in the 2.TextField Controller, it will be always enabled
+
| if there is any text in the Search Text Field
 
|
 
|
 
|-
 
|-
 
| '''Disabled:'''
 
| '''Disabled:'''
−
| if there is nothing text content in the 2.TextField Controller, it will be disabled
+
| if there is no text in the Search Text Field
 
|
 
|
 
|-
 
|-
 
| '''On Click:'''
 
| '''On Click:'''
−
| Find forwards searching text in the current document
+
| Backward searches the current document for the search text
 
|
 
|
 
|-
 
|-
Line 334: Line 330:
  
  
−
The is a simple tool bar item with BUTTON_SYMBOLTEXT type. Users can use to find forwards searching text in the current document. When the searching text is showed at top of the document, the The Dynamic Text Info2 will shown “ reached top of  document,continue form end” information.
+
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 ===
 
=== 5. "Search All" Button ===
Line 343: Line 339:
 
|-
 
|-
 
| '''Enabled:'''
 
| '''Enabled:'''
−
| if there is any text content in the TextField Controller, it will be always enabled
+
| if there is any text in the Search Text Field
 
|
 
|
 
|-
 
|-
 
| '''Disabled:'''
 
| '''Disabled:'''
−
| if there is nothing text content in the TextField Controller, it will be disabled
+
| if there is no text in the Search Text Field
 
|
 
|
 
|-
 
|-
 
| '''On Click:'''
 
| '''On Click:'''
−
| The all searching text will be shown hightlight and selected in the current document
+
| All instances of the search text, within the document, will be shown highlighted and selected
 
|
 
|
 
|-
 
|-
Line 364: Line 360:
  
  
−
The Button is a tool bar item with  BUTTON_SYMBOLTEXT type,when users click it, the searching text will be shown hightlight and selected. The “search all button” need not changed states.
+
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 ===
 
=== 6. "Match Case" CheckBox ===
Line 373: Line 369:
 
|-
 
|-
 
| '''Enabled:'''
 
| '''Enabled:'''
−
| During the search toolbar is open, it is always enabled
+
| When the search toolbar is enabled, it is always enabled
 
|
 
|
 
|-
 
|-
Line 385: Line 381:
 
|-
 
|-
 
| '''Checked:'''
 
| '''Checked:'''
−
| Searching text will match case to find in the current document
+
| Future text searches via the are case-sensitive
 
|
 
|
 
|-
 
|-
Line 398: Line 394:
  
  
−
The Match Case CheckBox is a check box button, after the check box is selected, searching text will match case to find in the current document, when searching text may not exist, The Dynamic Text Info2 will shown “ phrase not found” information.
+
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===
 
=== 7. "Whole Word" CheckBox===
Line 407: Line 403:
 
|-
 
|-
 
| '''Enabled:'''
 
| '''Enabled:'''
−
| During the searching toolbar is opening. it is always enabled
+
| When the search toolbar is enabled, it is always enabled
 
|
 
|
 
|-
 
|-
Line 432: Line 428:
  
  
−
The Whole Word Cis a check box button, after it is selected , searching text will match the whole word to find in the current document. When the whole word searching text not exist , he Dynamic Text Info2 will shown “ phrase not found” information.
+
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 ===
 
=== 8. "Count information" Label ===

Revision as of 22:29, 18 May 2009

This page exists to implemente 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.


Search toolbar

Swriter Scalc Impress Drawing

Document - ID Specification Owner Last Change - 2009-05-18 Status
Shizhoubo 2009-04-22 Draft
Conforms to
Applies to Swriter, Scalc, Impress, Drawing
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),Philip Ganchev(Philip) jaronbaron@gmail.com, phil.ganchev@gmail.com
Development shizhoubo(robertzhou) shizhoubo@redoffice.com
Quality Assurance Li Meiying,Zhu Lihua limeiying@redoffice.com,zhulihua@redoffice.com
Documentation shizhoubo(robertzhou) shizhoubo@redoffice.com

Approved for Implementation

Approved by Date
User Experience <Name> <Date>
Development <Name> <Date>
Quality Assurance <Name> <Date>
Documentation <Name> <Date>
String Review <Name> <Date>

Document Change History

Rev. Level Change Initials Date
1.0 initial version 2009-04-23

Glossary

Term Description

Motivation

The motivation for this feature is to enhance the speed of searching text, and to avoid a window hiding the content of the document.

User Scenarios

Currently OpenOffice.org users must use the search dialog to search text. When the search dialog obscures the document content, the user must move the search dialog via the cursor.

Goals

The goal for OpenOffice.org 3.x is to provide a tool bar which provides quick search functionality without obscuring user content, as an alternative (NOT a replacement) for the existing search dialog.

Requirements and Dependencies

Requirements

Provide a tool bar which gives users the possibility to apply frequently used commands without the opening search dialog.

Technical Dependencies

Implementation of the search tool bar depend on these searching algorithms of the current search dialog. It won't interfere with the search 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. Chrome Browser 1.JPG

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. Mozilla browser 1.JPG

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.

File:SpecSearc Toolbar1.JPG

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 ---
Retrieved from "https://wiki.openoffice.org/w/index.php?title=Specification_search_toolbar&oldid=127997"
Personal tools