diff --git a/mkdocs/docs/channels.md b/mkdocs/docs/channels.md index a55aa01..b95716d 100644 --- a/mkdocs/docs/channels.md +++ b/mkdocs/docs/channels.md @@ -13,13 +13,9 @@ Accessible at `/channel/` of your Tube Archivist, the **Overview Page** shows a The **Subscribe to Channels** button add icon opens a text field to subscribe to a channel. You have a few options: -- Enter the YouTube channel ID, a 25 character alphanumeric string. Example: - - `UCBa659QWEk1AI4Tg--mrJ2A` -- Enter the URL to the channel page on YouTube. Example: - - `https://www.youtube.com/channel/UCBa659QWEk1AI4Tg--mrJ2A` or alias url `https://www.youtube.com/@TomScottGo` -- Enter a channel alias starting with *@*, for example: `@TomScottGo` -- Enter the video URL for any video and let Tube Archivist extract the channel ID for you, for example `https://www.youtube.com/watch?v=2tdiKTSdE9Y` -- If you want to subscribe to more than one channel directly, you can add one channel per line in the text field +- Enter a [channel](urls.md#channel). +- Enter a [video](urls.md#video) and let Tube Archivist extract the channel ID for you. +- Add one per line. To search your channels, click on the search icon search icon to reach the search page. Start your query with `channel:`, learn more on the [search](search.md) page. diff --git a/mkdocs/docs/downloads.md b/mkdocs/docs/downloads.md index 999a065..176a2a2 100644 --- a/mkdocs/docs/downloads.md +++ b/mkdocs/docs/downloads.md @@ -27,30 +27,13 @@ The **Add to Download Queue** icon You opens a text field to subscribe to playlists. You have a few options: -- Enter the YouTube playlist id, for example: - - `PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha` -- Enter the Youtube dedicated playlist url, for example: - - `https://www.youtube.com/playlist?list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha` -- If you want to subscribe to more than one playlist directly, you can add one playlist per line in the text field +- Enter a playlist [playlist](urls.md#playlist) +- Add one per line. !!! note It doesn't make sense to subscribe to a playlist if you are already subscribed the corresponding channel as this will slow down the **Rescan Subscriptions** [task](downloads.md#rescan-subscriptions). diff --git a/mkdocs/docs/urls.md b/mkdocs/docs/urls.md new file mode 100644 index 0000000..96d5099 --- /dev/null +++ b/mkdocs/docs/urls.md @@ -0,0 +1,43 @@ +--- +description: How URLs from YouTube get parsed +--- + +# URLs +This document describes how Tube Archivist identifies and treats links from YouTube. + +!!! note + Application logic of Tube Archivist is tied only to the IDs, not the names. + +## Video +A video ID is **11** characters long, e.g. `2tdiKTSdE9Y`. + +Urls can have several forms: + +- Watch URL: Regular URLs so will see while browsing YouTube, with the path */watch* and a *v* parameter, e.g. `https://www.youtube.com/watch?v=2tdiKTSdE9Y` +- Share URL: Link you will get when you click on *share* on a video, e.g. `https://youtu.be/2tdiKTSdE9Y` +- Shorts URL: e.g. `https://www.youtube.com/shorts/U80grnZJm_8` + +## Channel +A channel ID is **24** characters long, e.g. `UCBa659QWEk1AI4Tg--mrJ2A`. + +Channel URLs can have these forms, all will get translated to the ID: + +- ID URL: With a *channel* path, e.g. `https://www.youtube.com/channel/UCBa659QWEk1AI4Tg--mrJ2A` +- Channel Handle: Starting with a `@` this handle is personal and unique, e.g. `@TomScottGo` +- Alias URL: Based off the channel handle, e.g. `https://www.youtube.com/@TomScottGo` + +### Channel sub pages +Tube archivist can separate between different subpages: + +- Videos only: `https://www.youtube.com/@IBRACORP/videos` +- Shorts only: `https://www.youtube.com/@IBRACORP/shorts` +- Streams only: `https://www.youtube.com/@IBRACORP/streams` +- Every other channel sub page will default to download all, for example `https://www.youtube.com/@IBRACORP/featured` will download videos and shorts and streams. + +## Playlist +A playlist ID can be `34`, `26` or `18` characters long, e.g. `PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha` + +- Playlist URLs start with a *playlist* path and has a *list* parameter, e.g. `https://www.youtube.com/playlist?list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha` + +### Playlist vs Video URLs +While browsing YouTube videos in Playlists, you might encounter URLs looking like that: `https://www.youtube.com/watch?v=QPZ0pIK_wsc&list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha`. As established above, based on the */watch* path and the *v* parameter, Tube Archivist will treat this as a video with the ID `QPZ0pIK_wsc` and **not** as a playlist. If you mean the playlist, you can easily grab the correct ID from the URL, e.g. `PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha`. diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml index b1877a4..84a5134 100644 --- a/mkdocs/mkdocs.yml +++ b/mkdocs/mkdocs.yml @@ -4,6 +4,7 @@ nav: - Home: 'index.md' - User Guide: - 'FAQ': 'faq.md' + - 'URLs': 'urls.md' - 'Downloads Page': 'downloads.md' - 'Channels Pages': 'channels.md' - 'Video': 'video.md'