Skip to content

Commit

Permalink
Merge pull request #219 from bkjwjason/docs/Screenshot-tweak
Browse files Browse the repository at this point in the history
Minor screenshot size fixes for UG
  • Loading branch information
euchangxian authored Nov 13, 2023
2 parents 98e9039 + 40395ca commit 72d0203
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ about animals in a shelter easily.
<!-- * Table of Contents -->
- [Quick start](#quick-start)
- [Features](#features)
- [Attributes of `Animal`](#attributes-of-animal)
- [Program usage help: `help`](#program-usage-help-help)
- [Adding an animal: `add`](#adding-an-animal-add)
- [Listing all animals: `list`](#listing-all-animals-list)
Expand Down Expand Up @@ -44,7 +45,7 @@ about animals in a shelter easily.
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>

<div style="display: flex; justify-content: center; align-items: center;">
<img src="images/Ui_default.png" alt="Default View" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/Ui_default.png" alt="Default View" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>


Expand Down Expand Up @@ -93,6 +94,10 @@ about animals in a shelter easily.

</box>

<box type="warning">
For longer error messages stated in the user guide, they have been shortened for brevity by displaying only the first few words followed by ellipsis.
</box>

### Attributes of `Animal`
Summarized in the table below are the attributes of `Animal` along with their constraints. Users are encouraged to read through
this table for an idea of what the attributes are supposed to look like, and refer to this table if they are unsure.
Expand All @@ -112,10 +117,6 @@ this table for an idea of what the attributes are supposed to look like, and ref

</details>

<box type="warning">
For longer error messages stated in the user guide, they have been shortened for brevity by displaying only the first few words followed by ellipsis.
</box>

### Program usage help: `help`
Displays either a link to this User Guide in a pop-up, or the usage guide of the specified command.

Expand All @@ -134,12 +135,12 @@ Displays either a link to this User Guide in a pop-up, or the usage guide of the

`help` will produce a link to the User Guide in a pop-up.
<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/help.png" alt="Pop-up" style="height: 200px; width: 300px; margin-bottom: 16px;">
<img src="images/help.png" alt="Pop-up" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>

`help add` will show usage guide of all commands that partial match with `add`.
<div style="display: flex; justify-content: center; align-items: center;">
<img src="images/help_add.png" alt="help add" style="height: 200px; width: 300px; margin-bottom: 16px;">
<img src="images/help_add.png" alt="help add" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>

**Upon failure:**
Expand Down Expand Up @@ -176,7 +177,7 @@ add n/NAME i/ID g/SEX s/SPECIES b/BREED db/DOB da/DOA
* `add n/Tofu i/1242 g/female db/2023-04-01 da/2023-05-25 s/cat b/British Shorthair` adds Tofu to the list.

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/add_eg1.png" alt="Add animal example" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/add_eg1.png" alt="Add animal example" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>

**Upon failure:**
Expand Down Expand Up @@ -226,7 +227,7 @@ Deletes the specified animal from the animal catalog.
* `delete 2` deletes the animal at `INDEX 2`.

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/delete_eg.png" alt="Delete animal example" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/delete_eg.png" alt="Delete animal example" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>

**Upon failure:**
Expand Down Expand Up @@ -263,13 +264,13 @@ Edits animals specified by the index with the newly specified prefix attributes.
* `edit 2 n/Pookie` edits the name of the animal at `INDEX 2` to be `Pookie`.

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/edit_eg1.png" alt="Edit animal name" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/edit_eg1.png" alt="Edit animal name" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>

* `edit 1 s/Dog b/Poodle` edits the species of the animal at `INDEX 1` to be `Dog` and the breed to be `Poodle`.

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/edit_eg2.png" alt="Edit animal species and breed" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/edit_eg2.png" alt="Edit animal species and breed" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>

**Upon failure:**
Expand Down Expand Up @@ -310,14 +311,14 @@ Searches animals that are filtered using the specified prefixes.
**Upon success:**
* `search n/Bear` returns all animals with the name `Bear`, not animals whose species is `Bear`
<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/Search_eg1.png" alt="Search for animals named 'Bear'" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/Search_eg1.png" alt="Search for animals named 'Bear'" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>


* `search n/Pookie b/Poodle` returns all animals with the name `Pookie` and is of the breed `Poodle`

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/Search_eg2.png" alt="Search for animals with multiple prefixes" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/Search_eg2.png" alt="Search for animals with multiple prefixes" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>

**Upon failure:**
Expand Down Expand Up @@ -347,7 +348,7 @@ Adds a specific new task to the task list of an animal.
* `addtask 1 Feed Pookie` adds a task with name `Feed Pookie` to the task list of the first animal.

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/addtask_eg1.png" alt="Add task example" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/addtask_eg1.png" alt="Add task example" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>

**Upon failure:**
Expand Down Expand Up @@ -388,7 +389,7 @@ from animal with index 12, but because there is a missing `TASK_INDEX`, the comm
* `deletetask 1 1` deletes the first task from the first animal in the list

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/Delete_task_eg.png" alt="Delete task example" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/Delete_task_eg.png" alt="Delete task example" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>


Expand Down Expand Up @@ -435,7 +436,7 @@ Marks the specified task as done.
* `mark 2 1 2` marks the first and second task of the second animal as done.

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/Mark_tasks_eg.png" alt="Mark task example" style="height: 300px; width: 400px; : margin-bottom: 16px;">
<img src="images/Mark_tasks_eg.png" alt="Mark task example" style="height: 300px; width: 550px; : margin-bottom: 16px;">
</div>


Expand Down Expand Up @@ -485,7 +486,7 @@ Marks the specified task as uncompleted.
* `unmark 3 1 2` marks the first and second task of the third animal as uncompleted.

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/Unmark_tasks_eg.png" alt="Unmark task example" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/Unmark_tasks_eg.png" alt="Unmark task example" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>


Expand Down Expand Up @@ -534,14 +535,14 @@ The animal cell whose details are currently being displayed in the detail view w
* Selecting an animal in the first cell will display the details as shown below, with the selected cell highlighted in orange.

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/Selected_Animal.png" alt="Selected animal view" style="height: 300px; width: 400px; margin-bottom: 16px;">
<img src="images/Selected_Animal.png" alt="Selected animal view" style="height: 300px; width: 550px; margin-bottom: 16px;">
</div>


* `edit 2 n/Pooh` will automatically cause the animal at `INDEX 2` to show in the detailed view, since it is a command in the list of animal-specific commands.

<div style="display:flex; justify-content: center; align-items:center;">
<img src="images/detailView_eg2.png" alt="Detailed view" style="height: 300px; width: 400px; : margin-bottom: 16px;">
<img src="images/detailView_eg2.png" alt="Detailed view" style="height: 300px; width: 550px; : margin-bottom: 16px;">
</div>


Expand All @@ -558,6 +559,7 @@ Pawfection data are saved in the hard disk automatically after any command that
Pawfection data are saved automatically as a JSON file `[JAR file location]/data/animalcatalog.json`. Advanced users are welcome to update data directly by editing that data file.

<box type="warning" seamless>

*Caution:*
If your changes to the data file makes its format invalid, Pawfection will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
</box>
Expand Down

0 comments on commit 72d0203

Please sign in to comment.