commit 26f99f36281658be3df8bc01908a28cb0af1ed56 Author: Andy <88590076+AAndyProgram@users.noreply.github.com> Date: Tue Dec 7 10:00:37 2021 +0300 Created Home (markdown) diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..8c6b785 --- /dev/null +++ b/Home.md @@ -0,0 +1,127 @@ +# Main Window + +In this window placed all controls for data manipulation. + +- ```Add/Edit/Delete``` - actions with users. +- ```Refresh``` - refresh users list. Not need to press this button. Added just for case... +- ```Info``` - show downloaded users and what exactly and how much been downloaded. + +## Buttons + +### Info + +In this form will be shown items which was downloaded (sorted by latest download date). Each data row provides information how many pictures and videos were downloaded for user. If no one media file downloaded, then user will not be shown in this form. + +By mouse double click by data row content folder will be opened. + +- ```View``` - view modes: + - ```Session``` - will be shown downloaded results by this session only; + - ```All``` - all users will be shown with sort by latest downloaded date. +- ```Refresh``` - refresh information list. Not need to press this button. Added just for case... + +In ```Session``` view mode information list updates automatically. + +### Channels + +Channels form will be opened. + +More about channels here. + +### Download + +- ```Download selected``` - run downloading one or more selected users +- ```Download all``` - run downloading all of users you have added to the program. **ATTENTION! THIS BUTTON DON'T RESPECT VIEW MODES LIKE LABELS AND/OR GROUPS. DOWNLOAD WILL BE RUNNING FOR ALL USERS YOU HAVE IN EITHER CASE!** +- ```Download video``` - download standalone video (Reddit and Twitter videos supported) +- ```Stop``` - stop all downloading operations + +### View + +- ```View``` - users view modes. + - First block indicates **how** users will be shown in the form. + - ```Large/Small images``` - with icons. + - ```List``` - simple, without icons. + - Second block indicates **which** users will be shown in the form. + - ```All``` - default. + - ```Regular``` - show users only which doesn't mark as ```Favorite``` or ```Temporary```. + - ```Temporary``` - show only users which marked as temporary. + - ```Favorite``` - show only users which marked as favorite. + - ```Labels``` - show users labeled with selected one or more label (press ```Select labels``` for select labels). + - ```No Labels``` - show users only which has no label. + - ```Select labels``` - labels form will be opened by press this button. Check one or more labels for show. + +### LOG + +Error log will be opened by click this button. Log contains program and downloading errors. Log saved automatically by program closing but you still can save it, copy, or clear (by using special log form buttons), if you want to... + +## Hot keys + +- ```Insert``` - add user +- ```F3``` - edit user +- ```F5``` - start downloading one or more selected users +- ```F6``` - start downloading all users you have. **Use carefully** +- ```F2``` - download standalone video by URL +- ```Del``` - delete one or more users + +By mouse double click on user icon, user's data folder will be opened. + +## Download standalone video + +*In this form downloading not starting automatically* + +- ```Add``` - add one video to download +- ```Add list``` - add one or more URLs to download +- ```Delete``` - delete some URL +- ```Download``` - download all video you have added +- ```Open saving path``` - folder will be opened in which videos downloaded to + +## Users list + +### Context menu + +- ```Download data``` - download data of this user/collection +- ```Edit user information``` - user editor will be opened by click on this button +- ```Delete user/collection``` - delete one or more selected users and/or collections. You will notify to confirm before delete. +- ```Change favorite``` - if user was marked as favorite then it becomes regular; otherwise, it becomes favorite. +- ```Change temporary``` - the same behavior like ```Change favorite``` but for temporary parameter. +- ```Change labels``` - change user labels +- ```Add to collection``` - add user to collection +- ```Merge collection files``` - move files into the root collection folder. +- ```Change image``` - change user icon +- ```Open contains folder``` - opening data folder of the user/collection you are selected +- ```Open site``` - open user profile +- ```Information``` - some user information + +## Collections + +Basically, I developed collections for multi profiles users, but you can use it by any you want. + +Add a new one by pressing ```+``` button or pick up an already exists. + +By adding user in collection, user's data will be moved into the collection folder with name of you picked up. + +### Merge collection files + +By the adding user in collection, new folder will be created in collection folder named by pattern ```Site```_```UserName```. It means each profile in collection stored separately. Merging collection files moving all files from all collection's profiles folders into the root folder. + +#### Collections example + +You have two users: SomeUserName1 (of Reddit) and SomeUserName1 (of Twitter). +1. Creating collection "First collection" +2. In the collections folder (you set it up in the program settings) will be created folder "First collection" +3. Folder SomeUserName1 (of Reddit) will be moved into "First collection" folder and renamed to "Reddit_SomeUserName1" +4. Folder SomeUserName1 (of Twitter) will be moved into "First collection" folder and renamed to "Twitter_SomeUserName1" + +If you want to merge collection. + +Files of folders "Reddit_SomeUserName1" and "Twitter_SomeUserName1" will be moved into the +"First collection" folder. + +# Black list + +The program has the ```Black list``` which included users you added to. It is only program blacklist and no effect to the site! + +Users who included in this list will be skipped on the channels downloading. If you add new user in the program and this user already exists in the blacklist, then you will notify about. Notification includes username and reason (if pointed) of deletion. + +In the program implemented two methods to add users in this list: +- with the reason (you can point the reason of ban for cases if you will try to add this user again); +- without the reason. \ No newline at end of file