-
Notifications
You must be signed in to change notification settings - Fork 581
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #181 from butteredyakiimo/branch-ug
Specify format error what-if
- Loading branch information
Showing
1 changed file
with
27 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ Here are some tasks which Foster Family can help you with: | |
| * **Search** for a fosterer using _any_ detail you can remember of them. | ||
| * **Gain insights** on the overall status of managed fosterers. | ||
|
|
||
| Foster Family is optimised for use via a **Command Line Interface (CLI)**. This means that you primarily interact with it by typing commands. It also retains the benefits of a Graphical User Interface (GUI), allowing you to interact with the application through graphical components. If you can type fast, Foster Family can get things done faster than traditional GUI apps. | ||
| Foster Family is optimised for use via a **Command Line Interface (CLI)**. This means that you primarily interact with it by typing commands. It also retains the benefits of a Graphical User Interface (GUI), allowing you to interact with the application (app) through graphical components. If you can type fast, Foster Family can get things done faster than traditional GUI apps. | ||
|
|
||
| This document is a comprehensive guide to all the commands available to you, along with **step-by-step explanations** and **examples** to help you master the features Foster Family has to offer. If you are a _new user_, we recommend beginning your journey with [Quick Start](#quick-start). For those who are _already acquainted_, you can refer to the [Table of Contents](#table-of-contents) below to navigate to a section that interests you. | ||
|
|
||
|
|
@@ -37,7 +37,7 @@ Step 4. Open a command terminal. | |
| Step 5. Navigate to the home folder you put the jar file in using the command<br> | ||
| `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> | ||
| Step 6. Use the `java -jar FosterFamily.jar` command to run the app.<br> | ||
|
|
||
| The Foster Family GUI, similar to the image below, should appear on your screen. Note that the app contains some sample data the first time you launch it.<br> | ||
|  | ||
|
|
@@ -271,7 +271,10 @@ To learn more about **editing a fosterer through the profile page**, refer to th | |
| * Extraneous parameters for commands that do not take in parameters (such as `help`, `exit`, `undo`, `sort` and `reset`) will be ignored.<br> | ||
| e.g. if the command specifies `help 123`, it will be interpreted as `help`. | ||
|
|
||
| * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines, as space characters surrounding line-breaks may be omitted when copied over to the application. | ||
| * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines, as space characters surrounding line-breaks may be omitted when copied over to the app. | ||
|
|
||
| * If the command you entered has an invalid format, our app will provide specific error messages to guide you to rectify the issue. | ||
|
|
||
| </div> | ||
|
|
||
| <br> | ||
|
|
@@ -877,7 +880,7 @@ Format: `exit` | |
|
|
||
| **:information_source: Notes about the command:**<br> | ||
|
|
||
| On the profile page, entering <code>exit</code> leads you back to the main page, instead of exiting the application. | ||
| On the profile page, entering <code>exit</code> leads you back to the main page, instead of exiting the app. | ||
|
|
||
| Please refer to [User Interface: The profile page: Exiting the profile page](#exiting-the-profile-page) for more information. | ||
|
|
||
|
|
@@ -930,30 +933,30 @@ If your changes to the data file makes its **format invalid**, Foster Family wil | |
|
|
||
| ## **Known Issues** | ||
|
|
||
| - If you are **using multiple screens** and you move the application to a secondary screen, a part of the GUI may appear "off-screen" if you later choose to switch back to your primary screen. <br> | ||
| To resolve this, you can delete the `preferences.json` file that was created, before running the application again. This file is located in the same home folder as your jar file. | ||
| - If you are **using multiple screens** and you move the app to a secondary screen, a part of the GUI may appear "off-screen" if you later choose to switch back to your primary screen. <br> | ||
| To resolve this, you can delete the `preferences.json` file that was created, before running the app again. This file is located in the same home folder as your jar file. | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
|
|
||
| <div style="page-break-after: always;"></div> | ||
|
|
||
| ## **Command Summary** | ||
|
|
||
| | Action | Format | Examples | | ||
| |------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Help** | `help` | - | | ||
| | **Add** from main page | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS housing/HOUSING_TYPE availability/AVAILABILITY animal/ANIMAL_NAME animalType/TYPE_OF_ANIMAL [t/TAG]…` | `add n/Jerry Tan p/98765412 e/[email protected] a/Baker street, block 5, #27-01 housing/HDB availability/NotAvailable animal/Dexter animalType/current.Cat t/Urgent` | | ||
| | **Add** from profile page | `add` | - | | ||
| | **List** or **Find** | `list`, `find` | `list`, `find`, `list available`, `find available` | | ||
| | **View Profile** | `view INDEX` | `view 1` | | ||
| | **Save updated fosterer details** | `save` | - | | ||
| | **Edit** from main page | `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…]` | `edit 2 n/James Lee e/[email protected]` | | ||
| | **Edit** from profile page | `edit INDEX` | `edit 1` | | ||
| | **Delete** | `delete INDEX [INDEX...]` | `delete 1 2 3` | | ||
| | **Sort** | `sort` | - | | ||
| | **View Available Fosterer Statistics** | `stats avail` | - | | ||
| | **View Current Fosterer Statistics** | `stats current` | - | | ||
| | **View Housing Statistics** | `stats housing` | - | | ||
| | **Undo** | `undo` | - | | ||
| | **Clear all data entries** | `reset`, followed by `reset confirm` | - | | ||
| | **Exit** from application / profile page | `exit` | - | | ||
| | Action | Format | Examples | | ||
| |----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Help** | `help` | - | | ||
| | **Add** from main page | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS housing/HOUSING_TYPE availability/AVAILABILITY animal/ANIMAL_NAME animalType/TYPE_OF_ANIMAL [t/TAG]…` | `add n/Jerry Tan p/98765412 e/[email protected] a/Baker street, block 5, #27-01 housing/HDB availability/NotAvailable animal/Dexter animalType/current.Cat t/Urgent` | | ||
| | **Add** from profile page | `add` | - | | ||
| | **List** or **Find** | `list`, `find` | `list`, `find`, `list available`, `find available` | | ||
| | **View Profile** | `view INDEX` | `view 1` | | ||
| | **Save updated fosterer details** | `save` | - | | ||
| | **Edit** from main page | `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…]` | `edit 2 n/James Lee e/[email protected]` | | ||
| | **Edit** from profile page | `edit INDEX` | `edit 1` | | ||
| | **Delete** | `delete INDEX [INDEX...]` | `delete 1 2 3` | | ||
| | **Sort** | `sort` | - | | ||
| | **View Available Fosterer Statistics** | `stats avail` | - | | ||
| | **View Current Fosterer Statistics** | `stats current` | - | | ||
| | **View Housing Statistics** | `stats housing` | - | | ||
| | **Undo** | `undo` | - | | ||
| | **Clear all data entries** | `reset`, followed by `reset confirm` | - | | ||
| | **Exit** from app / profile page | `exit` | - | | ||