Skip to content

Commit

Permalink
Merge pull request #156 from butteredyakiimo/branch-docs
Browse files Browse the repository at this point in the history
Modify line breaks
  • Loading branch information
butteredyakiimo authored Nov 13, 2023
2 parents caef36f + 9869421 commit 95db922
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,15 @@ There are two ways you can use to navigate to the profile page.
Let's say you want to open the profile page of a fosterer name Alex Yeoh who is currently at index 1.

<div style="text-align: center">
<img src="images/screenshots/ViewCommandExample.png" height="440" class="center"/>
<img src="images/screenshots/ViewCommandExample.png" height="380" class="center"/>
</div>

<br>

To do so, enter <code>view 1</code> as shown in the image above, which opens the profile page of the fosterer at index 1, Alex Yeoh.

<div style="text-align: center">
<img src="images/screenshots/EditExample.png" height="480" class="center"/>
<img src="images/screenshots/EditExample.png" height="420" class="center"/>
</div>

<br>
Expand Down Expand Up @@ -266,8 +266,6 @@ To learn more about **editing a fosterer through the profile page**, refer to th

<br>

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

### Viewing help for Commands : `help`

Opens a pop-up window, providing you with the link to our User Guide for help.
Expand All @@ -278,6 +276,8 @@ Format: `help`

<br>

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

### Adding a fosterer through the main window: `add`

Adds a fosterer to your address book, done through the main window.
Expand Down Expand Up @@ -352,6 +352,8 @@ In the case where duplicates field descriptions are given, the last one will be
* adds a fosterer named Jerry Tan, who lives in a Condo and is fostering a cat named Happy.
![Add](images/screenshots/AddDuplicate.png)

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

### Adding a fosterer through the profile page: `add`

Redirects you to an empty profile page with all the fields set to `nil`. In the profile page, you can key in the fosterer's details and save the
Expand All @@ -366,8 +368,6 @@ Format: `add`
* The restrictions imposed on what makes a valid fosterer, as explained in the section [Adding a fosterer through the main window: add](#adding-a-fosterer-through-the-main-window-add), still applies in this alternative way of adding a fosterer.
</div>

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

Here is the profile page you will see after entering <code>add</code>:

![Profile](images/screenshots/ProfilePage.png)
Expand Down Expand Up @@ -463,6 +463,8 @@ To learn more about profile page, please refer to the section [User Interface: T

<br>

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

### Saving changes in a fosterer's details: `save`

Saves changes to details of the fosterer which you have made in the profile page.
Expand All @@ -478,8 +480,6 @@ Saves changes to details of the fosterer which you have made in the profile page

Format: `save`

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

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

**:information_source: Notes about the command:**<br>
Expand All @@ -488,6 +488,8 @@ Format: `save`
* Entering <code>save</code> in [the profile of an already existing fosterer](#editing-a-fosterers-detail-through-the-profile-page--edit) saves the changes but does not exit the profile page, in case you want to edit more details.
</div>

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

Here is the result of entering <code>save</code> after adding a new fosterer name John:

![Save a new fosterer](images/screenshots/SaveNewFosterer.png)
Expand All @@ -506,14 +508,14 @@ As you can see, entering <code>save</code> for an already existing fosterer does

<br>

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

### Editing a fosterer's details through the main window: `edit`

Edits the details of the index-th fosterer in the list currently displayed in your address book, done through the main window.

Format: `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [housing/HOUSING_TYPE] [availability/AVAILABILITY] [animal/ANIMAL_NAME] [animalType/TYPE_OF_ANIMAL] [t/TAG…]`

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

Parameters:

| Parameter | About | Example |
Expand Down Expand Up @@ -792,8 +794,6 @@ Suppose you have 3 available fosterers: 1 can foster a dog, 1 can foster a cat a

<br>

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

### Viewing statistics of current fosterers : `stats current`
Helps you calculate statistics about fosterers who are currently fostering, and the type of animals they are fostering. Percentages are calculated to 2 decimal places.

Expand Down

0 comments on commit 95db922

Please sign in to comment.