Skip to content

Commit ec6e09a

Browse files
dylankhoodylankhoo
committed
Update missing info
1 parent 77a6c10 commit ec6e09a

File tree

1 file changed

+43
-25
lines changed

1 file changed

+43
-25
lines changed

‎docs/UserGuide.md‎

Lines changed: 43 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
- [Editing data file](#editing-data-file)
2828
- [CAUTION: Edits that make the data invalid can cause BookKeeper to behave in unexpected ways. Edit data files only if you are confident that you can update it correctly.](#caution-edits-that-make-the-data-invalid-can-cause-bookkeeper-to-behave-in-unexpected-ways-edit-data-files-only-if-you-are-confident-that-you-can-update-it-correctly)
2929
- [Data Validation](#data-validation)
30-
- [Notes:](#notes)
30+
- [Notes](#notes)
3131
- [Command Summary](#command-summary)
3232

3333
<div style="page-break-after: always;"></div>
@@ -63,9 +63,11 @@ Adds a book to the library collection.
6363
Format: `add-book BOOK_TITLE a/AUTHOR cat/CATEGORY cond/CONDITION loc/LOCATION [note/NOTE]`
6464

6565
Notes:
66-
- Books in inventory are unique.
66+
67+
- Books in inventory are unique.
6768
- Valid categories are: romance, adventure, action, horror, mystery, fiction, nonfiction, scifi, education.
6869
- Valid conditions are: poor, fair, good.
70+
- BookKeeper considers books of different casing as separate books.
6971

7072
Example:
7173

@@ -110,9 +112,13 @@ Expected Outcome:
110112
Removed book: Great Gatsby
111113
```
112114

115+
Notes:
116+
117+
- Removing a book with an existing loan will delete the associated loan as well
118+
113119
### Updating a Book: `update-book`
114120

115-
Updates the author, category, condition, location and note with the information provided. While the 4 fields are optional, `update-book` expects at least one field to be updated.
121+
Updates the author, category, condition, location and note with the information provided. While the 4 fields are optional, `update-book` expects at least one field to be updated. If a user wants to update a book title, they should use the `update-title` command instead.
116122

117123
Format: `update-book BOOK_TITLE [a/AUTHOR] [cat/CATEGORY] [cond/CONDITION] [loc/LOCATION] [note/NOTE]`
118124

@@ -135,6 +141,12 @@ Title: Great Gatsby
135141
Note: Replace ASAP
136142
```
137143

144+
Notes:
145+
146+
- Valid categories are: romance, adventure, action, horror, mystery, fiction, nonfiction, scifi, education.
147+
- Valid conditions are: poor, fair, good.
148+
- Blank Fields will not be updated
149+
138150
### Updating a Title: `update-title`
139151

140152
Updates the title of a book.
@@ -162,7 +174,7 @@ Title: The Great Gatsby
162174

163175
### Searching for a Book: `search-title`
164176

165-
Search for a book in the inventory by title based on the keyword.
177+
Search for a book in the inventory by title based on the keyword. Unlike all other commands, search-title uses _case-insensitive_ searching for a better user experience.
166178

167179
Format: `search-title KEYWORD`
168180

@@ -241,13 +253,18 @@ Here are the books in your inventory:
241253
Note: No notes available
242254
```
243255

256+
Notes:
257+
258+
- Valid categories are: romance, adventure, action, horror, mystery, fiction, nonfiction, scifi, education.
259+
244260
### Adding a Loan: `add-loan`
245261

246-
Adds a loan using the book title.
262+
Adds a loan using the book title.
247263

248264
Format: `add-loan BOOK_TITLE n/BORROWER_NAME d/RETURN_DATE p/PHONE_NUMBER e/EMAIL`
249265

250266
Notes:
267+
251268
- The book to be loaned out must exist in the inventory.
252269
- The RETURN_DATE must be in the format DD-MM-YYYY.
253270
- The RETURN_DATE cannot be in the past.
@@ -338,13 +355,13 @@ Expected Outcome:
338355
Here are the active loans:
339356
1. Title: Great Gatsby
340357
Borrower: John Doe
341-
Return Date: 2023-12-01
358+
Return Date: 12-01-2023
342359
Contact Number: 98765432
343360
Email: abc123@gmail.com
344361
345362
2. Title: Cheese Chronicles
346363
Borrower: Gerald
347-
Return Date: 2043-11-04
364+
Return Date: 11-04-2025
348365
...
349366
```
350367

@@ -427,28 +444,29 @@ Warning Message:
427444
### Notes:
428445

429446
- **Commands Are Case-Sensitive**: Ensure that commands and inputs (e.g., book titles, borrower names) match the exact case.
430-
- **Books Are Unique**: Each book in the inventory is unique and identified by its title. Duplicate books are not allowed.
431-
- **Input Character Limitations**: We guarantee support for the English keyboard only. For contact numbers, only Singapore numbers are supported (omit +65). Please do not use the character `|` in your inputs.
447+
- **Books Are Unique**: Each book in the inventory is unique and identified by its title. Duplicate books are not allowed. Books are case sensitive.
448+
- **Input Character Limitations**: We guarantee support for the English keyboard only. For contact numbers, only Singapore numbers are supported (omit +65). Please do not use the character `|` in your inputs. Special sequences such as ANSI escape code are not supported.
432449
- **Data Size/Length Limitations**: Inventory size, loan list length and no. of characters in user input should not exceed `2147483647` (>2 billion).
433450
- **User Responsibility**: User is responsible for text between flags (demarcated by `/`), e.g. `" "` is considered a valid book title if user follows proper command syntax.
451+
- **File Permissions**: Users should not tamper with BookKeeper file permissions to ensure a seamless experience.
434452

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

437455
## Command Summary
438456

439-
| Action | Format |
440-
|-----------------|------------------------------------------------------------------------------------------------|
441-
| Add Book | `add-book BOOK_TITLE a/AUTHOR cat/CATEGORY cond/CONDITION loc/LOCATION [note/NOTE]` |
442-
| Remove Book | `remove-book BOOK_TITLE` |
443-
| Update Book | `update-book BOOK_TITLE [a/AUTHOR] [cat/CATEGORY] [cond/CONDITION] [loc/LOCATION] [note/NOTE]` |
444-
| Update Title | `update-title BOOK_TITLE new/NEW_TITLE` |
445-
| Search Book | `search-title KEYWORD` |
446-
| View Inventory | `view-inventory` |
447-
| Delete Note | `delete-note BOOK_TITLE` |
448-
| List Category | `list-category CATEGORY` |
449-
| Add Loan | `add-loan BOOK_TITLE n/BORROWER_NAME d/RETURN_DATE p/PHONE_NUMBER e/EMAIL` |
450-
| Delete Loan | `delete-loan BOOK_TITLE` |
451-
| Edit Loan | `edit-loan BOOK_TITLE [n/BORROWER_NAME] [d/RETURN_DATE] [p/PHONE_NUMBER] [e/EMAIL]` |
452-
| View Loans | `view-loans` |
453-
| Display Help | `help` |
454-
| Exit Program | `exit` |
457+
| Action | Format |
458+
| -------------- | ---------------------------------------------------------------------------------------------- |
459+
| Add Book | `add-book BOOK_TITLE a/AUTHOR cat/CATEGORY cond/CONDITION loc/LOCATION [note/NOTE]` |
460+
| Remove Book | `remove-book BOOK_TITLE` |
461+
| Update Book | `update-book BOOK_TITLE [a/AUTHOR] [cat/CATEGORY] [cond/CONDITION] [loc/LOCATION] [note/NOTE]` |
462+
| Update Title | `update-title BOOK_TITLE new/NEW_TITLE` |
463+
| Search Book | `search-title KEYWORD` |
464+
| View Inventory | `view-inventory` |
465+
| Delete Note | `delete-note BOOK_TITLE` |
466+
| List Category | `list-category CATEGORY` |
467+
| Add Loan | `add-loan BOOK_TITLE n/BORROWER_NAME d/RETURN_DATE p/PHONE_NUMBER e/EMAIL` |
468+
| Delete Loan | `delete-loan BOOK_TITLE` |
469+
| Edit Loan | `edit-loan BOOK_TITLE [n/BORROWER_NAME] [d/RETURN_DATE] [p/PHONE_NUMBER] [e/EMAIL]` |
470+
| View Loans | `view-loans` |
471+
| Display Help | `help` |
472+
| Exit Program | `exit` |

0 commit comments

Comments
 (0)