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

Add glossary pages for <blink> and HTML color codes #35975

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

chrisdavidmills
Copy link
Contributor

Description

The MDN team inside Mozilla has started researching ways to improve MDN's SEO. One fairly low-risk, non-controversial idea is to add glossary pages for common web-related search terms that aren't covered in other places on MDN. This might be because they are inaccurate or obsolete ... but people still search for them.

MDN glossary pages for these terms would provide a useful landing place that we could then use to set the record straight and funnel users onto useful related documentation.

The two search terms we decided to start with are:

  • The <blink> element — The MDN docs for this feature were removed a while ago because it is obsolete and not supported anywhere. However, a few people were sad about this because <blink> represents an interesting piece of web history (see also @teoli2003's comment on the matter). A glossary entry would be a good way to represent this, while also making it clear why blinking text on the web is a no-no.
  • HTML color codes — no longer an accurate description of how colors are described and specified on the web, but still a common search term.

This PR adds both glossary pages.

Motivation

Additional details

Related issues and pull requests

@chrisdavidmills chrisdavidmills requested a review from a team as a code owner September 20, 2024 10:01
@chrisdavidmills chrisdavidmills requested review from hamishwillee and removed request for a team September 20, 2024 10:01
@github-actions github-actions bot added Content:Glossary Glossary entries size/m [PR only] 51-500 LoC changed labels Sep 20, 2024
Copy link
Contributor

Preview URLs

External URLs (10)

URL: /en-US/docs/Glossary/blink_element
Title: blink element (<blink> tag)


URL: /en-US/docs/Glossary/html_color_codes
Title: HTML color codes

@a-kyne
Copy link

a-kyne commented Sep 20, 2024

Some related data: people search for these two topics a lot: about 35,000 times per month. If we were to publish standalone pages that met user needs and ranked in the top three spots, we would probably get an additional 10,000 clicks per month from each page.

@Josh-Cena
Copy link
Member

If you discover any JS-related concept worth covering I'm more than happy to write it up, whether in the JS docs or glossary.

Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

Link to internal MDN resources where possible, especially as the goal it to increase page views. Put the "here's other related content on MDN" in the see also section rather than the main content. see https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Howto/Write_a_new_entry_in_the_glossary ...


{{GlossarySidebar}}

**HTML color codes** is a _defacto_ general term used to describe the earliest-available methods for specifying colors on web pages. This includes HTML color names such as `black`, `purple`, and `aqua`, and hexadecimal notations such as `#000000`, `#800080`, and `#00ffff`. These were originally defined in HTML specifications — see for example the [HTML 3.2 color definitions](https://www.w3.org/TR/2018/SPSD-html32-20180315/#colors) of the original 16 HTML colors.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**HTML color codes** is a _defacto_ general term used to describe the earliest-available methods for specifying colors on web pages. This includes HTML color names such as `black`, `purple`, and `aqua`, and hexadecimal notations such as `#000000`, `#800080`, and `#00ffff`. These were originally defined in HTML specifications — see for example the [HTML 3.2 color definitions](https://www.w3.org/TR/2018/SPSD-html32-20180315/#colors) of the original 16 HTML colors.
**HTML color codes** is a _defacto_ general term used to describe the earliest-available methods for specifying colors on web pages. This includes HTML color names such as `black`, `purple`, and `aqua`, and hexadecimal notations such as `#000000`, `#800080`, and `#00ffff`.

move the link to "see also"

Comment on lines +13 to +21
To look up web colors on MDN, see our {{cssxref("&lt;color&gt;")}} values reference documentation, or more specifically:

- Color names: {{cssxref("&lt;named-color&gt;")}}.
- Hexadecimal notations: {{cssxref("&lt;hex-color&gt;")}}.
- Color functions:
- [sRGB](https://en.wikipedia.org/wiki/SRGB) color space: {{CSSXref("color_value/hsl", "hsl()")}}, {{CSSXref("color_value/hwb", "hwb()")}}, and {{CSSXref("color_value/rgb", "rgb()")}}.
- [CIELAB](https://en.wikipedia.org/wiki/CIELAB_color_space) color space: {{CSSXref("color_value/lab", "lab()")}} and {{CSSXref("color_value/lch", "lch()")}}.
- [Oklab](https://bottosson.github.io/posts/oklab/) color space: {{CSSXref("color_value/oklab", "oklab()")}} and {{CSSXref("color_value/oklch", "oklch()")}}.
- Other color spaces: {{CSSXref("color_value/color", "color()")}}.
Copy link
Member

Choose a reason for hiding this comment

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

Suggest moving all of this to "see also"
link to interal content where possible, especially if the goal is to increase page views.
See https://developer.mozilla.org/en-US/docs/Glossary/Color_space - i added cielab, etc. there. we also have https://developer.mozilla.org/en-US/docs/Glossary/RGB


It is no longer accurate to refer to colors on the web as "HTML color codes" or "HTML color names". Colors are now specified in the [CSS color module](/en-US/docs/Web/CSS/CSS_colors), and generally known as CSS colors or web colors.

To look up web colors on MDN, see our {{cssxref("&lt;color&gt;")}} values reference documentation, or more specifically:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To look up web colors on MDN, see our {{cssxref("&lt;color&gt;")}} values reference documentation, or more specifically:

This isn't glossary-esque verbiage. Suggest removing this sentence and adding the header See Also here instead


## Brief history

In the early days of the web (the early- to mid-90s), there were not many features available for styling web pages. The [CSS](/en-US/docs/Web/CSS) specification (version 1) was first released in 1996, and not adopted consistently by browsers until much later. Before CSS, browsers experimented with several features to make particular text sections stand out and grab the user's attention if desired. The `<blink>` element was one of these, introduced in early versions of [Netscape Navigator](/en-US/docs/Glossary/Netscape_Navigator); [Internet Explorer's](/en-US/docs/Glossary/Microsoft_Internet_Explorer) {{htmlelement("marquee")}} element was another one.
Copy link
Member

Choose a reason for hiding this comment

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


The `<blink>` element was apparently created after a conversation in a bar in Mountain View between Netscape engineer [Lou Montulli](https://en.wikipedia.org/wiki/Lou_Montulli) and colleagues. When he went into the office the next morning, he found that one of his fellow engineers have stayed up all night and implemented it ([read the story here](https://web.archive.org/web/20220331020029/http://www.montulli.org/theoriginofthe%3Cblink%3Etag)).

While initially popular, `<blink>` became much maligned because of overuse; many people found it annoying. More importantly, it degrades readability, and can be particularly problematic for users with visual impairments or [cognitive disorders](/en-US/docs/Web/Accessibility/Cognitive_accessibility) such as epilepsy or ADHD. It can be disorienting or, in the worst cases, even trigger seizures.
Copy link
Member

Choose a reason for hiding this comment

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

internal link available


While initially popular, `<blink>` became much maligned because of overuse; many people found it annoying. More importantly, it degrades readability, and can be particularly problematic for users with visual impairments or [cognitive disorders](/en-US/docs/Web/Accessibility/Cognitive_accessibility) such as epilepsy or ADHD. It can be disorienting or, in the worst cases, even trigger seizures.

The [Web Content Accessibility Guidelines](/en-US/docs/Glossary/WCAG) state that content that blinks, flashes, or moves should be pausable/stoppable/hidable (see [2.2.2: Pause, Stop, Hide](https://www.w3.org/WAI/WCAG21/Understanding/pause-stop-hide)), and further highlights the dangers of flashing content in [2.3.1: Three Flashes or Below Threshold](https://www.w3.org/WAI/WCAG21/Understanding/three-flashes-or-below-threshold).
Copy link
Member

Choose a reason for hiding this comment

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

internal links available


- The CSS {{cssxref("text-decoration-line")}} property has a `blink` value that should have the same effect, but most modern browsers ignore it.
- The JavaScript {{jsxref("String.blink()")}} method wraps a text string in `<blink></blink>` tags but, as discussed earlier, this element is no longer supported anywhere.
- [CSS animations](/en-US/docs/Web/CSS/CSS_animations) could still be used to create blinking text. However, you should avoid blinking text on web pages for the reasons discussed above.
Copy link
Member

Choose a reason for hiding this comment

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

We had an example of this in the wiki days. not sure if it's still in our codebase..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Glossary Glossary entries size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants