Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-29 17:26:38 +01:00
Code Issues Packages Projects Releases Activity

docs(help): document backend logs retention

Browse Source
This commit is contained in:
Elian Doran
2025-08-13 16:07:13 +03:00
parent 43fd0924a1
commit 221ab02c24
19 changed files with 501 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Quick search.md vendored
View File

@@ -19,34 +19,41 @@ Based on the <a class="reference-link" href="../UI%20Elements/Vertical%20and%20h
Quick search includes the following features:
### Content Previews
Search results now display a 200-character preview of the note content below the note title. This preview shows the context where your search terms appear, making it easier to identify the right note without opening it.
### Infinite Scrolling
Results are loaded progressively as you scroll:
- Initial display shows 15 results
- Scrolling near the bottom automatically loads 10 more results
- Continue scrolling to load all matching notes
* Initial display shows 15 results
* Scrolling near the bottom automatically loads 10 more results
* Continue scrolling to load all matching notes
### Visual Features
- **Highlighting**: Search terms appear in bold with accent colors
- **Separation**: Results are separated with dividers
- **Theme Support**: Highlighting colors adapt to light/dark themes
* **Highlighting**: Search terms appear in bold with accent colors
* **Separation**: Results are separated with dividers
* **Theme Support**: Highlighting colors adapt to light/dark themes
### Search Behavior
Quick search uses progressive search:
1. Shows exact matches first
2. Includes fuzzy matches when exact results are fewer than 5
3. Exact matches appear before fuzzy matches
1. Shows exact matches first
2. Includes fuzzy matches when exact results are fewer than 5
3. Exact matches appear before fuzzy matches
### Keyboard Navigation
- Press `Enter` to open the first result
- Use arrow keys to navigate through results
- Press `Escape` to close the quick search
* Press `Enter` to open the first result
* Use arrow keys to navigate through results
* Press `Escape` to close the quick search
## Using Quick Search
1. **Typo tolerance**: Search finds results despite minor typos
2. **Content previews**: 200-character snippets show match context
3. **Infinite scrolling**: Additional results load on scroll
4. **Specific terms**: Specific search terms return more focused results
5. **Match locations**: Bold text indicates where matches occur
1. **Typo tolerance**: Search finds results despite minor typos
2. **Content previews**: 200-character snippets show match context
3. **Infinite scrolling**: Additional results load on scroll
4. **Specific terms**: Specific search terms return more focused results
5. **Match locations**: Bold text indicates where matches occur

48
docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Search.md vendored
View File

@@ -80,10 +80,11 @@ Trilium supports fuzzy search operators that find results with typos or spelling
* `note.content ~* develpment`: Will find notes containing "development" despite the typo
**Important notes about fuzzy search:**
- Fuzzy search requires at least 3 characters in the search term
- Maximum edit distance is 2 characters (number of character changes needed)
- Diacritics are normalized (e.g., "café" matches "cafe")
- Fuzzy matches work best for finding content with minor typos or spelling variations
* Fuzzy search requires at least 3 characters in the search term
* Maximum edit distance is 2 characters (number of character changes needed)
* Diacritics are normalized (e.g., "café" matches "cafe")
* Fuzzy matches work best for finding content with minor typos or spelling variations
### Advanced Use Cases
@@ -137,25 +138,24 @@ Trilium uses a progressive search strategy that performs exact matching first, t
### How Progressive Search Works
1. **Phase 1 - Exact Matching**: When you search, Trilium first looks for exact matches of your search terms. This handles the vast majority of searches (90%+) and returns results almost instantly.
2. **Phase 2 - Fuzzy Fallback**: If Phase 1 doesn't find enough high-quality results (fewer than 5 results with good relevance scores), Trilium automatically adds fuzzy matching to find results with typos or spelling variations.
3. **Result Ordering**: Exact matches always appear before fuzzy matches, regardless of individual scores. This ensures that when you search for "project", notes containing the exact word "project" will appear before notes containing similar words like "projects" or "projection".
1. **Phase 1 - Exact Matching**: When you search, Trilium first looks for exact matches of your search terms. This handles the vast majority of searches (90%+) and returns results almost instantly.
2. **Phase 2 - Fuzzy Fallback**: If Phase 1 doesn't find enough high-quality results (fewer than 5 results with good relevance scores), Trilium automatically adds fuzzy matching to find results with typos or spelling variations.
3. **Result Ordering**: Exact matches always appear before fuzzy matches, regardless of individual scores. This ensures that when you search for "project", notes containing the exact word "project" will appear before notes containing similar words like "projects" or "projection".
### Progressive Search Behavior
- **Speed**: Most searches complete using only exact matching
- **Ordering**: Exact matches appear before fuzzy matches
- **Fallback**: Fuzzy matching activates when exact matches return fewer than 5 results
- **Identification**: Results indicate whether they are exact or fuzzy matches
* **Speed**: Most searches complete using only exact matching
* **Ordering**: Exact matches appear before fuzzy matches
* **Fallback**: Fuzzy matching activates when exact matches return fewer than 5 results
* **Identification**: Results indicate whether they are exact or fuzzy matches
### Search Performance
Search system specifications:
- Content size limit: 10MB per note (previously 50KB)
- Edit distance calculations for fuzzy matching
- Infinite scrolling in Quick Search
* Content size limit: 10MB per note (previously 50KB)
* Edit distance calculations for fuzzy matching
* Infinite scrolling in Quick Search
## Under the Hood
@@ -228,14 +228,14 @@ You can open Trilium and automatically trigger a search by including the search
### Parameters
| Parameter | Value | Description |
|-----------|-------|-------------|
| MIN_FUZZY_TOKEN_LENGTH | 3 | Minimum characters for fuzzy matching |
| MAX_EDIT_DISTANCE | 2 | Maximum character changes allowed |
| RESULT_SUFFICIENCY_THRESHOLD | 5 | Minimum exact results before fuzzy fallback |
| MAX_CONTENT_SIZE | 10MB | Maximum note content size for search processing |
| --- | --- | --- |
| MIN\_FUZZY\_TOKEN\_LENGTH | 3 | Minimum characters for fuzzy matching |
| MAX\_EDIT\_DISTANCE | 2 | Maximum character changes allowed |
| RESULT\_SUFFICIENCY\_THRESHOLD | 5 | Minimum exact results before fuzzy fallback |
| MAX\_CONTENT\_SIZE | 10MB | Maximum note content size for search processing |
### Limits
* Searched note content is limited to 10MB per note to prevent performance issues
* Notes exceeding this limit will still be included in title and attribute searches
* Fuzzy matching requires tokens of at least 3 characters
* Searched note content is limited to 10MB per note to prevent performance issues
* Notes exceeding this limit will still be included in title and attribute searches
* Fuzzy matching requires tokens of at least 3 characters