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

Remove reference to "important" in <mark> element intro #21734

Merged
merged 1 commit into from Oct 22, 2022

Conversation

charlesroper
Copy link
Contributor

Description

According to the HTML Living Standard, mark is not supposed to denote importance, only relevance. Therefore removing the word "importance" from intro paragraph of element.

Additional details

See https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-mark-element

In particular the final example which, "shows the difference between denoting the importance of a span of text (strong) as opposed to denoting the relevance of a span of text (mark)."

Related issues and pull requests

Fixes #21595

@charlesroper charlesroper requested a review from a team as a code owner October 22, 2022 03:36
@charlesroper charlesroper requested review from estelle and removed request for a team October 22, 2022 03:36
@github-actions github-actions bot added the Content:HTML Hypertext Markup Language docs label Oct 22, 2022
According to the HTML Living Standard, mark is not supposed to denote importance, only relevance. Therefore removing the word "importance" from intro paragraph of <mark> element.

Fixes mdn#21595.
@github-actions
Copy link
Contributor

Preview URLs

Flaws (1)

URL: /en-US/docs/Web/HTML/Element/mark
Title: <mark>: The Mark Text element
Flaw count: 1

  • macros:
    • wrong xref macro used (consider changing which macro you use)

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 thank you @charlesroper !

@wbamberg wbamberg merged commit a7989a1 into mdn:main Oct 22, 2022
@charlesroper
Copy link
Contributor Author

@wbamberg Quick question on this if I may: I noticed the "wrong xref macro" warning when I was working on this, but didn't know what macro to change it to. Is there any advice on this anywhere?

@charlesroper charlesroper deleted the fix-mark branch October 23, 2022 23:23
@wbamberg
Copy link
Collaborator

@wbamberg Quick question on this if I may: I noticed the "wrong xref macro" warning when I was working on this, but didn't know what macro to change it to. Is there any advice on this anywhere?

This warning is not caused by anything you've done, so you don't need to fix it, but for interest's sake :)

MDN has a creaky old macro system called KumaScript, that is used for various things. One category of these is "xref macros", that build cross-references to other bits of the site. There are different xref macros for different bits - like jsxref for the JS docs, domxref for the Web/API docs, etc.

The MDN platform code (https://github.com/mdn/yari/) adds warnings when (among other things) you use the wrong xref (e.g. when you try to use domxref to link to a JS page, I guess).

In this case it's not even an xref macro call in the page, it's an xref macro call inside another macro. That macro is HTMLRef, which is the macro that builds the sidebar for this page. That macro is quite complicated, and I'm not sure where it is making the bad xref call. Probably one of the three template calls in here: https://github.com/mdn/yari/blob/b978c4dde4870869fc604e6090d3a1cbc12fe573/kumascript/macros/HTMLRef.ejs#L77-L87 (template is how you call a macro from another one).

Anyway though, over in #21617 (comment) we are plotting to remove HTMLRef entirely, so this issue will hopefully go away then :).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:HTML Hypertext Markup Language docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistent advice on the meaning of <mark>
2 participants