[WIP] feat: support underline for markdown and update string format pattern

[Bad3r]

Update formatting functions and format-text! to use %s pattern

TODO

• use util/get-selected-text

Depends on:

• enhance(E2E): editor string formatting and symbols autopairing tests #9388

breaking change:

• Remove /underline command and replace it with modKey + u shortcut

issues:

• close Add shortcut modKey + u to underline text #9390
• close Markdown: cannot put bold words inside italic sentence #8790 (comment)
• close Ctrl+i, Ctrl+b, etc. inserts more *s instead of terminating italic or bold substring #8819 (duplicate)

forum posts:

• https://discuss.logseq.com/t/more-options-for-text-formatting-bold-strikethrough-underline-etc/

QA Testing Instructions for Text Formatting Feature

Repeat the steps for markdown and org-mode formats.

Initial Setup:

1. Create a new block with the sentence: LOGSEQ: Logical Organization Graphical-System for Efficient Querying.

Test for Text Formatting Features:

Bold:

2. Select the word Graphical and apply bold formatting ($MOD+b)
3. Expected Result: **Graphical**|-System
4. Verify the result and cursor (|) position.
   Select the styled word Graphical again and remove the formatting by pressing the same shortcut.

Italic:

5. Select the word Graphical and apply italic formatting ($MOD+i)
6. Expected Result: *Graphical*|-System
7. Verify the result and cursor (|) position.
   Select the styled word Graphical again and remove the formatting by pressing the same shortcut.

Underline:

8. Select the word Graphical and apply underline formatting ($MOD+u)
9. Expected Result: <u>Graphical</u>|-System
10. Verify the result and cursor (|) position.
    Select the styled word Graphical again and remove the formatting by pressing the same shortcut.

Strikethrough:

11. Select the word Graphical and apply the strikethrough formatting ($MOD+Shift+s).
12. Expected Result: ~~Graphical~~|-System
13. Verify the result and cursor (|) position.
    Select the styled word Graphical again and remove the formatting by pressing the same shortcut.

Sequential Application and Removal of Formatting:

14. Select the word Graphical and apply all the text formatting shortcuts. Example: $MOD+i, $MOD+u, $MOD+Shift+s, $MOD+b.
15. Expected Result: **~~<u>*Graphical*</u>~~**|-System
16. Verify the result and cursor (|) position.
17. Then, remove each formatting one by one in reverse order.
18. Expected Result: Graphical|-System (Graphical should remain selected)
19. Expected Result: The word Graphical should remain selected after removing the formatting.

Test for Formatting Without Selection:

26. In a new block without any text selected, apply each formatting command or shortcut. Example: $MOD+i, $MOD+u, $MOD+Shift+s, $MOD+b.
27. Expected Result: **~~<u>*|*</u>~~**
28. Verify the result and cursor position.

Please remember to document any discrepancies between the expected and actual results, along with any error messages or issues encountered during testing.

logseq-string-formatting.mp4

This PR updates the text formatting functions to use a consistent %s pattern for wrapping text with the appropriate formatting markers. The format-text! function has also been updated to accommodate these changes.

• Updated get-bold, get-italic, get-strike-through, get-underline, and get-highlight functions to use %s pattern
• Modified format-text! to handle the new %s pattern in the formatting functions
• Ensured compatibility with existing text formatting behavior

The result of this change is introducing a new feature; underline text using mod + u. Since markdown doesn't support underlining, HTML syntax is needed. Due to the opening and closing tags being different for HTML, there was a need to update the text-format! function to accommodate this case. Instead of writing a special case for underlines, I opted to modify the existing format used to a more malleable one.

---

Warning
Old PR description

Discord: https://discord.com/channels/725182569297215569/735747000649252894/1100463176270745640

This pull request introduces a new feature that adds a keyboard shortcut for underlining text Mod + u in both Markdown and Org-mode formats. The implementation modifies the get-underline function and introduces the underline-format! function to support the respective underline syntax for each format. In Org-mode, the underscore (_) syntax is used, while in Markdown, the text is wrapped with the <u> and </u> HTML tags.

Since Markdown does not natively support underlines, I opted to use HTML tags as a workaround. This presented a challenge as the opening and closing tags are different. Initially, I considered modifying the format-text! function to handle this case, but doing so could potentially break other features. As a result, I decided to not change it.

This approach may have introduced some code duplication, and there could be a more efficient solution beyond my current understanding of the code. I apologize if this adds extra work to the review process. Please let me know if you have any suggestions for improvements or if further modifications are needed.

All translations have been added and its been added to the shortcuts page.

Video Demo:

composed-grasp-log-topic.mp4

QA Steps:

• open a markdown and/or org-mode graph
• select some text
• use the shortcut Mod + u to underline it

Test unwrapping

• select wrapped text
• use the same shortcut to undo the formatting.

[Bad3r]

@logseq/core, this PR is ready for review. Not sure who to ask. The original code is written by @tiensonqin ~3 years ago.~~ Is this change in pattern OK?

[Bad3r]

setting it as WIP for now as it could be improved to be more efficient.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
11 out of 12 committers have signed the CLA.

✅ andelf
✅ logseq-cldwalker
✅ RCmerci
✅ avelino
✅ giuseppedandrea
✅ tiensonqin
✅ Michele0303
✅ candideu
✅ optimistic5
✅ Bad3r
✅ hasecilu
❌ dependabot[bot]
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[cnrpman]

Humm, seems tons of conflicts given the great changes of the dicts
Also the commit history is so awful. Better to do a thorough interactive rebase from the current master

[Bad3r]

Humm, seems tons of conflicts given the great changes of the dicts Also, the commit history is so awful. Better to do a thorough interactive rebase from the current master

@cnrpman fixed the conflict. This PR is on hold until #9391 is merged.

[Bad3r]

Close due to the team not having time to review large community PRs and to save my time.