Skip to content

Commit

Permalink
docs: update search
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianschubek committed Oct 31, 2024
1 parent f64c9b1 commit 36b0eea
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/docs/configuration/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@ sidebar_position: 3

# Search & Sorting

![image](search1.png)
![image](search2.gif)

Click on the column header to sort by that column. Click again to reverse the sort order.

Click on the search icon to open the search input field. All engines search the current folder and all descendants of the current folder.
Click on the search icon to open the search input field and choose an engine to search the current folder and all descendants of the current folder.

## Engines

### Simple search

Most intuitive string-matching search engine with basic functionality.
Basic string-matching search engine. Enabled by default.

### Glob-based search

More powerful search engine for advanced users. It is simple to use and faster than the regex engine.
More powerful search engine for advanced users. It is simple to use and faster than the regex engine. Enabled by default.

| Pattern | Description |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -27,18 +29,17 @@ More powerful search engine for advanced users. It is simple to use and faster t

:::info
Expansion `{a,b,c}` is not available because it is not supported by the underlying base image (Alpine Linux).

Globstar `**` is not supported by PHP natively and may be implemented in the future.
Globstar `**` is not supported by PHP natively.
:::

> [Learn more](https://en.wikipedia.org/wiki/Glob_(programming))
### Regex-based search

This engine is the most powerful but slower than the glob engine. It is useful for complex searches.
This engine is the most powerful but slower than the glob engine. It is useful for complex searches. Disabled by default.

> [Learn more](https://en.wikipedia.org/wiki/Regular_expression)
import EnvConfig from '@site/src/components/EnvConfig';

<EnvConfig name="SEARCH|SEARCH_ENGINE|SEARCH_MAX_DEPTH|SEARCH_MAX_RESULTS|REVERSE_SORT" init="true|simple|25|100|false" values="true,false|simple,glob,regex|integer|integer|true,false" versions="3.7|3.7|3.7|3.7|1.0" desc="Enables or disables the search functionality|Search engine to evaluate query|Maximum recursive search depth (simple and regex engine only)|Maximum number of results in a single request|By default files and folders are sorted by name using natural sort."/>
<EnvConfig name="SEARCH|SEARCH_ENGINE|SEARCH_MAX_DEPTH|SEARCH_MAX_RESULTS|REVERSE_SORT" init="true|s,g|25|100|false" values="true,false|s,g,r|integer|integer|true,false" versions="3.7|3.8|3.7|3.7|1.0" desc="Enables or disables the search functionality|s=simple, g=glob, r=regex. Multiple values seperated using commas.|Maximum recursive search depth (simple and regex engine only)|Maximum number of results in a single request|By default files and folders are sorted by name using natural sort."/>
Binary file added docs/docs/configuration/search2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 36b0eea

Please sign in to comment.