11 Matching Annotations
  1. Apr 2021
    1. Which HTML tag I should use to enclose such notes to add a semantic meaning of a note that may be useful to read at a given point of a tutorial, but is not part of the main tutorial flow?
    2. A better description is in the specification itself. Why read secondary remarks when the source is written so good?
    3. I respectfully disagree with your assessment. You are referencing the quote "It's not appropriate to use the aside element just for parentheticals, since those are part of the main flow of the document." However the OP specifically said that they are looking for a semantic element for "a note that may be useful to read at a given point of a tutorial, but is not part of the main tutorial flow". That is what "aside" is for. It's not part of the main content flow.

      That's a tough one. I can see it both ways.

    4. An admonition is a parenthetical
    5. <aside> is appropriate if the side note "could be considered separate from the content"

      From a programmer's perspective:

      • It shouldn't be in an <aside>, if it is actually directly about what is in <main>
      • An <aside> should be able to be evaluated on its own, (almost entirely) in isolation from, and not dependent on anything in, the <main> content. This could be especially important/relevant for screen readers.
    6. <aside> is not appropriate if the side note is "a parenthetical". The W3C gives no examples of what it means.
    7. In my opinion, the W3C definition is unnecessarily confusing and restrictive. The dictionary definition of aside is "a temporary departure from a main theme or topic", and the spec should just stick to that, rather than introducing subtle distinctions.
    8. I believe the accepted answer is not quite correct. According to the HTML5 working draft, the <aside> element can be used to mark up side notes in certain, but not all cases:
    9. Of course, there is no reason why you can't use <aside> for all sidenotes, if it makes your code simpler. Think of it as civil disobedience. :)
    10. The dictionary definition of aside is "a temporary departure from a main theme or topic"