Various typesetting quirks for certain combinations of formatting elements in Markdown comments #1282

New Issue

Closed

opened 2023-08-15 01:06:10 +00:00 by brainchild · 8 comments

brainchild commented

2023-08-15 01:06:10 +00:00

Description

Certain combinations of formatting elements, in display of existing issues, lead to unappealing typesetting, as managed by style definitions.

Environment

Server: Codeberg community instance, codeberg.org, at time of posting.
GitNex version: 5.1.2
Installation source: F-Droid
System: Lineage OS for microG, version 19, on Pixel 4 (flame)
Authentication type: password

The issue relates to typographic display. Included at the end of the post is a sequence of screen captures intended to show system settings that may affect such display.

Details

A few quirks of formatting style were noticed when reviewing a post recently submitted to the issue tracker.

They include the following, as may be seen in the below screen capture (see highlighted area):

Excessive inline white space follows and precedes code spans.
Hyperlinks enclosing code spans are displayed with extra underlining preceding and following the horizontal extent of text.
For list items spanning multiple paragraphs, vertical space between list items is too little, but too great between paragraphs with an item.

Appendix

See below for screen captures representing relevant display settings.

# Description Certain combinations of formatting elements, in display of existing issues, lead to unappealing typesetting, as managed by style definitions. # Environment - Server: Codeberg community instance, `codeberg.org`, at time of posting. - GitNex version: 5.1.2 - Installation source: F-Droid - System: Lineage OS for microG, version 19, on Pixel 4 (flame) - Authentication type: password The issue relates to typographic display. Included at the end of the post is a sequence of screen captures intended to show system settings that may affect such display. # Details A few quirks of formatting style were noticed when reviewing a post recently submitted to the issue tracker. They include the following, as may be seen in the below screen capture (see highlighted area): - Excessive inline white space follows and precedes code spans. - Hyperlinks enclosing code spans are displayed with extra underlining preceding and following the horizontal extent of text. - For list items spanning multiple paragraphs, vertical space between list items is too little, but too great between paragraphs with an item. --- ![Screenshot_20230814-182245_GitNex.png](/attachments/6e571578-9bdc-4fb4-95aa-a8ed6a1fe1cc) ![Screenshot_20230814-164105_GitNex.png](/attachments/215ccd43-d885-4b6e-9557-a331cdc137ce) ![Screenshot_20230814-162602_GitNex.png](/attachments/64dcac7b-ff3d-49a5-afb8-d0e2b7d2ba02) # Appendix See below for screen captures representing relevant display settings. --- ![Screenshot_20230814-183006_Settings.png](/attachments/90582f63-20a4-407a-a90e-34df575da347) ![Screenshot_20230814-183023_Settings.png](/attachments/0a58e7f3-9607-4115-bf99-c683c95dab77) ![Screenshot_20230814-183045_Settings.png](/attachments/c090d429-322a-427f-aa41-734a2ceaed77) ![Screenshot_20230814-183058_Settings.png](/attachments/f6d8e4bb-874c-407b-adee-655dd9ab4319)

Screenshot_20230814-183006_Settings.png

132 KiB

Screenshot_20230814-183023_Settings.png

228 KiB

Screenshot_20230814-183045_Settings.png

133 KiB

Screenshot_20230814-183058_Settings.png

136 KiB

Screenshot_20230814-164105_GitNex.png

325 KiB

Screenshot_20230814-182245_GitNex.png

327 KiB

Screenshot_20230814-162602_GitNex.png

283 KiB

mmarif commented

2023-08-18 06:57:58 +00:00

Owner

Thanks for providing details for each step.

Excessive inline white space follows and precedes code spans.

I don't think this is an issue. It is normal, and in most places, you will see some space in it.

Hyperlinks enclosing code spans are displayed with extra underlining preceding and following the horizontal extent of text.

Valid point

For list items spanning multiple paragraphs, vertical space between list items is too little, but too great between paragraphs with an item.

Valid point

Now, onto the actual bits: we are using the https://github.com/noties/Markwon library for rendering Markdown. We have extended it a bit to add a few GitNex related features. However, these basic fixes should be done upstream.

I'm also not sure if the library is maintained anymore; the last release was in 2021.

Thanks for providing details for each step. > Excessive inline white space follows and precedes code spans. I don't think this is an issue. It is normal, and in most places, you will see some space in it. > Hyperlinks enclosing code spans are displayed with extra underlining preceding and following the horizontal extent of text. Valid point > For list items spanning multiple paragraphs, vertical space between list items is too little, but too great between paragraphs with an item. Valid point Now, onto the actual bits: we are using the https://github.com/noties/Markwon library for rendering Markdown. We have extended it a bit to add a few GitNex related features. However, these basic fixes should be done upstream. I'm also not sure if the library is maintained anymore; the last release was in 2021.

mmarif added the

💻 UI/UX

🪜 Upstream

labels 2023-08-18 06:58:22 +00:00

brainchild commented

2023-08-18 07:04:11 +00:00

Author

Does the library support custom styling? Could you render in a web display pane, first converting to a representation in HTML?

Nextcloud Notes is an example of an Android application under active development that displays Markdown text. Recent versions even have a WYSIYG editor.

The first issue looks quite awkward to me, and not as formatting to which I am accustomed.

Does the library support custom styling? Could you render in a web display pane, first converting to a representation in HTML? Nextcloud Notes is an example of an Android application under active development that displays Markdown text. Recent versions even have a WYSIYG editor. The first issue looks quite awkward to me, and not as formatting to which I am accustomed.

brainchild changed title from ~~Various typesetting quirks appear for certain cominations of formatting elements~~ to Various typesetting quirks for certain combinations of formatting elements in Markdown comments

2023-08-18 07:27:07 +00:00

mmarif commented

2023-08-18 07:40:13 +00:00

Owner

Nextcloud Notes is using the same library with modified tooling, and they have their own set of UI nitpicks.

To each their own; to me, these are not issues, just UI nitpicks, and I am personally fine with them.

However, to accommodate/fix these, I would advise opening an issue on the upstream project for the fixes.

Library examples: https://noties.io/Markwon/#supported-markdown-features

Nextcloud Notes is using the same library with modified tooling, and they have their own set of UI nitpicks. To each their own; to me, these are not issues, just UI nitpicks, and I am personally fine with them. However, to accommodate/fix these, I would advise opening an issue on the upstream project for the fixes. Library examples: https://noties.io/Markwon/#supported-markdown-features

brainchild commented

2023-08-18 07:45:27 +00:00

Author

The screenshots for Markwon show code spans formatted with background highlighting, making the excessive white space seem more natural. Most of the space is within the highlighted box, and therefore the space between its edges and the surrounding text is quite minimal.

foxy commented

2024-01-19 10:28:46 +00:00

Could I also mention inline code in headings being paragraph-sized? Example: https://codeberg.org/foxy/visimp. Are links not automatically detected if MD link syntax is not used on purpose?

Could I also mention inline code in headings being paragraph-sized? Example: [https://codeberg.org/foxy/visimp](https://codeberg.org/foxy/visimp). Are links not automatically detected if MD link syntax is not used on purpose?

mmarif added

🐛 Bug

and removed

🪜 Upstream

labels 2024-03-28 14:11:05 +00:00

mmarif added this to the 5.4.0 milestone 2024-03-28 14:11:28 +00:00

mmarif self-assigned this 2024-03-28 14:11:42 +00:00

mmarif referenced a pull request that will close this issue

2024-03-28 14:11:52 +00:00

Delete email from account / create ssh key / update profile details and other UI improvements #1342

mmarif commented

2024-03-28 14:13:59 +00:00

Owner

#1342 will address most of the UI MD issues.

@foxy I did not really understand your request or issue. Can you please add screenshots maybe to clarify it?
If needed please open a new issue.

#1342 will address most of the UI MD issues. @foxy I did not really understand your request or issue. Can you please add screenshots maybe to clarify it? If needed please open a new issue.

mmarif closed this issue

2024-03-28 15:54:13 +00:00

mmarif referenced this issue from a commit

2024-03-28 15:54:13 +00:00

Delete email from account / create ssh key / update profile details and other UI improvements (#1342)

foxy commented

2024-03-28 18:00:29 +00:00

Here it is: inline code + h1.