tubearchivist-frontend/docs/Home.md

30 lines
2.4 KiB
Markdown
Raw Normal View History

2021-09-26 04:21:54 +00:00
# Tube Archivist Wiki
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.
2021-09-26 04:21:54 +00:00
Table of contents:
2022-02-12 09:27:31 +00:00
* [FAQ](FAQ): Frequently asked questions what this project is and tries to do
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
2021-09-29 06:19:21 +00:00
* [Downloads](Downloads): Scanning subscriptions, handle download queue
* [Settings](Settings): All the configuration options
2021-11-25 16:38:00 +00:00
* [Video](Video): All details of a single video and playlist navigation.
* [Users](Users): User management admin interface
2021-09-28 14:58:43 +00:00
## Getting Started
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.
2021-09-28 14:58:43 +00:00
5. Sit back and enjoy your archived and indexed collection!
## General Navigation
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.
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.
* 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.
2021-09-28 14:58:43 +00:00
2021-09-29 06:19:21 +00:00
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.
2021-10-03 12:35:33 +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, 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.