Skip to content

Commit

Permalink
Update UG
Browse files Browse the repository at this point in the history
  • Loading branch information
Lalelulilulela committed Apr 15, 2024
1 parent bcc89d8 commit 978d576
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 35 deletions.
72 changes: 37 additions & 35 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Welcome to CCBot and thank you for choosing CCBot!
>_"Connecting lives, Connecting careers" ~CCBot_
CareerConnectBot (CCBot) is a **desktop app for managing job interview contacts, for you computing professionals!**
It is optimized for use via a Command Line Interface** (CLI) ,while still having the benefits of a Graphical User
**It is optimized for use via a Command Line Interface** (CLI) ,while still having the benefits of a Graphical User
Interface (GUI). If you can type fast, CCBot can get your contact management tasks done faster than traditional GUI apps.

### Key features
Expand Down Expand Up @@ -62,7 +62,32 @@ If you need to look for how to use a specific command, you may skip to the relev
1. Refer to the [Features](#features) below for details of each command.

--------------------------------------------------------------------------------------------------------------------
## Priority

## Features

<div markdown="block" class="alert alert-info">

**:information_source: Notes about the command format:**<br>

* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.

* Items in square brackets are optional.<br>
e.g `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.<br>
e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.

* Parameters can be in any order.<br>
e.g. 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.<br>
e.g. if the command specifies `help 123`, it will be interpreted as `help`.

* 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.
</div>

### Priority
>From 0-4 our program has 5 priorities. The lower the value, the higher the priority.
<span style="display: inline-block; width: 20px; height: 20px; background-color: #ff0000;"></span>
Expand All @@ -86,49 +111,26 @@ If you need to look for how to use a specific command, you may skip to the relev
**<span style="color:#8A15C5;">4 - Lowest Priority</span>** - This is the lowest priority.

--------------------------------------------------------------------------------------------------------------------
## Date and Time
### Date and Time
> Your CCBot uses date and time to better help you manage your interviews. This section contains all the details on how
> your CCBot interprets date and time.
* ### Format : `ddMMyyyyHHmm`
* `dd` - refers to the day and the acceptable range is from **01** to **31**
* `MM` - refers to the month and the acceptable range is from **01** to **12**
* `yyyy` - refers to the year and accepts any **4-digit** numbers from **0001** to **9999**
* `HH` - refers to the hour and the acceptable range is from **00** to **23**
* `mm` - refers to the minutes and the acceptable range is from **00** to **59**
* `dd` - refers to the day and the acceptable range is from **01** to **31**
* `MM` - refers to the month and the acceptable range is from **01** to **12**
* `yyyy` - refers to the year and accepts any **4-digit** numbers from **0001** to **9999**
* `HH` - refers to the hour and the acceptable range is from **00** to **23**
* `mm` - refers to the minutes and the acceptable range is from **00** to **59**
* ### Examples:
* `121220221400` is interpreted as **December 12, 2022 4:00 PM**
* `010100010000` is interpreted as **January 01, 0001 12:00 AM**
* `121220221400` is interpreted as **December 12, 2022 4:00 PM**
* `010100010000` is interpreted as **January 01, 0001 12:00 AM**
> #### Handling leap years
> * Your CCBot uses the ISO-8601 calendar system to handle leap years. This means that giving a leap day on a non-leap
> year returns the last valid day of that month.
> * Your CCBot uses the ISO-8601 calendar system to handle leap years. This means that giving a leap day on a non-leap
> year returns the last valid day of that month.
> * Example: `290220090000` will give the same output as `280220090000`
> * For more information, click [here](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDateTime.html).
--------------------------------------------------------------------------------------------------------------------
## Features

<div markdown="block" class="alert alert-info">

**:information_source: Notes about the command format:**<br>

* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.

* Items in square brackets are optional.<br>
e.g `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.<br>
e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.

* Parameters can be in any order.<br>
e.g. 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.<br>
e.g. if the command specifies `help 123`, it will be interpreted as `help`.

* 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.
</div>

### Viewing help : `help`

Expand Down
Binary file modified docs/images/helpMessage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 978d576

Please sign in to comment.