+
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
+[[homepage](https://ay2526s1-cs2103t-f09-4.github.io/tp/)]
+[[github](https://github.com/eltry42)]
[[portfolio](team/johndoe.md)]
* Role: Project Advisor
-### Jane Doe
+### Harun Abdullah Bin Mohd Jufri
-
-[[github](http://github.com/johndoe)]
+[[github](http://github.com/harun-abdullah)]
[[portfolio](team/johndoe.md)]
* Role: Team Lead
* Responsibilities: UI
-### Johnny Doe
+### Arun Ayyappan Vellaiyan
-
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/ArunV2048)] [[portfolio](team/johndoe.md)]
* Role: Developer
* Responsibilities: Data
-### Jean Doe
+### Adib
-
-[[github](http://github.com/johndoe)]
+[[github](http://github.com/adibice1)]
[[portfolio](team/johndoe.md)]
* Role: Developer
* Responsibilities: Dev Ops + Threading
-### James Doe
+### Darius Deng Yang
-
-[[github](http://github.com/johndoe)]
+[[github](http://github.com/darisusu)]
[[portfolio](team/johndoe.md)]
* Role: Developer
diff --git a/docs/Configuration.md b/docs/Configuration.md
index 13cf0faea16..32f6255f3b9 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -1,6 +1,8 @@
---
-layout: page
-title: Configuration guide
+ layout: default.md
+ title: "Configuration guide"
---
+# Configuration guide
+
Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).
diff --git a/docs/DevOps.md b/docs/DevOps.md
index 4724701da81..747f3f9a82d 100644
--- a/docs/DevOps.md
+++ b/docs/DevOps.md
@@ -1,12 +1,15 @@
---
-layout: page
-title: DevOps guide
+ layout: default.md
+ title: "DevOps guide"
+ pageNav: 3
---
-* Table of Contents
-{:toc}
+# DevOps guide
---------------------------------------------------------------------------------------------------------------------
+
+
+
+
+
+
+
+{{ page.alt_title | escape }}
-
- {{ content }}
-
-
-
- {{ content }}
-
- :information_source: **Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.
+
+
+**Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the FitBook, which `Person` references. This allows FitBook to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.
-
+
+
### Storage component
**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java)
-+
-
+
+:information_source: **Note:** If a command fails its execution, it will not call `Model#commitAddressBook()`, so the address book state will not be saved into the `addressBookStateList`.
+
-
+Step 4. The trainer now realizes that scheduling the session was a mistake (wrong client or time), and decides to undo that action by executing the `undo` command. The `undo` command will call `Model#undoAddressBook()`, which will shift the `currentStatePointer` once to the left, pointing it to the previous FitBook state, and restores FitBook to that state (removing the session).
-Step 4. The user now decides that adding the person was a mistake, and decides to undo that action by executing the `undo` command. The `undo` command will call `Model#undoAddressBook()`, which will shift the `currentStatePointer` once to the left, pointing it to the previous address book state, and restores the address book to that state.
+:information_source: **Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather
-than attempting to perform the undo.
+
-
+**Note:** If the `currentStatePointer` is at index 0, pointing to the initial FitBook state, then there are no previous FitBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the trainer rather than attempting to perform the undo.
+
+:information_source: **Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+**Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
-
+:information_source: **Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest address book state, then there are no undone AddressBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
+**Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest FitBook state, then there are no undone FitBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the trainer rather than attempting to perform the redo.
-
+
+:information_source: **Note:** These instructions only provide a starting point for testers to work on;
+
+
+**Note:** These instructions only provide a starting point for testers to work on;
testers are expected to do more *exploratory* testing.
-
+
### Launch and shutdown
1. Initial launch
- 1. Download the jar file and copy into an empty folder
+ 1. Download the jar file and copy into an empty folder
- 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
+ 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
1. Saving window preferences
- 1. Resize the window to an optimum size. Move the window to a different location. Close the window.
+ 1. Resize the window to an optimum size. Move the window to a different location. Close the window.
- 1. Re-launch the app by double-clicking the jar file.+ 1. Re-launch the app by double-clicking the jar file.
Expected: The most recent window size and location is retained. -1. _{ more test cases … }_ ### Deleting a person 1. Deleting a person while all persons are being shown - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. + 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + 1. Test case: `delete 1`
+ Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. + 1. Test case: `delete 0`
+ Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. + 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. -1. _{ more test cases … }_ ### Saving data 1. Dealing with missing/corrupted data files - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ -1. _{ more test cases … }_ + diff --git a/docs/Documentation.md b/docs/Documentation.md index 3e68ea364e7..082e652d947 100644 --- a/docs/Documentation.md +++ b/docs/Documentation.md @@ -1,29 +1,21 @@ --- -layout: page -title: Documentation guide + layout: default.md + title: "Documentation guide" + pageNav: 3 --- -**Setting up and maintaining the project website:** - -* We use [**Jekyll**](https://jekyllrb.com/) to manage documentation. -* The `docs/` folder is used for documentation. -* To learn how set it up and maintain the project website, follow the guide [_[se-edu/guides] **Using Jekyll for project documentation**_](https://se-education.org/guides/tutorials/jekyll.html). -* Note these points when adapting the documentation to a different project/product: - * The 'Site-wide settings' section of the page linked above has information on how to update site-wide elements such as the top navigation bar. - * :bulb: In addition to updating content files, you might have to update the config files `docs\_config.yml` and `docs\_sass\minima\_base.scss` (which contains a reference to `AB-3` that comes into play when converting documentation pages to PDF format). -* If you are using Intellij for editing documentation files, you can consider enabling 'soft wrapping' for `*.md` files, as explained in [_[se-edu/guides] **Intellij IDEA: Useful settings**_](https://se-education.org/guides/tutorials/intellijUsefulSettings.html#enabling-soft-wrapping) +# Documentation Guide +* We use [**MarkBind**](https://markbind.org/) to manage documentation. +* The `docs/` folder contains the source files for the documentation website. +* To learn how set it up and maintain the project website, follow the guide [[se-edu/guides] Working with Forked MarkBind sites](https://se-education.org/guides/tutorials/markbind-forked-sites.html) for project documentation. **Style guidance:** * Follow the [**_Google developer documentation style guide_**](https://developers.google.com/style). +* Also relevant is the [_se-edu/guides **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html). -* Also relevant is the [_[se-edu/guides] **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html) - -**Diagrams:** - -* See the [_[se-edu/guides] **Using PlantUML**_](https://se-education.org/guides/tutorials/plantUml.html) -**Converting a document to the PDF format:** +**Converting to PDF** -* See the guide [_[se-edu/guides] **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html) +* See the guide [_se-edu/guides **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html). diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index c8385d85874..00000000000 --- a/docs/Gemfile +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -source "https://rubygems.org" - -git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } - -gem 'jekyll' -gem 'github-pages', group: :jekyll_plugins -gem 'wdm', '~> 0.1.0' if Gem.win_platform? -gem 'webrick' diff --git a/docs/Logging.md b/docs/Logging.md index 5e4fb9bc217..589644ad5c6 100644 --- a/docs/Logging.md +++ b/docs/Logging.md @@ -1,8 +1,10 @@ --- -layout: page -title: Logging guide + layout: default.md + title: "Logging guide" --- +# Logging guide + * We are using `java.util.logging` package for logging. * The `LogsCenter` class is used to manage the logging levels and logging destinations. * The `Logger` for a class can be obtained using `LogsCenter.getLogger(Class)` which will log messages according to the specified logging level. diff --git a/docs/SettingUp.md b/docs/SettingUp.md index aef33ec72fd..5e8b9d11991 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -1,27 +1,33 @@ --- -layout: page -title: Setting up and getting started + layout: default.md + title: "Setting up and getting started" + pageNav: 3 --- -* Table of Contents -{:toc} +# Setting up and getting started + +
:exclamation: **Caution:**
+
+**Caution:**
Follow the steps in the following guide precisely. Things will not work out if you deviate in some steps.
-
+
First, **fork** this repo, and **clone** the fork into your computer.
If you plan to use Intellij IDEA (highly recommended):
+
1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to ensure Intellij is configured to use **JDK 17**.
-1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA.- :exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. +1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA. +
:bulb: **Tip:**
+
+ **Tip:**
Optionally, you can follow the guide [_[se-edu/guides] Using Checkstyle_](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use the CheckStyle within IDEA e.g., to report problems _as_ you write code.
-
+
1. **Set up CI**
diff --git a/docs/Testing.md b/docs/Testing.md
index 8a99e82438a..78ddc57e670 100644
--- a/docs/Testing.md
+++ b/docs/Testing.md
@@ -1,12 +1,15 @@
---
-layout: page
-title: Testing guide
+ layout: default.md
+ title: "Testing guide"
+ pageNav: 3
---
-* Table of Contents
-{:toc}
+# Testing guide
---------------------------------------------------------------------------------------------------------------------
+
+:link: **Link**: Read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html) to learn more about using Gradle.
-
+- **Mac users:** Ensure you have the precise JDK version prescribed [here](https://se-education.org/guides/tutorials/javaInstallationMac.html). -1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases). + -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. +--- +## Table of Contents + +- [Quick Start](#quick-start) +- [Command Summary](#command-summary) +- [UI Guide](#ui-guide) +- [Command Reference](#command-reference) +- [Data Handling](#data-handling) +- [FAQ](#faq) +- [Known Issues](#known-issues) + + + +--- + +## Quick Start + +1. Ensure you have **Java 17 or above** installed. + - **Mac users:** Follow the [installation guide](https://se-education.org/guides/tutorials/javaInstallationMac.html). + +2. Download the latest `.jar` file from your team’s [GitHub Releases](https://github.com/AY2526S1-CS2103T-F09-4/tp/releases). + +3. Copy the `.jar` file to any folder - this will serve as your **FitBook home folder**. + +4. Open a terminal and run: + ```bash + java -jar FitBook.jar + ``` + The GUI should appear within a few seconds, showing you a dashboard. Sample data will be pre-loaded. + +5. Try these example commands for starters: + - `client` or `list` - Switches from the dashboard to the full client list view + - `add n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 goal/Build muscle h/170 w/70 age/25 g/male dl/2025-11-10 paid/false s/WEEKLY:MON-1800-1930-TUE-1800-1900 bf/18.5 t/friends t/owesMoney` - Adds a new client with basic information + - `delete 1` – Deletes the first client in the list + - `exit` – Exits the application + +6. Refer to the [Command Reference](#command-reference) below for full details. + +[↑ Back to top](#fitbook-user-guide) + +--- +## Command Summary + +> ⚠️ **Note:** Please review the [Important Input Rule](#important-input-rule) before entering commands to avoid errors. + + +| **Command** | **Description** | **Example** | +|-------------------------------------------------------------------------------|-------------------------------------|----------------------------------------------------| +| [`add`](#add---add-a-client) | Add a new client | `add n/John Doe p/98765432 e/john@example.com ...` | +| [`edit`](#edit---edit-a-client) | Edit an existing client | `edit 2 n/James Tan e/jamestan@example.com` | +| [`list` / `client`](#list-or-client---view-all-clients) | View all clients | `list` or `client` | +| [`find`](#find---search-clients-by-name) | Search for clients by name | `find John Jane` | +| [`delete`](#delete---remove-a-client) | Delete a client | `delete 3` | +| [`clear`](#clear---delete-all-clients) | Delete all clients | `clear` | +| [`sortbypaid`](#sortbypaid---sort-clients-by-payment-status) | Sort clients by payment status | `sortbypaid` | +| [`sortbydeadline`](#sortbydeadline---sort-clients-by-payment-deadline) | Sort clients by payment deadline | `sortbydeadline desc` | +| [`sortbysession`](#sortbysession---sort-clients-by-upcoming-session) | Sort clients by upcoming session | `sortbysession` | +| [`session`](#session---update-a-clients-scheduled-session) | Update a client’s scheduled session | `session 1 s/WEEKLY:MON-1800-1930` | +| [`goal`](#goal---set-or-clear-a-fitness-goal) | Set or clear a fitness goal | `goal 1 goal/Run a marathon` | +| [`deadline`](#deadline---update-a-goal-deadline) | Update a goal deadline | `deadline 2 dl/2025-12-31` | +| [`paid`](#paid---record-payment-status) | Record payment status | `paid 3 paid/true` | +| [`height`](#height-weight-age-bodyfat-gender---update-individual-attributes) | Update height | `height 1 h/170` | +| [`weight`](#height-weight-age-bodyfat-gender---update-individual-attributes) | Update weight | `weight 1 w/70` | +| [`age`](#height-weight-age-bodyfat-gender---update-individual-attributes) | Update age | `age 1 age/25` | +| [`bodyfat`](#height-weight-age-bodyfat-gender---update-individual-attributes) | Update body fat | `bodyfat 1 bf/18.5` | +| [`gender`](#height-weight-age-bodyfat-gender---update-individual-attributes) | Update gender | `gender 1 g/female` | +| [`dashboard`](#dashboard---switch-to-dashboard-view) | Switch to dashboard view | `dashboard` | +| [`help`](#help---open-help-window) | Open help window | `help` | +| [`exit`](#exit---close-the-program) | Exit the program | `exit` | + +[↑ Back to top](#fitbook-user-guide) + +--- +## UI Guide + +The UI comprises a few main components, which can be manipulated via the commands below. + + +When entering the app, the user will see a dashboard component taking up the bulk of the screen. +The dashboard contains two lists: +1. Upcoming Sessions: + - Lists the current clients in order of nearest upcoming session from current datetime + - Each card contains only the client name and their session type +2. Unpaid Clients: + - Lists the current clients who have not paid (`paid` is false) + - Each card contains only the client name, deadline date, and phone number + +Pressing the client button on the left, the dashboard will be replaced with the full client list, +containing the full information of every client. + +Here, the user can further use commands like `find`, `sortbydeadline` to refine or reorder the results shown in the list. + +To the left, there is a sidebar with four buttons. + + + +The top two buttons allow the user to toggle between the dashboard and the main client list. +The Help button opens a new window containing a link to the user guide. +The Exit button will close the program. +All the buttons' functionalities can also be accessed via text commands, as seen below. + +At the bottom lies the CommandBox and ResultDisplay. + + + +The user can input their commands into the CommandBox. +Results of the command input will be immediately shown in the ResultDisplay, including error messages. +This is the main medium users are expected to interact with the program. + +[↑ Back to top](#fitbook-user-guide) + + +--- + +## Command Reference + +This section lists all available commands and how to use them. + +> ### Format conventions +> - Words in `UPPER_CASE` are parameters you should replace with your own values. +> - Items in `[square brackets]` are optional. +> - Items followed by `…` can be repeated multiple times. +> - Commands that update clients use the `INDEX` from the **full client list** (starting at 1). It does NOT refer to +the index of the dashboard lists. +> - Prefixes such as `n/` for name let you provide parameters in **any order**. + +> ### ⚠️ Important Input Rule +> +> You **must not include the `/` character in any input values**, except where it is used as a command prefix (e.g., `n/`, `p/`, `e/`). +> +> Using `/` inside actual data fields - such as names (`s/o`), addresses, goals, or tags - will cause the command to fail or be misinterpreted. +> +> +>> ❌ **Incorrect:** `add n/John s/o Doe ...` +>> +>> ✅ **Correct:** `add n/John s|o Doe ...` (use a different character instead of `/`) + +[↑ Back to Command Summary](#command-summary) + +--- + +### `add` - add a client + +**Format:** +``` +add n/NAME p/PHONE e/EMAIL a/ADDRESS dl/DEADLINE paid/PAID s/SCHEDULE [goal/GOAL] [h/HEIGHT] [w/WEIGHT] [age/AGE] [g/GENDER] [bf/BODYFAT] [t/TAG]… +``` + +**Example:** +``` +add n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 dl/2025-11-10 paid/false s/2025-11-12 18:00 goal/Build muscle h/170 w/70 age/25 g/male bf/18.5 t/friend t/owesMoney +``` + +**Guidance:** +- Required prefixes: `n/`, `p/`, `e/`, `a/`, `dl/`, `paid/`, `s/` +- Optional: `goal/`, `h/`, `w/`, `age/`, `g/`, `bf/`, `t/` +- `PHONE` must contain exactly 8 digits (numbers only, no spaces or symbols) +- Units: height (cm), weight (kg), age (years), body fat (%) +- `GENDER` accepts: `male`, `female`, `other`, `non-binary`, `prefer not to say` (case-insensitive, e.g., `Male`, `FEMALE`, `Non-Binary` are all accepted) +- `PAID` accepts `true` or `false` +- `DEADLINE` format: `yyyy-MM-dd` +- Automatically saves data after successful addition + +--- + +### `edit` - Edit a client -1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.
- A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
-  +**Format:** +``` +edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [h/HEIGHT] [w/WEIGHT] [age/AGE] [g/GENDER] [dl/DEADLINE] [paid/PAID] [s/SESSION] [bf/BODYFAT] [goal/GOAL] [t/TAG]… +``` -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: +**Example:** +``` +edit 2 p/91234567 e/alex@example.com goal/Run a half marathon +``` - * `list` : Lists all contacts. +**Guidance:** +- Provide at least one field to update. +- When specifying tags, existing tags are replaced with the new ones. +- Automatically saves changes after editing. - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. +--- - * `delete 3` : Deletes the 3rd contact shown in the current list. +### `list` or `client` - View all clients - * `clear` : Deletes all contacts. +**Format:** - * `exit` : Exits the app. +Use either of the following commands: -1. Refer to the [Features](#features) below for details of each command. +`list` or +`client` --------------------------------------------------------------------------------------------------------------------- +**Guidance:** +- Both commands display the full client list view. +- If the user is currently on the dashboard, these commands switch the view to the client list tab. +- They do **not** modify any data — only change the displayed view. +- You can use either command interchangeably. -## Features +> 💡 **Design Note:** +> `list` is provided for users familiar with traditional CLI syntax, +> While `client` offers a more intuitive, context-based option consistent with `dashboard`. +> Both are retained to improve accessibility and user experience. +--- -
+### `find` - Search clients by name
+**Format:**
+```
+find KEYWORD [MORE_KEYWORDS]…
+```
+**Example:**
+```
+find alex bernice
+```
-**:information_source: Notes about the command format:**
+**Guidance:** +- Case-insensitive search within names +- Multiple keywords perform an OR-search (matches if any keyword is present) +- Only full words will be matched e.g. `Han` will not match `Hans` +- Matches are displayed in the respective client and dashboard panels -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. -* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +  -* Items with `…` after them can be used multiple times including zero times.
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +--- -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. +### `delete` - Remove a client +**Format:** +``` +delete INDEX +``` +**Example:** +``` +delete 3 +``` -* 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. -
+**Guidance:**
+- Deletes the client at the given index in the displayed list.
+- Note: Index corresponds to the client list currently shown, which may be filtered or sorted.
-### Viewing help : `help`
+---
-Shows a message explaining how to access the help page.
+### `clear` - Delete all clients
+**Format:**
+```
+clear
+```
+> ⚠️ **Warning:** This action **cannot be undone**. Think twice!
-
-Format: `help`
+---
+
+### `sortbypaid` - Sort clients by payment status
+**Format:**
+```
+sortbypaid
+```
+
+**Guidance:**
+- Unpaid clients (paid:`false`) appear first.
+- Paid clients (paid:`true`) appear last.
+- Will switch back to client list to display sorted list.
+
+---
-### Adding a person: `add`
+### `sortbydeadline` - Sort clients by payment deadline
+**Format:**
+```
+sortbydeadline [asc/desc]
+```
+**Examples:**
+```
+- `sortbydeadline` or `sortbydeadline asc` → ascending
+- `sortbydeadline desc` → descending
+```
+**Guidance:**
+- Ascending: earliest → latest → no deadline
+- Descending: no deadline → latest → earliest
+- Will switch back to client list to display sorted list.
-Adds a person to the address book.
+---
-Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
+### `sortbysession` - Sort clients by upcoming session
+**Format:**
+```
+sortbysession
+```
+**Guidance:**
+- Clients with nearest upcoming sessions will appear first.
+- Will switch back to client list to display sorted list.
+---
-+**Guidance:** +- Case-insensitive search within names +- Multiple keywords perform an OR-search (matches if any keyword is present) +- Only full words will be matched e.g. `Han` will not match `Hans` +- Matches are displayed in the respective client and dashboard panels -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. -* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +  -* Items with `…` after them can be used multiple times including zero times.
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +--- -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. +### `delete` - Remove a client +**Format:** +``` +delete INDEX +``` +**Example:** +``` +delete 3 +``` -* 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. -
:bulb: **Tip:**
-A person can have any number of tags (including 0)
-
+### `session` - Update a client’s scheduled session
+**Format:**
+```
+session INDEX s/SESSION
+```
+**Example:**
+```
+session 1 s/WEEKLY:MON-1800-1930
+```
+**Guidance:**
+
+- FitBook automatically detects and rejects conflicting session timings.
+
+**Supported Session Formats:**
+
+| **Type** | **Format** | **Example** |
+|-----------|-------------|-------------|
+| **One-off** | `YYYY-MM-DD HH:MM` | `2025-06-10 14:30` |
+| **Weekly (single slot)** | `WEEKLY:DAY-START-END` | `weekly:mon-1800-1930` |
+| **Weekly (multi-slot)** | `WEEKLY:DAY-START-END-DAY-START-END` | `weekly:mon-1800-1930-tue-1800-1900` |
+| **Biweekly** | `BIWEEKLY:DAY-START-END` | `biweekly:fri-0900-1030` |
+| **Monthly** | `MONTHLY:DD HH:MM` | `monthly:15 10:00` |
+
+**Additional Notes:**
+- FitBook is optimised for same-day training sessions and therefore rejects unrealistic overnight ranges where the end time is earlier than the start time (e.g., `23:00-01:00`). Schedule these as two separate slots so each range stays within a single calendar day
+- `DAY` accepts: mon, tue, wed, thu, fri, sat, sun
+- Time uses 24-hour format (`HHmm` or `HH:MM`)
+- Multi-slot sessions list multiple day–time ranges sequentially
+- All times are interpreted in local time
+- Biweekly sessions assume the same weekday and time range is occupied for every occurrence. FitBook will block another client from taking that slot even on the assumption they would attend on alternate weeks, so coordinate such arrangements outside the app for now
-Examples:
-* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
-* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal`
+---
-### Listing all persons : `list`
+### `goal` - Set or clear a fitness goal
+**Format:**
+```
+goal INDEX goal/GOAL
+```
+**Example:**
+```
+goal 1 goal/Complete a triathlon
+```
+**Guidance:**
+- Use `goal/` with no text to clear the goal.
+- There is a limit of 100 characters for the goal field.
-Shows a list of all persons in the address book.
+---
-Format: `list`
+### `deadline` - Update a payment deadline
+**Format:**
+```
+deadline INDEX dl/DATE
+```
+**Example:**
+```
+deadline 4 dl/2025-12-31
+```
+**Guidance:**
+- Use `dl/` with no text to clear the deadline.
+- You can key in a date that is in the **past** or **more than one year from now**, but a warning message will pop up
-### Editing a person : `edit`
+---
-Edits an existing person in the address book.
+### `paid` - Record payment status
+**Format:**
+```
+paid INDEX paid/STATUS
+```
+**Example:**
+```
+paid 3 paid/true
+```
+**Guidance:**
+- Use `true` if the client has paid, or `false` otherwise.
+- Clients with paid status of `false` will be displayed in the dashboard under Unpaid Clients.
-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
+---
-* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …
-* At least one of the optional fields must be provided.
-* Existing values will be updated to the input values.
-* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
-* You can remove all the person’s tags by typing `t/` without
- specifying any tags after it.
+### `height`, `weight`, `age`, `bodyfat`, `gender` - Update individual attributes
+Each of these commands updates one attribute using the same format:
+
+**Format:**
+```
+ATTRIBUTE INDEX PREFIX/VALUE
+```
+**Examples:**
+```
+- height 2 h/168
+- weight 2 w/68.5
+- age 1 age/26
+- bodyfat 1 bf/17.2
+- gender 5 g/non-binary
+- gender 1 g/Male (case-insensitive: accepts Male, male, MALE, etc.)
+- gender 2 g/FEMALE (case-insensitive: accepts FEMALE, Female, female, etc.)
+```
+
+**Guidance:**
+- Height: Integer value between 50 and 300 (inclusive)
+- Weight: Numeric value greater than 20 and less than 500 (decimals allowed)
+- Age: Integer between 1 and 120 (inclusive)
+- Bodyfat: Numeric value between 5.0 and 60.0 (inclusive, up to one decimal place)
+- Gender: Accepts any one of the following (case-insensitive):
+ - `male`, `female`, `other`, `non-binary`, `prefer not to say` (or `Male`, `FEMALE`, `Non-Binary`, etc.)
+ - Short forms: `m`, `f`, `o`, `nb`, `pns` (also case-insensitive, e.g., `M`, `F`, `NB`)
-Examples:
-* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively.
-* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
+---
-### Locating persons by name: `find`
+### `dashboard` - Switch to dashboard view
+**Format:**
+```
+dashboard
+```
-Finds persons whose names contain any of the given keywords.
+---
-Format: `find KEYWORD [MORE_KEYWORDS]`
+### `help` - Open help window
+**Format:**
+```
+help
+```
+**Guidance:**
-* The search is case-insensitive. e.g `hans` will match `Hans`
-* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
-* Only the name is searched.
-* Only full words will be matched e.g. `Han` will not match `Hans`
-* Persons matching at least one keyword will be returned (i.e. `OR` search).
- e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
+Displays a new window with a link to the user guide.
-Examples:
-* `find John` returns `john` and `John Doe`
-* `find alex david` returns `Alex Yeoh`, `David Li`-  + -### Deleting a person : `delete` -Deletes the specified person from the address book. +--- -Format: `delete INDEX` +### `exit` - Close the program +**Format:** +``` +exit +``` -* Deletes the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, … +[↑ Back to top](#fitbook-user-guide) -Examples: -* `list` followed by `delete 2` deletes the 2nd person in the address book. -* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. +--- -### Clearing all entries : `clear` +## Data Handling -Clears all entries from the address book. +### Saving data +FitBook automatically saves all data to the hard disk after any command that changes data. No manual save is required. -Format: `clear` +### Data file location +Data is stored at: +``` +[JAR file location]/data/FitBook.json +``` -### Exiting the program : `exit` +### Editing data manually +Advanced users may edit the JSON file directly. +⚠️ Invalid edits (e.g. malformed JSON) will cause FitBook to start with an empty dataset. Always back up before editing. -Exits the program. +[↑ Back to top](#fitbook-user-guide) -Format: `exit` +--- -### Saving the data +# FAQ -AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. +**Q: Where is my data stored?** +**A:** In `data/FitBook.json`. You can change the path via `preferences.json` or by launching with `--data
:exclamation: **Caution:**
-If your changes to the data file makes its format invalid, AddressBook 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.
-Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. -
+```bash
+java -jar tp.jar --data data/FitBook.json
+```
-### Archiving data files `[coming in v2.0]`
+**Q: Why does `deadline` accept past dates?**
+**A:** For backfilling/record-keeping. A warning appears if the date is in the past or unusually far in the future.
-_Details coming soon ..._
+**Q: What happens if I set the same deadline again?**
+**A:** The command is idempotent—FitBook shows “Payment deadline unchanged” and doesn’t write data.
---------------------------------------------------------------------------------------------------------------------
+**Q: How do I clear an optional field?**
+**A:** Provide the prefix with no value, e.g., `goal/` clears the goal.
-## FAQ
+**Q: Can I sort or filter unpaid clients?**
+**A:** Yes—use `sortbypaid`, `sortbydeadline`, and check the Dashboard panels (“Unpaid Clients”, “Upcoming Sessions”).
-**Q**: How do I transfer my data to another Computer?-Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. -
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +**Q: Why did my command fail with “Unknown prefix: x/”?** +**A:** A mistyped prefix (e.g., `w/70 x/hello`) was detected before parsing. Fix the typo or remove the extra prefix. --------------------------------------------------------------------------------------------------------------------- +**Q: How do I resolve session conflicts?** +**A:** FitBook prevents overlapping sessions. Edit or delete the conflicting client’s session, or reschedule the new one. -## Known issues +**Q: Can I import from JSON/CSV?** +**A:** Not directly. Convert to FitBook’s schema or add via commands. *(Roadmap: CSV import helper.)* -1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. -2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window. +**Q: How do I change the theme or window size?** +**A:** Adjust via Settings (GUI) or edit `preferences.json → guiSettings` (width/height/coordinates). --------------------------------------------------------------------------------------------------------------------- +**Q: Is there undo/redo?** +**A:** Not yet. Back up `FitBook.json` before bulk edits. -## Command summary +[↑ Back to top](#fitbook-user-guide) -Action | Format, Examples ---------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**List** | `list` -**Help** | `help` +--- + +# Known Issues + +1. **Old file recreated (`addressbook.json` reappears).** + *Cause:* `preferences.json` still points to the old name. + *Fix:* Update `addressBookFilePath` to `data/FitBook.json` or delete `preferences.json` and relaunch. + +2. **Unknown prefix typos.** + *Symptom:* `w/70 x/abc` used to look like a weight error. + *Fix:* Now reported as `Unknown prefix: x/`. Correct the prefix. + +3. **Locale-specific date parsing.** + *Symptom:* Dates misread on non-`en-SG` locales. + *Fix:* Use `yyyy-MM-dd` or set system locale to English (Singapore). + +4. **Help window minimized won’t reopen with `help`.** + *Fix:* Restore it from the taskbar (JavaFX quirk). + +5. **Window opens off-screen after monitor changes.** + *Fix:* Delete `preferences.json` (resets window coordinates) and relaunch. + +6. **Pasting from rich text adds hidden characters.** + *Symptom:* Parser errors despite correct-looking text. + *Fix:* Paste via a plain-text editor; ensure ASCII spaces. + +7. **Session parsing rejects malformed schedules.** + *Symptom:* `s/MONTHLY:05 05` or missing separators. + *Fix:* Use `FREQ:DAY-HHMM-HHMM-...` (e.g., `WEEKLY:MON-1800-1930-TUE-1800-1900`). + +8. **Slow on network drives.** + *Cause:* Frequent JSON writes on network FS. + *Fix:* Run locally, then copy `FitBook.json` back. + +9. **Emoji/non-ASCII tags render oddly.** + *Fix:* Prefer alphanumeric tags or ensure system fonts support them. + +10. **Large data file slows startup (>10–20 MB).** + *Fix:* Archive old clients (export/remove), or split files and switch via `--data`. + +11. **Past-dated deadlines warn on “no-change” edits.** + *Expected:* Informational warning even if unchanged. + +12. **Case-sensitive tag duplicates (`friends` vs `Friends`).** + *Fix:* Standardize casing; merge via `find tag/` + `edit`. + +13. **Accidentally cleared a field (e.g., `goal/`).** + *Fix:* Re-set the value; there’s no undo stack. + +14. **Packaged JAR missing help assets.** + *Symptom:* Help/Docs don’t open after shading. + *Fix:* Ensure resources are on classpath and included by `shadowJar`. + +15. **Git credential warning on Windows (`credential-manager-core`).** + *Fix:* + + ```bash + git config --global credential.helper manager + # or: manager-core + ``` + +[↑ Back to top](#fitbook-user-guide) + +--- +*End of User Guide.* diff --git a/docs/UserGuide_backup.md b/docs/UserGuide_backup.md new file mode 100644 index 00000000000..93d4176d1ec --- /dev/null +++ b/docs/UserGuide_backup.md @@ -0,0 +1,342 @@ +--- +layout: default.md +title: "User Guide" +pageNav: 3 +--- + +# FitBook User Guide + +Hi Trainers!
+**FitBook** is a **desktop app for managing trainees, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). Whether you're tech-savvy or new to command-line interfaces, FitBook's simple command format makes it easy to learn and use effectively. + +**FitBook helps you:** +* **Manage client information** - Store and update trainee contact details, body statistics, and personal information +* **Track payments** - Monitor payment status and deadlines, helping you identify clients who need payment follow-up +* **Schedule sessions** - Organize one-off, weekly, biweekly, or monthly training sessions with automatic conflict detection +* **Track progress** - Record and update height, weight, body fat percentage, age, and gender data over time +* **Set goals** - Assign and track fitness goals with deadlines for each trainee +* **Organize efficiently** - Use tags to categorize clients and sort lists by payment status or deadlines + +With a few simple commands, you can utilise **FitBook's** in-built functions to manage all your trainees right at your fingertips! + + + + +
+ **Mac users:** Ensure you have the precise JDK version prescribed [here](https://se-education.org/guides/tutorials/javaInstallationMac.html). + +1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases). + +1. Copy the file to the folder you want to use as the _home folder_ for your FitBook. + +1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar FitBook.jar` command to run the application.
+ A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
+  + +1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
+ Some example commands you can try: + + * `list` : Lists all clients. + + * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to FitBook. + + * `delete 3` : Deletes the 3rd contact shown in the current list. + + * `clear` : Deletes all contacts. + + * `help` : Opens new window containing useful information. + + * `exit` : Exits the app. + +1. Refer to the [Features](#features) below for details of each command. + +-------------------------------------------------------------------------------------------------------------------- + +## Command summary + +Action | Format, Examples +-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------- +**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS dl/DEADLINE paid/PAID s/SCHEDULE [goal/GOAL] [h/HEIGHT] [w/WEIGHT] [age/AGE] [g/GENDER] [bf/BODYFAT] [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com` +**Clear** | `clear` +**Delete** | `delete INDEX`
e.g., `delete 3` +**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` +**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` +**List** | `list` +**View Client List** | `client` +**View Dashboard** | `dashboard` +**Sort by Paid** | `sortbypaid`
e.g., `sortbypaid` +**Sort by Deadline** | `sortbydeadline [asc/desc]`
e.g., `sortbydeadline desc` +**Help** | `help` + +-------------------------------------------------------------------------------------------------------------------- + +## Features + +
+ +* Words in `UPPER_CASE` are the parameters to be supplied by the user.
+ e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. + +* Items in square brackets are optional.
+ e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. + +* Items with `…` after them can be used multiple times including zero times.
+ e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. + +* Parameters can be in any order.
+ e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. + +* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
+ 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. +
+ +### Adding a person: `add` + +Adds a person to the address book. + +Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS dl/DEADLINE paid/PAID s/SCHEDULE [goal/GOAL] [h/HEIGHT] [w/WEIGHT] [age/AGE] [g/GENDER] [bf/BODYFAT] [t/TAG]…` + +* Adds a new trainee to FitBook with the specified information. +* All mandatory fields (`n/NAME`, `p/PHONE_NUMBER`, `e/EMAIL`, `a/ADDRESS`, `dl/DEADLINE`, `paid/PAID`, `s/SCHEDULE`) must be provided. +* Optional fields can be included in the same command or added later using other commands. +* The `SCHEDULE` parameter accepts various formats (one-off, weekly, biweekly, or monthly) as described in the Session Formatting Guide below. + +
+ +### Listing all persons : `list` + +Shows a list of all persons in the address book. + +Format: `list` + +Examples: +* `list` - Displays all trainees currently stored in FitBook + +
+ +### Editing a person : `edit` + +Edits an existing person in the address book. + +Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` + +* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, … +* At least one of the optional fields must be provided. +* Existing values will be updated to the input values. +* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. +* You can remove all the person’s tags by typing `t/` without + specifying any tags after it. + +Examples: +* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively. +* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. + +
+ +### Locating persons by name : `find` + +Finds persons whose names contain any of the given keywords. + +Format: `find KEYWORD [MORE_KEYWORDS]` + +* The search is case-insensitive. e.g `hans` will match `Hans` +* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` +* Only the name is searched. +* Only full words will be matched e.g. `Han` will not match `Hans` +* Persons matching at least one keyword will be returned (i.e. `OR` search). + e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` + +Examples: +* `find John` returns `john` and `John Doe` +* `find alex david` returns `Alex Yeoh`, `David Li`
+  + +
+ +### Deleting a person : `delete` + +Deletes the specified person from the address book. + +Format: `delete INDEX` + +* Deletes the person at the specified `INDEX`. +* The index refers to the index number shown in the displayed person list. +* The index **must be a positive integer** 1, 2, 3, … + +Examples: +* `list` followed by `delete 2` deletes the 2nd person in the address book. +* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. + + + +
+ +### Switching to the client list : `client` + +Switches the main component to the client list with all the clients' information. Will not do anything if already on the client list. + +Format: `client` + +Examples: +* `client` - Switches the view to show the client list panel + +
+ +### Switching to the dashboard : `dashboard` + +Switches the dashboard containing mainly upcoming payments and sessions information. Will not do anything if already on the dashboard. + +Format: `dashboard` + +Examples: +* `dashboard` - Switches the view to show the dashboard with upcoming payments and sessions + +
+ +### Clearing all entries : `clear` + +Clears all entries from the address book. + +### Exiting the program : `exit` + +Exits the program. + +
+ +### Sorting persons by paid status : `sortbypaid` + +Sorts the person list by payment status (unpaid clients first, paid clients second). + +Format: `sortbypaid` + +* Sorts the current person list by paid status +* Unpaid clients (paid: false) will appear first +* Paid clients (paid: true) will appear second +* The sorting is applied to the currently displayed list + +Examples: +* `sortbypaid` - Sorts the current list by payment status + + + +
+ +### Sorting persons by payment deadline : `sortbydeadline` + +Sorts the person list by payment deadline, in ascending or descending order. + +Format: `sortbydeadline [asc/desc]` + +* Sorts the current person list by payment deadline +* Ascending order: Earliest, latest, no deadline +* Descending order: No deadline, latest, earliest + +Examples: +* `sortbydeadline` - Sorts the current list in ascending order +* `sortbydeadline asc` - Sorts the current list in ascending order +* `sortbydeadline desc` - Sorts the current list in descending order + + + +
+ +### Saving the data + +FitBook data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually. + +### Editing the data file + +FitBook data is saved automatically as a JSON file `[JAR file location]/data/FitBook.json`. Advanced users are welcome to update data directly by editing that data file. + +
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous FitBook home folder. + +-------------------------------------------------------------------------------------------------------------------- + +## Known issues + +1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. +2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window. + +-------------------------------------------------------------------------------------------------------------------- + +## Session Formatting Guide: + +Use the `session` command to update a trainee's scheduled session using the same formats listed below. For example, +`session 2 s/WEEKLY:TUE-1900-2000` updates the second trainee's schedule. FitBook will reject the command if the new +session clashes with another trainee. + +* One-off sessions use the form `YYYY-MM-DD HH:MM` and must be scheduled in the future. +* Monthly sessions use `MONTHLY:DD HH:MM` (e.g. `MONTHLY:05 1830`). +* Weekly and biweekly sessions accept one or more day–time ranges using `DAY-START-END` segments chained by hyphens, such as `WEEKLY:MON-1700-1930-TUE-1800-1900`. +* Start and end times support `HHmm` or `HH:mm`. Each range must have the end time after the start time and ranges on the same day cannot overlap. +* Use the following formats when specifying session timings with the `s/` (schedule) prefix. +* Note: FitBook will automatically handle conflicts between overlapping sessions with an error message. + +| **Type** | **Format** | **Example** | +|-----------|-------------|-------------| +| **One-off** | `YYYY-MM-DD HH:MM` | `2025-06-10 14:30` | +| **Weekly (single slot)** | `WEEKLY:DAY-START-END` | `weekly:mon-1800-1930` | +| **Weekly (multi-slot)** | `WEEKLY:DAY-START-END-DAY-START-END` | `weekly:mon-1800-1930-tue-1800-1900` | +| **Biweekly** | `BIWEEKLY:DAY-START-END` | `biweekly:fri-0900-1030` | +| **Monthly** | `MONTHLY:DD HH:MM` | `monthly:15 10:00` | + +- DAY accepts: mon, tue, wed, thu, fri, sat, sun. +- Time values use the 24-hour format without separators (e.g. 1800 = 6:00 PM). +- Multi-slot entries can list multiple day–time ranges in sequence. +- Monthly sessions occur on the specified day of the month. +- All times are interpreted in local time. diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 6bd245d8f4e..00000000000 --- a/docs/_config.yml +++ /dev/null @@ -1,15 +0,0 @@ -title: "AB-3" -theme: minima - -header_pages: - - UserGuide.md - - DeveloperGuide.md - - AboutUs.md - -markdown: kramdown - -repository: "se-edu/addressbook-level3" -github_icon: "images/github-icon.png" - -plugins: - - jemoji diff --git a/docs/_data/projects.yml b/docs/_data/projects.yml deleted file mode 100644 index 8f3e50cb601..00000000000 --- a/docs/_data/projects.yml +++ /dev/null @@ -1,23 +0,0 @@ -- name: "AB-1" - url: https://se-edu.github.io/addressbook-level1 - -- name: "AB-2" - url: https://se-edu.github.io/addressbook-level2 - -- name: "AB-3" - url: https://se-edu.github.io/addressbook-level3 - -- name: "AB-4" - url: https://se-edu.github.io/addressbook-level4 - -- name: "Duke" - url: https://se-edu.github.io/duke - -- name: "Collate" - url: https://se-edu.github.io/collate - -- name: "Book" - url: https://se-edu.github.io/se-book - -- name: "Resources" - url: https://se-edu.github.io/resources diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html deleted file mode 100644 index 8559a67ffad..00000000000 --- a/docs/_includes/custom-head.html +++ /dev/null @@ -1,6 +0,0 @@ -{% comment %} - Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: - - 1. Head over to https://realfavicongenerator.net/ to add your own favicons. - 2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. -{% endcomment %} diff --git a/docs/_includes/head.html b/docs/_includes/head.html deleted file mode 100644 index 83ac5326933..00000000000 --- a/docs/_includes/head.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - {%- include custom-head.html -%} - -
- {%- assign default_paths = site.pages | map: "path" -%}
- {%- assign page_paths = site.header_pages | default: default_paths -%}
- {%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
- {{ site.title | escape }}
-
- {%- if titles_size > 0 -%}
-
- {%- endif -%}
-
-{{ page.title | escape }}
-
- {{ content }}
-
-
-
+
+
+
+
diff --git a/docs/_markbind/variables.json b/docs/_markbind/variables.json
new file mode 100644
index 00000000000..9d89eb0358b
--- /dev/null
+++ b/docs/_markbind/variables.json
@@ -0,0 +1,3 @@
+{
+ "jsonVariableExample": "Your variables can be defined here as well"
+}
diff --git a/docs/_markbind/variables.md b/docs/_markbind/variables.md
new file mode 100644
index 00000000000..89ae5318fa4
--- /dev/null
+++ b/docs/_markbind/variables.md
@@ -0,0 +1,4 @@
+
+ {{ content }}
+
+
+
- * Returns null if there are no matches
- *
- */
- private Level getLoggingLevel(String loggingLevelString) {
- return Level.parse(loggingLevelString);
+ /** Custom serializer for java.nio.file.Path that stores only the filename. */
+ private static class PathSerializer extends com.fasterxml.jackson.databind.ser.std.StdScalarSerializer Earliest deadlines first by default; accepts "desc" to invert.
+ * Scans an argument string for tokens that look like prefixes (letters followed by '/')
+ * appearing at word boundaries, and throws a {@link ParseException} if any such token
+ * is not among the allowed/known prefixes for a command.
+ */
+public final class PrefixGuards {
+ private static final Pattern ANY_PREFIX_PATTERN =
+ Pattern.compile("(?<=\\s|^)([A-Za-z]+/)");
+ private PrefixGuards() {}
+
+
+
+ /**
+ * Ensures the given argument string contains no unknown/typo prefixes.
+ *
+ * @param args the raw arguments string, e.g. {@code "n/John p/123 x/bad"}
+ * @param knownPrefixes a set of allowed prefix lexemes (e.g., {@code "n/", "p/", "e/"}).
+ * @throws ParseException if a token that looks like a prefix is not in {@code knownPrefixes}
+ */
+ public static void ensureNoUnknownPrefixes(String args, Set
+ * Usage: {@code sortbysession}
+ *
+ *
+ * When executed, the command sorts clients by their next upcoming session time
+ * (earliest first), using the current date-time as the reference. Descending order is not supported.
+ */
+public class SortBySessionCommandParser implements Parser