Editorial. Replace mdash HTML special char.

[atwixfirster]

Topic clarification/correction request

Topic Link

Translation dictionaries and language packages

Description

There are a lot of pages which have — special HTML char:

Possible solutions

Replace — with -.

Additional information

CC: @jeff-matthews

[jeff-matthews]

Thanks for reporting @atwixfirster. Your description suggests replacing the HTML entity with a hyphen/dash (-). The correct solution is to replace the HTML entity with the unicode em dash (—) character.

We use kramdown, which is supposed to convert three consecutive hyphens/dashes to a single em dash, but I haven't tested it to verify. See kramdown docs.

kramdown converts the following plain ASCII character into their corresponding typographic symbols:

--- will become an em-dash (like this —)
...

[atwixfirster]

@jeff-matthews , can we discuss the award for this issue? ;)

Many thanks!

[shrielenee]

@atwixfirster Points are awarded for completed PRs, not issues :)

Make this fix, per Jeff's info, and we can talk award points! 🏆

[atwixfirster]

@atwixfirster Points are awarded for completed PRs, not issues :)

Make this fix, per Jeff's info, and we can talk award points! 🏆

Ok, @shrielenee :)

This is a PR #6351

Now your move :)

Thanks

[hguthrie]

Three dashes does convert to an em dash; however, it stores it as three separate characters.

[atwixfirster]

Hi, @hguthrie

Three dashes does convert to an em dash; however, it stores it as three separate characters.

sounds like an approve?

[hguthrie]

I'm not quite sure, @atwixfirster . Also, I was thinking about the Jekyll headers surrounded by three dashes. We might have to check that it doesn't interfere...

[hguthrie]

Okay, I tested a few scenarios:
First, my IDE highlights some instances as an error, which reflects a preference in my environment, so take that with a grain of salt.
Second, when using three dashes inside of a Jekyll header will not work. For example, some of the fixes were in a title (src/guides/v2.3/install-gde/continue-to-verify.md).

Otherwise, it seems okay. As long as it is not used in a Jekyll title or alone on a single line, then it seems to work. Would probably be better to use the unicode —, though.

[keharper]

I didn't see the discussion happening here. Changing the mdash to 3 dashes in the frontmatter causes 3 separate dashes to be displayed in the title. I commented in #6351