mirror of
https://github.com/tubearchivist/tubearchivist
synced 2024-11-02 09:41:07 +00:00
33 lines
3.0 KiB
Markdown
33 lines
3.0 KiB
Markdown
# 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
|
|
* [Search](Search): Search your archive
|
|
* [Installation](Installation): 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.
|