From 55184f40f70e033a7780b7355891e0b1233a2d14 Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Tue, 9 Apr 2024 21:49:31 +0800 Subject: [PATCH 1/9] Add FAQ questions and answers 1. Transferring data to and from another computer 1. Launching TAPro in different ways 1. Checking Java Version 1. Using TAPro 1. Saving more time with advanced features --- docs/UserGuide.md | 123 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 117 insertions(+), 6 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 034aa7d7419..ca529a1da04 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -493,15 +493,127 @@ Furthermore, certain edits can cause the TAPro to behave in unexpected ways (e.g ## FAQ - +### Transfering Data to Another Computer +**Q**: How do I transfer my data to another computer? - -**Q:** How do I transfer my data to another computer? +**A**: Install the application in the target computer and replace the `data` folder with the `data` folder in +your current computer! Click `Yes` if are prompted to replace the existing `data` folder in your target computer. - -**A:** Install the application in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous TAPro home folder. +### Loading Data from Another Computer + +**Q**: How can I transfer my TAPro contacts to another Computer?
+**A**: Install TAPro in your target computer and paste the empty `data` folder it creates +with the `data` folder from your otehr computer. Paste it in the same directory as your TAPro JAR file in your +target computer. + +### Launching TAPro + +**Q**: How can I launch TAPro if clicking on the JAR file does not work?
+**A**: There are two possible methods to launch TAPro. + +**Method 1**: Using the Command Line +1. Open the command line in your operating system's terminal software. +2. Navigate to the directory where the JAR file is located. +3. Enter `java -jar TAPro.jar` and the TAPro Application should launch. + +**Method 2**: Using `.bat/.sh` Scripts +1. Create a new text file and paste the following line into the file: + ``` + java -jar [JAR file location]/TAPro.jar + ``` +2. Save the file as `TAPro.bat` (Windows) or `TAPro.sh` (macOS/Linux). +3. Change the admin settings of the script to allow it to run as a program: + - Windows: Right-click on the script and select Properties. Under General, check the box that says `Allow this file to run as a program`. + - macOS/Linux: Open the Terminal and navigate to the directory where the script is located. Type `chmod +x [script name]` and press `Enter`.
Note: (`chmod +x` changes permissions of the script to allow it to be executed) +4. Double-click on the script to launch TAPro. + +### Checking Java Version + +**Q**: How can I check my Java version?
+**A**: Open a command line and type `java -version`. If you do not have Java installed, you can install Java 11 using the Oracle guide [here](https://www.oracle.com/java/technologies/downloads/#java11). Alternatively, you can install the OpenJDK version. For macOS users, you may wish to follow the instructions [here](https://nus-cs2103-ay2324s1.github.io/website/admin/programmingLanguages.html). + +### Using TAPro + +**Q**: What are the available commands in TAPro?
+**A**: Please refer to the [Command Summary](#command-summary) for the list of available commands. + +**Q**: Do I need an internet connection to use TAPro?
+**A**: All of TAPro's functionality can be used offline! No internet connection is required. + +**Q**: How do I save my data?
+**A**: Data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually. + +**Q**: How can I remove a student's attendance for a particular week?
+**A**: In TAPro, you can remove a student's attendance for a particular week using the `unmark` command! The syntax +for the `unmark` command is as follows: +

The syntax for the `unmark` command is as follows: +``` +unmark nn/NUSNET_ID wk/WEEK_NUMBER +``` + +**Q**: Can I add tags to a TAPro contact if I want to remember something additional, like a birthday?
+**A**: Yes you can! In fact, you may use the `TAG` parameter of a contact to store any information you want. Simply +use `edit` with the `NUSNET` of the student and the information you wish to add to the contact, and you should be on your way! + + + +#g#Example:## Using tag as a birthday for contacts +``` +edit 1 t/12Dec +edit 2 t/25Jan +edit 3 t/1Mar +``` + + +#g#Example:## Using tag as a industry interest +``` +edit 1 t/EduTech +edit 2 t/Finance +edit 3 t/HealthTech +``` + + + + + +**Caution:** + +Do note that as of the current version of TAPro, you can only add one tag to a contact. Adding a new tag will +replace the existing tag. + +Do also note that tags are alphanumeric and cannot contain spaces or special characters. + + + +### Saving More Time +**Q**: How can I save more time when using TAPro?
+**A**: You can use the advanced features like **[autocomplete](#autocomplete)** and **[command history toggle](#retrieving-command-history)** in TAPro! +These +features are +designed to help you input commands faster and more efficiently. + + + +#g#Example:## Unmarking a wrongly marked student's attendance + +1. `mark nn/e0123456 wk/6` +1. Press the UP key to + retrieve the previous command. +1. Hold the LEFT key to +move the cursor to the beginning of the command. +1. Add a `un` in front of `mark` to change the command to `unmark nn/e0123456 wk/6`. +1. Press `Enter`! + + + + +**Note:** +Future enhancement include clicking RIGHT key to move the cursor to +the front of the command. + --- @@ -509,7 +621,6 @@ Furthermore, certain edits can cause the TAPro to behave in unexpected ways (e.g ## Known issues - **1. When using multiple screens** From 6bf956a42feb7bc6ae378eaa6a5d8764463572d5 Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Wed, 10 Apr 2024 11:46:40 +0800 Subject: [PATCH 2/9] Use question boxes --- docs/UserGuide.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index ca529a1da04..b5b8e5333a1 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -494,19 +494,25 @@ Furthermore, certain edits can cause the TAPro to behave in unexpected ways (e.g ## FAQ ### Transfering Data to Another Computer + + **Q**: How do I transfer my data to another computer? **A**: Install the application in the target computer and replace the `data` folder with the `data` folder in your current computer! Click `Yes` if are prompted to replace the existing `data` folder in your target computer. + ### Loading Data from Another Computer + **Q**: How can I transfer my TAPro contacts to another Computer?
**A**: Install TAPro in your target computer and paste the empty `data` folder it creates with the `data` folder from your otehr computer. Paste it in the same directory as your TAPro JAR file in your target computer. + ### Launching TAPro + **Q**: How can I launch TAPro if clicking on the JAR file does not work?
**A**: There are two possible methods to launch TAPro. @@ -526,22 +532,33 @@ target computer. - Windows: Right-click on the script and select Properties. Under General, check the box that says `Allow this file to run as a program`. - macOS/Linux: Open the Terminal and navigate to the directory where the script is located. Type `chmod +x [script name]` and press `Enter`.
Note: (`chmod +x` changes permissions of the script to allow it to be executed) 4. Double-click on the script to launch TAPro. + ### Checking Java Version + **Q**: How can I check my Java version?
**A**: Open a command line and type `java -version`. If you do not have Java installed, you can install Java 11 using the Oracle guide [here](https://www.oracle.com/java/technologies/downloads/#java11). Alternatively, you can install the OpenJDK version. For macOS users, you may wish to follow the instructions [here](https://nus-cs2103-ay2324s1.github.io/website/admin/programmingLanguages.html). + ### Using TAPro + + **Q**: What are the available commands in TAPro?
**A**: Please refer to the [Command Summary](#command-summary) for the list of available commands. + + **Q**: Do I need an internet connection to use TAPro?
**A**: All of TAPro's functionality can be used offline! No internet connection is required. + + **Q**: How do I save my data?
**A**: Data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually. + + **Q**: How can I remove a student's attendance for a particular week?
**A**: In TAPro, you can remove a student's attendance for a particular week using the `unmark` command! The syntax @@ -550,6 +567,8 @@ for the `unmark` command is as follows: ``` unmark nn/NUSNET_ID wk/WEEK_NUMBER ``` + + **Q**: Can I add tags to a TAPro contact if I want to remember something additional, like a birthday?
**A**: Yes you can! In fact, you may use the `TAG` parameter of a contact to store any information you want. Simply @@ -564,7 +583,6 @@ edit 2 t/25Jan edit 3 t/1Mar ``` - #g#Example:## Using tag as a industry interest @@ -574,7 +592,6 @@ edit 2 t/Finance edit 3 t/HealthTech ``` - @@ -586,8 +603,12 @@ replace the existing tag. Do also note that tags are alphanumeric and cannot contain spaces or special characters. + + ### Saving More Time + + **Q**: How can I save more time when using TAPro?
**A**: You can use the advanced features like **[autocomplete](#autocomplete)** and **[command history toggle](#retrieving-command-history)** in TAPro! These @@ -614,6 +635,7 @@ Future enhancement include clicking RIGHT key to move the cursor to the front of the command. + --- From d25d42f6b9cfcbf733620611dabb6d235c577272 Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Wed, 10 Apr 2024 12:02:39 +0800 Subject: [PATCH 3/9] Use CAPS for key presses --- docs/UserGuide.md | 108 +++++++++++++++++++++++----------------------- 1 file changed, 54 insertions(+), 54 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b5b8e5333a1..414825b38eb 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -23,7 +23,7 @@ If you can type fast, TAPro can get your contact management and attendance takin 1. Ensure you have Java 11 or above installed in your computer. - + **Installing Java:** @@ -39,7 +39,7 @@ The latest version is compatible with older versions. 1. Open a command terminal, `cd` into the folder you downloaded the jar file in, and run the `java -jar TAPro.jar` command to launch the application. - + A GUI similar to the below image should appear in a few seconds. Note how the app contains some sample data. @@ -50,7 +50,7 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap 5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window. - + **Here are some example commands you can try:** @@ -74,11 +74,11 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap ## Features - + **About the command format:**
- + Words in `UPPER_CASE` are the parameters to be supplied by the user. @@ -86,14 +86,14 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap - + Items in square brackets are optional. #g#Example:## `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. - + Items with `…`​ after them can be used multiple times including zero times. @@ -101,14 +101,14 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap - + Parameters can be in any order. #g#Example:## If the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. - + Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored. @@ -117,7 +117,7 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap - + **If you are using a PDF version of this document:** @@ -135,7 +135,7 @@ as well as quick reference of each command with simple examples on how to use th Format: `help` - + **A new window is opened:** @@ -146,7 +146,7 @@ A new window is opened, so that it does not clutter up your main window. A GUI s - + **Resizing the help window:** @@ -154,18 +154,18 @@ A new window is opened, so that it does not clutter up your main window. A GUI s The help window is resizable, so you can **easily reposition and resize** it to fit anywhere on your screen, exactly where you want it to be. - + **Switching quickly between the help and main window:** -* On Windows and most Linux distributions, you can use the keyboard shortcut: Alt + Tab, to switch between windows quickly. +* On Windows and most Linux distributions, you can use the keyboard shortcut: ALT + TAB, to switch between windows quickly. -* On macOS, you can use the keyboard shortcut: Cmd⌘ + Tab, to switch between windows quickly. +* On macOS, you can use the keyboard shortcut: ⌘CMD + TAB, to switch between windows quickly. - + **More about help's quick reference:** @@ -201,7 +201,7 @@ Format: `addstu n/NAME nn/NUSNET [p/PHONE] [e/EMAIL] [m/MAJOR] [t/TAG]…​` * The name and nusnet id must be provided. And nusnet id must be unique. * All the remaining fields are optional. If not provided, a placeholder value will be used. - + **Tip:** A person can have any number of tags (including 0) @@ -244,7 +244,7 @@ Examples: * `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email contact of the 1st person to be `91234567` and `johndoe@example.com` respectively. * `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. - + This command differs from most other commands that use the `NUSNET_ID` to identify a student. This command uses the index number shown in the displayed person list to identify the student to be edited. @@ -258,7 +258,7 @@ Finds students whose names contain any of the given keywords. Format: `find KEYWORD [MORE_KEYWORDS]…​` - + **Parameters of `find` command:** @@ -267,18 +267,18 @@ Format: `find KEYWORD [MORE_KEYWORDS]…​` - + **About the `find` command:** - + Only the name is searched. #g#Example:## `E01234567` will not match a student with NUSNet ID `E01234567`. - + The name search is case-insensitive. @@ -286,21 +286,21 @@ Format: `find KEYWORD [MORE_KEYWORDS]…​` - + The order of the keywords does not matter. #g#Example:## `Hans Bo` will match `Bo Hans` - + Only full words will be matched. #g#Example:## `Han` will not match `Hans` - + Students' name matching at least one keyword will be returned (i.e. `OR` search). @@ -308,17 +308,17 @@ Format: `find KEYWORD [MORE_KEYWORDS]…​` - + **Examples of using the find command:** - + #g#Example:## `find John` returns `john` and `John Doe` - + #g#Example:## `find alex david` returns `Alex Yeoh`, `David Li`, as seen in the image below. @@ -396,7 +396,7 @@ Format: `exit` Autocompletes a word or a set of words, based on the current input. - + **Autocomplete doesn't work on week number:** @@ -405,30 +405,30 @@ and it is much faster just typing out the number. - + #g#Example:## We have three students with NUSNet IDs `e0123456`, `e1234567` and `e2345678`. -If we type `mark nn/` into the command input box and press Tab, +If we type `mark nn/` into the command input box and press TAB, we can see that the text in the command input box autocompletes to become `mark nn/e01234567`. -Pressing Tab again, causes the text to update to `mark nn/e1234567`, +Pressing TAB again, causes the text to update to `mark nn/e1234567`, followed by `mark nn/e2345678`. - + **Using autocomplete to scroll through all possible autocomplete suggestions:** Autocomplete will scroll through all possible options, based on the existing data in your contact list. When reaching the end of the possible options list, pressing -Tab will wrap +TAB will wrap the possible options back to the start of that list again. - + **Sorted autocomplete suggestions:** @@ -446,7 +446,7 @@ TAPro saves successful commands input, so you can retrieve them later, using the Up and Down keys. - + #g#Example:## @@ -456,7 +456,7 @@ Pressing Up will update the text i the previous command `mark nn/e0123456`. - + **Only successful commands will be retrieved:** @@ -478,7 +478,7 @@ TAPro's data are saved in the hard disk automatically after any command that cha TAPro's data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. - + **Caution:** @@ -494,7 +494,7 @@ Furthermore, certain edits can cause the TAPro to behave in unexpected ways (e.g ## FAQ ### Transfering Data to Another Computer - + **Q**: How do I transfer my data to another computer? @@ -503,7 +503,7 @@ your current computer! Click `Yes` if are prompted to replace the existing `data ### Loading Data from Another Computer - + **Q**: How can I transfer my TAPro contacts to another Computer?
**A**: Install TAPro in your target computer and paste the empty `data` folder it creates @@ -512,7 +512,7 @@ target computer. ### Launching TAPro - + **Q**: How can I launch TAPro if clicking on the JAR file does not work?
**A**: There are two possible methods to launch TAPro. @@ -535,7 +535,7 @@ target computer. ### Checking Java Version - + **Q**: How can I check my Java version?
**A**: Open a command line and type `java -version`. If you do not have Java installed, you can install Java 11 using the Oracle guide [here](https://www.oracle.com/java/technologies/downloads/#java11). Alternatively, you can install the OpenJDK version. For macOS users, you may wish to follow the instructions [here](https://nus-cs2103-ay2324s1.github.io/website/admin/programmingLanguages.html). @@ -543,22 +543,22 @@ target computer. ### Using TAPro - + **Q**: What are the available commands in TAPro?
**A**: Please refer to the [Command Summary](#command-summary) for the list of available commands. - + **Q**: Do I need an internet connection to use TAPro?
**A**: All of TAPro's functionality can be used offline! No internet connection is required. - + **Q**: How do I save my data?
**A**: Data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually. - + **Q**: How can I remove a student's attendance for a particular week?
**A**: In TAPro, you can remove a student's attendance for a particular week using the `unmark` command! The syntax @@ -568,13 +568,13 @@ for the `unmark` command is as follows: unmark nn/NUSNET_ID wk/WEEK_NUMBER ``` - + **Q**: Can I add tags to a TAPro contact if I want to remember something additional, like a birthday?
**A**: Yes you can! In fact, you may use the `TAG` parameter of a contact to store any information you want. Simply use `edit` with the `NUSNET` of the student and the information you wish to add to the contact, and you should be on your way! - + #g#Example:## Using tag as a birthday for contacts ``` @@ -583,7 +583,7 @@ edit 2 t/25Jan edit 3 t/1Mar ``` - + #g#Example:## Using tag as a industry interest ``` @@ -593,7 +593,7 @@ edit 3 t/HealthTech ``` - + **Caution:** @@ -607,7 +607,7 @@ Do also note that tags are alphanumeric and cannot contain spaces or special cha ### Saving More Time - + **Q**: How can I save more time when using TAPro?
**A**: You can use the advanced features like **[autocomplete](#autocomplete)** and **[command history toggle](#retrieving-command-history)** in TAPro! @@ -615,7 +615,7 @@ These features are designed to help you input commands faster and more efficiently. - + #g#Example:## Unmarking a wrongly marked student's attendance @@ -628,7 +628,7 @@ move the cursor to the beginning of the command. 1. Press `Enter`! - + **Note:** Future enhancement include clicking Known issues - + **1. When using multiple screens** From 7283c9be178b0edd6b2e4e7827448597b8563394 Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Wed, 10 Apr 2024 12:08:20 +0800 Subject: [PATCH 4/9] Improve nits --- docs/UserGuide.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 414825b38eb..c3729845502 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -496,8 +496,7 @@ Furthermore, certain edits can cause the TAPro to behave in unexpected ways (e.g ### Transfering Data to Another Computer -**Q**: How do I transfer my data to another computer? - +**Q**: How do I transfer my data to another computer?
**A**: Install the application in the target computer and replace the `data` folder with the `data` folder in your current computer! Click `Yes` if are prompted to replace the existing `data` folder in your target computer. @@ -505,7 +504,7 @@ your current computer! Click `Yes` if are prompted to replace the existing `data ### Loading Data from Another Computer -**Q**: How can I transfer my TAPro contacts to another Computer?
+**Q**: How can I transfer my TAPro contacts to another computer?
**A**: Install TAPro in your target computer and paste the empty `data` folder it creates with the `data` folder from your otehr computer. Paste it in the same directory as your TAPro JAR file in your target computer. @@ -517,7 +516,7 @@ target computer. **Q**: How can I launch TAPro if clicking on the JAR file does not work?
**A**: There are two possible methods to launch TAPro. -**Method 1**: Using the Command Line +**Method 1**: Using the Command Terminal 1. Open the command line in your operating system's terminal software. 2. Navigate to the directory where the JAR file is located. 3. Enter `java -jar TAPro.jar` and the TAPro Application should launch. @@ -565,7 +564,7 @@ target computer. for the `unmark` command is as follows:

The syntax for the `unmark` command is as follows: ``` -unmark nn/NUSNET_ID wk/WEEK_NUMBER +unmark nn/NUSNET wk/WEEK ``` @@ -637,9 +636,7 @@ the front of the command. - ---- -
+{{ newPage }} ## Known issues From 5ce5b78c871bb0866ce692a6dad09dd4e2a904e5 Mon Sep 17 00:00:00 2001 From: Ethan Wei Yuxin Date: Wed, 10 Apr 2024 13:58:50 +0800 Subject: [PATCH 5/9] Update docs/UserGuide.md Co-authored-by: Wu Xiaoyun --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index fa89dfb8e25..5e02c5c1f0f 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -602,7 +602,7 @@ target computer. 2. Save the file as `TAPro.bat` (Windows) or `TAPro.sh` (macOS/Linux). 3. Change the admin settings of the script to allow it to run as a program: - Windows: Right-click on the script and select Properties. Under General, check the box that says `Allow this file to run as a program`. - - macOS/Linux: Open the Terminal and navigate to the directory where the script is located. Type `chmod +x [script name]` and press `Enter`.
Note: (`chmod +x` changes permissions of the script to allow it to be executed) + - macOS/Linux: Open the Terminal and navigate to the directory where the script is located. Type `chmod +x ` and press `Enter`.
Note: (`chmod +x` changes permissions of the script to allow it to be executed) 4. Double-click on the script to launch TAPro. From 0eedc56042aed9c03ac893d21ca69dceba19046b Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Wed, 10 Apr 2024 14:01:21 +0800 Subject: [PATCH 6/9] Change all nn/e to nn/E --- docs/UserGuide.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index fa89dfb8e25..a1d4a98dd31 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -56,7 +56,7 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap * `list` : Lists all contacts. -* `addstu nn/e0952224 n/John Doe p/98765432 e/johnd@example.com m/Computer Science` : Adds a student named `John Doe` to the contact book. +* `addstu nn/E0952224 n/John Doe p/98765432 e/johnd@example.com m/Computer Science` : Adds a student named `John Doe` to the contact book. * `delstu nn/NUSNET_ID` : Deletes the student with the specified `NUSNET_ID` from the contact book. @@ -207,9 +207,9 @@ Format: `addstu n/NAME nn/NUSNET [p/PHONE] [e/EMAIL] [m/MAJOR] [t/TAG]…​` Examples: -* `addstu n/John Doe nn/e1234567 p/98765432 e/johnd@example.com m/Computer Science` -* `addstu n/Betsy Crowe nn/e01234567 t/friend e/betsycrowe@example.com m/Mathematics p/1234567 t/club` -* `addstu n/Betsy Crowe nn/e01234567` +* `addstu n/John Doe nn/E1234567 p/98765432 e/johnd@example.com m/Computer Science` +* `addstu n/Betsy Crowe nn/E01234567 t/friend e/betsycrowe@example.com m/Mathematics p/1234567 t/club` +* `addstu n/Betsy Crowe nn/E01234567` ---
@@ -337,7 +337,7 @@ Marks a student's attendance for a particular week. Format: `mark nn/NUSNET_ID wk/WEEK_NUMBER` Example: -* `mark nn/e1234567 wk/3` +* `mark nn/E1234567 wk/3` ---
@@ -349,7 +349,7 @@ Unmarks a student's attendance for a particular week. Format: `unmark nn/NUSNET_ID wk/WEEK_NUMBER` Example: -* `unmark nn/e1234567 wk/3` +* `unmark nn/E1234567 wk/3` ---
@@ -416,10 +416,10 @@ The first word, will be autocompleted as a command name, instead of a parameter, We have three students with NUSNet IDs `e0123456`, `e1234567` and `e2345678`. If we type `mark nn/` into the command input box and press TAB, -we can see that the text in the command input box autocompletes to become `mark nn/e01234567`. +we can see that the text in the command input box autocompletes to become `mark nn/E01234567`. -Pressing TAB again, causes the text to update to `mark nn/e1234567`, -followed by `mark nn/e2345678`. +Pressing TAB again, causes the text to update to `mark nn/E1234567`, +followed by `mark nn/E2345678`. @@ -523,10 +523,10 @@ TAPro saves successful commands input, so you can retrieve them later, using the #g#Example:## -We have entered `mark nn/e0123456` as the previous command, and it was successful. Now the command input box is empty. +We have entered `mark nn/E0123456` as the previous command, and it was successful. Now the command input box is empty. Pressing {{ macros.keyFormat('Up') }} will update the text in the command input box to -the previous command `mark nn/e0123456`. +the previous command `mark nn/E0123456`. @@ -691,12 +691,12 @@ designed to help you input commands faster and more efficiently. #g#Example:## Unmarking a wrongly marked student's attendance -1. `mark nn/e0123456 wk/6` +1. `mark nn/E0123456 wk/6` 1. Press the UP key to retrieve the previous command. 1. Hold the LEFT key to move the cursor to the beginning of the command. -1. Add a `un` in front of `mark` to change the command to `unmark nn/e0123456 wk/6`. +1. Add a `un` in front of `mark` to change the command to `unmark nn/E0123456 wk/6`. 1. Press `Enter`! @@ -728,12 +728,12 @@ If you move the application to a secondary screen, and later switch to using onl | Action | Format, Examples | |--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Add Student** | `addstu n/NAME p/PHONE_NUMBER e/EMAIL nn/NUSNET_ID m/MAJOR [t/TAG]…​`
e.g., `addstu n/James Ho p/22224444 e/jamesho@example.com nn/e1234567 m/Computer Science t/friend t/colleague` | +| **Add Student** | `addstu n/NAME p/PHONE_NUMBER e/EMAIL nn/NUSNET_ID m/MAJOR [t/TAG]…​`
e.g., `addstu n/James Ho p/22224444 e/jamesho@example.com nn/E1234567 m/Computer Science t/friend t/colleague` | | **Clear** | `clear` | -| **Delete Student** | `delstu nn/NUSNET_ID`
e.g., `delstu nn/e0957499` | +| **Delete Student** | `delstu nn/NUSNET_ID`
e.g., `delstu nn/E0957499` | | **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [m/MAJOR] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` | -| **Mark** | `mark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `mark nn/e1234567 wk/3` | -| **Unmark** | `unmark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `unmark nn/e1234567 wk/3` | +| **Mark** | `mark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `mark nn/E1234567 wk/3` | +| **Unmark** | `unmark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `unmark nn/E1234567 wk/3` | | **Find** | `find KEYWORD [MORE_KEYWORDS]…​`
e.g., `find James Jake` | | **Set Course** | `setcrs COURSE_NAME` | | **List** | `list` | From 8529f92e5e07f27a6436fae46c58b8fec46ee1f6 Mon Sep 17 00:00:00 2001 From: Ethan Wei Yuxin Date: Wed, 10 Apr 2024 14:02:41 +0800 Subject: [PATCH 7/9] Update docs/UserGuide.md Co-authored-by: Wu Xiaoyun --- docs/UserGuide.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8227fbd1443..7c5bd4f3047 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -595,10 +595,11 @@ target computer. 3. Enter `java -jar TAPro.jar` and the TAPro Application should launch. **Method 2**: Using `.bat/.sh` Scripts -1. Create a new text file and paste the following line into the file: - ``` - java -jar [JAR file location]/TAPro.jar - ``` +1. Create a new text file and paste the following code into the file and edit it according to the comments: + ```sh + java -jar + # Replace "" with the path to TAPro on your system + # Example on linux: java -jar /home/linus/Downloads/TAPro.jar 2. Save the file as `TAPro.bat` (Windows) or `TAPro.sh` (macOS/Linux). 3. Change the admin settings of the script to allow it to run as a program: - Windows: Right-click on the script and select Properties. Under General, check the box that says `Allow this file to run as a program`. From 52d7e020074296ec7ce74b77f58993f59f7c953f Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Wed, 10 Apr 2024 14:08:43 +0800 Subject: [PATCH 8/9] Update .bat file command --- docs/UserGuide.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8227fbd1443..ffb4c9776ca 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -597,8 +597,10 @@ target computer. **Method 2**: Using `.bat/.sh` Scripts 1. Create a new text file and paste the following line into the file: ``` - java -jar [JAR file location]/TAPro.jar + java -jar ``` + Replace `` with the path to TAPro on your system, in quotes + Example on Windows: `java -jar "C:\Users\YOUR_USERNAME\Downloads\TAPro.jar"` 2. Save the file as `TAPro.bat` (Windows) or `TAPro.sh` (macOS/Linux). 3. Change the admin settings of the script to allow it to run as a program: - Windows: Right-click on the script and select Properties. Under General, check the box that says `Allow this file to run as a program`. From 8360b8604969c17767f9a315f3e1420604821d5b Mon Sep 17 00:00:00 2001 From: belligerentbeagle Date: Wed, 10 Apr 2024 14:28:39 +0800 Subject: [PATCH 9/9] Move comment outside code block so shell script works for .bat and .sh --- docs/UserGuide.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 103ecdf16ed..784e2a42e08 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -598,13 +598,11 @@ target computer. 1. Create a new text file and paste the following code into the file and edit it according to the comments: ```sh java -jar - # Replace "" with the path to TAPro on your system, in quotes. ``` - Example on Windows: `java -jar "C:\Users\YOUR_USERNAME\Downloads\TAPro.jar"` - - Example on Linux: `java -jar /home/YOUR_USERNAME/Downloads/TAPro.jar` - - Example on macOS: `java -jar "/Users/YOUR_USERNAME/Downloads/TAPro.jar"` + Replace "" with the path to TAPro on your system, in quotes.
+ Example on Windows: `java -jar "C:\Users\YOUR_USERNAME\Downloads\TAPro.jar"`
+ Example on Linux: `java -jar /home/YOUR_USERNAME/Downloads/TAPro.jar`
+ Example on macOS: `java -jar "/Users/YOUR_USERNAME/Downloads/TAPro.jar"`
2. Save the file as `TAPro.bat` (Windows) or `TAPro.sh` (macOS/Linux). 3. Change the admin settings of the script to allow it to run as a program: