2019-05-01, 02:35
This is an FYI concerning the use of <displayseason> and <displayepisode> tags in tvshow episode nfo files.
I looked in the wiki on tvshow nfo files, and it shows their existence, but provides no guidance (that I could find at least) on how to use them. There is an example nfo file with both set to "-1" but no explanation. So I examined these by test in Kodi 18.2 and also inspected VideoInfoTag.cpp in the code.
Findings:
1. These tags are used for placing special episodes into the media container lists for episodes sorted by episode. First, it is important that the video files (and corresponding nfos) be named using the "S00" (or analog) season identifier. The E01 episode identifier can also be significant as explained further below.
2. The setting media/video "flatten tv show seasons" controls in part where these specials are displayed. If "Never" there will be a tvshow media view for seasons with a "specials" season (followed by any other seasons) and when selected will show all the special episodes ordered by E01 episode number. This is always true. If "Always" the view for seasons doesn't exist and there will be no "specials" season listing. Instead the default is for all the specials to be displayed first ordered by E01 episode number.
3. The <displayseason> and <displayepisode> tags will force the special episodes to appear within a season even when the "flatten tv show seasons" is set to "Never" (in this case they will display within a season in addition to within the "specials" season).
4. The <displayseason> tag determines in which season folder (when tv show flatten" is "never") or the season/episode order (if "always") the special appears. Setting it to null, 0, or -1 (as in the wiki example) all cause the special NOT to show in a season folder ("never") or at the top of the episode list ("always"). The <displayepisode> tag determines which regular episode the special will sort BEFORE. So setting <displayepisode> to 5 will result in the special sorting before regular episode 5. Multiple specials can use the same <displayseason> and <displayepisode> setting. In that case they will be displayed in E01 episode order BEFORE the regular episode number in the tag. Setting the <displayepisode> tag to null, 1, 0, or -1 (as in the wiki example) will cause the special to order FIRST within the season.
5. There is another tag available that is not documented in the wiki: <displayafterseason>. This tag is a shorthand way of forcing the special to sort at the END of the season. For example <displayafterseason>2</displayafterseaon> will cause that special to sort as the LAST episode of the season 2 (it is the same as using <displayseason>2</displayseason> <displayepisode>1000</displayepisode>). There's no reason to use both displayseason/displayepisode and displayafterseason in the nfo file (but if you do the last one "wins").
I hope this is helpful for other users.
scott s.
.
I looked in the wiki on tvshow nfo files, and it shows their existence, but provides no guidance (that I could find at least) on how to use them. There is an example nfo file with both set to "-1" but no explanation. So I examined these by test in Kodi 18.2 and also inspected VideoInfoTag.cpp in the code.
Findings:
1. These tags are used for placing special episodes into the media container lists for episodes sorted by episode. First, it is important that the video files (and corresponding nfos) be named using the "S00" (or analog) season identifier. The E01 episode identifier can also be significant as explained further below.
2. The setting media/video "flatten tv show seasons" controls in part where these specials are displayed. If "Never" there will be a tvshow media view for seasons with a "specials" season (followed by any other seasons) and when selected will show all the special episodes ordered by E01 episode number. This is always true. If "Always" the view for seasons doesn't exist and there will be no "specials" season listing. Instead the default is for all the specials to be displayed first ordered by E01 episode number.
3. The <displayseason> and <displayepisode> tags will force the special episodes to appear within a season even when the "flatten tv show seasons" is set to "Never" (in this case they will display within a season in addition to within the "specials" season).
4. The <displayseason> tag determines in which season folder (when tv show flatten" is "never") or the season/episode order (if "always") the special appears. Setting it to null, 0, or -1 (as in the wiki example) all cause the special NOT to show in a season folder ("never") or at the top of the episode list ("always"). The <displayepisode> tag determines which regular episode the special will sort BEFORE. So setting <displayepisode> to 5 will result in the special sorting before regular episode 5. Multiple specials can use the same <displayseason> and <displayepisode> setting. In that case they will be displayed in E01 episode order BEFORE the regular episode number in the tag. Setting the <displayepisode> tag to null, 1, 0, or -1 (as in the wiki example) will cause the special to order FIRST within the season.
5. There is another tag available that is not documented in the wiki: <displayafterseason>. This tag is a shorthand way of forcing the special to sort at the END of the season. For example <displayafterseason>2</displayafterseaon> will cause that special to sort as the LAST episode of the season 2 (it is the same as using <displayseason>2</displayseason> <displayepisode>1000</displayepisode>). There's no reason to use both displayseason/displayepisode and displayafterseason in the nfo file (but if you do the last one "wins").
I hope this is helpful for other users.
scott s.
.