Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

text formatting infobubble is difficult to read #813

Open
Hugo-Trentesaux opened this issue Jun 26, 2020 · 7 comments
Open

text formatting infobubble is difficult to read #813

Hugo-Trentesaux opened this issue Jun 26, 2020 · 7 comments

Comments

@Hugo-Trentesaux
Copy link

When entering a description for a marker, a help bubble displays:

Text formatting

    *simple star for italic*
    **double star for bold**
    # one hash for main heading
    ## two hashes for second heading
    ### three hashes for third heading
    Simple link: [[http://example.com]]
    Link with text: [[http://example.com|text of the link]]
    Image: {{http://image.url.com}}
    Image with custom width (in px): {{http://image.url.com|width}}
    Iframe: {{{http://iframe.url.com}}}
    Iframe with custom height (in px): {{{http://iframe.url.com|height}}}
    Iframe with custom height and width (in px): {{{http://iframe.url.com|height*width}}}
    --- for an horizontal rule

This is difficult to read for inexperienced users not familiar with this kind of markup. Maybe setting the special characters to bold could help identifying them. It has been reported to me that the vertical bar in the "Link with text" is difficult to see.

[[ http://example.com | text of the link ]] or even color would help to understand.

@Spielmops
Copy link

Zoom in with the browser like in any webpage: CTRL and + or CTRL and mousewheel

@Hugo-Trentesaux
Copy link
Author

Zooming in will not highlight the markdown signs as I suggest. Bold font should be applied instead.

@Spielmops
Copy link

You are right, but if I zoom in, everything is good to read. On the other hand: a little bit of color enhances the readability - as known from editors with syntax-highlighting ...
Spielmops

@PeskyPotato
Copy link

I've attempted to make the modal description a bit more verbose so unfamiliar users get a better understanding. I've also added more formatting to the text to improve readability. Not sure if this would help at all but a starting point.

screenshot of modal each category has a header, description and example

This would mean the translations need to be redone in each language again.

@davidbgk
Copy link
Contributor

davidbgk commented Apr 2, 2024

@PeskyPotato thank you for your suggestion! I'm a bit afraid about the size of the box with such details but I agree that it's a necessity for it to be pertinent for all users 👍

@PeskyPotato
Copy link

PeskyPotato commented Apr 3, 2024

I'm a bit afraid about the size of the box with such details

This was my concern as well, on smaller screens it can be a bit much to have all that text. I'll try and condense it a little bit without trying to take out any details to see how it looks, later today. Maybe the solution might just be to have a similar output to what was there before but with a link to the documentation with a more verbose description of each.

davidbgk added a commit that referenced this issue Apr 15, 2024
The goal is to be able to embed some of the FAQ entries within the app, see #1710 and #813 for instance.
davidbgk added a commit that referenced this issue May 3, 2024
The goal is to be able to embed some of the FAQ entries within the app, see #1710 and #813 for instance.
davidbgk added a commit that referenced this issue May 6, 2024
The goal is to be able to embed some of the FAQ entries within the app, see #1710 and #813 for instance.
davidbgk added a commit that referenced this issue May 9, 2024
The goal is to be able to embed some of the FAQ entries within the app, see #1710 and #813 for instance.
@Spielmops
Copy link

Thank you all, looks much better now.

Spielmops

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants