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

Clarify name of IMSC namespaces #304

Merged
merged 4 commits into from
Feb 6, 2018
Merged

Conversation

palemieux
Copy link
Contributor

Closes #301

@@ -1120,7 +1120,7 @@ <h3>Profile Signaling</h3>

<ul>
<li>the <a>Document Instance</a> also conforms to [[!EBU-TT-D]], in which case neither the <code>ttp:profile</code>
attribute nor the <code>ttp:profile</code> element are present, and, instead, the designator of the IMSC1 profile to which
attribute nor the <code>ttp:profile</code> element are present, and, instead, the designator of the IMSC 1.0 profile to which
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this intended to include sub-versions like 1.0.1?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nigelmegitt No. As discussed before, IMSC 1.0.1 does not trigger a change in the profile designators. The modification above is merely intended to match the name of the profile in the namespaces table.

Copy link
Contributor

Choose a reason for hiding this comment

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

But this pull request removes the "1.0" from namespaces table, so why introduce it here? Shouldn't the change be "IMSC1" -> "IMSC"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nigelmegitt This PR removes 1.0 from the namespace names used for the IMSC attribute vocabularies (so that the namespaces can be reused in IMSC > 1). The PR retains the 1.0 in the profile designator names (which perhaps should not be listed in the namespace table?), so that new profile designators can be defined in IMSC 1.1.

Copy link
Contributor

Choose a reason for hiding this comment

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

@palemieux In that case the wording should be "... and, instead, the designators of the IMSC profiles to which ..."

There are no constraints about how many IMSC profiles a document may conform to simultaneously, nor which particular versions of those profiles apply here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In that case the wording should be "... and, instead, the designators of the IMSC profiles to which ..."

@nigelmegitt This specification only specifies one applicable profile designator ("IMSC 1.0 Text Profile Designator" or "IMSC 1.0 Image Profile Designator") , so the plural would be misleading. Furthermore, the current text does not prevent other designators from being present.

Copy link
Contributor

Choose a reason for hiding this comment

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

This specification only specifies one applicable profile designator ("IMSC 1.0 Text Profile Designator" or "IMSC 1.0 Image Profile Designator") , so the plural would be misleading.

@palemieux The IMSC 1.1 text profile will be different from the IMSC 1.0 profile, but a document may conform to both, so it is reasonable to plan ahead here and allow for other IMSC profiles to be signalled if they apply. Perhaps the reason for permitting multiple profile conformance to be declared needs to be clarified in a note though, since I agree it would be confusing if it suggests that a document instance could be conformant to both the text and image profiles.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perhaps the reason for permitting multiple profile conformance to be declared needs to be clarified in a note though

@nigelmegitt I am not sure what the note would say. Do you have a suggestion? Doesn't EBU-TT-D already notes that ebuttm:conformsToStandard can signal conformance to multiple specifications simultaneously?

Copy link
Contributor

Choose a reason for hiding this comment

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

@palemieux Yes, EBU-TT-D does permit signalling of conformance to multiple specifications.

Note: In the case that future versions of this specification define additional profile designators and the document instance conforms to more than one profile designator, it is recommended that all of the applicable profile designators are signalled. In general a single document instance does not conform to both the text profile and the image profile.

Copy link

@andreastai andreastai left a comment

Choose a reason for hiding this comment

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

Thanks a lot @palemieux! Looks good to me and issue #304 is addressed with this PR.

I agree with Nigel, that some clarification is needed regarding the change in the Profile Signaling section. I propose to open a new issue for this question. Other aspects may also be discussed in this new issue (e.g. how to handle the expected EBU-TT-D update (version 1.0.1).

For the time being the change in the profiling section could be reverted or be merged for later discussion. Either way is fine with me.

"#ebu-tt-d-interop"></a>; or
<li>
<p>the <a>Document Instance</a> also conforms to [[!EBU-TT-D]], in which case neither the <code>ttp:profile</code>
attribute nor the <code>ttp:profile</code> element are present, and, instead, the designator of the IMSC 1.0 profile to
Copy link
Contributor

Choose a reason for hiding this comment

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

There's an instance of "IMSC1 profile" on line 1118 - does that also need changing to "IMSC 1.0 profile"?

Copy link
Contributor Author

@palemieux palemieux Jan 24, 2018

Choose a reason for hiding this comment

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

Done at ea2637a

Copy link
Contributor

@nigelmegitt nigelmegitt left a comment

Choose a reason for hiding this comment

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

I'm basically happy with this - there's a query re line 1118 and an editorial point, but they should be easily resolved allowing approval from my point of view.

"#ebu-tt-d-interop"></a>; or</p>

<div class='note'>
<p>Additional <code>ebuttm:conformsToStandard</code> elements can be present beyond the two recommended above,
Copy link
Contributor

Choose a reason for hiding this comment

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

Editorial point: I think the word "beyond" is unclear here - I'd prefer "additional to" so that it cannot be interpreted as "instead of".

@@ -1115,15 +1115,22 @@ <h4>Maximum number</h4>
<h3>Profile Signaling</h3>

<p>The <code>ttp:profile</code> attribute SHOULD be present on the <code>tt</code> element and equal to the designator of the
IMSC1 profile to which the <a>Document Instance</a> conforms, and the <code>ttp:profile</code> element SHOULD NOT be present,
unless:</p>
IMSC1 1.0 profile to which the <a>Document Instance</a> conforms, and the <code>ttp:profile</code> element SHOULD NOT be
Copy link
Contributor

Choose a reason for hiding this comment

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

IMSC1 1.0 -> IMSC 1.0 ?

Copy link
Contributor Author

@palemieux palemieux Jan 25, 2018

Choose a reason for hiding this comment

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

Fixed at 4610d2e

@palemieux palemieux merged commit 3f1d31e into master Feb 6, 2018
@palemieux palemieux deleted the issue-301-namespace-naming branch February 9, 2018 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants