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.

Sign up for GitHub

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

update help link and UG #173

Merged
merged 5 commits into from
Apr 15, 2024
+43 −17
Merged

update help link and UG #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ab484dd
update help link
dabzpengu Apr 14, 2024
118d185
Merge branch 'master' of https://github.com/AY2324S2-CS2103T-T08-3/tp…
dabzpengu Apr 14, 2024
07e2053
update UG for explaining date and time format
dabzpengu Apr 14, 2024
6d0e8b4
Merge branch 'master' of https://github.com/AY2324S2-CS2103T-T08-3/tp…
dabzpengu Apr 15, 2024
060292e
update UG to explain handling leap years
dabzpengu Apr 15, 2024
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
56 changes: 41 additions & 15 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,26 @@ contact management tasks done faster than traditional GUI apps.
**<span style="color:#8A15C5;">4 - Lowest Priority</span>** - This is the lowest priority.

--------------------------------------------------------------------------------------------------------------------
## 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**
* ### Examples:
* `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.
> * 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">
Expand Down Expand Up @@ -122,6 +141,11 @@ A person can have any number of tags (including 0)
* `TAG` should be a single alphanumerical word with no spaces.
* `PRIORITY` should be a number between 0 and 4.
* `INTERVIEW_TIME` should be in the format `ddMMyyyyHHmm`.
* `dd` - refers to the day and the acceptable range is from **01** to **31**<br/>
* `MM` - refers to the month and the acceptable range is from **01** to **12**<br/>
* `yyyy` - refers to the year and accepts any **4-digit** numbers from **0001** to **9999**<br/>
* `HH` - refers to the hour and the acceptable range is from **00** to **23**<br/>
* `mm` - refers to the minutes and the acceptable range is from **00** to **59**
* `INFO` can take any values.

Examples:
Expand All @@ -135,7 +159,7 @@ i/Remote work s/4000 pl/Python t/criminal pri/4`

Adds a resume to the addressbook.

Format: `resume cn/COMPANY_NAME n/NAME p/PHONE_NUMBER a/ADDRESS e/EMAIL s/SALARY edu/EDUCATION a/ADDRESS`
Format: `resume cn/COMPANY_NAME n/NAME p/PHONE_NUMBER a/ADDRESS e/EMAIL s/SALARY edu/EDUCATION`

* `COMPANY_NAME` should be less than 100 characters, and it should not be blank.
* `NAME` should only contain alphanumeric characters and spaces, and it should not be blank.
Expand Down Expand Up @@ -395,18 +419,20 @@ This value cannot be modified or added by the `edit` or `add` commands.
| **jd/** | The job difficulty (only for `sort` command) |

## Constraints Summary
| Field | Constraint |
|----------------------|----------------------------------------------------------------------------------------------------------|
| `COMPANY_NAME` | Should be less than 100 characters, and it should not be blank. |
| `NAME` | Should only contain alphanumeric characters and spaces, and it should not be blank. |
| `PHONE_NUMBER` | Should only contain numbers, and it should be at least 3 digits long. |
| `EMAIL` | Should be a valid email address. |
| `ADDRESS` | Can take any values, and it should not be blank. |
| `SALARY` | Should only contain numbers, with range [0, 2147483647] or two pure digital numbers with '-' in between. Both digital numbers should be within the range [0, 2147483647]. |
| `PROGRAMMING_LANGUAGE` | Should be alphanumeric and may contain some special characters (+ and #), and must be less than 50 characters. |
| `TAG` | should be a single alphanumerical word with no spaces. |
| `PRIORITY` | Should be a number between 0 and 4. |
| `INTERVIEW_TIME` | Should be in the format `ddMMyyyyHHmm`. |
| `INFO` | Can take any values, and it should not be blank. |
| `EDUCATION` | Should only contain alphanumeric characters and spaces, and it should not be blank. |

| Field | Constraint |
|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `COMPANY_NAME` | Should be less than 100 characters, and it should not be blank. |
| `NAME` | Should only contain alphanumeric characters and spaces, and it should not be blank. |
| `PHONE_NUMBER` | Should only contain numbers, and it should be at least 3 digits long. |
| `EMAIL` | Should be a valid email address. |
| `ADDRESS` | Can take any values, and it should not be blank. |
| `SALARY` | Should only contain numbers, with range [0, 2147483647] or two pure digital numbers with '-' in between. Both digital numbers should be within the range [0, 2147483647]. |
| `PROGRAMMING_LANGUAGE` | Should be alphanumeric and may contain some special characters (+ and #), and must be less than 50 characters. |
| `TAG` | Should be alphanumeric. |
| `PRIORITY` | Should be a number between 0 and 4. |
| `INTERVIEW_TIME` | Should be in the format `ddMMyyyyHHmm`.<br/>* `dd` - refers to the day and the acceptable range is from **01** to **31**<br/> * `MM` - refers to the month and the acceptable range is from **01** to **12**<br/>* `yyyy` - refers to the year and accepts any **4-digit** numbers from **0001** to **9999**<br/> * `HH` - refers to the hour and the acceptable range is from **00** to **23**<br/> * `mm` - refers to the minutes and the acceptable range is from **00** to **59** |
| `INFO` | Can take any values, and it should not be blank. |
| `EDUCATION` | Should only contain alphanumeric characters and spaces, and it should not be blank. |


2 changes: 1 addition & 1 deletion src/main/java/seedu/address/model/person/InterviewTime.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public class InterviewTime {

public static final String MESSAGE_CONSTRAINTS = "Error thrown, date and time format may be wrong. Check UG.";

public static final String REGEX_YYYY = "\\d{4}";
public static final String REGEX_YYYY = "\"([1-9]\\\\d{3}|0\\\\d{3})\"";
public static final String REGEX_DD = "(0[1-9]|[1-2][0-9]|3[01])";
public static final String REGEX_MM = "(0[1-9]|1[0-2])";
public static final String REGEX_HHMM = "^([0-1][0-9]|2[0-3])[0-5][0-9]$";
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/ui/HelpWindow.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/
public class HelpWindow extends UiPart<Stage> {

public static final String USERGUIDE_URL = "https://se-education.org/addressbook-level3/UserGuide.html";
public static final String USERGUIDE_URL = "https://ay2324s2-cs2103t-t08-3.github.io/tp/UserGuide.html";
public static final String HELP_MESSAGE = "Refer to the user guide: " + USERGUIDE_URL;

private static final Logger logger = LogsCenter.getLogger(HelpWindow.class);
Expand Down
Loading