From 883d344e52dd4ba1da4862b8f5cf22999e9c9385 Mon Sep 17 00:00:00 2001 From: Lim YingXuan <101786124+lunaroddity@users.noreply.github.com> Date: Tue, 14 Nov 2023 02:18:01 +0800 Subject: [PATCH 1/2] Remove line breaks after Parameter Information callout boxes and highlighted text jumping to top --- docs/UserGuide.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 6ec28705976..5c8aa5486d6 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -46,7 +46,7 @@ Handy tips to enhance your experience with SOCareers. Additional information to enrich your understanding of SOCareers. -[Highlighted text](): Links to jump to the corresponding sections in the user guide
+[Highlighted text](#lol): Links to jump to the corresponding sections in the user guide
`Monospaced text`: Command formats to guide your usage of SOCareers @@ -205,7 +205,7 @@ Keep track of who you know easily by adding them to your contacts. * `TAG` can be used multiple times in one command
* `NAME` **cannot** have consecutive spaces -
+ **Example**: `add p n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 t/friends t/colleagues` * Adds the person named ‘John Doe’ to the list of persons with the following details: @@ -231,7 +231,7 @@ Keep track of your favourite companies effortlessly by adding them to your conta **:pencil: Parameter Information**
`TAG` can be used multiple times in one command -
+ **Example**: `add c n/TikTok p/98765432 e/tiktokHiring@example.com d/Top Tech Company t/tech t/interested` * Adds the company named ‘TikTok’ to the list of companies with the following details: @@ -273,7 +273,7 @@ Keep track of your dream internships efficiently by adding them to their respect * `SCHEDULED_INTERVIEW_TIME` can only be used **once** and must be in the format `DD-MM-YYYY HH:mm` where DD is the day, MM is the month, YYYY is the year and HH:mm is the time in 24-hour notation -
+ **Example**: `add i 3 n/Marketing Intern 2024 d/Conduct market research and analysis s/20-02-2024 09:45` * Adds the internship named ‘Marketing Intern 2024’ to the third company in the list with the following details: @@ -348,7 +348,7 @@ Keep your list of persons organised by deleting contacts you no longer need. * The `INDEX` depends on the currently displayed list of persons which changes as you search for specific people
-
+ **Example**: `delete p 2` * Deletes the second person in the list of persons @@ -383,7 +383,7 @@ Keep your list of companies organised by deleting companies you are no longer in * The `INDEX` depends on the currently displayed list of companies which changes as you sort companies or search for specific companies
-
+ **Example**: `delete c 2` * Deletes the second company in the list of companies @@ -418,7 +418,7 @@ Keep your list of internships for each company organised by deleting internships * The `COMPANY_INDEX` depends on the currently displayed list of companies which changes as you sort companies or search for specific companies
-
+ **Example**: `delete i c/2 i/1` * Deletes the first internship of the second company in the list of companies that is currently displayed @@ -456,7 +456,7 @@ Review the information you included about the people you know efficiently by vie * The `INDEX` depends on the currently displayed list of persons which changes as you search for specific people
-
+ **Example**: `view p 1` * Displays the first contact in the person list in the display box @@ -491,7 +491,7 @@ viewing their respective contacts. * The `INDEX` depends on the currently displayed list of companies which changes as you sort companies or search for specific companies
-
+ **Example**: `view c 1` * Displays the first contact in the companies list in the display box @@ -539,7 +539,7 @@ Keep your information on the people you know up-to-date by editing their respect Editing the tags of a person overwrites any existing tags
* Add the tags you would like to keep to the command to ensure that they are not removed
-
+ **Example**: `edit p 1 n/Tim e/tim@example.com a/123, Ang Mo Kio Ave 2, #02-26 t/friends` * Edits the first contact in the list of persons to have the following new details: @@ -594,7 +594,7 @@ you sort companies or search for specific companies
Editing the tags of a company overwrites any existing tags.
* Add the tags you would like to keep to the command to ensure that they are not removed.
-
+ **Example**: `edit c 1 n/AlphaGrep e/alphaGrep@example.com d/A cool company t/tech` * Edits the first contact in the list of companies to have the following new details: @@ -639,7 +639,7 @@ you sort companies or search for specific companies
* If a parameter is unspecified, its value will not be edited
-
+ **Example**: `edit i c/1 i/1 n/Finance Intern 2024 s/20-02-2024 09:45` * Edits the first internship of the first company in the list of companies to have the following new details: @@ -697,7 +697,7 @@ assigned to them. * The search is case-insensitive (e.g. `john` will match `John`)
* Partial keywords are not supported (e.g. `Jo` will not match `John`)
-
+ **Example**: `find p n/John t/friend` * Updates the list of persons to list only those who match at least one of the specified names or tags @@ -733,7 +733,7 @@ using a tag you have assigned to it. * The search is case-insensitive (e.g. `apple` will match `Apple`)
* Partial keywords are not supported (e.g. `Ap` will not match `Apple`)
-
+ **Example**: `find c n/AlphaGrep t/tech` * Updates the list of companies to list only those who match at least one of the specified names or tags @@ -768,7 +768,7 @@ specified time period. * `START_DATETIME` and `END_DATETIME` can only be used **once** each.
-
+ **Example**: `sort c start/01-02-2024 00:01 end/01-04-2024 00:01` * Sorts and displays the companies that have internships with interviews between 1 February 2024, 12.01am and @@ -808,7 +808,7 @@ Start from a clean slate instantly by clearing your contacts. **:warning: Warning**
This is **irreversible** and will delete **all** contacts you have added! Make sure you make a copy of the `data` folder in the home folder of SOCareers as a backup before executing this command.
-
+ * After running the command, the output in the UI should be similar to the one shown below:

![clear command result](images/clear.png) From 26031fe583927a8ce2a9f31aee94b0a71ffa744e Mon Sep 17 00:00:00 2001 From: Lim YingXuan <101786124+lunaroddity@users.noreply.github.com> Date: Tue, 14 Nov 2023 02:19:54 +0800 Subject: [PATCH 2/2] Fix formatting error --- docs/UserGuide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 5c8aa5486d6..9508de7b4c6 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -174,6 +174,7 @@ as space characters surrounding line-breaks may be omitted when copied over to t | `end/END_TIME` | `DD-MM-YYYY HH:mm` where DD is the day, MM is the month, YYYY is the year and HH:mm is the time in 24-hour notation | 20-02-2024 09:45 | [Back to Table of Contents](#table-of-contents) + --- ## Features