Skip to content

Commit 2c26659

Browse files
authored
feat: All settings sections now link to their docs (#1987)
* feat: Settings pane now links to docs for all features * docs: Settings screenshots now show new docs links
1 parent cb5f0ae commit 2c26659

File tree

5 files changed

+27
-8
lines changed

5 files changed

+27
-8
lines changed
-5.33 KB
Loading
1.01 KB
Loading
6.74 KB
Loading
-9.34 KB
Loading

src/Config/SettingsTab.ts

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,10 @@ export class SettingsTab extends PluginSettingTab {
166166
new Setting(containerEl)
167167
.setName('Set created date on every added task')
168168
.setDesc(
169-
"Enabling this will add a timestamp ➕ YYYY-MM-DD before other date values, when a task is created with 'Create or edit task', or by completing a recurring task.",
169+
SettingsTab.createFragmentWithHTML(
170+
"Enabling this will add a timestamp ➕ YYYY-MM-DD before other date values, when a task is created with 'Create or edit task', or by completing a recurring task.</br>" +
171+
'<p>See the <a href="https://publish.obsidian.md/tasks/Getting+Started/Dates#Created+date">documentation</a>.</p>',
172+
),
170173
)
171174
.addToggle((toggle) => {
172175
const settings = getSettings();
@@ -178,7 +181,12 @@ export class SettingsTab extends PluginSettingTab {
178181

179182
new Setting(containerEl)
180183
.setName('Set done date on every completed task')
181-
.setDesc('Enabling this will add a timestamp ✅ YYYY-MM-DD at the end when a task is toggled to done.')
184+
.setDesc(
185+
SettingsTab.createFragmentWithHTML(
186+
'Enabling this will add a timestamp ✅ YYYY-MM-DD at the end when a task is toggled to done.</br>' +
187+
'<p>See the <a href="https://publish.obsidian.md/tasks/Getting+Started/Dates#Done+date">documentation</a>.</p>',
188+
),
189+
)
182190
.addToggle((toggle) => {
183191
const settings = getSettings();
184192
toggle.setValue(settings.setDoneDate).onChange(async (value) => {
@@ -230,7 +238,10 @@ export class SettingsTab extends PluginSettingTab {
230238
new Setting(containerEl)
231239
.setName('Next recurrence appears on the line below')
232240
.setDesc(
233-
'Enabling this will make the next recurrence of a task appear on the line below the completed task. Otherwise the next recurrence will appear before the completed one.',
241+
SettingsTab.createFragmentWithHTML(
242+
'Enabling this will make the next recurrence of a task appear on the line below the completed task. Otherwise the next recurrence will appear before the completed one.</br>' +
243+
'<p>See the <a href="https://publish.obsidian.md/tasks/Getting+Started/Recurring+Tasks">documentation</a>.</p>',
244+
),
234245
)
235246
.addToggle((toggle) => {
236247
const { recurrenceOnNextLine: recurrenceOnNextLine } = getSettings();
@@ -246,7 +257,12 @@ export class SettingsTab extends PluginSettingTab {
246257

247258
new Setting(containerEl)
248259
.setName('Auto-suggest task content')
249-
.setDesc('Enabling this will open an intelligent suggest menu while typing inside a recognized task line.')
260+
.setDesc(
261+
SettingsTab.createFragmentWithHTML(
262+
'Enabling this will open an intelligent suggest menu while typing inside a recognized task line.</br>' +
263+
'<p>See the <a href="https://publish.obsidian.md/tasks/Getting+Started/Auto-Suggest">documentation</a>.</p>',
264+
),
265+
)
250266
.addToggle((toggle) => {
251267
const settings = getSettings();
252268
toggle.setValue(settings.autoSuggestInEditor).onChange(async (value) => {
@@ -296,10 +312,13 @@ export class SettingsTab extends PluginSettingTab {
296312
new Setting(containerEl)
297313
.setName('Provide access keys in dialogs')
298314
.setDesc(
299-
'If the access keys (keyboard shortcuts) for various controls' +
300-
' in dialog boxes conflict with system keyboard shortcuts' +
301-
' or assistive technology functionality that is important for you,' +
302-
' you may want to deactivate them here.',
315+
SettingsTab.createFragmentWithHTML(
316+
'If the access keys (keyboard shortcuts) for various controls' +
317+
' in dialog boxes conflict with system keyboard shortcuts' +
318+
' or assistive technology functionality that is important for you,' +
319+
' you may want to deactivate them here.</br>' +
320+
'<p>See the <a href="https://publish.obsidian.md/tasks/Getting+Started/Create+or+edit+Task#Keyboard+shortcuts">documentation</a>.</p>',
321+
),
303322
)
304323
.addToggle((toggle) => {
305324
const settings = getSettings();

0 commit comments

Comments
 (0)