diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 44e573d7bda..4b70faecf57 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -19,6 +19,9 @@ D.A.V.E. is here to enhance your advisory journey by simplifying information man - [Glossary](#Glossary) - [Tutorial for new users](#D.A.V.E.-Tutorial-for-new-users) - [Features](#Features) +- [FAQ](#faq) +- [Known issues](#known-issues) +- [Command Summary](#command-summary) # Glossary @@ -56,9 +59,14 @@ e.g. if the command specifies `exit 2`, it will be interpreted as the `exit` com - What it does: Add potential leads and their basic information, e.g. name, age, year of study, major, etc. - Command format: `addlead n/NAME p/PHONE e/EMAIL a/ADDRESS k/KEY_MILESTONE [m/MEETING_TIME] [t/TAG]...`. - Example usage: `Example: addlead n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 k/01/12/2023 m/10/10/2023 14:30 t/classmate`. + + Duplicate names are not allowed in the record. The system will prevent the entry of the same name for more than once. + + - Acceptable values for each compulsory parameter: - `NAME`: can contain any string of alphanumeric characters. - The name can contain spaces but cannot be blank (only contain spaces). + - Names are case-sensitive. This means that "John" and "john" are treated as different names, and you can enter both in the record without any issues. - `PHONE`: any valid 8-digit integer, at least 3 digits long. - `EMAIL`: a string of the format `local-part@domain` - The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). @@ -94,9 +102,15 @@ Example: addlead n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2 - What it does: Add potential clients and their basic information, e.g. name, age, year of study, major, etc. - Command format: `addclient n/NAME p/PHONE e/EMAIL a/ADDRESS [m/MEETING_TIME] [t/TAG]...`. - Example usage: `Example: addclient n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 m/10/10/2023 14:30 t/classmate`. + + + Duplicate names are not allowed in the record. The system will prevent the entry of the same name for more than once. + + - Acceptable values for each compulsory parameter: - `NAME`: can contain any string of alphanumeric characters. - The name can contain spaces but cannot be blank (only contain spaces). + - Names are case-sensitive. This means that "John" and "john" are treated as different names, and you can enter both in the record without any issues. - `PHONE`: any valid 8-digit integer, at least 3 digits long. - `EMAIL`: a string of the format `local-part@domain` - The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). @@ -308,11 +322,21 @@ Example: deletemeeting 1 ### Edit - -- What it does: Edit the details of a lead or client. +- What it does: Edit the details of a lead or a client. - Command format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [k/KEY_MILESTONE] [t/TAG]...` + + + Duplicate names are not allowed in the record. The system will prevent the entry of the same name for more than once. + + - Example usage: `edit 1 n/John Doe p/98765432` + + + This command will clear the tags of a lead or client. + + +

Before using edit

@@ -433,6 +457,7 @@ from current date to ensure a follow-up by the user. `The person index provided is invalid` + ### Locating person by name - What it does: Finds persons whose names contain any of the given keywords. - Command format: `find NAME [MORE_NAMES]` @@ -480,5 +505,50 @@ Example usage: - What it does: Exits the program. - Command format: `exit`. - - +-------------------------------------------------------------------------- +## FAQ + +**Q**: How do I transfer my data to another computer?
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous JobFestGo home folder. + +**Q**: What do I do if the clicking of the Dave JAR file does not work?
+**A**: Given below are the steps to launch Dave using CLI: + +1. Open the command prompt +1. Navigate to the directory where the JAR file is located using cd [JAR file location] +1. Type `java -jar DAVE.jar` and press enter +1. Dave should launch + +**Q**: How can I check my Java version? +**A**: Open a command prompt and type `java -version` . If you do not have Java installed, you +can download it [here](https://www.oracle.com/java/technologies/downloads/#java11). + +--------------------------------------------------------------------------------- + +## Known issues + +1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. + +---------------------------------------------------------------------------------- +## Command summary + + +Action | Format, Examples +-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------- +**Add lead** | `addlead n/NAME p/PHONE e/EMAIL a/ADDRESS k/KEY_MILESTONE [m/MEETING_TIME] [t/TAG]...​`
e.g. `addlead n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 k/01/12/2023 m/10/10/2023 14:30 t/classmate` +**Add client** | `addclient n/NAME p/PHONE e/EMAIL a/ADDRESS [m/MEETING_TIME] [t/TAG]...​`
e.g. `addclient n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 m/10/10/2023 14:30 t/classmate` +**View all leads and clients** | `list` +**View all clients** | `listclient` +**View all leads** | `listlead` +**View a specific person** | `view INDEX`
e.g. `view 1` +**Delete** | `delete INDEX`
e.g. `delete 1` +**Add meeting time** | `addmeeting INDEX m/MEETING_TIME`
e.g. `addmeeting 1 m/12/10/2023 16:00` +**Delete meeting time** | `deletemeeting INDEX`
e.g. `deletemeeting 1` +**Edit** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [k/KEY_MILESTONE] [t/TAG]...​`
e.g. `edit 1 n/John Doe p/98765432` +**Sort meeting time** | `sortmeeting` +**Convert lead to client** | `convertoclient INDEX`
e.g. `converttoclient 1` +**Convert client to lead** | `convertolead INDEX`
e.g. `converttolead 1` +**Locating person by name** | `find NAME [MORE_NAMES]`
e.g. `find John David` +**Clear** | `clear` +**Help** | `help` +**Exit** | `exit` diff --git a/docs/_markbind/layouts/default.md b/docs/_markbind/layouts/default.md index b6eae2d30a2..6e221df3d23 100644 --- a/docs/_markbind/layouts/default.md +++ b/docs/_markbind/layouts/default.md @@ -30,7 +30,7 @@ * [Quick Start]({{ baseUrl }}/UserGuide.html#quick-start) * [Features]({{ baseUrl }}/UserGuide.html#features) * [FAQ]({{ baseUrl }}/UserGuide.html#faq) - * [Command Summary]({{ baseUrl }}/UserGuide.html#faq) + * [Command Summary]({{ baseUrl }}/UserGuide.html#command-summary) * [Developer Guide]({{ baseUrl }}/DeveloperGuide.html) :expanded: * [Acknowledgements]({{ baseUrl }}/DeveloperGuide.html#acknowledgements) * [Setting Up]({{ baseUrl }}/DeveloperGuide.html#setting-up-getting-started)