-
-
Notifications
You must be signed in to change notification settings - Fork 461
[Feature Request][Docs]: Text field formatting #1302
Copy link
Copy link
Open
Labels
TagStudio: LibraryRelating to the TagStudio library systemRelating to the TagStudio library systemType: DocumentationAdditions/changes to documentationAdditions/changes to documentationType: EnhancementNew feature or requestNew feature or requestType: UI/UXUser interface and/or user experienceUser interface and/or user experience
Metadata
Metadata
Assignees
Labels
TagStudio: LibraryRelating to the TagStudio library systemRelating to the TagStudio library systemType: DocumentationAdditions/changes to documentationAdditions/changes to documentationType: EnhancementNew feature or requestNew feature or requestType: UI/UXUser interface and/or user experienceUser interface and/or user experience
Checklist
Description
Currently, all text fields using
TextWidgetsupport 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:
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).fields.mdAlternatives
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.