Difference between revisions of "Documentation Talk:Subtitles"

From VideoLAN Wiki
Jump to navigation Jump to search
m
m (copy-edit for clarity)
Line 1: Line 1:
I believe there to be an incorrect statement with regard to the default state of subtitles. The statement refers to the input/codecs tab in the preferences, specifically the "subtitle track" value.  The documentation claims that a "0" value disables subtitles by default, but this does not appear to be true - at least not with current release of VLC (2.1.5).  I have discovered that the value DOES affect the subtitle track - but it serves as a "relative index" value for the "Subtitle>Sub Track" selection menu.  A "-1" corresponds to "Disable", a "0" to the first subtitle-track, a "1" to the second track, and so on...  Currently, this doc claims that a value of "0" disables subtitles.  This should say "-1" to turn subtitles off by default. The statement (instructing how to disable subtitles by default):
+
I believe there to be an incorrect statement with regard to the default state of subtitles.
  
:On the "Subtitle Track ID" selection window, change the value to "0".
+
The statement refers to the input/codecs tab in the preferences, specifically the "subtitle track" value.  The documentation claims that a "0" value disables subtitles by default, but this does not appear to be true &mdash; at least not with current release of VLC (2.1.5).<br />
 +
I have discovered that the value DOES affect the subtitle track &mdash; but it serves as a "relative index" value for the "Subtitle>Sub Track" selection menu.  A "-1" corresponds to "Disable", a "0" to the first subtitle-track, a "1" to the second track, and so on...<br />
 +
Currently, this doc claims that a value of "0" disables subtitles.  This should say "-1" to turn subtitles off by default. The statement (instructing how to disable subtitles by default):
 +
 
 +
:<tt>On the "Subtitle Track ID" selection window, change the value to "0".</tt>
 +
 
 +
I have verified that when set to "-1", the Subtitles>Sub Track is set to "Disable".  When I change the value to "0", the first subtitle track is selected; a value of "1" caused the ''second'' subtitle track to be selected, and so on.<br />
 +
It might be more intuitive if the values did start at "0" (for disabled), as then a "1" would correspond to subtitle track 1... but for now, it is offset by -1 &mdash; which adheres to the convention that "-1" is used to disable an option or feature.<br />
 +
Apologies for the extremely verbose entry here, but as it is my first I want to ensure that I provide full context and leave no room for misinterpretation.
  
I have verified that when set to "-1", the Subtitles>Sub Track is set to "Disable".  When I change the value to "0", the first subtitle track is selected; a value of "1" caused the ''second'' subtitle track to be selected, and so on.  It might be more intuitive if the values did start at "0" (for disabled), as then a "1" would correspond to subtitle track 1... but for now, it is offset by -1 - which adheres to the convention that "-1" is used to disable an option or feature.  Apologies for the extremely verbose entry here, but as it is my first I want to ensure that I provide full context and leave no room for misinterpretation. 
 
 
The ''problem'' though, in short, is very simple.  The wiki should state that "-1" is the correct value to disable subtitles.  It ''could'' be enhanced with wording that explains that the value corresponds to Sub Track, as mentioned above, with 0:sub-track-1, 1:sub-track-2, etc..  At a minimum, for the short term, I propose that the statement be changed to:
 
The ''problem'' though, in short, is very simple.  The wiki should state that "-1" is the correct value to disable subtitles.  It ''could'' be enhanced with wording that explains that the value corresponds to Sub Track, as mentioned above, with 0:sub-track-1, 1:sub-track-2, etc..  At a minimum, for the short term, I propose that the statement be changed to:
  
On the "Subtitle Track ID" selection window, change the value to "-1".
+
:<tt>On the "Subtitle Track ID" selection window, change the value to "-1".</tt>
  
 
At present, the doc is simply incorrect ;-)
 
At present, the doc is simply incorrect ;-)
 +
 +
--[[User:Aprilia1k|Aprilia1k]] ([[User talk:Aprilia1k|talk]]) 18:50, 1 February 2015 (CET)

Revision as of 07:39, 24 February 2015

I believe there to be an incorrect statement with regard to the default state of subtitles.

The statement refers to the input/codecs tab in the preferences, specifically the "subtitle track" value. The documentation claims that a "0" value disables subtitles by default, but this does not appear to be true — at least not with current release of VLC (2.1.5).
I have discovered that the value DOES affect the subtitle track — but it serves as a "relative index" value for the "Subtitle>Sub Track" selection menu. A "-1" corresponds to "Disable", a "0" to the first subtitle-track, a "1" to the second track, and so on...
Currently, this doc claims that a value of "0" disables subtitles. This should say "-1" to turn subtitles off by default. The statement (instructing how to disable subtitles by default):

On the "Subtitle Track ID" selection window, change the value to "0".

I have verified that when set to "-1", the Subtitles>Sub Track is set to "Disable". When I change the value to "0", the first subtitle track is selected; a value of "1" caused the second subtitle track to be selected, and so on.
It might be more intuitive if the values did start at "0" (for disabled), as then a "1" would correspond to subtitle track 1... but for now, it is offset by -1 — which adheres to the convention that "-1" is used to disable an option or feature.
Apologies for the extremely verbose entry here, but as it is my first I want to ensure that I provide full context and leave no room for misinterpretation.

The problem though, in short, is very simple. The wiki should state that "-1" is the correct value to disable subtitles. It could be enhanced with wording that explains that the value corresponds to Sub Track, as mentioned above, with 0:sub-track-1, 1:sub-track-2, etc.. At a minimum, for the short term, I propose that the statement be changed to:

On the "Subtitle Track ID" selection window, change the value to "-1".

At present, the doc is simply incorrect ;-)

--Aprilia1k (talk) 18:50, 1 February 2015 (CET)