diff --git a/Channels.md b/Channels.md index 7072e6e..5d9ab29 100644 --- a/Channels.md +++ b/Channels.md @@ -7,14 +7,14 @@ Accessible at `/channel/` of your Tube Archivist, the **Overview Page** shows a - You can filter that list to show or hide subscribed channels from the drop down menu. Clicking on the channel banner or the channel name will direct you to the *Channel Detail Page*. - If you are subscribed to a channel a *Unsubscribe* button will show. -The **Subscribe to Channels** button add icon opens a text field to subscribe to a channel. You have a few options: +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. For example *UCBa659QWEk1AI4Tg--mrJ2A* - Enter the URL to the channel page on YouTube. For example *https://www.youtube.com/channel/UCBa659QWEk1AI4Tg--mrJ2A* - 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* - Add one per line. - **Note**: Adding a link to a YouTube username will not work, for example: *https://www.youtube.com/c/TomScottGo* will fail, because a user can have multiple channels. On YouTube same as on **Tube Archivist**, you can only subscribe to a channel and *not* a user. -The search icon search icon opens a text box to search for indexed channel names. Possible matches will show as you type. +The search icon search icon opens a text box to search for indexed channel names. Possible matches will show as you type. ## Channel Detail Each channel will get a dedicated channel detail page accessible at `/channel//` of your Tube Archivist. This page shows all the videos you have downloaded from this channel plus additional metadata. diff --git a/Home.md b/Home.md index 3be976e..8a38826 100644 --- a/Home.md +++ b/Home.md @@ -5,25 +5,23 @@ Welcome to the official Tube Archivist Wiki. This is an up-to-date documentation of user functionality. Table of contents: -* [Main](Main.md): Tube Archivist landing page -* [Channels](Channels.md): Browse your channels, handle subscriptions -* [Downloads](Downloads.md): Scanning subscriptions, handle download queue -* [Settings](Settings.md): All the configuration options +* [Main](Main): Tube Archivist landing page +* [Channels](Channels): Browse your channels, handle subscriptions +* [Downloads](Downloads): Scanning subscriptions, handle download queue +* [Settings](Settings): All the configuration options ## Getting Started -1. [Subscribe](Channels.md#channels-overview) to some of your favourite YouTube channels. -2. [Scan](Downloads.md#rescan-subscriptions) subscriptions to add the latest videos to the download queue. -3. [Add](Downloads.md#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download. -4. [Download](Downloads.md#download-queue) and let **Tube Archivist** do it's thing. +1. [Subscribe](Channels#channels-overview) to some of your favourite YouTube channels. +2. [Scan](Downloads#rescan-subscriptions) subscriptions to add the latest videos to the download queue. +3. [Add](Downloads#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download. +4. [Download](Downloads#download-queue) and let **Tube Archivist** do it's thing. 5. Sit back and enjoy your archived and indexed collection! ## General Navigation -* Clicking on the channel name or the channel icon brings you to the dedicated channel page to show videos from to that channel. +* Clicking on the channel name or the channel icon brings you to the dedicated channel page to show videos from that channel. * Clicking on a video title brings you to the dedicated video page and shows additional details. * Clicking on a video thumbnail opens the video player and starts streaming the selected video. * Hover over the playing video to show additional control options. -Videos you *haven't* marked as **watched** show a empty checkbox, click on it to mark it as watched: -unseen icon -Videos you *have* marked as watched, will show as a filled checkbox: -seen icon \ No newline at end of file + +An empty checkbox icon unseen icon will show for videos you haven't marked as watched. Click on it and the icon will change to a filled checkbox seen icon indicating it as watched. diff --git a/Main.md b/Main.md index 6119e8d..6f80522 100644 --- a/Main.md +++ b/Main.md @@ -7,4 +7,4 @@ This is the landing page, when you first open **Tube Archivist**. You have a few - With **Hide Watched** you can filter out videos you have already marked as watched to only show unwatched videos. - You can use those two options together to for example filter the list to *Hide Watched* videos **and** sort by date downloaded. -Additionally the search icon search icon opens a text field to search your collection. +Additionally the search icon search icon opens a text field to search your collection. diff --git a/Settings.md b/Settings.md index 18ba306..72495bc 100644 --- a/Settings.md +++ b/Settings.md @@ -8,7 +8,7 @@ Switch between the easy on the eyes dark theme and the burning bright theme. ## Archive View These default values will get applied on container restart. -- **Default Sort**: This defines the default sort order as described on the [Main](Main.md) page. +- **Default Sort**: This defines the default sort order as described on the [Main](Main) page. - **Default Hide Watched**: Hide watched videos by default. - **Show Subscribed Channels Only**: This controls the filter on the *Channel Overview Page*. - **Page Size**: Defines how many results get displayed on a given page. Same value goes for all archive views. @@ -61,4 +61,4 @@ BE AWARE: This will **not** backup any media files, just the metadata from the E ## Restore From Backup The restore functionality will expect the same zip file in *cache/backup* as created from the **Backup database** function. This will recreate the index from the snapshot. If there are multiple backup files in the folder, the newest one will take priority. -BE AWARE: This will **replace** your current index with the one from the backup file. This won't restore any media files. \ No newline at end of file +BE AWARE: This will **replace** your current index with the one from the backup file. This won't restore any media files. diff --git a/assets/icon-search.png b/assets/icon-search.png new file mode 100644 index 0000000..ee82c61 Binary files /dev/null and b/assets/icon-search.png differ diff --git a/assets/icon-seen.png b/assets/icon-seen.png new file mode 100644 index 0000000..fc5988c Binary files /dev/null and b/assets/icon-seen.png differ diff --git a/assets/icon-unseen.png b/assets/icon-unseen.png new file mode 100644 index 0000000..8b7778b Binary files /dev/null and b/assets/icon-unseen.png differ