Merge pull request AY2324S1-CS2103T-W10-1#179 from ylyma/fix-bugs

Update UI images
amosting · Nov 11, 2023 · 9cb4501 · 9cb4501
2 parents 9cefad2 + 2ee6dbb
commit 9cb4501
Show file tree

Hide file tree

Showing 43 changed files with 56 additions and 37 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -303,7 +303,7 @@ The following activity diagram summarizes what happens when a user executes a `c
 
 ![CompareActivityDiagram](images/CompareActivityDiagram.png)
 
-### \[Proposed\] Comment feature
+### Comment feature
 
 #### Implementation
 The comment command allows users to insert a comment on TA applicants in TAfinder app.

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -133,7 +133,7 @@ An example of the final command is displayed below.
 
 </box>
 
-The GUI similar to the below should appear in a few seconds. ![Ui](images/Ui.png)
+The GUI similar to the below should appear in a few seconds. ![Ui](images/navigationUI.png)
 
 ### 1.3. Utilisation
 
@@ -164,17 +164,17 @@ OR return to the [Table of Contents](#table-of-contents) to find your desired co
 </box>
 
 ### 1.4. Navigating the User Interface
-![UI with shaded areas](images/tafinder-UI.png)
+![UI with shaded areas](images/navigation_coloredUI.png)
 
 The UI has the following areas:
-- <span style="background-color:rgba(126, 217, 87, 1)">Navigation bar</span>
+- <span style="background-color:#70AD47">Navigation bar</span>
   - This is where you can navigate to the `File` and `Help` menus.
-- <span style="background-color:rgba(255, 222, 89, 1)">Command Input Box</span>
+- <span style="background-color:#FFC000">Command Input Box</span>
   - This where commands are typed
   - press `Enter` to execute it.
-- <span style="background-color:rgba(255, 112, 112, 1)">Command Result Screen</span>
+- <span style="background-color:#FF0000">Command Result Screen</span>
   - This is where the result of the command is displayed. Applicants are displayed in a list format.
-- <span style="background-color:rgba(170, 210, 232, 1)">Applicant list</span>
+- <span style="background-color:#2A035D">Applicant list</span>
   - This is where the list of applicants is displayed.
 
 --------------------------------------------------------------------------------------------------------------------
@@ -282,7 +282,7 @@ Here are some examples you can try with the `add` command.
 
 Following the example above, if you entered everything correctly, you should see the following:
 
-![add.jpg](images/add_command_image_UG.png)
+![add.jpg](images/add_afterUI.png)
 
 You have now successfully added your first applicant to the list. As you add more applicants to the list,
 watch out for the expected and erroneous messages below that could be displayed in the command result screen!
@@ -329,14 +329,14 @@ Repeated applicant:<br>
 
 #### 2.1.2. Editing an applicant: `edit`
 
-![edit function UI](images/editUI.png)
-
 <box type="definition">
 
 Edits an existing applicant in the list of applicants.
 
 </box>
 
+![edit function UI](images/edit_afterUI.png)
+
 <box type="info">
 
 **Format:**
@@ -428,14 +428,14 @@ Index out of range:<br>
 ---
 
 #### 2.1.3. Deleting an applicant: `delete`
-![delete function UI](images/delete-UI.png)
-
 <box type="definition">
 
 Delete a singular existing applicant in the list of applicants.
 
 </box>
 
+![delete function UI](images/delete_afterUI.png)
+
 <box type="info">
 
 **Format:**
@@ -510,8 +510,6 @@ Shows a list of applicants.
 
 </box>
 
-![listUI-1](images/listUI-1.png)
-![listUI-2](images/listUI-2.png)
 
 <box type="info">
 
@@ -526,34 +524,40 @@ Shows a list of applicants.
 
 </box>
 
+![listUI](images/listUI.png)
+
 <box no-icon type="info" light>
 
 **`list hidden`**
 - Shows a list of all hidden applicants.
 
 </box>
 
+![listhiddenUI](images/listhiddenUI.png)
+
 <box no-icon type="info" light>
 
 **`list bookmarked`**
 - Shows a list of all bookmarked applicants.
 
 </box>
 
+![listbookmarkedUI](images/listbookmarkedUI.png)
+
 </box>
 
 ---
 
 #### 2.1.5. Viewing the details of a single applicant: `view`
 
-![edit function UI](images/viewUI.png)
-
 <box type="definition">
 
 Displays a single applicant.
 
 </box>
 
+![edit function UI](images/viewUI.png)
+
 <box type="info">
 
 **Format:**
@@ -614,7 +618,6 @@ Confirmation message:<br>
 
 </box>
 
-
 <box type="wrong">
 
 **Errors:**
@@ -648,9 +651,6 @@ Hides/unhides an applicant from the list of applicants.
 
 </box>
 
-![hide function UI](images/hideUI.png)
-
-
 <box type="info">
 
 **Format:** 
@@ -660,24 +660,32 @@ Hides/unhides an applicant from the list of applicants.
 <box no-icon type="info" light>
 
 `hide INDEX`
-- Hides the applicant at the specified INDEX from all future lists. The index refers to the number shown in the displayed person list.
+- Hides the applicant at the specified INDEX from all future lists. The index refers to the number shown in the displayed person list.</br>
+  Index must be a positive integer (e.g. 1, 2, 3...).
 
 </box>
 
+![hideUI](images/hide_afterUI.png)
+
 <box no-icon type="info" light>
 
 `unhide INDEX`
-- Unhides the applicant at the specified INDEX from all future lists. The index refers to the number shown in the displayed person list.
+- Unhides the applicant at the specified INDEX from all future lists. The index refers to the number shown in the displayed person list. </br>
+Index must be a positive integer (e.g. 1, 2, 3...).
 
 </box>
 
+![unhideUI](images/unhide_afterUI.png)
+
 <box no-icon type="info" light>
 
 `unhide-all`
 - Unhides all applicants that were previously hidden.
 
 </box>
 
+![unhideallUI](images/unhideall_afterUI.png)
+
 </box>
 
 <box type="info" theme="dark">
@@ -694,7 +702,7 @@ Hides/unhides an applicant from the list of applicants.
 <box type="default" light>
 
 **`list hidden` then `unhide 2`**
-- Lists all hidden applicants, then unhides the applicant at index 2 of the list of hidden applicants.
+- Lists all hidden applicants, then unhides the applicant at index 2 in the list of hidden applicants.
 
 </box>
 
@@ -756,7 +764,10 @@ Sorts applicants by a field
 
 </box>
 
-![sort function UI](images/sortUI.png)
+|              Before                |               After                |
+|:----------------------------------:|:----------------------------------:|
+| ![sortUI](images/sort_afterUI.png) | ![sortUI](images/sort_afterUI.png) |
+
 
 <box type="info">
 
@@ -890,14 +901,18 @@ Comparing the same applicant:<br>
 
 #### 2.2.5. Bookmarking/Unbookmarking applicants: `bookmark/unbookmark`
 
-![bookmark function UI](images/bookmarkUI.png)
+
 
 <box type="definition">
 
 Bookmarks/Unbookmarks a specific applicant.
 
 </box>
 
+|                        Before                         |               After                |
+|:-----------------------------------------------------:|:----------------------------------:|
+| ![bookmark function UI](images/bookmark_beforeUI.png) | ![bookmark function UI](images/bookmark_afterUI.png) |
+
 <box type="info">
 
 **Format:**
@@ -979,7 +994,7 @@ Lets find out how to do use the comment feature to do so.
 
 **Format:**
 
-**`comment INDEX COMMENT`**
+**`comment INDEX c/COMMENT`**
 
 <box no-icon type="info" seamless>
 
@@ -1004,7 +1019,7 @@ The index of the applicant is the number beside the applicant's name in the list
 
 Following the example above, if you entered everything correctly, you should see the following:
 
-![comments.jpg](images/comment.jpg)
+![commentUI.jpg](images/comment_afterUI.png)
 
 You have now successfully commented on the applicant. As you comment on more applicants in the list,
 watch out for the expected and erroneous messages below that could be displayed in the command result screen!
@@ -1057,6 +1072,10 @@ Imports an entire list of applicants along with their details from a CSV file.
 
 </box>
 
+|            Sample .csv             |                After import                |
+|:----------------------------------:|:------------------------------------------:|
+| ![sampleCSV](images/samplecsv.png) |   ![importUI](images/import_afterUI.png)   |
+
 <box type="info">
 
 **Format:**
@@ -1115,14 +1134,14 @@ Missing file permissions or invalid file path:<br>
 
 #### 2.3.2. Attaching file to applicant profiles: `attach`
 
-![attach function UI](images/attachUI.png)
-
 <box type="definition">
 
 Attaches local files to the profiles of applicants to provide even more richness and insight into their applications
 
 </box>
 
+![attach function UI](images/attach_afterUI.png)
+
 <box type="info">
 
 **Format:**

diff --git a/docs/images/add_afterUI.png b/docs/images/add_afterUI.png
diff --git a/docs/images/attachUI.png b/docs/images/attachUI.png
diff --git a/docs/images/attach_afterUI.png b/docs/images/attach_afterUI.png
diff --git a/docs/images/attach_beforeUI.png b/docs/images/attach_beforeUI.png
diff --git a/docs/images/bookmarkUI.png b/docs/images/bookmarkUI.png
diff --git a/docs/images/bookmark_afterUI.png b/docs/images/bookmark_afterUI.png
diff --git a/docs/images/bookmark_beforeUI.png b/docs/images/bookmark_beforeUI.png
diff --git a/docs/images/comment_afterUI.png b/docs/images/comment_afterUI.png
diff --git a/docs/images/comment_beforeUI.png b/docs/images/comment_beforeUI.png
diff --git a/docs/images/compareUI.png b/docs/images/compareUI.png
diff --git a/docs/images/delete-UI.png b/docs/images/delete-UI.png
diff --git a/docs/images/delete_afterUI.png b/docs/images/delete_afterUI.png
diff --git a/docs/images/delete_beforeUI.png b/docs/images/delete_beforeUI.png
diff --git a/docs/images/editUI.png b/docs/images/editUI.png
diff --git a/docs/images/edit_afterUI.png b/docs/images/edit_afterUI.png
diff --git a/docs/images/edit_beforeUI.png b/docs/images/edit_beforeUI.png
diff --git a/docs/images/exportUI.png b/docs/images/exportUI.png
diff --git a/docs/images/hideUI.png b/docs/images/hideUI.png
diff --git a/docs/images/hide_afterUI.png b/docs/images/hide_afterUI.png
diff --git a/docs/images/hide_beforeUI.png b/docs/images/hide_beforeUI.png
diff --git a/docs/images/import_afterUI.png b/docs/images/import_afterUI.png
diff --git a/docs/images/import_beforeUI.png b/docs/images/import_beforeUI.png
diff --git a/docs/images/listUI-1.png b/docs/images/listUI-1.png
diff --git a/docs/images/listUI-2.png b/docs/images/listUI-2.png
diff --git a/docs/images/listUI.png b/docs/images/listUI.png
diff --git a/docs/images/listbookmarkedUI.png b/docs/images/listbookmarkedUI.png
diff --git a/docs/images/listhiddenUI.png b/docs/images/listhiddenUI.png
diff --git a/docs/images/navigationUI.png b/docs/images/navigationUI.png
diff --git a/docs/images/navigation_coloredUI.png b/docs/images/navigation_coloredUI.png
diff --git a/docs/images/samplecsv.png b/docs/images/samplecsv.png
diff --git a/docs/images/sortUI.png b/docs/images/sortUI.png
diff --git a/docs/images/sort_afterUI.png b/docs/images/sort_afterUI.png
diff --git a/docs/images/sort_beforeUI.png b/docs/images/sort_beforeUI.png
diff --git a/docs/images/unhide_afterUI.png b/docs/images/unhide_afterUI.png
diff --git a/docs/images/unhide_beforeUI.png b/docs/images/unhide_beforeUI.png
diff --git a/docs/images/unhideall_afterUI.png b/docs/images/unhideall_afterUI.png
diff --git a/docs/images/unhideall_beforeUI.png b/docs/images/unhideall_beforeUI.png
diff --git a/docs/images/viewUI.png b/docs/images/viewUI.png
diff --git a/src/main/java/seedu/address/MainApp.java b/src/main/java/seedu/address/MainApp.java
@@ -70,10 +70,10 @@ public void init() throws Exception {
     /**
      * Returns a {@code ModelManager} with the data from {@code storage}'s address
      * book and {@code userPrefs}. <br>
-     * The data from the sample address book will be used instead if
-     * {@code storage}'s address book is not found,
-     * or an empty address book will be used instead if errors occur when reading
-     * {@code storage}'s address book.
+     * The data from the sample applicant list will be used instead if
+     * {@code storage}'s applicant list is not found,
+     * or an empty applicant list will be used instead if errors occur when reading
+     * {@code storage}'s applicant list.
      */
     private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) {
         logger.info("Using data file : " + storage.getAddressBookFilePath());
@@ -84,12 +84,12 @@ private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) {
             addressBookOptional = storage.readAddressBook();
             if (!addressBookOptional.isPresent()) {
                 logger.info("Creating a new data file " + storage.getAddressBookFilePath()
-                        + " populated with a sample AddressBook.");
+                        + " populated with a sample applicant list.");
             }
             initialData = addressBookOptional.orElseGet(SampleDataUtil::getSampleAddressBook);
         } catch (DataLoadingException e) {
             logger.warning("Data file at " + storage.getAddressBookFilePath() + " could not be loaded."
-                    + " Will be starting with an empty AddressBook.");
+                    + " Will be starting with an empty applicant list.");
             initialData = new AddressBook();
         }
 

diff --git a/src/main/java/seedu/address/logic/commands/ListCommand.java b/src/main/java/seedu/address/logic/commands/ListCommand.java
@@ -36,7 +36,7 @@ public CommandResult execute(Model model) {
         requireNonNull(model);
 
         if (fieldName.isEmpty()) {
-            model.updateFilteredPersonList(Model.PREDICATE_SHOW_ALL_PERSONS);
+            model.updateFilteredPersonList(Model.PREDICATE_SHOW_ALL_UNHIDDEN_PERSONS);
         } else {
             Predicate<Person> predicate = new ListPredicate(fieldName, true);
             model.updateFilteredPersonList(predicate);

diff --git a/src/main/java/seedu/address/model/UserPrefs.java b/src/main/java/seedu/address/model/UserPrefs.java
@@ -14,7 +14,7 @@
 public class UserPrefs implements ReadOnlyUserPrefs {
 
     private GuiSettings guiSettings = new GuiSettings();
-    private Path addressBookFilePath = Paths.get("data" , "addressbook.json");
+    private Path addressBookFilePath = Paths.get("data" , "tafinder.json");
     private Path attachmentsBasePath = Paths.get("data" , "attachments");
 
     /**