es: URL Protocol

Discussion related to "Everything" 1.5 Alpha.
Post Reply
void
Developer
Posts: 16680
Joined: Fri Oct 16, 2009 11:31 pm

es: URL Protocol

Post by void »

The es: URL Protocol allows you to open Everything and set the search from a web-browser.

For example, clicking on es:abc will open Everything and set the search to: abc



Installation
Syntax
Search
Query Strings
Select Filename
Escape Character
Advanced Setup
Examples
Excel Link



Installation

The es: URL Protocol is disabled by default.

To enable the es: URL protocol:
  • In Everything, from the Tools menu, click Options.
  • Click the General tab on the left.
  • Check es: URL protocol.
  • Click OK.


To disable the es: URL protocol:
  • In Everything, from the Tools menu, click Options.
  • Click the General tab on the left.
  • Uncheck es: URL protocol.
  • Click OK.


Syntax

es:search
es:search?query-settings
es:search?query-settings#filename-select

search sets the search box text.
query-settings enables/disables search options. (optional)
filename-select selects a file/folder by filename. (optional)

Escape special URL characters with: %



Search

The es:// or es: prefix is removed when applying your search.

The standard Everything search syntax is supported.

The search can be blank.

Escape special URL characters with: %



Query Strings

Use ? to start the query string.
Use & to separate key=value pairs.

For example:

es:mysearch?key=value&key2=value2&key3=value3&...

The following query strings are supported:
sort=<property-name> (use a dash (-) instead of a space)
ascending=x (where x can be 1=ascending or 0=descending)
case=x (where x can be 1=enable or 0=disable)
diacritics=x (where x can be 1=enable or 0=disable)
path=x (where x can be 1=enable or 0=disable)
regex=x (where x can be 1=enable or 0=disable)
wholeword=x (where x can be 1=enable or 0=disable)
whole_word=x (where x can be 1=enable or 0=disable)
suffix=x (where x can be 1=enable or 0=disable)
prefix=x (where x can be 1=enable or 0=disable)
ignorepunctuation=x (where x can be 1=enable or 0=disable)
ignore_punctuation=x (where x can be 1=enable or 0=disable)
ignorewhitespace=x (where x can be 1=enable or 0=disable)
ignore_whitespace=x (where x can be 1=enable or 0=disable)
omitresults=x (where x can be 1=enable or 0=disable)
omit_results=x (where x can be 1=enable or 0=disable)
tempomitresults=x (where x can be 1=enable or 0=disable)
temp_omit_results=x (where x can be 1=enable or 0=disable)
filter=<filter-name>
view=details
view=thumbnails
view=<thumbnail-size>
thumbnailsize=<thumbnail-size>
thumbnail_size=<thumbnail-size>
newwindow=x (where x can be 1=enable or 0=disable)
new_window=x (where x can be 1=enable or 0=disable)
newtab=x (where x can be 1=enable or 0=disable)
new_tab=x (where x can be 1=enable or 0=disable)



Select Filename

Use # to select a file/folder by filename.

For example, search for notepad and select C:\Windows\Notepad.exe:
es:notepad#c:\windows\notepad.exe

Escape special URL characters with: %



Escape Character

Use % to escape special URL characters such as: : ? & #

# %23
: %3A
% %25
? %3F
& %26
(space) %20



Advanced Setup:

The es: URL protocol is installed in the registry under:

HKEY_CLASSES_ROOT\ES

Code: Select all

Windows Registry Editor Version 5.00

[HKEY_CLASSES_ROOT\ES]
@="URL:Everything Search Protocol"
"URL Protocol"=""

[HKEY_CLASSES_ROOT\ES\shell]

[HKEY_CLASSES_ROOT\ES\shell\open]

[HKEY_CLASSES_ROOT\ES\shell\open\command]
@="\"C:\\Program Files\\Everything\\Everything64.exe\" -url \"%1\"
The open command can be customized.
-url



Examples:

Search for ABC AND 123:
es:ABC%20123

Search for foo#bar:
es:foo%23bar

Enable regex and search for ^123456789:
es:^123456789?regex=1

Enable regex, set the sort to date modified descending and search for ^123456789:
es:^123456789?regex=1&sort=date-modified-descending

Clear the search and select C:\Windows\Notepad.exe
es:#c%3A%5Cwindows%5Cnotepad.exe

Search for *.jpg and show thumbnails:
es:*.jpg?view=128



Excel Link:

Use =HYPERLINK() to create a clickable link in Excel.

For example:

=HYPERLINK("es:"&A1, "Open in Everything")
Post Reply