WedLinker User Guide

WedLinker is your essential desktop app for managing wedding-related contacts, designed specifically for professional wedding planners. With a powerful Command Line Interface (CLI), WedLinker is optimised for fast typers, simplifying your contact management tasks through quick, text-based commands. This means you can accomplish your tasks faster than with traditional GUI apps, giving you more time to focus on what matters most—creating memorable experiences for your clients.

While WedLinker excels with its CLI for speed, it still offers the valuable visual elements of a Graphical User Interface (GUI). The GUI provides an organised and intuitive layout, making it easy to visualise your contacts, weddings, and tasks at a glance. This combination of efficiency and clarity ensures that you can manage your wedding planning responsibilities with ease and precision.

---

Quick start

1. Ensure you have Java 17 or above installed on your computer by performing the following:

   1. Open your system terminal

      1. Windows:
         

         1. Hold down Windows button and R (⊞ Win + R )
         2. Type cmd and press enter

      2. MacOS -- do one of the following:
         

         • Click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal, OR
         • In the Finder, open the /Applications/Utilities folder, then double-click Terminal.
   2. Type java -version and press enter
   3. If you have `Java 17 installed, the terminal should look something like:

         C:\Users\UserName>java -version
         java version "17.0.12" 2024-07-16 LTS
         Java(TM) SE Runtime Environment (build 17.0.12+8-LTS-286)
         Java HotSpot(TM) 64-Bit Server VM (build 17.0.12+8-LTS-286, mixed mode, sharing)
   

2. If you do not have Java 17 installed, or you are unsure, refer to the guide below.

   1. Download Java 17 from the official website: https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html
   2. Select the installation package based on your Operating System. For Apple users select macOS, for Windows users select Windows.
   3. Follow the instruction guide to install Java on your device. For more information use this guide: https://docs.oracle.com/en/java/javase/23/install/overview-jdk-installation.html

3. Download the latest version of WedLinker from here. Select WedLinker.jar to begin the download.

4. Copy the file to the folder you want to use as the home folder for your WedLinker.

5. Open WedLinker by double clicking the program file, WedLinker.jar.
   A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
   

6. 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 contacts.

   • add n/John Doe p/98765432 e/johnd@example.com a/ABC Photography Studio : Adds a contact named John Doe to the Address Book.

   • delete 3 : Deletes the 3rd contact shown in the current list.

   • clear : Deletes all contacts.

   • exit : Exits the app.

7. Refer to the Features below for details of each command.

---

Features

General Features

Viewing help : help

Shows a message explaning how to access the help page.

Format: help

Listing all Persons : list

Shows a list of all saved Persons in the WedLinker.

Format: list

Listing all Weddings : list-weddings

Shows a list of all Weddings in the WedLinker.

Format: list-weddings

Listing all Tasks : list-tasks

Shows a list of all Tasks in the WedLinker

Format: list-tasks

Locating contacts by any field, similar to a search function: find

Finds all persons based on the specified keywords (case-insensitive) after the prefix representing the field, and displays them as a list with index numbers.

Format: find PREFIX KEYWORD [KEYWORD]…​

• The search is case-insensitive. e.g hans will match Hans.
• The prefix that corresponds to the field you want to search should be specified. e.g. use find n/Alex to search by name, use find e/alex@gmail.com to search by email.
• The search will return partial matches and full matches.
• Only one field can be searched at a time, but multiple keywords can be searched for the same field by using the by placing each keyword after the appropriate prefix.
• Only the first prefix entered will be used for the search. For example, if you enter find find n/Alex a/, the search will only look for matches in the name field and ignore the address field.
• The order of the keywords does not matter. e.g. n/Hans n/Bo will return the same contacts as n/Bo n/Hans.

Examples:

• find n/John returns john and John Doe
• find p/973 returns all Contacts whose phone number contains 973
• find n/alex n/david returns Alex Yeoh, David Li
  
• find t/friends returns all Contacts tagged with 'guest'
  
• find w/Casey's Wedding returns all Contacts involved with Casey's Wedding
  

Clearing all entries : clear

Clears all entries from the address book.

Format: clear

Caution: This action is irreversible and cannot be undone. Please ensure you have backed up any important information before proceeding.

Exiting the program : exit

Exits the program.

Format: exit

Saving the data

WedLinker data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

Editing the data file

WedLinker data are saved automatically as a JSON file [JAR file location]/data/WedLinker.json. Advanced users are welcome to update data directly by editing that data file.

Person Features

Adding a person: add

Adds a person to the address book.

Format: add n/NAME [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​ [w/WEDDING]…​

Examples:

• add n/John Doe p/98765432 e/johnd@example.com a/XYZ Floral Services
• add n/Betsy Crowe e/betsycrowe@example.com a/ABC Photo Studio p/1234567 t/Photographer

Editing a person : edit

Edits an existing person in the address book.

Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS]

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

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 Edits the name of the 2nd person to be Betsy Crower

Deleting a person : delete

Deletes the specified person from WedLiker.

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 n/Betsy followed by delete 1 deletes the 1st person in the results of the find command.

Tag Features

Adding a tag : create-tag

Creates a Tag within WedLinker to be used on contacts.

Format: create-tag t/TAGNAME

• The TAGNAME is alphanumeric and can contain whitespaces.
• Tags are unique in WedLinker, there would not be any duplicated Tags.
• Contacts can share Tags.

Assign tag to contact : tag

Assigns a Tag to the specified person in WedLinker

Format: tag INDEX t/TAGNAME [f/]

• Tag a specified contact based on the INDEX with a Tag.
• The index refers to the index number shown in the displayed person list.
• The index must be a positive integer 1, 2, 3, …​.
• The Tag must exists in WedLinker before it can be assigned.
• If the Tag does not exist, you can use f/ to force the creation and assignment of the Tag.

Unassign tag to contacts : untag

Untags a Tag from a specified person in WedLinker

Format: untag INDEX t/TAGNAME

• Untag a specified contact based on their INDEX with a Tag.
• The index refers to the index number shown in the displayed person list.
• The index must be a positive integer 1, 2, 3, …​.

Deleting a tag : delete-tag

Deletes a Tag from WedLinker.

Format: delete-tag t/TAGNAME [f/]

• Deletes a Tag from WedLinker.
• The Tag must exists in WedLinker.
• The Tag cannot be assigned to any contacts.
• If the Tag is in used, you can use f/ to force the deletion of the Tag and unassign this tag from all contacts.

Wedding Features

Adding a Wedding : create-wedding

Creates a Wedding within WedLinker to be with contacts.

Format: create-wedding w/WEDDINGNAME

• The WEDDINGNAME is alphanumeric and can contain whitespaces.
• Weddings are unique in WedLinker, there would not be any duplicated Weddings.
• Contacts can be assigned to the Wedding using the assign-wedding command.

Assign contact to a Wedding : assign-wedding

Assigns a contact to a Wedding.

Format: assign-wedding INDEX w/WEDDINGNAME

• Assigns a specified contact to the Wedding based on their INDEX.
• The index refers to the index number shown in the displayed person list.
• The index must be a positive integer 1, 2, 3, …​.
• The Wedding must exists in WedLinker before it can be assigned.
• If the Wedding does not exist, you can use f/ to force the creation and assignment of the Wedding.

Edit Wedding details : edit-wedding

Edits the details of a Wedding.

Format: edit-wedding INDEX [w/WEDDINGNAME] [a/ADDRESS]

• Edits the specific Wedding at the INDEX when in list-wedding view.
• The index must be a positive integer 1, 2, 3, …​.
• Existing values in the specified fields will be overwritten with the specified values.

Unassign contacts from a Wedding : unassign-wedding

Unassigns a contact from a Wedding in WedLinker.

Format: unassign-wedding INDEX w/WEDDINGNAME

• Unassign a contact that is assigned in a Wedding.
• The index refers to the index number shown in the displayed person list.
• The index must be a positive integer 1, 2, 3, …​.

Deleting a Wedding : delete-wedding

Deletes a Wedding from WedLinker.

Format: delete-wedding w/WEDDINGNAME [f/]

• Deletes a Wedding from WedLinker.
• The no contacts should be assigned to the Wedding before it is deleted.
• If there are still contacts assigned, you can use f/ to force the deletion of the Wedding and unassign all contacts.

Task Features

Creating a Task : create-task

Creates a Task in WedLinker

Format: create-task tk/TASKDESCRIPTION [REMARKS]

• Tasks may have no dates, a single date indicating a deadline, or two dates to define a start and end period.
• The dates can be specified under REMARKS with the format d/YYYY-MM-DD
• Tasks are unique in WedLinker, there would not be any duplicated tasks.
• Tasks can be assigned to a contact using the assign-task command.

Delete a Task : delete-task

Deletes a Task from WedLinker

Format: delete-task INDEX

• Deletes the specific Task at the INDEX when in list-tasks view.
• The index must be a positive integer 1, 2, 3, …​.

Assigning a Task to a contact : assign-task

Format: assign-task PERSONINDEX TASKINDEX

• Assigns a Task to a contact.
• The indexes correspond to the indexes when in the list-tasks view.
• The PERSONINDEX refers to the index of the person shown under the People column.
• The TASKINDEX refers to the index of the task shown under the Tasks column
• The indexes must be positive integers 1, 2, 3, …​.

Un-assigning a Task from a contact : unassign-task

Format: unassign-task PERSONINDEX TASKINDEX_OFPERSON

• Un-assigns a Task from a contact.
• The PERSONINDEX is the index of the person shown in the displayed person list.
• The TASKINDEX_OFPERSON is the index of the task associated with the selected person.
• The indexes must be positive integers 1, 2, 3, …​.

Mark a task as completed : mark-task

Format: mark-task TASKINDEX

• Marks a Task as completed.
• The index correspond to the index of the task when in the list-tasks view.
• The index must be a positive integers 1, 2, 3, …​.

Un-mark a task : unmark-task

Format: unmark-task TASKINDEX

• Marks a Task as not completed.
• The index correspond to the index of the task when in the list-tasks view.
• The index must be a positive integers 1, 2, 3, …​.

---

FAQ

Q: How do I transfer my data to another Computer?
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 WedLinker 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.

---

Command summary