Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Branch documentation #241

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 8 additions & 15 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
* [Product Overview](#product-overview)
* [Key Definitions](#key-definitions)
* [Features Overview](#overview-of-main-features)
* [Quick Start Guide](#quick-start)
* [Quick Start](#quick-start)
* [Command Failures](#command-failure)
* [Viewing help](#viewing-help-help)
* [Features](#features)
* [Viewing help](#viewing-help-help)
* [Command Failures](#command-failure)
* [Managing Tags](#1-managing-tags)
* [Creating tags](#creating-tags-create)
* [Listing all tags](#listing-all-tags-listt)
Expand Down Expand Up @@ -69,7 +69,7 @@ Access our self-curated user guide below to learn more on how you can integrate
[Jump back to Table of Contents](#table-of-contents)

--------------------------------------------------------------------------------------------------------------------
## Overview of Main Features
## Features Overview

While **JABPro** offers a whole range of features, we believe that the following features are likely to be the most useful to you:

Expand Down Expand Up @@ -127,8 +127,8 @@ You are an **advanced** user if ...
**Notes** and **tips** curated for you are labeled by the following box!


<div style="display: flex; justify-content: center; align-items:center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 15px; font-weight: bold;">Advanced</p>
<div style="display: flex; justify-content: center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 17px; font-weight: bold;">Advanced</p>
</div>

<br>
Expand Down Expand Up @@ -209,6 +209,8 @@ Not to worry, here are some steps you can take to fix this:
| <img src="images/blue.png" width="10px" height="10px"> | Applicant Information Panel | Displays a detailed view of an applicant, providing information of status and remarks, in addition to the basic information about the applicant. |
| <img src="images/purple.png" width="10px" height="10px"> | Summary Statistics Panel | Displays summary statistics for a particular applicant pertaining to a specific tag. |

<div style="page-break-after: always;"></div>

In addition, there are windows such as:
* Help Window [accessed by the `help` command, or through Menu Bar].
* Events Window [accessed by the `schedule` command, or through Menu Bar].
Expand Down Expand Up @@ -456,7 +458,6 @@ Format: `remark INDEX r/REMARK`
* You can get the remark previously inputted by using the `**REMARK**` keyword. It will be replaced with the previous remark (see example below). The keyword `**REMARK**` is case-sensitive. This means that `remark 1 r/**remark**` will just replace the remark with the word `**remark**`.
* You can use multiple prefix for `remark` but only the last prefix will be used. This means that `remark 1 r/remark r/remark2` will just replace the remark with `remark2`.

<div style="page-break-after: always;"></div>

**An example of the `remark` command being successfully executed:**
1. Enter the command `remark 1 r/Great attitude, hardworking`
Expand Down Expand Up @@ -714,7 +715,6 @@ hasn't been created is for the sake of convenience (i.e. if you had forgotten to
Nonetheless, we **strongly recommend you to use `create` to create categorized tags** if your only intention is to _create tags_.
</box>

<div style="page-break-after: always;"></div>

**An example of the `edit` command being successfully executed:**
1. Enter the command `edit 1 n/Alex Ho p/91234567` (**edits name and phone number**)
Expand All @@ -723,7 +723,6 @@ Nonetheless, we **strongly recommend you to use `create` to create categorized t
![Edit-Success](images/edit-command-success.png)
<br>

<div style="page-break-after: always;"></div>

**An example of the `edit` command being successfully executed with tags and score:**
1. Ensure that you have created a tag `Interview` under the `assessment` category using the `create` command. Enter the command `create t/assessment Interview`
Expand All @@ -733,8 +732,6 @@ Nonetheless, we **strongly recommend you to use `create` to create categorized t
![Edit-Success](images/edit-command-with-stats-success.png)
<br>

<div style="page-break-after: always;"></div>

**An example of the `edit` command being successfully executed to clear a tags and score:**
1. Enter the command `edit 1 t/` (**Clear all tags**)
2. This is the result of the successful `edit` command (Take note that command entered will not be shown in the result):
Expand Down Expand Up @@ -970,8 +967,6 @@ Read more about this in the [Summary Statistics](#summary-statistics) section.

</box>

<div style="page-break-after: always;"></div>

Set up for examples when you first start JABPro with default data:
1. `list`
2. `create t/assessment interview` to create a tag `interview` under the `assessment` category.
Expand All @@ -983,7 +978,6 @@ Set up for examples when you first start JABPro with default data:
![Filter-Setup](images/filter-setup.png)
<br>

<div style="page-break-after: always;"></div>

**An example of the `filter` command being successfully executed:**
1. Enter the command `list`
Expand All @@ -993,7 +987,6 @@ Set up for examples when you first start JABPro with default data:
![Filter-Success](images/filter-command-success.png)
<br>

<div style="page-break-after: always;"></div>

**An example of the `filter` command being successfully executed with `median`:**
1. Enter the command `list`
Expand Down
Loading