-
-
Notifications
You must be signed in to change notification settings - Fork 220
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add info about logical operators for filter patterns, and examples, to help text #559
Comments
You mean the help page inside the application or the help site ? I suspect nobody would read the in-app help if it was longer. |
I mean the in-app help. The box showing the search prefixes is about half the width of the screen so there's easily enough space for another column showing examples, and perhaps a column with a short explanation. If you did that then I think you could remove lines 2 & 3 below the "Search Modes" header without any loss of comprehension. Those lines could be replaced by a couple of lines stating the logical operators, e.g: "logical operators !,&,| and parentheses can be used to combine filters, e.g. '(!/foo/)&c/bar/'. For efficiency place content matches last." This would be enough to prompt memory or figure out how they work. |
I think you're right. |
Also IMO it makes more sense to put the "Search Modes" section first (and the "Configuration" section last) on the help page since I suspect that people will be looking at it more frequently than the other stuff (there are 10 different prefixes to remember). When I press |
Looks good to me |
I have so many different query languages to remember (regexps, xpath, jq,...)
It would be useful to have more info in the help page in case I forget exactly how broot filter queries work (e.g. after not using it for a long while). Maybe some short examples too (e.g. for the tokens search; it took me a while to work out you need to separate tokens with commas).
The text was updated successfully, but these errors were encountered: