This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 28073 - [WebVTT] Rename "line position" to something more appropriate?
Summary: [WebVTT] Rename "line position" to something more appropriate?
Status: RESOLVED FIXED
Alias: None
Product: TextTracks CG
Classification: Unclassified
Component: WebVTT (show other bugs)
Version: unspecified
Hardware: PC All
: P2 normal
Target Milestone: ---
Assignee: This bug has no owner yet - up for the taking
QA Contact: Web Media Text Tracks CG
URL:
Whiteboard: v1 widereview
Keywords:
Depends on:
Blocks:
 
Reported: 2015-02-22 10:28 UTC by Silvia Pfeiffer
Modified: 2017-07-10 23:41 UTC (History)
4 users (show)

See Also:


Attachments

Description Silvia Pfeiffer 2015-02-22 10:28:52 UTC
The line position is actually more referring to the concept of a 
cue box than to the concept of a line. The first sentence states "The 
line position defines the position of the cue box.". It would be could 
to have a term that describe this "feature" as an property of the cue 
box instead of lines. As the syntax maybe hard to change it could help 
if a synonymous word could be found.

As per feedback by Andreas Tai:
http://lists.w3.org/Archives/Public/public-texttracks/2015Feb/0005.html
Comment 1 Silvia Pfeiffer 2015-02-22 10:29:54 UTC
Maybe "cue position"?
Comment 2 Silvia Pfeiffer 2015-02-22 10:30:34 UTC
Futher feedback by Andreas:
Furthermore a relationship to text 
position could be used in addition. While text position "defines the 
positioning of the cue box in the direction defined by the writing 
direction", the line positon defines the position of the cue box 
orthogonal to the direction defined by the writing direction (?).
Comment 3 Philip Jägenstedt 2015-02-27 11:14:55 UTC
The names on VTTCue seem pretty sensible to me: line and position.

We could possibly call the concepts simply "A line" and "A position" too, but would that be any clearer? I guess "A line position" is a bit less wrong when it comes to percentage line positions.
Comment 4 Silvia Pfeiffer 2015-03-08 08:46:57 UTC
x and y dimensions don't work either because line and position depend on the writing direction.

We could start using "offset".


How about improving the definition of "text position" and "line position":

The text position defines the offset of the cue box in the direction defined by the writing direction.

"position alignment" then defines what that offset is anchored at wrt the cue box: start, middle or end of cue box in direction defined by the writing direction.

The line position defines the offset of the cue box orthogonal to the direction defined by the writing direction.

"line alignment" then defines what that offset is anchored at wrt the cue box: start, middle or end of cue box in direction orthogonal to the direction defined by the writing direction.
Comment 5 Andreas Tai 2015-03-22 15:50:44 UTC
Makes sense to me.(In reply to Silvia Pfeiffer from comment #4)
> x and y dimensions don't work either because line and position depend on the
> writing direction.
> 
> We could start using "offset".
> 
> 
> How about improving the definition of "text position" and "line position":
> 
> The text position defines the offset of the cue box in the direction defined
> by the writing direction.
> 
> "position alignment" then defines what that offset is anchored at wrt the
> cue box: start, middle or end of cue box in direction defined by the writing
> direction.
> 
> The line position defines the offset of the cue box orthogonal to the
> direction defined by the writing direction.
> 
> "line alignment" then defines what that offset is anchored at wrt the cue
> box: start, middle or end of cue box in direction orthogonal to the
> direction defined by the writing direction.

Makes sense to me.
Comment 6 Philip Jägenstedt 2015-03-23 09:55:47 UTC
In my own reading of the spec, the definitions (which could be improved) aren't the biggest source of confusion. Rather it's that the labels "line position" and "text position" are easy enough to confuse, in particular I often have to check if "line position" corresponds to VTTCue.line or VTTCue.position.
Comment 7 Silvia Pfeiffer 2015-06-07 08:40:59 UTC
(In reply to Philip Jägenstedt from comment #6)
> In my own reading of the spec, the definitions (which could be improved)
> aren't the biggest source of confusion. Rather it's that the labels "line
> position" and "text position" are easy enough to confuse, in particular I
> often have to check if "line position" corresponds to VTTCue.line or
> VTTCue.position.

How about "line offset" and "text offset" then? That clarifies "line position"...
Comment 8 Silvia Pfeiffer 2015-06-07 08:58:17 UTC
(In reply to Silvia Pfeiffer from comment #7)
> (In reply to Philip Jägenstedt from comment #6)
> > In my own reading of the spec, the definitions (which could be improved)
> > aren't the biggest source of confusion. Rather it's that the labels "line
> > position" and "text position" are easy enough to confuse, in particular I
> > often have to check if "line position" corresponds to VTTCue.line or
> > VTTCue.position.
> 
> How about "line offset" and "text offset" then? That clarifies "line
> position"...

Actually, "text position" remains, of course. But "line offset" could work.
Comment 9 Silvia Pfeiffer 2015-06-07 09:26:54 UTC
I've given it a go at https://github.com/w3c/webvtt/pull/194 . See what you think.
Comment 10 Philip Jägenstedt 2015-06-08 12:50:42 UTC
Merged.
Comment 11 Philip Jägenstedt 2015-06-09 10:05:20 UTC
Reopened due to https://github.com/w3c/webvtt/pull/194#issuecomment-110051562
Comment 12 Silvia Pfeiffer 2015-06-12 21:57:24 UTC
Further improvements in https://github.com/w3c/webvtt/pull/197 .

IMO that change has made things much clearer. The word offset works really well because it explains clearly what the lines are offset from, i.e. which side of the video viewport.
Comment 13 Silvia Pfeiffer 2015-08-09 06:29:03 UTC
Fix landed. Please open new bugs if you want to further tweak the language.
Comment 14 David Singer 2016-10-11 18:25:04 UTC
wording improved (line offset, etc.)
Comment 15 Andreas Tai 2017-07-10 06:16:33 UTC
There has been a long discussion about this issue and the current status in the draft seems to reflect what can be achieved. Therefore, I accept that only part of the original proposal can be addressed. From my view the original PR (https://github.com/w3c/webvtt/pull/197) was a good pragmatic way to solve the problem. By disconnecting the terminology from the "cue" concept in PR 211 (https://github.com/w3c/webvtt/pull/211) the solution was reverted and the situation has not really improved. But because it seems not possible to come to another agreement, the dependencies between the different parts make terminology changes very difficult and also because this has been in the draft now for 2 years, it seems best to not start the discussion again.
Comment 16 Silvia Pfeiffer 2017-07-10 07:10:55 UTC
Hi Andreas,
Thanks for going through all your bugs and accepting the decisions!

On this bug FYI: in the end we renamed "line position" to "line offset", so we actually did accept the change.
Comment 17 Andreas Tai 2017-07-10 19:30:13 UTC
Hi Silvia,

The full comment in my email was as follows:

" The line position is actually more referring to the concept of a
cue box than to the concept of a line. The first sentence states "The
line position defines the position of the cue box.". It would be could
to have a term that describe this "feature" as an property of the cue
box instead of lines. As the syntax maybe hard to change it could help
if a synonymous word could be found. Furthermore a relationship to text
position could be used in addition. While text position "defines the
positioning of the cue box in the direction defined by the writing
direction", the line positon defines the position of the cue box
orthogonal to the direction defined by the writing direction (?)."


In the version I reviewed Feb 2015 the terms have been:

"line position" and "text position"

Now the terms are:

"line" and "position"


If you read just the first sentences of each concept it seems a bit circular:

line: The line defines positioning of the cue box.

position: The position defines the indent of the cue box in the direction defined by the writing direction.


"line offset" is used in the description once ("The line offsets the cue box from the top...") but not as the name of the concept.

So overall, I am not sure if it is now better then before. 

(I use as reference the latest editor draft from 25th of June 2017)
Comment 18 Silvia Pfeiffer 2017-07-10 23:41:41 UTC
A cue box is position by counting lines from the top and a percentage indent from the left. That's why they use of the word "line" makes sense - and the wording "line offset" has been used to describe it.

You seem to have more of a problem with the word "position" though - it would probably have been better to use "indent" for it, but that's likely a bit too late.

May it would be best to add a drawing that explains the concepts. The words we choose are always going to be ambiguous to some people.

Also, we could make just a simple change from:
"line: The line defines positioning of the cue box."
to
"line: The line defines the offset of the cue box."