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

Wrap defined term in dfn elements #1664

Closed
Jym77 opened this issue Jul 12, 2021 · 3 comments · Fixed by #1744
Closed

Wrap defined term in dfn elements #1664

Jym77 opened this issue Jul 12, 2021 · 3 comments · Fixed by #1744
Assignees
Labels
Definition Editorial For editorial changes that does not change the meaning of a rule or Glossary term

Comments

@Jym77
Copy link
Collaborator

Jym77 commented Jul 12, 2021

Our definitions usually contain the defined term wrapped in underscores (hence in italic), e.g.

A _semantic link_ is any element which has the [semantic role][] of [`link`][link] or a [semantic role][] that inherits from the [`link`][link] role.

We should rather wrap them in (semantically correct) dfn elements (if our markdown processing allows it), e.g.

A <dfn>semantic link<dfn> is any element which has the [semantic role][] of [`link`][link] or a [semantic role][] that inherits from the [`link`][link] role.

We should also add an id to the dfn element either all the time or at least for those definitions that define more than one term (e.g. Text Inheriting its Programmatic Language from an Element so that we can refer the correct one when needed.

@Jym77 Jym77 added Definition Editorial For editorial changes that does not change the meaning of a rule or Glossary term labels Jul 12, 2021
@Jym77
Copy link
Collaborator Author

Jym77 commented Jul 14, 2021

Actually, this could also be used for names of listed conditions and would greatly help referring to them in the running text:

… at least one of the following condition is true:
- <dfn id="cond-foo">Foo</dfn> Lorem Ipsum Foo; or
- <dfn id="cond-bar">Bar</dfn> Lorem Ipsum Bar.

(…)

This element matches the [foo][#cond-foo] condition.

@WilcoFiers
Copy link
Member

What is the benefit you expect to get from doing this?

@Jym77
Copy link
Collaborator Author

Jym77 commented Jul 15, 2021

Using the semantic dfn element in the web pages, rather than the semantically meaningless em.
Plus, the possibility to give an id to these means we can refer to them directly which is useful for definitions that include several terms (or for the named list conditions).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Definition Editorial For editorial changes that does not change the meaning of a rule or Glossary term
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants