Skip to content

The semantic of components is guessed #120

@umbobabo

Description

@umbobabo

To create good semantic HTML via the Content Tree we may need to make assumption based on the component usage.
Let me try to explain with an example. This is currently the edited HTML for a Big Number:

<div className="...">
      <div className="...">{number}</div>
      <div className="...">
        {description}
      </div>
    </div>

It's was likely done before the introduction on HTML5 semantic tags. Ideally, today, should be something more like...

<aside>
  <dl>
      <dt>111</dt>
      <dd>Venenatis urna massa</dd>
  </dl>
</aside>

Semantically, this read something like This box contains an aside information for this article, it's a definition list with the term 111 and related description.
However, the Content tree doesn't have anything semantic information to pass to the frontend, in this case we can just assume that because it's a BigNumber, it will be an aside information.

Some components like Timeline could be potentially used as aside or relevant part of the reading flow, as such, make assumptions may lead to wrong semantic tags.

Should be the Content Tree Nodes semantic?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions