-
-
Notifications
You must be signed in to change notification settings - Fork 442
Description
Checklist
- I am using an up-to-date version.
- I have read the documentation.
- I have searched existing issues.
Description
Currently, all text fields using TextWidget support markdown. However, this information is not stated anywhere in the UX or documentation. I was under the assumption that it was plaintext, but because it is markdown I now need to escape or use alternative characters for some items (like ~). Also of note, which markdown extended syntax is used should be specified to users. One of the most common extended syntax used ~~strikethough~~, where the implementation TagStudio is using uses ~strikethrough~ OR ~~strikethrough~~, which makes it difficult to type ~ multiple times in one textbox field.
Solution
Recommendations:
- Add a tip to the text field editing dialog (near
EditTextBox) that specifies that markdown is supported. Ideally, it should link the a page containing all formats supported by the extended syntax used in TagStudio (QTMarkdownText). - Update the web documentation,
fields.md - Consider adding "prettyprint" / "wysiwyg" / "rich" editing of the markdown
- Consider using a markdown extended syntax that is typically user-facing, rather than an extended syntax that is typically developer-facing.
Alternatives
While documentation around the markdown capability is needed regardless, allowing the user to have a plaintext text field (either library-wide disable of markdown, or a flag on the field to use plaintext) would bypass the issues that led to this request.
Additional Notes:
I may be able to contribute to this issue, however I would like confirmation of what solution items are picked before beginning.