User Guide

About QuickContacts

QuickContacts is a contacts and schedule management system that enables you to track your contacts and manage your schedule with ease! As a busy individual with a considerable number of contacts and meetings to attend, you can seamlessly save contact and meeting information with QuickContacts. QuickContacts provides you with a bird’s eye view of all your meetings, making sure that you will never miss any of them again.

We, the developers at QuickContacts, understand the amount of time required to manage many contacts and maintaining a schedule with many meetings with them. Perfect for individuals that are looking for efficiency, QuickContacts can be used without having you to ever reach for your mouse. Complete with an autocomplete assistance, you can be assured that your time spent managing your contacts and schedule is minimised!

QuickContacts is specially designed for:

• Seamless creation and management of contacts and meetings
• Users who have a large number of contacts and meetings
• Typists

This user guide provides a detailed documentation on QuickContacts and serves as an introduction on how to incorporate QuickContacts into your daily workflow. From having QuickContacts installed to making the best use out of QuickContacts, this user guide has everything you need. Head over to the Getting started section to get onboard!

Table of Contents

• About QuickContacts
• Table of Contents
• Using this User Guide
  • Icon Coloured Boxes
• Installation
• Quick Reference Guide
  • User Interface Layout
  • Command Format
    • Prefix
    • Understanding Commands
  • Date and Time Formats
    • Date Formats
    • Time Formats
• Features
  • Autocomplete inputs
  • Traversing commands
• Person-Related Commands
  • Adding a person: add
  • Listing all persons : list
  • Editing a person : edit
  • Finding persons by name : find
  • Deleting a person : delete
  • Exporting of contact : export
  • Importing of contacts : import
• Meeting-Related Commands
  • Adding a Meeting : addm
  • Editing a Meeting : editm
  • Sorting Meetings : sortm
  • Finding Meetings by Attendee Name : findm
  • View all Meetings : findm without arguments
  • Export Meetings : exportm
  • Import Meetings : importm
  • Delete Meetings : delm
  • Marking Meetings as done or undone : mark or unmark
  • Showing pending meetings : pending
• General Features
  • Theme toggling
  • Viewing help : help
  • Clearing all entries : clear
  • Saving the data
  • Editing the data file
  • Exiting the program : exit
• FAQ
• Command summary
  • Person Commands
  • Meeting Commands
  • General Commands

Using this User Guide

Welcome to QuickContacts!

If you have yet to install QuickContacts, head over to the Installation section to install QuickContacts.

Icon Coloured Boxes

Throughout this user guide, you may observe coloured boxes that provide useful information with an icon on its top-left indicating the type of information present.

Installation

1. Ensure you have Java 11 or above installed in your computer

2. Download the latest version of quickcontacts.jar from here

3. Copy the file to an empty folder you want to use as the home folder for QuickContacts

4. Double-click on the downloaded .jar file to launch QuickContacts

And that’s it! You are good to go with QuickContacts.

Quick Reference Guide

This section will walk you through the essential parts of understanding and using QuickContacts in detail.

User Interface Layout

Upon launching QuickContacts, you will be greeted by the following Graphical User Interface (GUI).

We can break the GUI into several parts:

1. Menu Bar: This is where you find auxiliary features
2. Result Display Box: This is where you get feedback from the command executed
3. Meetings List: This is where you view all your meetings
4. Contacts List: This is where you view all your contacts
5. Command Box: This is where you input commands to interact with QuickContacts

Command Format

QuickContacts provides a powerful Command Line Interface (CLI) which rely heavily on commands. In this subsection, we will discover how the commands are designed.

Prefix

Prefixes are placeholders in a command that uniquely identify different input parameters. Each prefix is typically followed by the corresponding input data.

Understanding Commands

Now that we are familiar with the prefixes and corresponding input data, let us put them together and see how a command works. Take the following as an example:

Command: add n/CONTACT_NAME [p/CONTACT_PHONE_NUMBER] [e/CONTACT_EMAIL] [a/CONTACT_ADDRESS] [t/CONTACT_TAG]...

A valid executable command of this example form is:

add n/Noah t/friend t/nus t/cs2103t

The above command would create a new contact with the name Noah and tags friend, nus and cs2103t. The phone number, email address and address of Noah will be left empty as they are not provided.

Date and Time Formats

QuickContacts allow for various date and time formats to be inputted for commands that takes them in as arguments, for example addm. Below, we can find the valid date and time formats.

Date Formats

Time Formats

Features

Here, you may find all the details about every feature that QuickContacts provide to empower you to make full use of the power of QuickContacts.

Autocomplete inputs

Simply hit the TAB key on your keyboard when you are entering a certain command to have QuickContacts autocomplete the next nearest command word similar to the one you are typing!

Examples:

• a -> add after hitting TAB (since add is the next most similar command word)
• ex -> export after hitting TAB

Autocompletion also works for the next possible prefix for a given command! This way, you will never have to memorise any prefix nor syntax for commands.

Examples:

• add -> add n/ after hitting TAB (since n/ is the next prefix for add)
• add n/Bobby -> add n/Bobby p/ after hitting TAB (since p/ is the next prefix for add after n/)

Traversing commands

Have you ever wanted to input commands similar to one that you have just inputted? With command traversal provided in QuickContacts, you will never have to copy and paste commands ever again.

All you have to do is to hit the UP and DOWN arrow keys on your keyboard to go to the previous and next command respectively. It is as simple as that!

Person-Related Commands

In this subsection, you may find all the commands that are related to contacts.

Adding a person: add

Adds a person to the address book.

• The name of a person is case-sensitive, thus John Doe and john doe are considered different persons.

Format: add n/CONTACT_NAME [p/CONTACT_PHONE_NUMBER] [e/CONTACT_EMAIL] [a/CONTACT_ADDRESS] [t/CONTACT_TAG]...

Tip: A person can have any number of tags (including 0)

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

Shows a list of all persons in the address book.

Format: list

Editing a person : edit

Edits an existing person in the address book.

Format: edit INDEX [n/CONTACT_NAME] [p/CONTACT_PHONE_NUMBER] [e/CONTACT_EMAIL] [a/CONTACT_ADDRESS] [t/CONTACT_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.

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

Caution:
Deleting a person does not affect any meetings that have already been created with the person as one of the attendees.

Exporting of contact : export

• Exports the persons at the specified INDEXes.
• The index refers to the index number shown in the displayed person list.
• The index must be a positive integer: 1, 2, 3…

Format: export p/INDEX [p/MORE_INDEXES]...

Importing of contacts : import

• Imports the persons in the provided JSON.
• The JSON must contain a valid array of persons

Example:

[
  {
    "name": "Alice Pauline",
    "phone": "94351253",
    "email": "alice@example.com",
    "address": "123, Jurong West Ave 6, #08-111",
    "tagged": [
      "friends"
    ]
  },
  {
    "name": "Benson Meier",
    "phone": "98765432",
    "email": "johnd@example.com",
    "address": "311, Clementi Ave 2, #02-25",
    "tagged": [
      "owesMoney",
      "friends"
    ]
  }
]

Format: import JSON [f/]

Meeting-Related Commands

In this subsection, you may find all the commands that are related to meetings.

Adding a Meeting : addm

Adds a meeting to the address book.

Format: addm m/MEETING_TITLE dt/MEETING_DATE_TIME [p/MEETING_ATTENDEE]... [l/MEETING_LOCATION] [des/MEETING_DESCRIPTION]

Constraints:

• MEETING_DATE_TIME must be provided in the format as shown here.
• MEETING_ATTENDEE must be a valid contact in the address book.

Examples:

• addm m/CS2103T Tutorial p/John Doe p/Jane Doe dt/04-01-2023 10:00 l/COM1-B103 des/CS2103T Tutorial
• addm m/CS2103T Tutorial p/John Doe p/Mary Jane dt/04-01-2023 22:22 l/COM1-B103 des/CS2101 Tutorial

Editing a Meeting : editm

Edits an existing meeting in the meeting book.

Format: editm INDEX [m/MEETING_TITLE] [p/MEETING_ATTENDEE]... [dt/MEETING_DATE_TIME] [l/MEETING_LOCATION] [des/MEETING_DESCRIPTION]

• Edits the meeting at the specified INDEX. The index refers to the index number shown in the displayed meeting 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.
• MEETING_DATE_TIME must be provided in the format as defined here.

Example:

• editm 1 m/Project Update dt/04-01-2023 10:00 Edits the date/time first meeting to be on 04-01-2023 10:00, and changes its title to Project Update.

Sorting Meetings : sortm

Sorts meetings in the currently displayed address book by a specified attribute, in ascending order.

Format: sortm ATTRIBUTE [r]

• Sorts the meetings in the address book by the specified ATTRIBUTE:

• If the r option is included, the meetings will be sorted in reverse(descending) order.
• Meetings with the same value for the specified attribute will be sorted by date/time in ascending order.
• Examples:
  • sortm m/ sorts meetings by title in ascending order.
  • sortm dt/r sorts meetings by date/time in descending order.

Finding Meetings by Attendee Name : findm

Find meetings whose names contain any of the given keywords.

Format: findm KEYWORD [MORE_KEYWORDS]

• The search is case-insensitive. e.g. hans will match Hans
• Space is delimiter, so if you search John Doe it will list all people with either John or Doe in their name.
• Only the name of attendees in meeting are searched
• Only full words will be matched e.g. Han will not match Hans
• Meetings matching at least one keyword will be returned (i.e. OR search). e.g. John Doe will return Meetings that contain either John Doe, or Doe John

Examples:

• findm John returns Meeting that contains attendees whose Name contains John
• findm John Mary returns Meeting that contains attendees whose Name contains John or Mary

View all Meetings : findm without arguments

Shows a list of all meetings in the meeting book.

Format: findm

• No parameters are required.
• If arguments are given, will instead behave like as stated here

Export Meetings : exportm

Exports the meetings at the specified INDEX’s and between start and end dates.

• If only MEETING_EXPORT_START_DATE provided, meetings after MEETING_EXPORT_START_DATE, inclusive, will be exported
• If only MEETING_EXPORT_END_DATE is provided, meetings after MEETING_EXPORT_END_DATE, inclusive, will be exported
• If both are provided, meetings between the two dates, inclusive, will be exported
• Regardless of the above, meetings at provided INDEXes will be provided
• At least one of the parameters must be provided
• The indexes refer to the index numbers shown in the displayed meetings list
• The indexes must be positive integers 1, 2, 3…
• The start and end dates must be valid dates in the format as defined here.

Format: exportm m/INDEX [p/MORE_INDEXES]... [start/MEETING_EXPORT_START_DATE] [end/MEETING_EXPORT_END_DATE]

Example: exportm start/01/01/23 m/1 will export the first meeting and any meetings starting from 01/01/23

Import Meetings : importm

• Imports the meetings in the provided JSON.
• The JSON must contain a valid array of meetings

Example:

[
  {
    "title": "Dinner with Alice",
    "dateTime": "01/02/2023 19:00",
    "attendees": [
      {
        "name": "Alice Pauline",
        "phone": "94351253",
        "email": "alice@example.com",
        "address": "123, Jurong West Ave 6, #08-111",
        "tagged": [
          "friends"
        ]
      }
    ],
    "location": "NUS",
    "description": "Weekly catchup"
  },
  {
    "title": "Zoom meeting for agenda planning",
    "dateTime": "13/03/2023 12:45",
    "attendees": [
      {
        "name": "Alice Pauline",
        "phone": "94351253",
        "email": "alice@example.com",
        "address": "123, Jurong West Ave 6, #08-111",
        "tagged": [
          "friends"
        ]
      }
    ],
    "location": "https://us02web.zoom.us/j/999?pwd=ABCdEfGmNopQrSt12",
    "description": "Plan for project work"
  }
]

Optional Parameter f/ that forces imports regardless of duplicate values. f/ does not take any values.

Format: importm JSON f/

Delete Meetings : delm

Deletes the specified meeting.

Format: delm INDEX

• Deletes the meeting at the specified INDEX.
• The index refers to the index number shown in the displayed meetings list.
• The index must be a positive integer: 1, 2, 3…

Examples:

• findm followed by delm 2 deletes the 2nd meeting.

Marking Meetings as done or undone : mark or unmark

Marks the specified meetings as either done or undone.

Format: mark m/INDEX [m/INDEXES]... or unmark m/INDEX [m/INDEXES]...

• The index refers to the index number shown in the displayed meetings list.
• The index must be a positive integer: 1, 2, 3…

Showing pending meetings : pending

Shows meetings that are not marked as done and those that are in the future i.e not over yet.

Format: pending

General Features

Theme toggling

Toggles the theme from dark to light or vice versa.

Viewing help : help

Shows a message explaining how to access the help page.

If used with a command word, shows a message explaining how to use the command in the output box.

Examples:

• help add shows a message explaining how to use the add command.
• help delm shows a message explaining how to use the delm command.

Format: help [COMMAND_WORD]

Clearing all entries : clear

Clears all entries from the address book.

Format: clear

Saving the data

QuickContacts 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

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

Caution: If your changes to the data file makes its format invalid, QuickContacts will discard all data and start with an empty data file at the next run.

Exiting the program : exit

Exits the program.

Format: exit

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 QuickContacts home folder.

Command summary

Person Commands

Meeting Commands

General Commands