Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Docs: Add title to <abbr> in docs

See original GitHub issue

Summary

when a abbreviation is marked with <abbr> then it is underlined and i can hoover over it and it becomes a ? but no more info is there 😦

Motivation

the underline and the change of the icon feels useless if there is no more information, because i expect that is clickable when i see a ?

Steps to resolve this issue

should we add a title parameter to the <abbr> tag?

Draft the doc

Write the doc, following the format listed in these resources:
- Overview on contributing to documentation
- Docs Templates
- Example of a similar article
Add the article to the docs sidebar under the [parent doc] section.

Open a pull request

Open a pull request with your work including the words “closes #[this issue’s number]” in the pull request description

Issue Analytics

State:
Created 3 years ago
Comments:5 (3 by maintainers)

Top GitHub Comments

1reaction

marcysuttoncommented, Jun 12, 2020

Screen reader users will get the surrounding context, and adding <abbr> with titles to inline copy will indeed be redundant. I’ve opened a PR to remove them since I agree they aren’t necessary. https://github.com/gatsbyjs/gatsby/pull/24964

0reactions

mueschacommented, May 29, 2020

ah ok - has the removement of all <abbr> any impact for screenreaders? maybe they read it better with this marker?

Top Results From Across the Web

Add a title, heading, or table of contents in a document

Make a title or heading · On your computer, open a document in Google Docs. · Select the text you want to change....

<abbr>: The Abbreviation element - HTML - MDN Web Docs

The HTML element represents an abbreviation or acronym. ... Adding a title attribute lets you provide an expansion or definition for the ...

Abbreviations Extractor add-on for Google Docs - YouTube

Lets you to extract the abbreviations from the current Doc file and insert them as a table in your preferred location.

Headings and titles | Google developer documentation style ...

When using an abbreviation in a heading or title, spell out the abbreviation in the first paragraph that follows the heading or title....

<abbr>: The Abbreviation element - HTML: Hypertext Markup ...

Adding a title attribute lets you provide an expansion or definition for the abbreviation or acronym. HTML. <p>Ashok's joke made me <abbr title="Laugh...