suzanne.soy/SearchBar
1
0
Fork 0
Code Issues 20 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

README text around animations

Browse Source
This commit is contained in:
Suzanne Soy 2022-03-13 23:37:46 +00:00
parent 62061af89c
commit d13ae55211
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -16,7 +16,19 @@ The search bar appears next to the [`What's this?`](https://wiki.freecad.org/Std
![Screenshot of the search bar, with results in its drop-down menu and extra info about the result in a separate pane](screenshot.png) ![Screenshot of the search bar, with results in its drop-down menu and extra info about the result in a separate pane](screenshot.png)
When using the search bar for the first time, it will contain only the tools of the workbenches which have already been loaded in FreeCAD.
To include results from other workbenches, select the first search result "Refresh list of tools" which will load all FreeCAD workbenches
and memorize their tools. After restarting FreeCAD, the search result will include the memorized tools, even if the workbenches have not
been loaded yet. When selecting a tool from the search results, SearchBar will attempt to automatically load the workbenches which could
have provided that tool.
![Animation showing how to initially load all workbenches using the first entry in the search bar](animAopt.gif) ![Animation showing how to initially load all workbenches using the first entry in the search bar](animAopt.gif)
To navigate the search results, use the up and down arrows. Typing characters will filter the results on the fly. The extended information
panel next to the search results provides further documentation about the results, e.g. Python snippets which can be copy-pasted (note:
currently a bug crashes FreeCAD if using the context menu to perform the copy, please do not use the context menu until
https://github.com/SuzanneSoy/SearchBar/issues/12 is fixed.
![Animation showing how to navigate the search results with the up and down keys and select code examples from the results](animB2op.gif) ![Animation showing how to navigate the search results with the up and down keys and select code examples from the results](animB2op.gif)
### Installation ### Installation