Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update namespace documents #581

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

Conversation

palemieux
Copy link
Contributor

No description provided.

@palemieux palemieux requested review from himorin and nigelmegitt May 4, 2023 17:59
@palemieux palemieux self-assigned this May 4, 2023
@nigelmegitt
Copy link
Contributor

nigelmegitt commented May 5, 2023

Would be helpful to make the paths match their eventual destination more closely. Suggest:

URL Current path in this PR Proposed path
http://www.w3.org/ns/ttml/profile/imsc1/extension/ imsc1/spec/imsc-extension-namespace.html profile/imsc1/extension/index.html
http://www.w3.org/ns/ttml/profile/imsc1.1/image imsc1/spec/imsc-image-namespace.html profile/imsc1.1/image.html
http://www.w3.org/ns/ttml/profile/imsc1 imsc1/spec/imsc-namespace.html profile/imsc1.html
http://www.w3.org/ns/ttml/profile/imsc1.2/text imsc1/spec/imsc-text-namespace.html profile/imsc1.2/text.html

I'm wondering if the trailing / in the extension namespace URL is correct, both here and in the IMSC specification?

Also considered: making the path begin with ns/ttml/profile/ instead of profile/.

This is just a suggestion though - any other considerations here @palemieux or @himorin ?

Comment on lines 8 to 9
<p>The namespace <code>http://www.w3.org/ns/ttml/profile/imsc1</code> is specified at <a
href="http://www.w3.org/TR/ttml-imsc/">TTML Text and Image Profiles for Internet Media Subtitles and Captions</a>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

In IMSC the base URI is never used on its own. Instead, fragment identifiers are used i.e. each of #styling, #parameter and #metadata are appended to http://www.w3.org/ns/ttml/profile/imsc1.

Should we add <div id="[styling|parameter|metadata]">...</div> for each, so that the complete URI resolves to something?

And here, state that this document is for the (unused) root of those URIs?

@palemieux
Copy link
Contributor Author

I'm wondering if the trailing / in the extension namespace URL is correct, both here and in the IMSC specification?

Yes, the TTML 1 extension namespace (TT Extension) also has a slash: https://www.w3.org/TR/2018/REC-ttml1-20181108/#vocabulary-namespaces

@nigelmegitt
Copy link
Contributor

Yes, the TTML 1 extension namespace (TT Extension) also has a slash

I see, yes, it's used as an xml:base - I guess that makes sense. Thanks for checking.

@palemieux
Copy link
Contributor Author

Should we add

...
for each, so that the complete URI resolves to something?

See revised text.

@himorin
Copy link
Contributor

himorin commented May 23, 2023

@palemieux I suppose we will copy these files into /ns/ space, so how about to open a PR to w3c/ns repository first to ask about lines to be included in namespace documents?
Like, a PR to update https://github.com/w3c/ns/blob/main/ttml/profile/imsc1/extension/Overview.html for imsc1/spec/imsc-extension-namespace.html, etc.

(Quite sorry for slow response...)

@palemieux palemieux requested a review from nigelmegitt May 23, 2023 14:49
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.

What do you think about the path change suggestions too, @palemieux ?

</head>
<body>
<p>The namespace <code>http://www.w3.org/ns/ttml/profile/imsc1.1/image</code> is specified at <a
href="http://www.w3.org/TR/ttml-imsc1.2/">TTML Text and Image Profiles for Internet Media Subtitles and Captions 1.2</a>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a bit of a conundrum: it's a) a profile designator not a namespace and b) initially specified at https://www.w3.org/TR/ttml-imsc1.1/ - since we don't seem to have any particular motivation to mark IMSC 1.1 as being superseded, should we not link to it instead of 1.2? Or link to both?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The image profile is fully specified in IMSC 1.2, and IMSC 1.2 notes that no substantive changes have not been made since IMSC 1.1, so I think the reference to IMSC 1.2 is appropriate.

<title>IMSC 1.2 Text Profile Designator</title>
</head>
<body>
<p>The namespace <code>http://www.w3.org/ns/ttml/profile/imsc1.2/text</code> is specified at <a
Copy link
Contributor

@nigelmegitt nigelmegitt May 23, 2023

Choose a reason for hiding this comment

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

Suggested change
<p>The namespace <code>http://www.w3.org/ns/ttml/profile/imsc1.2/text</code> is specified at <a
<p>The profile designator <code>http://www.w3.org/ns/ttml/profile/imsc1.2/text</code> is specified at <a

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the purpose of reserving http://www.w3.org/ns/ttml/profile/imsc1.2/text, it is considered a namespace by the W3C AFAIK.

Comment on lines +8 to +9
<p>The namespace <code>http://www.w3.org/ns/ttml/profile/imsc1.1/image</code> is specified at <a
href="http://www.w3.org/TR/ttml-imsc1.2/">TTML Text and Image Profiles for Internet Media Subtitles and Captions 1.2</a>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<p>The namespace <code>http://www.w3.org/ns/ttml/profile/imsc1.1/image</code> is specified at <a
href="http://www.w3.org/TR/ttml-imsc1.2/">TTML Text and Image Profiles for Internet Media Subtitles and Captions 1.2</a>.</p>
<p>The profile designator <code>http://www.w3.org/ns/ttml/profile/imsc1.1/image</code> is specified at <a
href="http://www.w3.org/TR/ttml-imsc1.1/">TTML Text and Image Profiles for Internet Media Subtitles and Captions 1.1</a>.</p>

@palemieux
Copy link
Contributor Author

What do you think about the path change suggestions too, @palemieux ?

I do not think it helps very much since the files need to be manually moved to a different tree.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants