tmedwards / sugarcube-2

SugarCube is a free (gratis and libre) story format for Twine/Twee.
https://www.motoslave.net/sugarcube/2/
BSD 2-Clause "Simplified" License
185 stars 42 forks source link

Please add to the documentation what content is allowed in "desc:" strings #301

Closed selden closed 4 months ago

selden commented 6 months ago

It'd be very helpful to have a formal description of what type of content is supported in desc: parameters.

Is your feature request related to a problem?

Indirectly. I wanted to add extensive help to the Settings menu dialog. The description of desc: in the Setting API discussion and elsewhere just says that it accepts a string, so I (incorrectly?) assumed that meant only plain text, which would have been insufficient for what I wanted to do. So far I haven't found anything obvious in the documentation which states otherwise. However, it was revealed to me on the IF forum that links work within that quoted string. Experimentation seems to suggest that just about any SugarCube expression works, too, but it'd be nice know if this is a safe assumption.

Describe the solution you'd like. A clear and concise description of the limitations of desc: strings.