[FEATURE REQUEST] allow descriptions in fields

[danielo515]

Is your feature request related to a problem? Please describe. Configurable scripts are great. However they lack a key feature: descriptions. Using someone script where all you can see is the author, title and field names is not going to help you understanding how to use it.

Describe the solution you'd like I think that allowing to define descriptions for both the script and each field will make it easier for people to understand how configuration is supposed to be setup and how the script is supposed to be used.

Additional context This is specially handy in case you have scripts that "set variables". Descriptions could explain what variables will be set and with wich name so you can use them easier in complex macros

[FeralFlora]

I came here to request the same thing, since I am developing a Quickadd script for dissemination to others

Without a description, the setting/field names have to be longer and / or you have to provide a lot more instructions to go along with the script.

Descriptions would make user scripts a lot more self-explanatory.

[danielo515]

As a workaround (a bit overkill one) I've built a new plugin: https://github.com/danielo515/obsidian-modal-form It is designed to integrate nicely with other plugins like quickadd

[FeralFlora]

As a workaround (a bit overkill one) I've built a new plugin: https://github.com/danielo515/obsidian-modal-form It is designed to integrate nicely with other plugins like quickadd

That's very cool! Does it also work with Quickadd's user script settings?

[danielo515]

As a workaround (a bit overkill one) I've built a new plugin: https://github.com/danielo515/obsidian-modal-form It is designed to integrate nicely with other plugins like quickadd

That's very cool! Does it also work with Quickadd's user script settings?

Not sure what do you mean by that, could you elaborate? It works in every place you can access the global app object

[FeralFlora]

@danielo515 I've made a user script for Quickadd with settings that you can specify. Quickadd provides this settings page:

Can your plugin override that and add descriptions?

[chhoumann]

Great feature request. In hindsight, it should have been there from the beginning! Thank you.

I just added it in the latest release (1.3.0) :)

[FeralFlora]

@chhoumann Nice! I assume that it's just description: "Description text"?

[chhoumann]

@chhoumann Nice! I assume that it's just description: "Description text"?

Yep!

[danielo515]

@danielo515 I've made a user script for Quickadd with settings that you can specify. Quickadd provides this settings page:

Can your plugin override that and add descriptions?

Oh, I see. No the integration is not that deep 🙂

[FeralFlora]

Oh, I see. No the integration is not that deep 🙂 Okay, well doesn't matter now that the feature request has been implemented 👍