A few readability-related suggestions for the help document

[Raindrops]

This help page needs some polishing for better clarity:

1. Before starting the help text, please explain the shorthand notation you are using.
For example, => is a shorthand notation for "evaluates to-"
Also, optional parameters are enclosed in [], and they can be omitted.

2. Please add TOC for the whole page.
The page is too long, and without a TOC, it borders on TLDR!

3. The content should be re-arranged hierarchically
Please indent the subtopics.

4. There should be an additional section that explains the operators.
For example, the meaning of == and << is not clear.

This section should be broken down into subtopics such as logical, mathematical, text manipulation, etc.

5. The angular brackets are used for two different purposes:
(i) to show that the text is proxy (to be replaced with actual value).
For example, #char:<expression> and #day:<date>
(ii) to enclose elements of a group in RegEx.

This is confusing.

6. In a few places, the <> are not removed in examples. (typos)
For example, in the following text:
Example: #get-attributes:<"C:\Windows\Notepad.exe"> => 32

7. It would be great to have a table of all available functions, which has three columns: syntax, examples and remarks.
Separate tables should be made to list different types of functions.

8. It would be great to have another page that shows how the command line mode is used.
That page should address non-programmers (people who can write scripts can manage this on their own. But it's the mere mortals who need hand-holding.)

9. It would be great to have a "cookbook" section (aka "step-by-step").
The forum is full of queries about tasks for which Everything already has controls.
(For example, "How do I go to the previous search?", "How do I close the window with ESC?", etc.)

But this fact is not clear to the user even after reading the help doc earnestly.
So this cookbook section will guide the user about how to fulfill his most frequent needs.
This list can be compiled through user-contribution.

10. Clearly, some functions can be entered in the Search Bar.
So their use is not limited to command line.

The help should explain which functions can be used in this manner (and how to use them).

[NotNull]

9. It would be great to have a "cookbook" section (aka "step-by-step").
The forum is full of queries about tasks for which Everything already has controls.
(For example, "How do I go to the previous search?", "How do I close the window with ESC?", etc.)

When you encounter any taht are useful for the general public, please post them in the "Greatest Hits" thread.

[Raindrops]

Sure thing!

[void]

The preprocessor syntax is still maturing and is subject to change.
Most users will never need to use the preprocessor.
The preprocessor is an advanced feature to rewrite your searches.

1. Before starting the help text, please explain the shorthand notation you are using.
For example, => is a shorthand notation for "evaluates to-"
Also, optional parameters are enclosed in [], and they can be omitted.

I've updated the help to include:
=> means "evalulates to".

The following are standard:
[optional parameter]
<required parameter>

Unforunately, the preprocessor uses [] and <> in the syntax making this confusing.
I'll likely remove the <> style syntax from the help in favor of the [] syntax.
Showing examples for each function may also help.

2. Please add TOC for the whole page.
The page is too long, and without a TOC, it borders on TLDR!

This will happen during beta, before release.
Difficult to do at the moment when adding new functions each week.
I'll categorize all the functions once they are well defined.

3. The content should be re-arranged hierarchically
Please indent the subtopics.

phpbb is quite limited with formatting/indenting.
I'll improve the formatting when converted to the support wiki.

4. There should be an additional section that explains the operators.
For example, the meaning of == and << is not clear.

I have updated the help for [eval:expression] to:
Evaluate a C expression and return the result.
I have put on my TODO list to add all operators and operator precedence to the help.

This section should be broken down into subtopics such as logical, mathematical, text manipulation, etc.

Breaking the search functions and search preprocessor into categories is on my TODO list.

5. The angular brackets are used for two different purposes:
(i) to show that the text is proxy (to be replaced with actual value).
For example, <expression> and #day:<date>
(ii) to enclose elements of a group in RegEx.
This is confusing.

Yes, this is confusing.
The < > brackets are a part of the syntax and need to be treated literally.
I'll update the help to show preprocessor functions with the [] style syntax, eg: [day:mydate]
Providing examples may also help here.

6. In a few places, the <> are not removed in examples. (typos)
For example, in the following text:
Example: #get-attributes:<"C:\Windows\Notepad.exe"> => 32

This is not a typo.
<> is a part of the syntax.

7. It would be great to have a table of all available functions, which has three columns: syntax, examples and remarks.
Separate tables should be made to list different types of functions.

Sounds like a job for the conversion to the support wiki.

8. It would be great to have another page that shows how the command line mode is used.
That page should address non-programmers (people who can write scripts can manage this on their own. But it's the mere mortals who need hand-holding.)

I'll add more useful command line examples as they are found here.

For example:
Everything64.exe -s [year:now:]-[text:month:now:,00]-[text:day:now:,00]

9. It would be great to have a "cookbook" section (aka "step-by-step").
The forum is full of queries about tasks for which Everything already has controls.
(For example, "How do I go to the previous search?", "How do I close the window with ESC?", etc.)

But this fact is not clear to the user even after reading the help doc earnestly.
So this cookbook section will guide the user about how to fulfill his most frequent needs.
This list can be compiled through user-contribution.

Hopefully Google (or other web search engines) or the forum search will help here.

I try to use the syntax with my answers:

To do x:

• Step 1
• Step 2
• Step 3
• ...

10. Clearly, some functions can be entered in the Search Bar.
So their use is not limited to command line.

The help should explain which functions can be used in this manner (and how to use them).

You can use any search function or preprocessor search from the command line.
You'll just need to make sure you correctly escape command line operators, such as | < >

Search Functions
Search Commands
Command Line Options



Thank you for the suggestions.

[Raindrops]

If you are thinking of making a support wiki, here is an example to emulate.

I created that help.
The developer of ReNamer (Denis Kozlov) created the Wiki framework and also added the more advanced topics/details.

We can do the same here: There are many active and knowledgeable members here, who can contribute...

[Raindrops]

@point#10: I know that all commands are meant for command line use.
I was referring to their use within the GUI (by entering them in the Search Bar.)

Non-programmers like me need more detailed description for both types of use:
(a) as command line, and
(b) as GUI-based commands.