From 709c7b88f57baf1b7856ee82634150cf1224dc3c Mon Sep 17 00:00:00 2001 From: simon Date: Sat, 8 Jan 2022 21:21:49 +0700 Subject: [PATCH] wiki refresh for new search functionality --- docs/Channels.md | 6 +++--- docs/Downloads.md | 2 +- docs/Home.md | 5 ++--- docs/Main.md | 10 ---------- docs/Playlists.md | 4 ++-- docs/Settings.md | 5 +++++ docs/assets/icon-sort.png | Bin 0 -> 2063 bytes 7 files changed, 13 insertions(+), 19 deletions(-) delete mode 100644 docs/Main.md create mode 100644 docs/assets/icon-sort.png diff --git a/docs/Channels.md b/docs/Channels.md index 3de8bb8..ff34f6d 100644 --- a/docs/Channels.md +++ b/docs/Channels.md @@ -1,6 +1,6 @@ # Channels Overview and Channel Detail Page -The channels are organized on two different levels, similar as the playlists: +The channels are organized on two different levels, similar as the [playlists](Playlists): ## Channels Overview Accessible at `/channel/` of your Tube Archivist, the **Overview Page** shows a list of all channels you have indexed. @@ -14,13 +14,13 @@ The **Subscribe to Channels** button opens a text box to search for indexed channel names. Possible matches will show as you type. +You can search your indexed channels by clicking on the search icon search icon. This will open a dedicated page. ## 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. - If you are subscribed to the channel, an *Unsubscribe* button will show, else the *Subscribe* button will show. - You can *Show* the channel description, that matches with the *About* tab on YouTube. - The **Mark as Watched** button will mark all videos of this channel as watched. -- The button **Delete Channel** will delete the channel plus all videos of this channel, both media files and metadata. +- The button **Delete Channel** will delete the channel plus all videos of this channel, both media files and metadata additionally this will also delete playlists metadata belonging to that channel. - The button **Find Playlists** will go out to youtube and look for playlists belonging to this channel and index all with at least one video downloaded. Only do this for channels where you care about playlists as this will slow down indexing new videos for having to check which playlist this belongs to. - The button **Show Playlists** will go to the [playlists](Playlists) page and filter the list to only show playlists from this channel. diff --git a/docs/Downloads.md b/docs/Downloads.md index dce6ad8..2174644 100644 --- a/docs/Downloads.md +++ b/docs/Downloads.md @@ -5,7 +5,7 @@ Accessible at `/downloads/` of your Tube Archivist, this page handles all the do ## Rescan Subscriptions The **Rescan Subscriptions** icon rescan icon will start a background task to look for new videos from the channels and playlists you are subscribed to. You can define the channel and playlist page size on the [settings page](Settings#subscriptions). With the default page size, expect this process to take around 2-3 seconds for each channel or playlist you are subscribed to. A status message will show the progress. -Then for every video found, **Tube Archivist** will skip the video if it has already been downloaded or if you added it to the *ignored* list before. All the other videos will get added to the download queue. Expect this to take around 1 second for each video as **Tube Archivist** needs to grab some additional metadata. New videos will get added at the bottom of the download queue. +Then for every video found, **Tube Archivist** will skip the video if it has already been downloaded or if you added it to the *ignored* list before. All the other videos will get added to the download queue. Expect this to take around 2 seconds for each video as **Tube Archivist** needs to grab some additional metadata. New videos will get added at the bottom of the download queue. ## Download Queue The **Start Download** icon download icon will start the download process starting from the top of the queue. Take a look at the relevant settings on the [Settings Page](Settings#downloads). Once the process started, a progress message will show with additional details and controls: diff --git a/docs/Home.md b/docs/Home.md index e1f5a2f..6a0ba77 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -2,7 +2,6 @@ Welcome to the official Tube Archivist Wiki. This is an up-to-date documentation of user functionality. Table of contents: -* [Main](Main): Tube Archivist landing page * [Channels](Channels): Browse your channels, handle channel subscriptions * [Playlists](Playlists): Browse your indexed playlists, handle playlist subscriptions * [Downloads](Downloads): Scanning subscriptions, handle download queue @@ -21,9 +20,9 @@ Table of contents: * 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. +* Clicking on the search icon gridview icon will open a dedicated search page to search over your complete index. 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, the listview icon listview icon will arrange the items in a list. +When available the gridview icon gridview icon will display the list in a grid, the listview icon listview icon will arrange the items in a list. The sort icon listview icon will open additional sort options. diff --git a/docs/Main.md b/docs/Main.md deleted file mode 100644 index 6f80522..0000000 --- a/docs/Main.md +++ /dev/null @@ -1,10 +0,0 @@ -# Tube Archivist Home Page Functionality - -This is the landing page, when you first open **Tube Archivist**. You have a few options to sort and filter that view: -- With the **Sort Order** you can select how the "Recent Videos" are sorted: - - **Date Published**: Sorts the list by date when the video was published on YouTube, newest on top. - - **Date Downloaded**: Sorts the list based on when you have downloaded the video to your archive, newest on top. -- 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. diff --git a/docs/Playlists.md b/docs/Playlists.md index 7f3a8e0..cede675 100644 --- a/docs/Playlists.md +++ b/docs/Playlists.md @@ -1,5 +1,5 @@ # Playlist Overview and Playlist Detail Page -The playlists are organized in two different levels, similar as the channels: +The playlists are organized in two different levels, similar as the [channels](Channels): ## Playlist Overview Accessible at `/playlist/` of your Tube Archivist, this **Overview Page** shows a list of all playlists you have indexed over all your channels. @@ -13,7 +13,7 @@ The **Subscribe to Playlist** button opens a text box to search for indexed playlists. +You can search your indexed playlists by clicking on the search icon search icon. This will open a dedicated page. ## Playlist Detail Each playlist will get a dedicated playlist detail page accessible at `/playlist//` of your Tube Archivist. This page shows all the videos you have downloaded from this playlist. diff --git a/docs/Settings.md b/docs/Settings.md index a3c0d7b..22d1484 100644 --- a/docs/Settings.md +++ b/docs/Settings.md @@ -27,6 +27,10 @@ Additional settings passed to yt-dlp. - **Embed Metadata**: This saves the available tags directly into the media file by passing `--embed-metadata` to yt-dlp. - **Embed Thumbnail**: This will save the thumbnail into the media file by passing `--embed-thumbnail` to yt-dlp. +## Integrations +All third party integrations of TubeArchivist will **always** be *opt in*. +- **returnyoutubedislike.com**: This will get dislikes and average ratings for each video back by integarting with the API from [returnyoutubedislike.com](https://www.returnyoutubedislike.com/). + # Scheduler Setup Schedule settings expect a cron like format, where the first value is minute, second is hour and third is day of the week. Day 0 is Sunday, day 1 is Monday etc. @@ -40,6 +44,7 @@ Examples: NOTE: - Changes in the scheduler settings require a container restart to take effect. +- Cron format as *number*/*number* are none standard cron and are not supported by the scheduler, for example **0 0/12 \*** is invalid, use **0 \*/12 \*** instead. - Avoid an unnecessary frequent schedule to not get blocked by YouTube. For that reason * or wildcards for minutes are not supported. ## Rescan Subscriptions diff --git a/docs/assets/icon-sort.png b/docs/assets/icon-sort.png new file mode 100644 index 0000000000000000000000000000000000000000..c8d895caaaad379766da0edd7cfc9775d780c762 GIT binary patch literal 2063 zcmXAqdsI@{8o*Jr?zPO(N*ycEv^0}ptX9^FhoyEZ$LE;VI7;PYQ(kd=qzHN_yZK`3 zct?wpNz7+uNoGY$L3E{}-Av8Wn~bPXhL4m3DhNlor{<5}`u6_zZ+&}z-#@z`G#Ie9 zaO){xf&MHW8WpV`hj4ehT3{T?jN=Q4#cEkwZYz z)A8i(tsWOFU|U$a{U<}UdH%>j#Q)Z4aPg?_vs*Vnr|mz%x8a1hHb)|DJQ{~sKt3-s z!dF=7lINcYF3xva?Kyf<{hqhH!yXw<3#*$R>f77h9Xwh!ABO?aTl}9zq^ba)T%q4H zSL}Z`&mS1JwmW$Eul>DoWcg2G0P#26bPr$s$j;)uyr(RTQub)Gs99GjHLwXI zq5%;{{Q{_XToU9YIDzVQNssbSV;_^{F#EKT)59+$!-$|Y%fy7pc#KZ9o= zj+~uVKT|U~8P_RILVnhy`i}Z6hbo(NJ?5%!rY7(h#COH}g-lg+p4JAOQ;oObHiMa} z>KBq#EYGq6n}PAkbK#8wi0s4EDh2U#xMkVQi%LrAvRWC~2tmdYk^`mY{eY(GP|~-& zjiNYYP)Sl~58)hHyY*M#>VBY;cNN?k??g&2E)|~1rm1Id%NoIT#CprYxghdm96gR3V8N&D|k*qhb)@vfQmZ{zc+{$n`doJf?-?}fKU^tX;7Z|cl90@<+i3J z`RMB^MmseY$ual9!Z_95qk}~GC{-wlDFhHHJL8MR0%3d0P@+79AS=g|=3Sy#Tb0w> zO;gF9J+4MJV74C85wKqb)*=_J*})V>_s4}z%3~@4WI}$+{CzW!6$P1hW8oN*)mtT0 zCy909nLv$4kQQSIRis<7}btmR=FnG4uiiOJP8&#)T9GrbNiTvFa8 z+E+3{o}lH!M6SbM%R?Ulu`}4cv0`3nA$M3lI?>N;C+O*9W}YrUTyi!kxmfuEp0SoY zh(^B^ho6UOaanEy^2B%~Wlv_YBd&1P`>9s)TynZo)HA2q_D`}8eb@5*KnNw9Ll`je zWI>cKJE~#tmtcy@Dh2hEwY(O!WZqPxMKv^SiZL~`@pDW_Fje;H^AdS3UxO+EchK$rztfN3?gP3xA3H*x)ErybMF9pz-&wRv%w82lFG(qS-b@-QdeO@0`4& z*CnTa!IhytQ}`k3>&aH}*9kc+qQYazWdfGnog-AU7<5M)TFd-+ks9WNZjp&}Mcxn05rzB{q#(b}OfR?*jw z$zh+3OWU%Ue462Io#blYrumvIE6c!Z#fIovIB(VLOUvFQbT1ZlgSOj6`y&W3tUwx7xTBjHip|2C&lTXhlY@qU>V_6S|Ru}2B@5-k&ErtBvX3rLKk|B2E z!!l1}usBk?#z2(EZD8@J_jQIWU&K%5YIK?V##AIw3-Y@T;rsS{NDjejY+-gR{^Ifa zcKtUU$ZEZ)(HSmEV+Rxo9>&OZ|u7D_g|X|V)D%IR&AfN=|}%_%#na#|N4U`bN&yDq+I_1 literal 0 HcmV?d00001