EasyWeds User Guide

Tip: Refer to FAQ for help on setting up.

Notes about the command format:

• Press 'TAB' to auto-complete the command you are typing in the command box.
  e.g. if you type ad and press 'TAB', it will auto-complete to add and if you press it again it will auto-complete to addWedding and if you press it again it will auto-complete to addTask.

• 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 edit 1 n/NAME [r/ROLE] can be used as edit 1 n/John Doe r/Florist or as edit 1 n/John Doe.

• 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.

Tip: Click on the "Go To User Guide" button and the User Guide will be opened in your default browser.

• Input values must be provided for all fields.
• Your name will appear in the contact book exactly as you entered it.
• Only alphanumeric latin characters are allowed for the name field.
• A person with the same name or a similar name to an existing person in the contacts will be flagged out.
• If any of the fields' content include any of the delimiters n/, p/, e/, a/, r/, include a \ before the delimiter.
  • e.g. Name of a contact is "John p/Doe": add n/John p/Doe p/98765432 ... will not be accepted due to a duplicate delimiter p/. Instead, use add n/John \p/Doe p/98765432 ... to denote that "/p" is indeed part of the name.
  • This applies to all fields.

Examples:

add n/John Doe p/87654321 e/johnd@example.com a/John street, block 123, #01-01 r/Photographer

This command adds a person named John Doe with the phone number 87654321, email johnd@example.com, address John street, block 123, #01-01, and role Photographer.

add n/Betsy Crowe r/Florist e/betsycrowe@example.com a/Blk 321 Clementi West St 1 p/12345678

This command adds a person named Betsy Crowe with the role Florist, email betsycrowe@example.com, address Blk 321 Clementi West St 1, and phone number 12345678.

• 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.
• Similar to adding a person, there will be a check for duplicates for the person's name

Examples:

edit 1 p/91234567 e/johndoe@example.com

This command edits the phone number and the email address of the 1st person to be 91234567 and johndoe@example.com respectively.

edit 2 n/Betsy Crower r/photographer

This command edits the name and the role of the 2nd person to be Betsy Crower and photographer respectively.

• 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

delete 2

This command deletes the 2nd person in the contact book.

find Betsy

delete 1

This command deletes the 1st person in the results of the find command.

• 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
• Either the name or the role will be 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

This command returns john and John Doe

find florist

This command returns all Persons with the role of florist

find alex david

This command returns Alex Yeoh, David Li (Refer to the image below)

Tip: In order for the 'find' by role command to be effective, ensure that you use the same noun for the same type of role (e.g. please do not call one person 'florist' and another person 'flower maker' and instead choose to give the same role to both)

• Input values must be provided for all fields.
• If any of the fields' content includes any of the delimiters n/, d/, l/, include a \ before the delimiter.
  • E.g. Name of a wedding is "John & Jane d/ Doe's Wedding": addWedding n/John & Jane d/ Doe's Wedding d/20-May-2026 l/Marina Bay Sands will not be accepted due to a duplicate delimiter /d. Instead, use addWedding n/John & Jane \d/ Doe's Wedding d/20-May-2026 l/Marina Bay Sands to denote that d/ is indeed part of the name.
  • This applies to all fields.
• Format of the date is flexible, e.g. "dd-MMM-yyyy", "dd/MM/yyyy", "dd.MM.yyyy", "dd MMM yyyy".
• If using MMM format, only the first letter should be capitalized (e.g. Jan, Feb).
• Date must be a valid date and in the future.

Examples:

addWedding n/John & Jane's Wedding d/20-May-2026 l/Marina Bay Sands

This command adds a wedding event named John & Jane's Wedding on 20-May-2026 at Marina Bay Sands.

• Edits the wedding event at the specified WEDDING_ID.
• At least one of the optional fields must be provided.
• Existing values will be updated to the input values.
• Details of the wedding you want to edit cannot be the same as what is already in the wedding.

Examples:

editWedding W1 d/20-Jun-2026 l/Marina Bay Sands

This command edits the date and location of the 1st wedding event to be 20-Jun-2026 and Marina Bay Sands respectively.

editWedding W2 n/John & Jane's Wedding

This command edits the name of the 2nd wedding event to be John & Jane's Wedding.

• Deletes the wedding event with the specified WEDDING_ID.
• Tags of contacts associated with the deleted wedding event will be removed.

Examples:

deleteWedding W2

This command deletes the wedding event with ID W2 (Refer to the image below)

• Adds a new task to a wedding event specified by WEDDING_ID.

Examples:

addTask w/W1 desc/Book florist

This command adds a new task Book Florist to the wedding event W1.

Examples:

listTask w/W2

This command shows a list of all tasks of the wedding event W2 (Refer to the image below)

• Marks the task at the specified INDEX from the wedding event specified by WEDDING_ID as completed.
• The index refers to the index number shown in the displayed task list. The index must be a positive integer 1, 2, 3, …​
• WEDDING_ID is the unique identifier of the wedding event.

Examples:

mark w/W1 i/1

This command marks the Task at index 1 of the wedding event W1 as completed (Refer to the image below)

• Marks the task at the specified INDEX from the wedding event specified by WEDDING_ID as not completed.
• The index refers to the index number shown in the displayed task list. The index must be a positive integer 1, 2, 3, …​
• WEDDING_ID is the unique identifier of the wedding event.

Examples:

unmark w/W1 i/1

This command marks the task at index 1 of the wedding event W1 as not completed.

• Deletes the task at the specified INDEX from the wedding task list of the wedding event specified by WEDDING_ID.
• The index refers to the index number shown in the displayed task list. The index must be a positive integer 1, 2, 3, …​
• WEDDING_ID is the unique identifier of the wedding event.

Examples:

deleteTask w/W1 i/1

This command deletes a task at index 1 from the wedding task list of the wedding event W1.

• Tags the person at the specified INDEX to the wedding event specified by WEDDING_ID.
• The index refers to the index number shown in the displayed person list. The index must be a positive integer 1, 2, 3, …​
• WEDDING_ID is the unique identifier of the wedding event.
• Contacts can only be tagged to wedding events that are already existing in the system.
• Each contact can be tagged to more than one wedding event.

Examples:

tag 1 W1 

This command tags the first person to the wedding event W1

tag 1 W2

This command tags the first person to the wedding event W2. Now the first person will be tagged to both W1 and W2. (Refer to the image below)

• Untags the person at the specified INDEX from the wedding event specified by WEDDING_ID.
• The index refers to the index number shown in the displayed person list. The index must be a positive integer 1, 2, 3, …​
• WEDDING_ID is the unique identifier of the wedding event.
• Contacts can only be untagged from wedding events that are already existing in the system.

Examples:

untag 1 W1

This command untags the first person from the wedding event W1

• Filters contacts that are tagged with the specified WEDDING_ID
• Wedding ID is the unique identifier of the wedding event.
• Only the wedding event corresponding to the WEDDING_ID will be displayed in the list of weddings.

Examples:

filter W2

This command displays the details of W2 and returns the contacts that are tagged to W2. (Refer to the image below)

Tip: Remember to use list to show the full contact book again after you used find and filter.

Tip: In order to prevent you from accidentally clearing the contact book (which is unrecoverable), we have included a Confirmation Check similar to adding duplicates.

Caution:
As much as you are able to manually edit the details of contacts and wedding events, you are strongly advised against editing the weddingIDs in the data file as this will very likely cause the application to behave in unexpected ways.

If your changes to the data file make its format invalid, EasyWeds 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 EasyWeds to behave in unexpected ways (e.g. if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.

"How do I know if I have Java installed or what version I have?"

• Open a terminal (for macOS/Linux) or command prompt (for Windows).
• Type in this command: java -version
• If you have Java installed, you will see a version number that looks like this: "17.0.1" (or higher).
• If you don’t have Java installed or see a version lower than 17, download the latest JDK from here.

"What is the home folder and where do I copy the file?"

• You can choose any folder to be the home folder where you want to store your EasyWeds files.
• Choose a folder location which you can find easily afterwards (e.g. Documents).
• Copy (or move) the downloaded .jar file into this folder, which will contain your EasyWeds data as you use the application.

"How do I open a command terminal and navigate to a folder?"

On Windows:

Press Win + R, type cmd, and press Enter to open the command prompt. Use the cd command to navigate to your folder. For example, if your file is on the Desktop, type:

cd Desktop

On MacOS:

Press Command + Space, type Terminal, and press Enter. Use the cd command to navigate to your folder. For example, if your file is on the Desktop, type:

cd ~/Desktop

On Linux:

Open your terminal (typically found in Applications > Utilities or by pressing Ctrl + Alt + T). Use the cd command to navigate to your folder. For example, if your file is in your home directory, type:

cd ~

"Why do I get an error when I try to run the command java -jar easyweds.jar."

Ensure that you have typed in the exact name of the .jar file. If the file was renamed, use that name in the command instead:

java -jar "<name_of_file>.jar"

"How do I transfer my data to another Computer?"

Install the app on the other computer and overwrite the empty data file it creates with the file that contains the data of your previous EasyWeds home folder.