Skip to content

files/en-us/learn/getting_started_with_the_web/html_basics/index.md: Remove extra asterisks#11202

Merged
Rumyra merged 2 commits intomdn:mainfrom
PythonCoderAS:patch-2
Dec 16, 2021
Merged

files/en-us/learn/getting_started_with_the_web/html_basics/index.md: Remove extra asterisks#11202
Rumyra merged 2 commits intomdn:mainfrom
PythonCoderAS:patch-2

Conversation

@PythonCoderAS
Copy link
Copy Markdown
Contributor

Summary

Removes extra asterisks from places they do not belong

Motivation

They are out of place.

Supporting details

#11201

Related issues

Fixes #11201

Metadata

  • Adds a new document
  • Rewrites (or significantly expands) a document
  • Fixes a typo, bug, or other error

@PythonCoderAS PythonCoderAS requested a review from a team as a code owner December 14, 2021 15:13
@PythonCoderAS PythonCoderAS requested review from Rumyra and removed request for a team December 14, 2021 15:13
@github-actions github-actions Bot added the Content:Learn Learning area docs label Dec 14, 2021
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 14, 2021

Preview URLs

Flaws

URL: /en-US/docs/Learn/Getting_started_with_the_web/HTML_basics
Title: HTML basics
on GitHub
Flaw count: 1

  • broken_links:
    • Link points to the page it's already on

External URLs

URL: /en-US/docs/Learn/Getting_started_with_the_web/HTML_basics
Title: HTML basics
on GitHub

No new external URLs

(this comment was updated 2021-12-14 17:02:46.298937)

@cw118
Copy link
Copy Markdown
Member

cw118 commented Dec 14, 2021

@PythonCoderAS Hello, I believe the intended formatting here is hypertext reference—the translated versions of this page that have yet to be converted to Markdown have the two words wrapped in <em> tags, and I'm guessing the single asterisks were escaped in an attempt to use italics.

Since parts of the words have been "bolded" with two asterisks, it would likely be best to use underscores (_) to achieve an italic-nested bold effect as follows: _**h**ypertext **ref**erence_.

@PythonCoderAS
Copy link
Copy Markdown
Contributor Author

@PythonCoderAS Hello, I believe the intended formatting here is hypertext reference—the translated versions of this page that have yet to be converted to Markdown have the two words wrapped in \<em\> tags, and I'm guessing the single asterisks were escaped in an attempt to use italics.

Since parts of the words have been "bolded" with two asterisks, it would likely be best to use underscores (_) to achieve an italic-nested bold effect as follows: _**h**ypertext **ref**erence_.

@cw118 Thanks! Is it possible to see the non-transformed versions? I think that a lot of <em> -> \* errors may have resulted this way. Maybe the transformer can use _ instead of \*?

@cw118
Copy link
Copy Markdown
Member

cw118 commented Dec 14, 2021

Is it possible to see the non-transformed versions? I think that a lot of <em> -> \* errors may have resulted this way. Maybe the transformer can use _ instead of \*?

@PythonCoderAS I'm actually not very familiar with the way MDN's markdown conversion works, but I've seen <em>, when it's not within a tag like <strong>, turn into both _ and * (or perhaps one of the two only gets added/modified manually). However, it's mainly when italic and bold text is being nested within one another that errors arise. I've created an issue in the mdn/yari repo about the conversion of nested em and strong tags—if I'm not mistaken, that's where the code for the markdown converter is.

As for seeing the non-transformed versions, since the HTML files are deleted after conversion to markdown, I tend to just change the language of the page I'm viewing. Most language locales still have their files in HTML, so sometimes I look through the source code of a page's translated version(s) in mdn/translated-content to compare formatting, but note that translations take quite a bit of work to maintain and don't always match the English version.

Anyhow, I'm by no means an expert, but I'm sure a solution will be found :)

@Rumyra
Copy link
Copy Markdown
Collaborator

Rumyra commented Dec 16, 2021

Thanks @PythonCoderAS - this now renders perfectly well 👍

@Rumyra Rumyra merged commit e444d24 into mdn:main Dec 16, 2021
@PythonCoderAS PythonCoderAS deleted the patch-2 branch December 16, 2021 14:48
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Dec 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Content:Learn Learning area docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Issue with "HTML basics": Misplaced asterisks

3 participants