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

Jump to bottom

More line breaks #154

Merged
merged 3 commits into from
Nov 13, 2023
Merged

More line breaks #154

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be4ade2
Change numbering to steps in quick start
butteredyakiimo Nov 13, 2023
71cd418
Improve line breaks in UG
butteredyakiimo Nov 13, 2023
76ab749
Improve line breaks again
butteredyakiimo Nov 13, 2023
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
67 changes: 35 additions & 32 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,26 @@ This user guide contains **all** the commands available to you, along with **ste


## **Quick Start**
1. Ensure you have Java `11` or above installed in your computer. You can download it from [here](https://www.oracle.com/sg/java/technologies/javase/jdk11-archive-downloads.html).

2. Download the latest `FosterFamily.jar` from [here](https://github.com/AY2324S1-CS2103T-T13-4/tp/releases).
Step 1. Ensure you have Java `11` or above installed in your computer. You can download it from [here](https://www.oracle.com/sg/java/technologies/javase/jdk11-archive-downloads.html).

3. Copy the file to the folder you want to use as the _home folder_ for Foster Family.
Step 2. Download the latest `FosterFamily.jar` from [here](https://github.com/AY2324S1-CS2103T-T13-4/tp/releases).

4. Open a command terminal.
Step 3. Copy the file to the folder you want to use as the _home folder_ for Foster Family.

5. Navigate to the home folder you put the jar file in using the command `cd <path_to_home_folder>`, replacing `<path_to_home_folder>` with your file path.
Step 4. Open a command terminal.

6. Use the `java -jar FosterFamily.jar` command to run the application.<br>
Step 5. Navigate to the home folder you put the jar file in using the command `cd <path_to_home_folder>`, replacing `<path_to_home_folder>` with your file path.

Step 6. Use the `java -jar FosterFamily.jar` command to run the application.<br>

The Foster Family GUI should appear on screen, similar to the screenshot attached below. Note how the app contains some sample data.<br>
![Ui](images/Ui.png)

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


7. Type a command in the command box and press Enter to execute it. e.g. typing `help` and pressing Enter will open the help window.<br>
Step 7. Type a command in the command box and press Enter to execute it. e.g. typing `help` and pressing Enter will open the help window.<br>

Some example commands you can try:

Expand Down Expand Up @@ -116,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="490" class="center"/>
<img src="images/screenshots/ViewCommandExample.png" height="440" 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="570" class="center"/>
<img src="images/screenshots/EditExample.png" height="480" class="center"/>
</div>

<br>
Expand All @@ -135,28 +136,24 @@ To do so, enter <code>view 1</code> as shown in the image above, which opens the
Typing in the name of the field you want to edit, or substrings of the field, directs your cursor to the textbox, allowing you to make changes.

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

<br>

In the example above, entering <code>name</code>, or a substring of name like <code>nam</code>, brings the focus to the name field.

<br>

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

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

After you are done editing, pressing the Enter key on your keyboard brings your cursor back to the command box with your new changes intact. <br>
If you wish to revert back to the original value of the field while editing in the textbox, press the Esc key to undo the changes and direct your cursor back to the command box.

<br>
If you wish to revert back to the original value of the field while editing in the textbox, press the Esc key to undo the changes and direct your cursor back to the command box.

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

In the example above, after changing name from 'Yeoh' to 'Yeo' the Enter key was pressed.
Expand All @@ -172,7 +169,7 @@ Entering <code>save</code> saves the changes you made into the storage.
Let's say after changing the name, you want to save your changes.

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

<br>
Expand All @@ -184,7 +181,7 @@ Key in <code>save</code> and press Enter to save the changes.
<div style="page-break-after: always;"></div>

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

<br/>
Expand All @@ -203,9 +200,7 @@ Attempting to exit without saving your changes will give you a warning message,

Let's say you have already saved your changes.

<div style="text-align: center">
<img src="images/screenshots/ExitCommandSavedBefore.png" height="310" class="center"/>
</div>
![Exit command saved after](images/screenshots/ExitCommandSavedBefore.png)

<br>

Expand Down Expand Up @@ -324,8 +319,6 @@ Valid cases:
| 4 | Not fostering (e.g. overseas, currently not able to foster) | `NotAvailable` | `nil` | `nil` |
| 5 | Fostering: ALL information must be present | `NotAvailable` | `current.Dog/Cat` | NOT `nil` |

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

* For invalid cases, error messages will be shown when you enter the invalid commands. For example:
![Add](images/screenshots/AddErrorMessage.png)

Expand Down Expand Up @@ -483,10 +476,10 @@ Saves changes to details of the fosterer which you have made in the profile page

</div>

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

Format: `save`

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

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

**:information_source: Notes about the command:**<br>
Expand Down Expand Up @@ -578,6 +571,8 @@ Before you type the save command, make sure there is no accidental overwrite wit

<br>

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

### Editing a fosterer's details through the profile page: `edit`

Edits the details of the index-th fosterer in the list currently displayed in your address book, done through the profile page.
Expand All @@ -591,8 +586,6 @@ Parameters:
| `INDEX` | - The index of a fosterer displayed in the list obtained from a `list`/`find` command <br/> - Index must be a positive integer | `1`, `2`, `3` |


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

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

**:information_source: Notes about the command:**<br>
Expand All @@ -609,6 +602,8 @@ more flexibility.

</div>

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

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

**:warning: Caution:**<br>
Expand All @@ -620,8 +615,6 @@ Before you type the save command, make sure there is no accidental overwrite wit

<br/>

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

Here is a summary of how to edit a fosterer Alex Yeoh who is currently at index 1:

Step 1. Enter the profile page with `view INDEX` or `edit INDEX`. e.g. `view 1` or `edit 1`.
Expand All @@ -630,6 +623,8 @@ Step 1. Enter the profile page with `view INDEX` or `edit INDEX`. e.g. `view 1`
<img src="images/screenshots/View1.png" height="480" class="center"/>
</div>

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

Step 2. Type in the name of the field you want to edit onto the command box. This will make the textbox visible next to the field and automatically set the text cursor to the textbox. e.g. Enter 'name'.

<div style="text-align: center">
Expand All @@ -638,6 +633,8 @@ Step 2. Type in the name of the field you want to edit onto the command box. Thi

<br>

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

Step 3. Edit the original value to a new value. e.g. From Alex Yeoh to 'Bob Yeoh'.

<div style="text-align: center">
Expand All @@ -646,6 +643,8 @@ Step 3. Edit the original value to a new value. e.g. From Alex Yeoh to 'Bob Yeoh

<br>

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

Step 4. Press Enter to return the text cursor back to the command box. This makes the textbox disappear.

<div style="text-align: center">
Expand All @@ -654,6 +653,8 @@ Step 4. Press Enter to return the text cursor back to the command box. This make

<br>

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

Step 5. Enter `save` to save your changes.

<div style="text-align: center">
Expand Down Expand Up @@ -718,6 +719,8 @@ In this example, Alex, Bernice and Charlotte are the fosterers deleted.

<br>

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

### Sorting fosterers: `sort`

Sorts your list of fosterers alphabetically, by name.
Expand Down Expand Up @@ -789,6 +792,8 @@ 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 Expand Up @@ -896,8 +901,6 @@ On the profile page,<br>

<br>

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

### Saving data

In the main window, your Foster Family data is saved in the hard disk automatically after any command that changes the data, so no manual saving is needed. However, edits made in the profile page have to be saved via the `save` command. Else, changes will be discarded once you exit out of that fosterer's profile page.
Expand Down
Loading