From c00fe15854a7a308e96861f4771168af22198453 Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Sat, 11 Nov 2023 18:08:03 +0800 Subject: [PATCH] update some UG and DG headers --- docs/DeveloperGuide.md | 6 +-- docs/UserGuide.md | 99 ++++++++++++++++++++++-------------------- 2 files changed, 55 insertions(+), 50 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index c45c4d312c6..837f7d8c3a9 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -4,19 +4,19 @@ title: Developer Guide -------------------------------------------------------------------------------------------------------------------- -## **Acknowledgements** +## Acknowledgements * {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} -------------------------------------------------------------------------------------------------------------------- -## **Setting up, getting started** +## Setting up, getting started Refer to the guide [_Setting up and getting started_](SettingUp.md). -------------------------------------------------------------------------------------------------------------------- -## **Design** +## Design
diff --git a/docs/UserGuide.md b/docs/UserGuide.md index fc9f1222804..d25307e4f09 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -26,15 +26,17 @@ You can click on any of the links below to navigate to the respective sections f {% include toc.md header=true show-in-toc=true ordered=true %} -## 1. Quick start +## Quick start -### 1.1. Prerequisites +### Prerequisites -#### 1.1.1. Java +#### Java Ensure you have [Java `11`](https://www.oracle.com/sg/java/technologies/javase/jdk11-archive-downloads.html) or above installed. Java is the language that your computer uses to understand TAfinder. -**Not sure how to check your Java version?** +
+ +**:bulb: Not sure how to check your Java version?** **Step 1.** Open up **Command Prompt** (Windows) or **Terminal** (Mac and Linux). @@ -49,9 +51,12 @@ An example is shown below. java version "xxx" ``` +
+
-#### 1.1.2. Glossary +#### Glossary + | Words/Abbreviations | Explanation | |---------------------|-------------------------------------------------------------------------------------------------------------------------------------| | **TA** | Teaching Assistant | @@ -62,7 +67,7 @@ An example is shown below. | **Toast** | A popup alert to inform users about certain information | | **Tag** | Tags are associated with applicants, users can tag applicants with any keyword they want,
the number of tags are not restricted | -### 1.2. Installation +### Installation **Step 1.** Download the latest `tafinder.jar` from [here](). @@ -70,9 +75,9 @@ An example is shown below. **Step 3.** Double-click on the `tafinder.jar` file to start the app. - +
-**TAfinder does not open?** +**:bulb: TAfinder does not open?** **Step 1.** Open a command terminal. @@ -88,11 +93,11 @@ An example of the final command is displayed below. > java -jar xxxx/xxxx/tafinder.jar ``` - +
The GUI similar to the below should appear in a few seconds. ![Ui](images/Ui.png) -### 1.3. Utilisation +### Utilisation **Step 1:** Type the command in the Command Input Box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
@@ -110,17 +115,17 @@ Some example commands you can try: **Step 2:** Observe the changes to the application.
- +
-**Not sure what the commands above does?** +**:bulb: Not sure what the commands above does?** You can find all about the usable commands [here](#2-features),
look at a summary of all the usable commands [here](#72-command-summary),
OR return to the [Table of Contents](#table-of-contents) to find your desired command. - +
-### 1.4. Navigating the User Interface +### Navigating the User Interface ![UI with shaded areas](images/tafinder-UI.png) The UI has the following areas: @@ -136,11 +141,11 @@ The UI has the following areas: -------------------------------------------------------------------------------------------------------------------- -## 2. Features +## Features - +
-**Notes about the command format:**
+**:information_source: Notes about the command format:**
* Words in `UPPER_CASE` are the parameters to be supplied by the user.
e.g. in `add n/NAME`,
@@ -169,13 +174,13 @@ can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. - +
--- -### 2.1. Basic applicant management +### Basic applicant management -#### 2.1.1. Adding an applicant: `add` +#### Adding an applicant: `add` You have just finished setting up TAfinder and you are ready to add your first applicant. Let's find out how you can add the applicant to the list. @@ -184,7 +189,7 @@ Let's find out how you can add the applicant to the list. **`add s/STUDENT_NUMBER n/NAME p/PHONE e/EMAIL g/GPA [pg/PREVIOUS_GRADE] [is/INTERVIEW_SCORE] [c/COMMENT] [t/TAG]…`** - +
- **`s/STUDENT_NUMBER`**: Student number of the applicant - **`n/NAME`**: Name of the applicant. @@ -196,7 +201,7 @@ Let's find out how you can add the applicant to the list. - **`[c/COMMENT]`**: Comments for the applicant. - **`[t/TAG]`**: Tags of the applicant. - +
@@ -284,7 +289,7 @@ Repeated applicant:
--- -#### 2.1.2. Editing an applicant: `edit` +#### Editing an applicant: `edit` ![edit function UI](images/editUI.png) @@ -384,7 +389,7 @@ Index out of range:
--- -#### 2.1.3. Deleting an applicant: `delete` +#### Deleting an applicant: `delete` ![delete function UI](images/delete-UI.png) @@ -459,7 +464,7 @@ Index out of range:
--- -#### 2.1.4 Listing all applicant: `list` +#### Listing all applicant: `list` @@ -501,7 +506,7 @@ Shows a list of applicants. --- -#### 2.1.5. Viewing the details of a single applicant: `view` +#### Viewing the details of a single applicant: `view` ![edit function UI](images/viewUI.png) @@ -597,7 +602,7 @@ Index out of range:
--- -#### 2.1.6 Hiding an applicant from list: `hide`/`unhide` +#### Hiding an applicant from list: `hide`/`unhide` @@ -703,9 +708,9 @@ Index out of range:
--- -### 2.2. Applicant evaluation & comparison +### Applicant evaluation & comparison -#### 2.2.1 Sorting applicants by GPA: `sort` +#### Sorting applicants by GPA: `sort` @@ -758,7 +763,7 @@ Empty list:
--- -#### 2.2.4 Comparing 2 applicants: `compare` +#### Comparing 2 applicants: `compare` ![compare function UI](images/compareUI.png) @@ -845,7 +850,7 @@ Comparing the same applicant:
--- -#### 2.2.5. Bookmarking/Unbookmarking applicants: `bookmark/unbookmark` +#### Bookmarking/Unbookmarking applicants: `bookmark/unbookmark` ![bookmark function UI](images/bookmarkUI.png) @@ -928,7 +933,7 @@ Index out of range:
--- -#### 2.2.6. Commenting on TA applicant: **`comment`** +#### Commenting on TA applicant: **`comment`** One of yours TAs is unable to make it for the interview. You want to make a comment on the applicant to remind yourself to follow up with him/her. @@ -1004,9 +1009,9 @@ Index out of range:
--- -### 2.3. Files and data management +### Files and data management -#### 2.3.1. Importing applicants from spreadsheet: `import` +#### Importing applicants from spreadsheet: `import` @@ -1070,7 +1075,7 @@ Missing file permissions or invalid file path:
--- -#### 2.3.2. Attaching file to applicant profiles: `attach` +#### Attaching file to applicant profiles: `attach` ![attach function UI](images/attachUI.png) @@ -1155,12 +1160,12 @@ Any other unexpected error:
 --- -## 3. Data Management -### 3.1. Saving the data +## Data Management +### Saving the data TAfinder data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. -### 3.2. Editing the data file +### Editing the data file TAfinder data are saved automatically as a JSON file `[JAR file location]/data/tafinder.json`. Advanced users are welcome to update data directly by editing that data file. @@ -1173,24 +1178,24 @@ If your changes to the data file makes its format invalid, TAfinder will discard -------------------------------------------------------------------------------------------------------------------- -## 4. Upcoming Features [coming in a future update!] +## Upcoming Features [coming in a future update!] -------------------------------------------------------------------------------------------------------------------- -## 5. FAQ +## 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 AddressBook home folder. -------------------------------------------------------------------------------------------------------------------- -## 6. Known Issues +## 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. -------------------------------------------------------------------------------------------------------------------- -## 7. Summary -### 7.1. Prefix Summary +## Summary +### Prefix Summary | Parameter | Prefix | Rules | |----------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Student number | s/ | - Should be in the format `AdddddddL`,
where `d` represents digit and `L` represents capital letters. | @@ -1202,8 +1207,8 @@ If your changes to the data file makes its format invalid, TAfinder will discard | Tag | t/ | - Should only contain alphanumeric characters.
- Should not contain spaces. | -### 7.2. Command Summary -#### 7.2.1. Basic applicant management commands +### Command Summary +#### Basic applicant management commands | Action | Format, Examples | |-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Add** | - `add [s/STUDENT_NUMBER] [n/NAME] [p/PHONE] [e/EMAIL] [g/GPA] [t/TAG]…`
- e.g., `add s/A0269357C n/john doe p/91234567 e/johndoe@example.com g/5.0 t/pastTA t/deanslist` | @@ -1213,7 +1218,7 @@ If your changes to the data file makes its format invalid, TAfinder will discard | **View** | - `view INDEX`
- e.g., `view 3` | | **Hide/Unhide** | - `hide INDEX` / `unhide INDEX`
- e.g., `hide 3` / `unhide 3` | | -#### 7.2.2. Applicant comparison and evaluation commands +#### Applicant comparison and evaluation commands | Action | Format, Examples | |-------------------------|-----------------------------------------------------------------------------------| | **Sort GPA** | - `sort-gpa` | @@ -1222,7 +1227,7 @@ If your changes to the data file makes its format invalid, TAfinder will discard | **Comment** | - `comment INDEX COMMENT`
- e.g., `comment 3 Hardworking` | -#### 7.2.3. Data management and export commands +#### Data management and export commands | Action | Format, Examples | |-------------------------|-----------------------------------------------------------------| | **Export** | - `export FILENAME`
- e.g., `export ta-applicants.csv` |