Merge pull request #144 from AY2122S1-CS2103T-W15-3/update-ug

Update User Guide
AY2122S1-CS2103T-W15-3 · Oct 28, 2021 · cfea315 · cfea315
2 parents 698e676 + 5c5969f
commit cfea315
Show file tree

Hide file tree

Showing 10 changed files with 602 additions and 243 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
diff --git a/docs/images/Ui.png b/docs/images/Ui.png
diff --git a/docs/images/clickableLinkExample.png b/docs/images/clickableLinkExample.png
diff --git a/docs/images/demo-screenshots/BookmarkContact.png b/docs/images/demo-screenshots/BookmarkContact.png
diff --git a/docs/images/demo-screenshots/BookmarkEvents.png b/docs/images/demo-screenshots/BookmarkEvents.png
diff --git a/docs/images/demo-screenshots/UnmarkContacts.png b/docs/images/demo-screenshots/UnmarkContacts.png
diff --git a/docs/images/demo-screenshots/UnmarkEvents.png b/docs/images/demo-screenshots/UnmarkEvents.png
diff --git a/docs/images/demo-screenshots/helpMessage.png b/docs/images/demo-screenshots/helpMessage.png
diff --git a/src/main/java/seedu/address/logic/commands/contact/CFindCommand.java b/src/main/java/seedu/address/logic/commands/contact/CFindCommand.java
@@ -21,18 +21,21 @@
 public class CFindCommand extends Command {
 
     public static final String COMMAND_WORD = "cfind";
+    public static final String PARAMETERS = "[KEYWORD]… "
+            + "[" + PREFIX_PHONE + "KEYWORD…] "
+            + "[" + PREFIX_EMAIL + "KEYWORD…] "
+            + "[" + PREFIX_ADDRESS + "KEYWORD…] "
+            + "[" + PREFIX_TELEGRAM + "KEYWORD…] "
+            + "[" + PREFIX_ZOOM + "KEYWORD…] "
+            + "[" + PREFIX_TAG + "KEYWORD…]\n";
+    public static final String SYNTAX = COMMAND_WORD + " " + PARAMETERS;
 
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all contacts whose fields contains any of the "
             + "given keywords.\n"
-            + "At least one field must be present, name keywords must follow directly after the command word\n"
-            + "Parameters: [NAME_KEYWORD] "
-            + "[" + PREFIX_PHONE + "PHONE_KEYWORDS] "
-            + "[" + PREFIX_EMAIL + "EMAIL_KEYWORDS] "
-            + "[" + PREFIX_ADDRESS + "ADDRESS_KEYWORDS] "
-            + "[" + PREFIX_TELEGRAM + "TELEGRAM_KEYWORDS] "
-            + "[" + PREFIX_ZOOM + "ZOOM_KEYWORDS] "
-            + "[" + PREFIX_TAG + "TAG_KEYWORDS]\n"
+            + "At least one keyword must be present. "
+            + "For name search, keywords must follow directly after the command word\n"
+            + "Parameters: " + PARAMETERS
             + "Example: " + COMMAND_WORD + " alice bob charlie "
             + PREFIX_PHONE + "91234567 "
             + PREFIX_EMAIL + "[email protected]";

diff --git a/src/main/java/seedu/address/logic/commands/event/EFindCommand.java b/src/main/java/seedu/address/logic/commands/event/EFindCommand.java
@@ -22,17 +22,20 @@
 public class EFindCommand extends Command {
 
     public static final String COMMAND_WORD = "efind";
+    public static final String PARAMETERS = "[KEYWORD]… "
+            + "[" + PREFIX_START_TIME + "KEYWORD…] "
+            + "[" + PREFIX_END_TIME + "KEYWORD…] "
+            + "[" + PREFIX_ADDRESS + "KEYWORD…] "
+            + "[" + PREFIX_DESCRIPTION + "KEYWORD…] "
+            + "[" + PREFIX_ZOOM + "KEYWORD…] "
+            + "[" + PREFIX_TAG + "KEYWORD…]\n";
+    public static final String SYNTAX = COMMAND_WORD + " " + PARAMETERS;
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all events whose fields contains any of the "
             + "given keywords.\n"
-            + "At least one field must be present, name keywords must follow directly after the command word\n"
-            + "Parameters: [NAME_KEYWORD] "
-            + "[" + PREFIX_START_TIME + "START_TIME_KEYWORDS] "
-            + "[" + PREFIX_END_TIME + "END_TIME_KEYWORDS] "
-            + "[" + PREFIX_ADDRESS + "ADDRESS_KEYWORDS] "
-            + "[" + PREFIX_DESCRIPTION + "DESCRIPTION_KEYWORDS] "
-            + "[" + PREFIX_ZOOM + "ZOOM_KEYWORDS] "
-            + "[" + PREFIX_TAG + "TAG_KEYWORDS]\n"
+            + "At least one keyword must be present. "
+            + "For name search, keywords must follow directly after the command word\n"
+            + "Parameters: " + PARAMETERS
             + "Example: " + COMMAND_WORD + " cs 2103t "
             + PREFIX_START_TIME + "2020-12-01 "
             + PREFIX_EMAIL + "[email protected]";