Skip to content

Commit ffd8c91

Browse files
prepare AMO listing
1 parent 5951f75 commit ffd8c91

8 files changed

+29
-34
lines changed

README.md

+29-34
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,44 @@
11

2-
# TST Tab Search -- filter Tree Style Tab's sidebar
2+
# <sub><a href="https://addons.mozilla.org/firefox/addon/tst-search/"><img src="./resources/get-ff-ext.png" width="86" height="30"></a></sub> TST Tab Search -- filter Tree Style Tab's sidebar
33

4-
<!-- <sub><a href="https://addons.mozilla.org/firefox/addon/tst-search/"><img src="./resources/get-ff-ext.png" width="86" height="30"></a></sub> -->
4+
<!-- AMO short description:
5+
Search for or filter the Tabs in TST's sidebar, and quickly find and activate them.
6+
-->
57

6-
This is an extension for the browser extension [Tree Style Tabs](https://github.com/piroor/treestyletab#readme) (TST). It adds a search box at the bottom of TST's sidebar, allowing to search the titles and URLs (or whatever) of the tabs in the current window/sidebar, optionally case sensitive, as whole word, or by regular expression.
7-
Matching tabs will be highlighted in the tree, and/or non-matches will be suppressed (see extension preferences).
8-
Should the search bar not show up after installing this extension, then have a look at `about:addons` > "Extensions" > "TST Tab Search" > "Preferences".
8+
<!-- AMO long description: (AMO keeps line breaks, and supports a few HTML tags. Copy from here till the first MarkDown heading, but do remove the image tags.) -->
99

10-
<img alt="Searching for Cats" src="./resources/screenshot.png" width="264px">
10+
This is an extension for the browser extension <a href="https://github.com/piroor/treestyletab#readme">Tree Style Tabs</a> (TST). It adds a search box to TST's sidebar, allowing to search the tabs in the current window. With TST Tab Search you can: <ul>
11+
<li> start searching with a global search hotkey (Ctrl+Shift+F) </li>
12+
<li> customize the filtered tabs and the search panel </li>
13+
<li> cycle through results and then switch to the tabs </li>
14+
<li> search case sensitive, as whole word, or by regular expression </li>
15+
<li> show and search by tab ID </li>
16+
<li> search by any tab property </li>
17+
</ul>
1118

12-
Thats pretty much all there is to say.
13-
Many thanks to TST's author [piroor](https://github.com/piroor), who has not only developed TST as a great standalone extension, but also designed a very good API for other extensions to interact and integrate with TST. With that, writing the initial version of this extension from scratch took only about two long afternoons.
19+
<img alt="Tab searches with different settings " src="./resources/screenshot-merged.png" width="600px"> <!-- remove this for AMO -->
1420

15-
<b>Permissions Used</b>:
21+
There are quite a lot of things that can, but don't need to, be changed in the extensions options. The descriptions of the options also explain how some of the more advanced search features work.
22+
Should the search bar not show up after installing this extension, then have a look at the top of the options page as well.
23+
The options can be opened by either going to `about:addons` > "Extensions" > "TST Tab Search" > "Preferences", or right clicking the icon at the top right of the browser > "Manage Extension" > "Preferences". Should the icon not be there, then right click any of the other icons, select "Customize Toolbar" (last entry) and look on that page.
1624

17-
- "Access to browser tabs": Get titles and URLs of tabs to be searched.
18-
- "Display notifications to you": Notify when something went wrong, or right.
25+
Many thanks to TST's author <a href="https://github.com/piroor">piroor</a>, who has not only developed TST as a great standalone extension, but also designed a very good API for other extensions to interact and integrate with TST. With that, writing the initial version of this extension from scratch took only about two long afternoons (but refining it took a lot longer)
1926

20-
<!-- NOTE: AMO keeps line breaks within paragraphs ... -->
27+
<b>Permissions Used</b>: <ul>
28+
<li> "Access to browser tabs": Get titles and URLs of tabs to be searched. </li>
29+
<li> "Display notifications to you": Notify when something went wrong, or right. </li>
30+
</ul>
2131

32+
<b>Privacy / Disclaimer</b>: <ul><!--break--></ul>
33+
This extension doesn't collect any data, nor does it directly or indirectly contact any entity outside the browser, nor does it anything that should be detectable by websites whatsoever.
34+
This extension only momentarily changes how tabs are displayed in the sidebar, but does no persistent changes to them, and should thus also not be able to cause any (tab) data loss.
2235

23-
## Additional Features
24-
25-
I am happy to receive feedback or contributions on this. This is a (currently short) list of stuff that should be addressed:
26-
27-
* more/better highlight styles, esp. for pinned tabs (can be tried via "Custom Styles")
28-
* update the screenshot with active tab and counter (and/or add more screenshots)
2936

37+
## Additional Features
3038

31-
# TODO
39+
I am happy to receive feedback or contributions on this. This is the list of stuff that should be addressed:
3240

33-
* for/before AMO listing (/the README)
34-
* add disclaimer: this is a fairly young extension
35-
* state: does not mess with FF tabs, only affects how TST displays them (and is thus pretty safe to use, even in beta)
36-
* write the short description / summary
37-
* maybe rework the entire listing:
38-
* short description
39-
* features
40-
* more screenshots
41-
* clear prompt to review the settings
42-
* privacy policy
43-
* currently does not send anything
44-
* except on dev build the update poll once a day, which isn't analyzed at all, and can be disabled in FF
45-
* will never send any tab content, URLs or search terms
46-
* *maybe*: It is possible, yet unlikely, that ... . But should there would be a clear notification of any changes in that direction, before they would take effect.
47-
* add (badge) link to AMO listing
41+
* Nothing on the agenda for now. Feel free to [suggest something](https://github.com/NiklasGollenstede/tst-search/issues).
4842

4943

5044
## Development builds -- <sub>[![](https://ci.appveyor.com/api/projects/status/github/NiklasGollenstede/tst-search?svg=true)](https://ci.appveyor.com/project/NiklasGollenstede/tst-search)</sub>
@@ -57,6 +51,7 @@ These builds use a different id (`-dev` suffix), so they are installed as a sepa
5751
* any options set are managed individually (so pre-release versions can't mess with your settings)
5852
* they never update to release versions, but
5953
* they update themselves to the latest development version (once a day, or when clicking `about:addons` > ⚙ > "Check for Updates")
54+
* privacy notice this sends an anonymous version request to a private server (which doesn't currently log it)
6055
* every release version has a corresponding development version (the one with the same prefix and highest build number)
6156

6257

resources/screenshot-by-id.png

158 KB
Loading

resources/screenshot-default.png

113 KB
Loading

resources/screenshot-global.png

144 KB
Loading

resources/screenshot-merged.png

133 KB
Loading

resources/screenshot-modes.png

120 KB
Loading

resources/screenshot-visuals.png

107 KB
Loading

resources/screenshot.png

-31.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)