Skip to content

Commit ad0a8f8

Browse files
author
Ryan Huebert
committed
docs: revise to make more linear
1 parent 82dad5d commit ad0a8f8

File tree

1 file changed

+94
-31
lines changed

1 file changed

+94
-31
lines changed

docs/Editing/Auto-Suggest.md

Lines changed: 94 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -140,55 +140,118 @@ There are some Auto-Suggest behaviours that might be improved in future releases
140140
- When Auto-Suggest is used in [[Kanban plugin]] cards (or any other plugins that use the [[Tasks Api#Auto-Suggest Integration|auto-suggest integration]]), the [[Task Dependencies|dependencies]] suggestions are not available, because there is not yet a mechanism for plugins to access all the tasks in the vault.
141141
- We are tracking this in [issue #3274](https://github.com/obsidian-tasks-group/obsidian-tasks/issues/3274).
142142

143-
## Minimizing Suggestion Conflicts With Other Plugins
143+
## Managing Auto-Suggest Conflicts With Other Plugins
144144

145-
Obsidian plugins, such as Tasks, cannot detect if auto-suggest features from other plugins are enabled. It's the user's responsibility to manage conflicts between auto-suggest features. Tasks auto-suggest will only appear on lines that start with `- [ ]` and contain the global filter (if one is set).
145+
When multiple Obsidian plugins offer auto-suggest features, they can interfere with each other, causing suggestions to not appear when expected or overwhelming you with too many options. This guide explains how to configure popular plugins to work together seamlessly.
146146

147-
### Strategies
147+
### Understanding the Problem
148+
149+
Auto-suggest conflicts occur because:
150+
151+
- Multiple plugins try to provide suggestions simultaneously
152+
- Obsidian prioritizes suggestions from plugins that load first
153+
- Some plugins consume all available "suggestion space," blocking others
154+
- Different plugins use overlapping trigger conditions
155+
156+
Common symptoms:
157+
158+
- Expected suggestions don't appear
159+
- Wrong plugin's suggestions show up
160+
- Suggestion list becomes cluttered or unresponsive
161+
162+
### How Plugin Loading Works
148163

164+
Obsidian loads community plugins in the order they appear in your plugin list. The first plugin to load gets first priority for suggestions. When that plugin runs out of suggestions, the next plugin can offer its suggestions.
165+
166+
**Key principle:** Plugins with fewer, more specific suggestions should load first so they aren't blocked by plugins with more numerous or unpredictable suggestions.
167+
168+
**Note:** Tasks auto-suggest will only appear on lines that start with `- [ ]` and contain the global filter (if one is set).
169+
170+
### Strategies
149171
To simultaneously use auto-suggest features from other plugins, a strategy must be implemented to minimize conflicts. Plugin specific settings and plugin load order can be utilized to obtain a mostly seamless experience.
150172

151173
In Obsidian plugins that load first have suggestions prioritized. Given that, it makes sense to load plugins with less suggestions and/or less trigger text first. Doing so will pass priority to the next plugin when suggestions run out.
152174

153-
#### Plugin Specific Settings
175+
#### Configure Plugin Specific Settings
176+
**Tasks Plugin:**
177+
178+
- Go to Settings → Tasks → Auto-suggest
179+
- Set "Minimum match length for auto suggest" to **1**
180+
- Why: This allows other plugins to show suggestions when Tasks has no matches
181+
182+
**Natural Language Dates:**
183+
184+
- Go to Settings → Natural Language Dates
185+
- Set trigger phrase to **@** (or another single character that doesn't conflict with Tasks syntax)
186+
- Why: Single-character triggers work well with the load order approach
187+
188+
**Various Compliments:**
189+
190+
- Go to Settings → Various Compliments → Suggest
191+
- Consider adding a line filter regex if you want to limit where it appears
192+
- Note: This plugin provides many suggestions and should load last
193+
194+
#### Set Load Orders
195+
Choose one of these methods:
196+
197+
##### Method A: Manual Load Order (No Additional Plugins)
198+
199+
1. Go to Settings → Community plugins
200+
2. Disable all auto-suggest plugins
201+
3. Re-enable them in this exact order:
202+
- **Tasks** (enable first)
203+
- **Natural Language Dates** (enable second)
204+
- **Various Compliments** (enable last)
205+
206+
##### Method B: Using Lazy Plugin Loader
207+
208+
1. Install and enable Lazy Plugin Loader
209+
2. Go to Settings → Lazy Plugin Loader
210+
3. Configure delays:
211+
- **Natural Language Dates:** Instant
212+
- **Tasks:** Short delay
213+
- **Various Compliments:** Long delay
214+
215+
#### Expected Results
216+
217+
With proper configuration, you should see:
218+
**On task lines** (starting with `- [ ]`):
219+
220+
1. Tasks-specific suggestions appear (due dates, priorities, etc.)
221+
2. When typing `@`, Natural Language Dates suggestions appear
222+
3. Various Compliments fills in remaining suggestion space
223+
224+
**On regular lines:**
154225

155-
A few mentions on plugin specific settings:
226+
1. Natural Language Dates responds to `@` trigger
227+
2. Various Compliments provides general text suggestions
156228

157-
- Tasks plugin setting:
158-
- Minimum match length for auto suggest` must be 1 or greater to allow subsequently loaded plugins to display suggestions.
159-
- Various Compliments:
160-
- can be provided a by line regex filter but mainlining it may be a recurring chore and cause unsuspected behavior.
161-
- Natural Language Dates:
162-
- the trigger phrase default of @ works well, prefer something that doesn't conflict with the Tasks Plugin
229+
#### Troubleshooting
230+
**General:**
163231

164-
#### Managing Load Orders
232+
- Restart Obsidian after changing settings or load order
165233

166-
1. no additional plugins: disabling then enabling a plugin will cause it to be loaded first.
167-
2. lazy plugin loader: delay loading to plugins to obtain goal load order
234+
**Tasks suggestions not appearing:**
168235

169-
### Example Strategies
236+
- Verify the line is a task
237+
- Check if a global filter is set in Tasks settings
238+
- Ensure minimum match length is set to 1 or more
239+
- Check that it's loading before Various Compliments
170240

171-
The following strategy aims to use load order to provide a seamless auto suggestion experience.
241+
**Natural Language Dates not working:**
172242

173-
| Load | Plugin | Notes | Suggestion Space |
174-
| ---- | ---------------------- | ----------------------------------------------------------------------------- | ------------------------- |
175-
| 1st | Natural Language Dates | prefer 1 character trigger phrase that doesn't conflict with tasks, @ is okay | 1 character |
176-
| 2nd | Tasks | minimum match length must be 1 to load subsequent plugins | minimal |
177-
| 3rd | Various Compliments | takes the most suggestion space and will block plugins loaded after | very large, unpredictable |
243+
- Confirm you're using the correct trigger character
244+
- Check that it's loading before Various Compliments
245+
- Try a different trigger character if conflicts persist
178246

179-
#### With Core Obsidian With Tasks
247+
**Too many suggestions from Various Compliments:**
180248

181-
1. set Tasks minimum match length for auto suggest to 1.
182-
2. disable then enable tasks
183-
3. disable then enable natural language dates
184-
4. disable then enable various compliments
249+
- Move it to load last in the order
185250

186-
#### With Lazy Plugin Loader
251+
**Suggestions completely missing:**
187252

188-
1. set minimum match length for auto suggest to 1.
189-
2. set tasks to short delay
190-
3. set natural language dates to instant (or short with no conflicting trigger phrase)
191-
4. set various compliments to long delay
253+
- Check that all plugins are enabled
254+
- Verify you're typing in the correct context (task lines vs regular text)
192255

193256
## Common Questions
194257

0 commit comments

Comments
 (0)