Context Search — Olivier de Broqueville

Context Search

Firefox add-on to search selected text in a web page using your favorite search engines organized in folders.

Features

• Organize your search engines in (sub-)folders
• Access search engines from the Context Menu
• Access search engines from an Icons Grid
• Compatible with search engines using either GET or POST requests
• Reverse-image search
• Site search
• Carry out multiple searches at once using multisearch
• Manage your search engines from the extension's Options page
• Many ways to easily add a new search engine
• Support for search engines using OpenSearch description format
• Simply add a search engine from mycroftproject.com
• Use custom favicons for your search engines
• Use custom prompts to question a selection of AI chatbots
• Carry out searches from the Omnibox, i.e. url address bar
• Assign keyboard shortcuts to your search engines
• Export/Import your list of search engines as a safe backup

Issues
Please report issues you encounter using Context Search here:
https://github.com/odebroqueville/contextSearch/issues

Permissions

Notifications, Downloads, History and Bookmarks are now optional permissions. They are disabled by default. If you'd like to show notifications and/or save your list of search engines to your local disk, or search your history or bookmarks from the Omnibox, then open the extensions manager, select Context Search and under the Permissions tab enable the appropriate permissions.

To open search results in a new private window, in the extensions manager, allow Context Search to "Run in Private Windows".

How does it work

1. Select some text on a webpage
2. Right click (or Alt-click) on a selection
3. A context menu (or a grid of icons) appears, displaying the list of search engines chosen in the extension's preferences
4. Click on the search engine with which you’d like to search for the selected text

The search results will appear as defined in the extension's preferences page.

Managing search engines

To manage your favorite search engines, you can go to the preferences page of Context Search. You can reach this page by opening the extensions page (Addon Manager) where all your add-ons are listed and then clicking on the "Preferences" button.

Please refer to the 4th screenshot above.

1. The checkbox at the start of a line determines whether the search engine should appear in the context menu.
2. The next item on the line contains the name of the search engine and is followed by a keyword.
3. This keyword is used in the url address bar (or omnibox) after the word “cs “ and before the search terms (e.g. to search for linux using the search engine Wikipedia, you would type: ‘cs w linux’, where w is the keyword assigned to Wikipedia).
4. Next, you can assign a keyboard shortcut to a search engine to perform a quick search. Please note that not all key combinations will work as some may be reserved by the browser or your system.
5. The second checkbox specifies whether you’d like to use the search engine in a “multi-search”. A “multi-search” is a search performed using multiple search engines and can be selected in the context menu of in the grid of icons.
6. The checkbox is followed by the search query string. This is the generic url you would use to perform a search. Search query strings may contain the parameters %s or {searchTerms} where you'd like your search terms, i.e. the selected text, to appear.
7. Click on and drag the move icon to the left of the trash icon to move each search engine up or down in the list.
8. Click on the trash icon to remove a search engine from the list.

The 'Reset' button will re-load the default list of search engines and their associated favicons.

You can also import a JSON file containing your own list of search engines. It is strongly recommended to export your customized list of search engines as a backup in case anything goes wrong.

How to add a search engine to your custom list of search engines

Video demo: https://youtu.be/_kV7JCgGQLk

* visit mycroftproject.com and click on the Context Search icon that appears before the textual link of a listed search engine
* use the page action (i.e. Context Search icon in the url address bar) to add a search engine if the website supports open search
* add a search engine manually via the Options page (you can test the query string before adding the search engine)
* to add a search engine that uses a submit form via an HTTP POST request, double click in the website's search text box, then give your search engine a name

How to add an AI prompt to your custom list of search engines

Prior to using an AI provider, ensure that you have logged in to their website. At the bottom of the Options page, select the tab to 'Add a new AI prompt'. Chose the AI provider you'd like to use, add a name for your prompt and enter your prompt by inserting %s where you'd like your text selection to appear (e.g. 'Comprehensively explain the following for a 10 year old: %s').

In most cases, after selecting text on a web page and selecting your prompt in the context menu, a new tab will open with the prompt pasted in the search box. However, pressing the ENTER key will not work! You have to place the cursor in the search box, then press the SPACE bar and finally press the ENTER key. The search results should then appear.

At any time, you may press CMD + V to paste you prompt if it doesn't appear.

How to add a separator (horizontal line) in the context menu

At the bottom of the Options page, simply click on the "Add separator" button. This will add a separator to the bottom of your search engines list. Then, use the arrow handle to the right of the horizontal line to move the separator to the position where you would like it to be. The separator should appear in the context menu.

How to add a custom favicon for a search engine

From the Options page, click on the favicon right before the search engine's name. A popup window will open displaying the current favicon and the associated base64 string. Either drag & drop a new png image onto the existing one or paste the base64 string of your new image. Then click on the 'Save' button for your changes to take effect. The popup will automatically close after you click on the 'Save' button.

How to perform a search in the omnibox

In the omnibox (or url address bar), type 'cs ' (without the quotes, and where cs stands for Context Search) followed by the keyword you have chosen for your seaarch engine in the extension's preferences, e.g. 'w ' (again without quotes) for Wikipedia, followed by your search term(s). The dot ('.'), the exclamation mark ('!'), '!h' or 'history' and '!b' or 'bookmarks' are reserved keywords.

Here are some examples:

cs w atom
will search for the word 'atom' in Wikipedia.

cs .
will open the Options page

cs ! cold fusion
will perform a multi-search for the search terms 'cold fusion'

cs !h or cs history
will display all your history

cs !b Mozilla or cs bookmarks Mozilla
will display all bookmarks that include the term Mozilla

cs !b recent or cs bookmarks recent
will display your 10 most recent bookmarks

The main structure of a JSON file containing the search engines

```javascript
{
"id": {
"index": 0,
"name": "search engine's name",
"keyword": "keyword to be used in an omnibox search",
"keyboardShortcut": "keyboard shortcut assigned to the search engine",
"multitab": "takes the value true or false depending on whether this search engine should be included in a multi-search or not",
"url": "search engine query string (without the search terms)",
"show": "takes the value true if the search engine is to be shown in the context menu or false if not",
"base64": "a base 64 string representation of the search engine's favicon"
}
}
```

Here is an example of a JSON file containing 3 search engines:

```javascript
{
"bing": {
"index": 0,
"name": "Bing",
"keyword": "b",
"keyboardShortcut": "",
"multitab": false,
"url": "https://www.bing.com/search?q=",
"show": true,
"base64": ""
},
"google": {
"index": 1,
"name": "Google",
"keyword": "g",
"keyboardShortcut": "",
"multitab": false,
"url": "https://www.google.com/search?q=",
"show": true,
"base64": ""
},
"yahoo": {
"index": 2,
"name": "Yahoo!",
"keyword": "y",
"keyboardShortcut": "",
"multitab": false,
"url": "https://search.yahoo.com/search?p=",
"show": true,
"base64": ""
}
}
```

It is not required to provide the base 64 string representation of any search engine's favicon. This string will automatically be loaded for you.

Special thanks to the following contributors

• Carl Scheller for implementing the drag & drop feature to move search engines in the Options page
• Geoffrey De Belie for the Dutch translation
• Krzysztof Galazka for the Polish translation
• Sergio Tombesi for the Italian and Spanish translations
• Fushan Wen for the Chinese translation
• Sveinn í Felli for the Icelandic translation

Code made by others used in this extension

• SortableJS v1.15.2 minified with many contributors, which can be found on GitHub here: https://github.com/SortableJS/Sortable/blob/1.15.2/Sortable.min.js