Dvc.org: glossary: no tooltip when there's break lines in <abbr> tags

[jorgeorpinel]

For example the lines

- `etag`: strong ETag response header (only HTTP <abbr>external
  dependencies</abbr> created with `dvc import-url`)

won't produce a glossary tooltip. But they should.

If we require <abbr> terms to be in a single line, then maybe the automatic linter (pretty-quick) that runs on a Git pre-commit hook should enforce that format, like it enforces quoted text to be in a single line?

[jorgeorpinel]

What do you think @algomaster99? Thanks

[algomaster99]

@jorgeorpinel prettier and Rewraps plugin both take care of it. They put <abbr>...</abbr> in one line.

[jorgeorpinel]

Not when there's a space in the term like the example I pasted in the description of this issue, above. Another one: <abbr>data artifact</abbr>

[algomaster99]

@jorgeorpinel
One solution I have thought for this is to add 'external\ndependencies' to the match array. Notice that I added a new-line character between the words.

[shcheklein]

@algomaster99 I think we can "normalize" the term before trying to match it in JS itself. Remove extra spaces, convert n to space, tabs to spaces, etc.

[algomaster99]

@shcheklein I don't get what you mean by normalize? Can you explain?

[shcheklein]

@algomaster99:

} else if (props.tag === 'abbr') {
    const text = props.children[0]
    return <Tooltip text={text} />
  }

you can do something like:

const text = normalize_space(props.children[0])

[jorgeorpinel]

It's either that or making prettier force those tags into a single line, if that's possible. But I'm guessing that's not possible to do with prettier, so I second normalizing 🙂

[jorgeorpinel]

@algomaster99 I thought of another improvement.

• The match terms should be case insensitive so that for example, both Workspace and workspace match workspace (without having to also specify Worspace in the match array.

UPDATE: Extracted to #547

[jorgeorpinel]

It would also be nice to have a Glossary menu item on the nav bar that opens a page in the docs where all these terms are listed (with <a name='the-term'> anchors. This is mainly to link from glossary descriptions (because we can't have tooltips inside tooltips) but may be useful in other cases perhaps? And to read the full list in case anyone is curious. What do you think? Probably deserves its own issue though.

[shcheklein]

It would also be nice to have a Glossary menu item on the nav bar that opens a page...

@jorgeorpinel I think it deserves it's own issue. Not a top priority, but let's create an issue for sure.