This is the main window of the app:

![](Images/Screenshot.png)

# Search bar

Across the top is the search bar. This is where you type in what you want to look for. If you're inside a category, the search bar changes to this:

![](Images/Search%20bar%20with%20category.png)

This shows the category you're currently in. Some plugins allow you to connect to multiple environments. In this case, Teams Chat is connected into the user directory of JIRA. This will be shown in parenthesis next to the name of the category.

You'll also see a search hint on the type of data you can search for. In the main list, you can search for categories and in your history. If you're inside a category, the search hint tells you what you can search for.

At the far right you can also see the backspace icon. Clicking this will reset your search. If you press **Esc** you back out of the current category, or close the app.

# Searching

Below the search bar are the search results:

![](Images/Search%20results.png)

When you open the app, this list will show you the items you've used last. Once you start typing, this list is filtered down to only include items matching your filter:

![](Images/Filtered%20on%20JIRA.png)

The part of the search result that matched your filter is show in bold.

The order of the search results depends on a few factors:

- Search results matching a full word are sorted higher.
- Search results that match a word earlier in the text are sorted higher. The "Teams Chat" search result is an example of this. It was sorted higher before, but because "JIRA Board" has the word JIRA further to the start of the text, it's sorted higher.
- Fuzzy matches are sorted lower.

The following example shows a few of these rules in action:

![](Images/Matching%20rules.png)

Here I've searched for the letters "jb". These are the initial letters of "JIRA Board", which is the top match 😀. These type of shortcuts work often and well with the app.

"JIRA Dashboard" also matched the "jb" search characters, but, because the "b" didn't appear at the start of a word, its priority is lower than that of "JIRA Board".

These two search results are exact matches. This means that all characters could be matches to the search result. Below these two matches are fuzzy matches. TQL has a spell checker built in and attempts to fuzzy match your filter to search results if it can. You can identify fuzzy matches by the red squiggly line below the matched characters.

There are a few other factors that also influence the sort order:

- Pinned items are sorted above everything else (except if they're fuzzy matches).
- Often used items are sorted higher.

# Working with search results

There are two types of search results:

- Search results you can activate. These have the running man icon next to them.
- Categories that you can enter to search. These have the bullet list icon next to them.

This example shows a search result that you can both activate, and is a category. It shows the running man icon and the bullet list icon.

![](Images/Search%20result%20with%20category.png)

These icons appear if the search result is highlighted, or when you hover the mouse over the search result.

## Navigating between search results

While searching, the top search result is highlighted automatically. If you want to select a different one, you can use the **Up**, **Down**, **Page Up** and **Page Down** keys to select it.

## Using search results

You activate a search result by pressing **Enter** with the search result highlighted, or clicking on it. This will activate the item (e.g. by opening a URL) and close the app.

You can enter a category by pressing **Tab**. Press **Esc** if you want to back out of the category again.

## Favorites

Whenever you use an item, it's added to your history. These items show with a star icon next to them. In this example, the top six items came from my history, and the remainder are categories I haven't used yet:

![](Images/Filtered%20on%20JIRA.png)

This also works when you're inside a category:

![](Images/Favorites%20in%20a%20category.png)

The top five search results I've opened at least once. Below it are the rest of my JIRA boards.

You can remove an item from the history by clicking the star icon.
## Pinning and unpinning

You can pin search results. This will cause them to be sorted above other search results. Usually it's not necessary to pin items. The search algorithms do a good job of prioritizing what's important for you. If you find however that you'd like some items to appear higher in the list by default, you can pin search results to achieve this.

To pin a search result, hover over the search result to make the pin icon appear and click it:

![](Images/Pin%20icon.png)

If I now rerun the JIRA search, the Teams Chat item appears to the top:

![](Images/JIRA%20search%20with%20pin.png)

You can unpin search results by hovering over a pinned item and clicking the unpin icon:

![](Images/Unpin%20icon.png)

## Coping links

Most items that you can activate can also be copied. You can copy an item by clicking the copy icon on it:

![](Images/Copy%20icon.png)

# Cheat sheet and other functions

Across the bottom of the window is a cheat sheet and a few other functions:

![](Images/Cheat%20sheet.png)

The text shows different keys you can use to work with the app:

- **Alt+Spacebar** opens TQL. You can customize this key combination in the settings.
- **Enter** activates a search result.
- **Tab** enters a category.

The icons give you access to some a few other functions. The feedback icon helps you to create GitHub issues for feedback and bugs:

![](Images/Feedback%20icon.png)

Clicking this icon opens the following screen:

![](Images/Leave%20feedback.png)

The cog icon opens the configuration screen:

![](Images/Cog%20icon.png)

The help icon opens the wiki:

![](Images/Help%20icon.png)

# Notification icon

![](Images/Notification%20icon.png)

TQL adds a notification icon to the task tray. The search window opens if you click this. If you right click this, the above menu appears.