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

Update tooling and instructions for ER and RDD #315

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

SteveLLamb
Copy link
Member

@SteveLLamb SteveLLamb commented Mar 5, 2025

Updated instructions, updated Foreword (and streamlined logic), added clause for contact info, updated validation.

@SteveLLamb SteveLLamb requested a review from palemieux March 5, 2025 22:07
Copy link

github-actions bot commented Mar 5, 2025

Copy link
Member

@palemieux palemieux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tests should be added as well.

@SteveLLamb SteveLLamb requested a review from palemieux March 6, 2025 06:55
@palemieux
Copy link
Member

Can you create a sample RDD document under test/resources/html/validation?

doc/main.html Outdated
<p>The <code>id</code> attribute shall be present on the <code>dl</code> element and equal to
<code>rdd-proponent</code>.

<p>If present, the <code>dl</code> element, as described in <a href="#sec-dl-element"></a>, shall use a single <code>dt</code> element for each company name designated as a Proponent of the document, and multiple lines of <code>dd</code> as needed for contact information for each company listed. The contact infomation should at least include an address and email, reach out to SMPTE HO for further deatails. </p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't a single

, with potentially multiple lines? Each
is supposed to be a synonym of the
, not a separate line

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... in fact, I am not convinced <dl> is the right approach if there are multiple proponents... can you provide an example of how this would work?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<dl id="element-proponent">
 
      <dt>Company name</dt>
        <dd>Contact name</dd>
        <dd>Contact email</dd>
        <dd>Company Address</dd>
        <dd>Company website</dd>
     
      <dt>Company 2 name</dt>
        <dd>Contact name</dd>
        <dd>Contact email</dd>
        <dd>Company 2 Address</dd>
        <dd>Company 2 website</dd>
   
</dl>

Nothing prevents the usage of multiple dd for each dt, such as https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl#single_term_multiple_descriptions. This is frankly the least ugly way to present, besides trying to to the same with ul and then wrapping a style in CSS.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the above example to the documentation as well.

@SteveLLamb SteveLLamb requested a review from palemieux March 14, 2025 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants