You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**Command Line Interface**| A text-based interface used for entering commands directly. |
84
+
|**Graphical User Interface**| The visual interface that enhances user interaction with graphical elements. |
85
+
|**Parameters**| Specific pieces of information required by commands to execute a function.|
86
+
|**Attribute**| A single detail of a student.|
87
+
|**INDEX**| A case-insensitive, unique identification code assigned to each student.|
88
+
|**NUSNET**| A unique identification code assigned to each student.|
89
+
|**TAG**| A one-word, non-space separated, case-insensitive, alphanumeric label that can be associated with a student for categorization. For example `bestFriend4Ever`, `colleague`, `Club` are valid tags, but `best friend`, `best-friend` are not valid tags.|
90
+
|**Autocomplete**| A feature that predicts and completes commands as you type.|
91
+
|**Command History**| A record of successfully executed commands that can be retrieved for reuse.|
|**ASCII**| American Standard Code for Information Interchange |
98
+
|**GUI**| Graphical User Interface |
99
+
|**CLI**| Command Line Interface |
100
+
|**TA**| Teaching Assistant |
101
+
|**CS**| Computer Science |
102
+
|**NUS**| National University of Singapore|
103
+
|**URL**| Uniform Resource Locator |
104
+
|**JSON**| JavaScript Object Notation |
105
105
106
106
### Recognised Prefixes for Attributes
107
-
| Prefix | Attribute |
108
-
|--------|-----------------------------|
109
-
|**n/**| Name of the student |
110
-
|**nn/**| NUSNet ID of the student |
111
-
|**p/**| Phone number of the student |
112
-
|**e/**| Email of the student |
113
-
|**m/**| Major of the student |
114
-
|**t/**| Tag of the student |
107
+
| Prefix | Attribute|
108
+
|---------|-----------------------------|
109
+
|**n/**| Name of the student |
110
+
|**nn/**| NUSNet ID of the student |
111
+
|**p/**| Phone number of the student |
112
+
|**e/**| Email of the student |
113
+
|**m/**| Major of the student |
114
+
|**t/**| Tag of the student |
115
115
|**wk/**| Week number for attendance |
116
116
117
117
This segment aims to make your TAPro experience as smooth as silk. With these notions and terms at your fingertips, you're well on your way to becoming a TAPro power user!
@@ -164,7 +164,7 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap
164
164
165
165
*`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.
166
166
167
-
*`delstu nn/NUSNET_ID` : Deletes the student with the specified `NUSNET_ID` from the contact book.
167
+
*`delstu nn/NUSNET` : Deletes the student with the specified `NUSNET` from the contact book.
168
168
169
169
*`clear` : Deletes all students, and their contact and attendance information.
**Note:** NUSNet provided will be converted to uppercase automatically upon running the command. (e.g., `e0123456` will be converted to `E0123456`)
328
-
</box>
329
-
330
-
<boxtype="info"light>
331
-
332
-
**Note:** Tags must be a single, non-space separated, alphanumeric word. For example `bestFriend4Ever`, `colleague`, `Club` are valid tags, but `best friend`, `best-friend` are not valid tags.
333
-
</box>
334
-
335
-
<boxtype="warning"light>
336
-
337
-
**Note:** The application will not wrap the text in the various fields. By [international standards](https://en.wikipedia.org/wiki/E.164), telephone numbers should not exceed 15 digits. And long names and email addresses are extremely rare, which falls outside of normal use cases. Lastly, most students will have no more than 2 majors.
327
+
**Note:** NUSNet ID is case-insensitive, and it will be converted to uppercase automatically upon running the command. (e.g., `e0123456` will be converted to `E0123456`)
338
328
</box>
339
329
340
330
Examples:
341
-
*`addstu n/John Doe nn/e1234567 p/98765432 e/johnd@example.com m/Computer Science`
@@ -362,7 +352,7 @@ If there are additional arguments behind `list` we will simply ignore them.
362
352
363
353
Edits an existing person in the contact book.
364
354
365
-
Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [m/MAJOR] [nn/NUSNET_ID] [t/TAG]…`
355
+
Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [m/MAJOR] [nn/NUSNET] [t/TAG]…`
366
356
367
357
* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …
368
358
* At least one of the optional fields must be provided.
@@ -376,7 +366,7 @@ Examples:
376
366
*`edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
377
367
378
368
<boxtype="info"light>
379
-
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.
369
+
This command differs from most other commands that use the `NUSNET` to identify a student. This command uses the index number shown in the displayed person list to identify the student to be edited.
Marks a student's attendance for a particular week.
467
457
468
-
Format: `mark nn/NUSNET_ID wk/WEEK_NUMBER`
458
+
Format: `mark nn/NUSNET wk/WEEK_NUMBER`
469
459
470
460
Example:
471
461
*`mark nn/E1234567 wk/3`
@@ -477,7 +467,7 @@ Example:
477
467
478
468
Unmarks a student's attendance for a particular week.
479
469
480
-
Format: `unmark nn/NUSNET_ID wk/WEEK_NUMBER`
470
+
Format: `unmark nn/NUSNET wk/WEEK_NUMBER`
481
471
482
472
Example:
483
473
*`unmark nn/E1234567 wk/3`
@@ -490,15 +480,15 @@ Example:
490
480
491
481
Deletes the specified student from the contact book.
492
482
493
-
Format: `delstu nn/NUSNET_ID`
483
+
Format: `delstu nn/NUSNET`
494
484
495
485
* Deletes the student with the specified NUSNet ID from the contact book.
496
486
497
487
Examples:
498
488
*`delstu nn/E0957499` deletes the student with the NUSNet ID of `E0957499` in the contact book.
499
489
500
490
Pro Tip:
501
-
* If you cannot remember your student's NUSNet ID, you could use `find Betsy` or `list` followed by `delstu nn/<Betsy's NUSNET_ID>` to find and delete the student.
491
+
* If you cannot remember your student's NUSNet ID, you could use `find Betsy` or `list` followed by `delstu nn/<Betsy's NUSNET>` to find and delete the student.
502
492
503
493
<markdownclass="d-print-none">---</markdown>
504
494
<divstyle="page-break-after: always;"></div>
@@ -834,6 +824,12 @@ Do also note that tags are alphanumeric and cannot contain spaces or special cha
**Q:** Long names, phone numbers, emails and majors are truncated in the UI. Why does TAPro not make these text wrap around?<br/>
830
+
**A:** By [international standards](https://en.wikipedia.org/wiki/E.164), telephone numbers should not exceed 15 digits. And typical names and email addresses are rarely too long, which falls outside of normal use cases. Lastly, most students will have no more than 2 majors. So under any normal use case, the fields will not contain texts long enough to be truncated. Having a single line of text for each field also ensures the UI remains clean and uncluttered.
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.
878
874
</box>
879
875
880
-
<box type="warning" theme="danger"seamless>
876
+
<box type="warning" theme="danger"light>
881
877
882
878
**2. If you have more than one copy of TAPro running**
883
879
@@ -888,20 +884,16 @@ If you have more than one copy of TAPro running, the application may not functio
0 commit comments