From c9dfaaf7d81fb9397a3dbee0dc1edbbff37d8efc Mon Sep 17 00:00:00 2001 From: Christian Heimlich Date: Fri, 4 Jul 2025 07:11:27 -0400 Subject: [PATCH] fix: Country/language code mixup for subtitles A couple sections in the documentation erroneously refer to a subtitle related parameter needing to be an ISO 3166 country code, when they actually are supposed to be an ISO 639 language code. --- mkdocs/docs/search.md | 2 +- mkdocs/docs/settings/actions.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs/docs/search.md b/mkdocs/docs/search.md index 65bf0b0..55fea12 100644 --- a/mkdocs/docs/search.md +++ b/mkdocs/docs/search.md @@ -65,7 +65,7 @@ Clicking the play button on the thumbnail will open the in-place player at the t Narrow down your search with these secondary keywords: -- `lang`: Search for matches only within a language. Use the same two letter ISO country code as you have set on the settings page. +- `lang`: Search for matches only within a language. Use the same two letter ISO 639 language code as you have set on the settings page. - `source`: Can either be *auto* to search through auto generated subtitles only or *user* to search through user uploaded subtitles only. **Example**: diff --git a/mkdocs/docs/settings/actions.md b/mkdocs/docs/settings/actions.md index 161c268..3726a4d 100644 --- a/mkdocs/docs/settings/actions.md +++ b/mkdocs/docs/settings/actions.md @@ -71,7 +71,7 @@ If the video you are trying to import is not available on YouTube any more, **Tu - The file `.info.json` is required to extract the required information. - Add the thumbnail as `.`, where valid file extensions are *.jpg*, *.png* or *.webp*. If there is no thumbnail file, **Tube Archivist** will try to extract the embedded cover from the media file or will fallback to a default thumbnail. -- Add subtitles as `..vtt` where *lang* is the two letter ISO country code. This will archive all subtitle files you add to the import folder, independent from your configurations. Subtitles can be archived and used in the player, but they can't be indexed or made searchable due to the fact, that they have a very different structure than the subtitles as **Tube Archivist** needs them. +- Add subtitles as `..vtt` where *lang* is the appropriate two letter ISO 639 language code. This will archive all subtitle files you add to the import folder, independent from your configurations. Subtitles can be archived and used in the player, but they can't be indexed or made searchable due to the fact, that they have a very different structure than the subtitles as **Tube Archivist** needs them. - For videos, where the whole channel is not available any more, you can add the `.info.json` file as generated by *youtube-dl/yt-dlp* to get the full metadata. Alternatively **Tube Archivist** will extract as much info as possible from the video info.json file. ### Some notes: