From 061b775cd599b014bb4fee629b4357432b79a786 Mon Sep 17 00:00:00 2001 From: Andy <88590076+AAndyProgram@users.noreply.github.com> Date: Mon, 27 Dec 2021 00:36:12 +0300 Subject: [PATCH] Updated Home (markdown) --- Home.md | 136 +++++++++++++++++++++++++++++--------------------------- 1 file changed, 71 insertions(+), 65 deletions(-) diff --git a/Home.md b/Home.md index e6f558c..e020e35 100644 --- a/Home.md +++ b/Home.md @@ -1,129 +1,135 @@ # Main Window -In this window placed all controls for data manipulation. +This window contains all data management tools. - ```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. +- ```Refresh``` - refresh the user list. You do not need to press this button. Added just in case... +- ```Info``` - show downloaded users and what exactly and how many were 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. +This form will show downloaded items (sorted by latest download date). Each line of data contains information about how many images and videos have been downloaded for the user. If no media is downloaded, the user will not appear in this form. -By mouse double click by data row content folder will be opened. +Double-click on the data line will open the content folder. - ```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... + - ```Session``` - show downloaded results for this session only; + - ```All``` - show downloaded results for all users, sorted by last downloaded date. +- ```Refresh``` - update information list. You don't need to press this button. Added just in case... -In ```Session``` view mode information list updates automatically. +In the ```Session``` view, the list is updated automatically. ### Channels -Channels form will be opened. +The channels form will open. More about channels [here](https://github.com/AAndyProgram/SCrawler/wiki/Channels). +### Saved posts + +This button looks like a bookmark. When you click on this button, the program will start downloading your saved Reddit posts. Saved posts are stored in the Reddit data path in the ```!Saved posts``` folder. + ### Download - ```Download selected``` - start downloading one or more selected users. -- ```Download all``` - run the download for all users you added to the program who are marked as ```Ready for download```. **ATTENTION! THIS BUTTON DOESN'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. +- ```Download all``` - run the download for all users you added to the program who are marked as ```Ready for download```. **ATTENTION! THIS BUTTON DOESN'T RESPECT VIEW MODES LIKE LABELS AND/OR GROUPS. THE DOWNLOAD WILL RUN FOR ALL YOUR USERS ANYWAY!** +- ```Download video``` - download a separate video (Reddit and Twitter videos supported) or Instagram post (photo and video). +- ```Stop``` - stop all download operations. ### View - ```View``` - users view modes. - - First block indicates **how** users will be shown in the form. + - The first block specifies **how** users will be displayed on the form. - ```Large/Small images``` - with icons. - ```List``` - simple, without icons. - - Second block indicates **which** users will be shown in the form. + - The second block specifies the **sites** of the users that will be displayed on the form. + - ```All``` - default + - ```Specific sites``` - select sites to be displayed + - The third block specifies **what** users will be displayed on 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. + - ```Regular``` - only show users who are not marked as ```Favorite``` or ```Temporary```. + - ```Temporary``` - only show users marked as temporary. + - ```Favorite``` - only show users marked as favorite. + - ```Labels``` - show users labeled with one or more selected label (click ```Select labels``` to select labels). + - ```No Labels``` - only show users without a label. + - ```Select labels``` - Select one or more labels to display. ### 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... +The error log will be opened by clicking on this button. The log contains program and download errors. The log is saved automatically when you close the program, but you still can save, copy, or clear it (using the special buttons on the log form) if you want... ## 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 +- ```F6``` - start downloading all your users marked as ```Ready for download```. +- ```F2``` - download a separate video or Instagram post +- ```Del``` - delete one or more selected users -By mouse double click on user icon, user's data folder will be opened. +Double-click the user to open the content folder. -## Download standalone video +## Download separate video -*In this form downloading not starting automatically* +*The download does not start automatically in this form* -- ```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. +- ```Add``` - add one video or Instagram post to download. +- ```Add list``` - add one or more video URLs to download. +- ```Delete``` - remove URL. +- ```Download``` - download all videos you added. +- ```Open saving path``` - a folder will open where the videos are downloaded to. ## Users list ### Context menu -- ```Download data``` - download the data of this user/collection. -- ```Download data limited``` - download the data of this user/collection only the specified number of posts. -- ```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. -- ```Ready for download``` - this means when you press button ```Download All``` (in the main window) this user will be downloaded. -- ```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 +- ```Download data``` - download this user/collection data. +- ```Download data limited``` - download this user/collection data only the specified number of posts. +- ```Edit user information``` - open a form to change user parameters. +- ```Delete user/collection``` - delete one or more selected users/collections. +- ```Change favorite``` - if the user was marked as favorite, he becomes a regular; otherwise, he becomes the favorite. +- ```Change temporary``` - if the user was marked as temporary, he becomes a regular; otherwise, he becomes the temporary. +- ```Ready for download``` - download this user in the operation ```Download all```. +- ```Change labels``` - change user labels. +- ```Add to collection``` - add user to collection. +- ```Merge collection files``` - move files to collection root folder. +- ```Change image``` - change user icon. +- ```Open contains folder``` - open selected user/collection folder. +- ```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. +I've developed collections for users with multiple profiles, but you can use them however you like. -Add a new one by pressing ```+``` button or pick up an already exists. +Add a new one by clicking the ```+``` button, or select an existing one. -By adding user in collection, user's data will be moved into the collection folder with name of you picked up. +When you add a user to a collection, the user's data will be moved to the collection folder with the name you specified. -### Merge collection files +### Merging 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. +When you add a user to the collection, a new folder will be created in the collection folder named by pattern ```Site```_```UserName```. That is, each profile in the collection is stored separately. When you merge, all files in the profiles' folders are moved to the root of the collection. #### 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". +You have two users: SomeUserName1 (from Reddit) and SomeUserName1 (from Twitter). +1. Creation of the "First collection" collection. +2. The folder "First collection" will be created in the collections folder (you specify it in the program settings). +3. The SomeUserName1 (Reddit) folder will be moved to the "First collection" folder and renamed to "Reddit_SomeUserName1". +4. The SomeUserName1 (Twitter) folder will be moved to the "First collection" folder and renamed to "Twitter_SomeUserName1". -If you want to merge collection. +If you want to merge the collection. -Files of folders "Reddit_SomeUserName1" and "Twitter_SomeUserName1" will be moved into the -"First collection" folder. +Files from the "Reddit_SomeUserName1" and "Twitter_SomeUserName1" folders will be moved to 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! +The program has the ```Black list```, which included users you have added to. It is only a blacklist of the program and no impact on 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. +Users in this list will be skipped when downloading channels. If you add a new user to the program and this user is already blacklisted, you will receive a notification about. The notification includes the username and the reason (if specified) for 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 +The program implements two ways to add users to this list: +- with a reason (you can specify the reason for the ban for cases if you try to add this user again); +- with no reason. \ No newline at end of file