Links to settings

[Taitava]

As I'm updating the documentation, it came to my mind that all instructions that guide a user how they can navigate the settings panel to find a specific setting, could additionally contain links that could take the user directly to the correct setting. This plugin is heavily settings based, so this could be handy.

• Settings links would not replace navigation guides nor screenshots.
• Not only for documentation: Users could store links to their most frequently visited settings that they tweak every now and then.

Features:

• Draft for base url: obsidian://shell-commands-settings/?vault=vaultName&objectId=&settingId=
• Go to a specific setting in a shell command's settings modal.
  • objectId should be the shell command's id. I.e. the link is targeted to a specific shell command
  • settingId should be the setting's code like it appears in data.json configuration file.
• Let a user pick a shell command, and go to a specific setting in that shell command's settings modal.
  • Use ask=shell-command instead of objectId. A small popup modal will be shown to user, where they can pick a shell command from a list. After that they will be taken to the specified setting.
  • settingId same as above.
• Go to a specific setting in the main settings view:
  • objectId should be omitted to denote that we are targeting a setting that does not relate to any particular item, but rather the global space of the plugin.
  • settingId same as above.
• Other objects:
  • objectId can be an id of: a shell command, a prompt (or prompt field), a variable (custom or builtin), a shell (custom or builtin), an output wrapper, or whatever item that has an id in the data.json configuration file.
  • ask can be: shell-command, prompt, prompt-field, builtin-variable, custom-variable, builtin-shell, custom-shell, output-wrapper etc.

Another way

Alternative plan for the above: Denote a specific setting using a path-like string:

• root.shell_commands.id:c0wajcu2vp.output_channels.stdout
• root.shell_commands.ask.output_channels.stdout