diff --git a/mkdocs/docs/assets/icon-filter.png b/mkdocs/docs/assets/icon-filter.png new file mode 100644 index 0000000..f832ba7 Binary files /dev/null and b/mkdocs/docs/assets/icon-filter.png differ diff --git a/mkdocs/docs/assets/icon-multi-select.png b/mkdocs/docs/assets/icon-multi-select.png new file mode 100644 index 0000000..bae60a6 Binary files /dev/null and b/mkdocs/docs/assets/icon-multi-select.png differ diff --git a/mkdocs/docs/downloads.md b/mkdocs/docs/downloads.md index d7cf24a..dbc4259 100644 --- a/mkdocs/docs/downloads.md +++ b/mkdocs/docs/downloads.md @@ -25,7 +25,14 @@ After downloading, **Tube Archivist** tries to add new videos to already indexed The **Add to Download Queue** icon add icon opens a text field to manually add videos to the download queue. Add one item per line. This will _not_ add videos already in the queue, previously ignored or already indexed. ### Fast add -This will add videos in bulk to the queue, at the expense of having less metadata and no thumbnail available in the download queue. The full metadata will get index as usual after downloading. Particularly usefull to add whole channels and playlists in bulk, has no effect when just adding a single video. +This will add videos in bulk to the queue, at the expense of having less metadata and no thumbnail available in the download queue. The full metadata will get index as usual after downloading. Particularly usefull when adding whole channels and playlists, has no effect when adding single videos. + +### Re-Download +In some cases you might want to re-download videos. For example if you unexpectedly got a lower resolution or if you want to upgrade the archive with better quality media files. + +- This will add, download and index videos again, even if they are already in your archive. +- This will _not_ add videos already in the queue or previously ignored. +- Also see [multiselect](index.md#multiselect). ### Auto download If you add them with *Download Now*, this will start the download automatically with priority. diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md index dd2ca85..6e881ff 100644 --- a/mkdocs/docs/index.md +++ b/mkdocs/docs/index.md @@ -20,19 +20,63 @@ Welcome to the official Tube Archivist Docs. This is an up-to-date documentation * Clicking on the search icon gridview icon 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. - +### Watched State 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 - click again to revert. -When available, the gridview icon gridview icon will display the list in a grid. A grid row holds 3 items by default, use the listview icon icon to add more or the listview icon icon to remove items per row, depending on your screen size. The listview icon listview icon will arrange the items in a list. The sort icon listview icon will open additional sort options. In places where videos are listed the gridview icon tableview will allow you to get technical information like video codec, audio codec, filesize and image resolution of the listed videos. +### Display layout +- gridview icon: Gridview icon will display the list in a grid. A grid row holds 3 items by default. + - listview icon: On larger screens, the plus icon adds more items to the grid row. + - listview icon: The minus icon reduces items per row. +- listview icon: The list view arranges the items in a list. +- gridview icon: The tableview will allow you to get technical information like video codec, audio codec, filesize and image resolution of the listed videos. +### Sort +Toggle sort options by clicking on the listview icon sort icon. This gives sort by options for: + +- Published: Date published +- Downloaded: Date downloaded +- Views: View count +- Likes: Like count +- Duration: Duration of the video +- Media Size: Mediasize on disk +- Width: In pixels +- Height: In pixels + +Additionally you can change the sort order to: + +- Desc: Descending +- Asc: Ascending + +### Filter +The filter icon gridview icon Shows options for filtering: + +- Watched state: Show watched only, unwatched only or all. +- Types: By video types, that's regular videos, shorts or streams. +- Height: Media file height in pixels. That is useful for upgrading video resolutions or to verify if you downloaded the expected resolution. Works best in table view: gridview icon. + +### Multiselect +The multi select icon gridview icon allows you to select multiple videos to then apply actions in bulk. + +- Select/unselect videos individually by clicking on the checkbox overlay on the top left of the video thumbnail. In table view gridview icon, the select checkbox is in the first column. +- An info box will indicate how many videos you have selected. The selection persists over page navigation and between different views. +- In tableview gridview icon an additional "select all" checkbox is show, to select all videos visible. That is dependent on your [Archive View Page Size](settings/user.md#archive-view-page-size). +- The "clear" button will empty your selection. +- To avoid confusion when multiselect is active, the watched checkbox is hidden. +- Toggle the multiselect icon again to exit multiselect mode. + +Then the actions currently supported: + +- **Redownload**: This downloads and indexes the selected videos again. Also see [Downloads#re-download](downloads.md#re-download). + +## Keyboard Shortcuts You can control the video player with the following keyboard shortcuts: - `?`: Show help - `p`: Toggle play/pause -- `m`: toggle mute -- `f`: toggle fullscreen -- `c`: toggle subtitles if available -- `>`: increase playback speed -- `<`: decrease playback speed -- `←` (left arrow): jump back 5 seconds -- `→` (right arrow): jump forward 5 seconds +- `m`: Toggle mute +- `f`: Toggle fullscreen +- `c`: Toggle subtitles if available +- `>`: Increase playback speed +- `<`: Decrease playback speed +- `←` (left arrow): Jump back 5 seconds +- `→` (right arrow): Jump forward 5 seconds