tubearchivist/docs/Home.md

# Tube Archivist Wiki
Welcome to the official Tube Archivist Wiki. This is an up-to-date documentation of user functionality.

Table of contents:
* [FAQ](FAQ): Frequently asked questions what this project is and tries to do
* [Channels](Channels): Browse your channels, handle channel subscriptions
* [Playlists](Playlists): Browse your indexed playlists, handle playlist subscriptions
* [Downloads](Downloads): Scanning subscriptions, handle download queue
* [Settings](Settings): All the configuration options
* [Video](Video): All details of a single video and playlist navigation.
* [Users](Users): User management admin interface
* [Installation](Installation): WIP - detailed installation instructions for various platforms.

## Getting Started
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 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.
* Clicking on the search icon <img src="assets/icon-search.png?raw=true" alt="gridview icon" width="20px" style="margin:0 5px;"> will open a dedicated search page to search over your complete index.
* The pagination - if available - builds links for up to 10'000 results, use the search, sort or filter functionality to find what you are looking for.


An empty checkbox icon <img src="assets/icon-unseen.png?raw=true" alt="unseen icon" width="20px" style="margin:0 5px;"> will show for videos you haven't marked as watched. Click on it and the icon will change to a filled checkbox <img src="assets/icon-seen.png?raw=true" alt="seen icon" width="20px" style="margin:0 5px;"> indicating it as watched - click again to revert.

When available the <img src="assets/icon-gridview.png?raw=true" alt="gridview icon" width="20px" style="margin:0 5px;"> gridview icon will display the list in a grid. A grid row holds 3 items by default, use the <img src="assets/icon-add.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> icon to add more or the <img src="assets/icon-substract.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> icon to remove items per row, depending on your screen size. The <img src="assets/icon-listview.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> listview icon will arrange the items in a list. The sort icon <img src="assets/icon-sort.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> will open additional sort options.
initial wiki pages 2021-09-26 04:21:54 +00:00			`# Tube Archivist Wiki`
documenting main pages 2021-09-28 14:58:43 +00:00			`Welcome to the official Tube Archivist Wiki. This is an up-to-date documentation of user functionality.`

initial wiki pages 2021-09-26 04:21:54 +00:00			`Table of contents:`
add FAQ wiki page 2022-02-12 09:27:31 +00:00			`* [FAQ](FAQ): Frequently asked questions what this project is and tries to do`
update docs with playlist info 2021-11-25 16:38:00 +00:00			`* [Channels](Channels): Browse your channels, handle channel subscriptions`
			`* [Playlists](Playlists): Browse your indexed playlists, handle playlist subscriptions`
fix links and icons 2021-09-29 06:19:21 +00:00			`* [Downloads](Downloads): Scanning subscriptions, handle download queue`
			`* [Settings](Settings): All the configuration options`
update docs with playlist info 2021-11-25 16:38:00 +00:00			`* [Video](Video): All details of a single video and playlist navigation.`
add throttled-rate and user management docs 2021-10-26 11:21:36 +00:00			`* [Users](Users): User management admin interface`
add link to installation.md to home 2022-04-10 09:53:07 +00:00			`* [Installation](Installation): WIP - detailed installation instructions for various platforms.`
documenting main pages 2021-09-28 14:58:43 +00:00
			`## Getting Started`
fix links and icons 2021-09-29 06:19:21 +00:00			`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.`
documenting main pages 2021-09-28 14:58:43 +00:00			`5. Sit back and enjoy your archived and indexed collection!`

			`## General Navigation`
fix links and icons 2021-09-29 06:19:21 +00:00			`* Clicking on the channel name or the channel icon brings you to the dedicated channel page to show videos from that channel.`
documenting main pages 2021-09-28 14:58:43 +00:00			`* 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.`
wiki refresh for new search functionality 2022-01-08 14:21:49 +00:00			`* Clicking on the search icon <img src="assets/icon-search.png?raw=true" alt="gridview icon" width="20px" style="margin:0 5px;"> will open a dedicated search page to search over your complete index.`
indicate max page size on downloads page, add note to wiki, #156 2022-02-12 12:42:07 +00:00			`* The pagination - if available - builds links for up to 10'000 results, use the search, sort or filter functionality to find what you are looking for.`
documenting main pages 2021-09-28 14:58:43 +00:00
fix links and icons 2021-09-29 06:19:21 +00:00
update docs for v0.0.6 take 2 2021-10-17 04:31:21 +00:00			`An empty checkbox icon <img src="assets/icon-unseen.png?raw=true" alt="unseen icon" width="20px" style="margin:0 5px;"> will show for videos you haven't marked as watched. Click on it and the icon will change to a filled checkbox <img src="assets/icon-seen.png?raw=true" alt="seen icon" width="20px" style="margin:0 5px;"> indicating it as watched - click again to revert.`
bumping versions for new release 2021-10-03 12:35:33 +00:00
update docs for v0.1.6 2022-06-01 10:00:06 +00:00			When available the <img src="assets/icon-gridview.png?raw=true" alt="gridview icon" width="20px" style="margin:0 5px;"> gridview icon will display the list in a grid. A grid row holds 3 items by default, use the <img src="assets/icon-add.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> icon to add more or the <img src="assets/icon-substract.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> icon to remove items per row, depending on your screen size. The <img src="assets/icon-listview.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> listview icon will arrange the items in a list. The sort icon <img src="assets/icon-sort.png?raw=true" alt="listview icon" width="20px" style="margin:0 5px;"> will open additional sort options.