User Guide

About Swift+

Swift+ is a project management app designed to help software engineering (SWE) project leads in tracking their daily interactions with contacts. As a project lead, you can easily record down your clients and teammates by creating and editing contacts using Swift+. Using Swift+’s task management system, you can assign tasks to contacts and mark tasks as completed. Finally, you can gain an overview of your project with our intuitive side-by-side user interface.

Perfect for SWE professionals, Swift+ is built around a command line interface, complete with an autocomplete feature. If you have fast fingers, Swift+ can help you manage contacts and tasks more quickly than a traditional point-and-click interface.

This user guide provides details on how to use Swift+ in your daily workflow. This guide covers how to set up Swift+ and use its text-based commands. Get started now by heading over to the How to use this user guide section!

---

Table of Contents

1. About Swift+
2. How to use this user guide
   1. Icons
   2. Sections
3. Getting Started
   1. Installation
   2. Layout
      1. Contact View
      2. Task View
   3. How to use Swift+ commands
      1. Flag
      2. Parameter
      3. Command Format
4. Commands
   1. Contact Commands
      1. Adding a contact: add_contact
      2. Listing all contacts: list_contact
      3. Finding contacts by name: find_contact
      4. Editing a contact: edit_contact
      5. Deleting a contact: delete_contact
      6. Selecting a contact: select_contact
   2. Task Commands
      1. Adding a task: add_task
      2. Listing all tasks: list_task
      3. Finding tasks by name: find_task
      4. Editing tasks: edit_task
      5. Deleting tasks: delete_task
      6. Selecting a task: select_task
      7. Marking a task as complete: mark
      8. Marking a task as incomplete: unmark
      9. Assigning a task to a contact: assign
      10. Unassign a task from a contact: unassign
   3. General Commands
      1. Toggling between contacts and tasks tabs: Ctrl + Tab
      2. Viewing help: help
      3. Clearing all data: clear
      4. Exiting the program : exit
   4. Command suggestion and autocomplete
   5. Saving the data
   6. Editing the data file
5. FAQ
6. Command Summary

---

How to use this user guide

Icons

Throughout this website, you may find colored boxes that contain useful information. The icon at the top of the box represents the type of information contained.

Icon	Meaning
	Tips to help you make the most out of Swift+.
	Information you should take note of while using Swift+.
	Warnings that may corrupt your app and data if not followed.

Sections

If you have not installed Swift+, head over to the Installation section.

After installing Swift+, you can refer to our Getting Started section on the basics of using Swift+. This includes the app’s,

• Layout
• Command format

To view each command in detail, you can head over to the Commands section.

If you are an experienced user, you can refer to the Command Summary for a quick overview of the commands in Swift+.

If you have any questions while using the app, please refer to our FAQ section.

For any further queries or suggestions, you may reach out to us here!

---

Getting Started

This section covers how to install and start using Swift+.

Installation

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

2. Download the latest release of swift+.jar from here.

3. Copy the file to an empty folder. This will be your home folder for Swift+.

4. Double-click on the jar file to launch Swift+.

Congratulations! You have successfully set up Swift+.

Layout

After you open Swift+, the app will appear in the form of a graphical user interface, or GUI. In Swift+, you can toggle between the Contact View and the Task View. Let’s take a look at the different components in Swift+ below.

Swift+’s GUI:

This table showcases the components shared by both Contact View and Task View.

Component Name	Image
Menu Bar
Command Input Box
Command Results

Contact View

The contact view is primarily for viewing contacts. The main panel on the left shows a list of contacts and all of their contact information. The right sidebar contains tasks with essential details.

Component Name	Image
Contact List
Task Sidebar

Task View

The task view is mainly for viewing tasks. The main panel on the left displays a list of tasks and all of their details. The right sidebar contains contacts with essential contact information.

Component Name	Image
Task List
Contact Sidebar

How to use Swift+ commands

Swift+ is built around text-based commands. Before we dive deeper into the details in the Commands section, let’s learn the basic components and format of a command.

Flag

A flag is a delimiter that allows Swift+ to distinguish different input fields. For each flag, you would put in the corresponding parameter immediately after.

Flag	Corresponding Parameter
a/	ADDRESS
c/	CONTACT_INDEX
d/	DESCRIPTION
dl/	DEADLINE
e/	EMAIL
n/	NAME
p/	PHONE_NUMBER
t/	TAG, TASK_INDEX

Parameter

A parameter represents placeholders where you input data. Usually, parameters follow immediately after their corresponding flag.

Each parameter has unique constraints, which restricts what you can type in for the parameter. Refer to the table below for details.

Refer to the Command Format section on how to use flags and parameters together.

Parameter	Corresponding Flag	Description
ADDRESS	a/	Specifies the address of a contact. An example use for this field include recording a client’s home or office address.
CONTACT_INDEX	c/	Refers to the index number shown in the displayed contact list. Must be a positive whole number, e.g. 1, 2, 3.
CONTACT_NAME	n/	Specifies the name of a contact. Should only contain alphanumeric characters, spaces, and the following symbols: , - '.
DEADLINE	dl/	Specifies the due date of a task. Must be in the format of dd-MM-yyyy HHmm. e.g. 12-06-2020 1234 represents 12 June 2020 12:34.
DESCRIPTION	d/	Specifies the description and details of a task. Should only contain alphanumeric characters, spaces, and the following symbols: $ & + , : ; = ? @ # | ' < > . \ - ^ * ( ) % !.
EMAIL	e/	Specifies the email of a contact. Must be in the format of USERNAME@DOMAIN. USERNAME should only contain alphanumeric characters and the following special symbols: + _ . -. USERNAME cannot start or end with the above special symbols. DOMAIN consists of domain labels separated by periods (.), e.g. nus.edu.sg. DOMAIN must end with a domain label with at least 2 characters, e.g. .com. Each domain label must only consist of alphanumeric characters, separated only by hyphens, if any, e.g. swift-plus.com. Each domain label start and end with alphanumeric characters.
KEYWORD	Not applicable	Specifies the keywords to search for when finding contacts or tasks. Can contain alphanumeric characters, spaces, and any special characters.
PHONE_NUMBER	p/	Specifies the phone number of a contact. Should only contain numbers. Must be at least 3 digits long.
TAG	t/	Specifies the tag to categorize a contact under. Should only contain alphanumeric characters.
TASK_INDEX	t/	Refers to the index number shown in the displayed task list. Must be a positive whole number, e.g. 1, 2, 3.
TASK_NAME	n/	Specifies the name of a task. Should only contain alphanumeric characters, spaces, and the following symbols: , - '.

Command Format

To understand how a full command is interpreted, let’s look at the following example.

Example: add_contact n/CONTACT_NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​

	Component Name	Meaning
add_contact	Command Word	Tells Swift+ to execute command to add contact.
n/	Flag	Distinguishes CONTACT_NAME from other input fields.
CONTACT_NAME	Parameter	Represents placeholder for name of contact that you wish to input.

Notice how t/TAG is wrapped in [ ]. Items in square brackets are optional.

• For example, n/CONTACT_NAME [t/TAG] can be used as n/Mark t/friend or as n/Mark.

Furthermore, notice how [t/TAG] is followed by …​. Items followed by …​ can be inputted multiple times, including zero times.

• For example, n/CONTACT_NAME [t/TAG]…​ can be used as n/Mark (i.e. 0 times), n/Mark t/friend, n/Mark t/friend t/family, and etc.

---

Commands

This section covers how to use each command in detail. You can refer to the Parameter section to view the constraints for each parameter.

Contact Commands

Adding a contact: add_contact

Adds a contact.

Format: add_contact n/CONTACT_NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​

Examples:

• add_contact n/Mark Yang p/12345678 e/mark@example.com a/block 123 adds a contact named Mark Yang with a phone number of 12345678, email of mark@example.com, and address of block 123.
• add_contact n/Anne Marie t/developer e/anne@example.com a/Newgate office p/87654321 t/client adds a contact named Anne Marie with a developer tag, a friend tag, email of anne@example.com, address of Newgate office, and phone number of 87654321.

Listing all contacts: list_contact

Shows a list of all contacts in the main panel and a list of all tasks in the sidebar.

Format: list_contact

Example:

• list_contact displays a list of all contacts, as shown in the diagram below.

Finding contacts by name: find_contact

Finds contacts whose names contain any of the given keywords.

Format: find_contact KEYWORD [MORE_KEYWORDS]

Examples:

• find_contact Mark returns Mark and mark.
• find_contact mark wilson returns Mark Yang and Steve Wilson.

Editing a contact: edit_contact

Edits an existing contact.

Format: edit_contact CONTACT_INDEX [n/CONTACT_NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​

Examples:

• edit_contact 1 p/91234567 e/mark@example.com edits the phone number and email address of the 1st contact to be 91234567 and mark@example.com respectively.
• edit_contact 2 n/Anne t/ edits the name of the 2nd contact to be Anne and clears all of Anne’s tags.

Deleting a contact: delete_contact

Deletes the specified contact.

Format: delete_contact CONTACT_INDEX

Examples:

• list_contact followed by delete_contact 2 deletes the 2nd contact in the entire contact list.
• find_contact Anne followed by delete_contact 1 deletes the 1st contact in the results of the find_contact Anne command.

Selecting a contact: select_contact

Displays the selected contact in the main panel and displays the tasks assigned to the contact in the sidebar.

Format: select_contact CONTACT_INDEX

Examples:

• list_contact followed by select_contact 1 selects the 1st contact in the entire contact list and shows all tasks assigned to that contact.
• find_contact Bernice followed by select_contact 1 selects the 1st contact in the results of the find_contact Bernice command and shows all task assigned to that person.
  e.g. In the screenshot below, we can see the selected contact on the main panel and their assigned tasks on the sidebar.

Task Commands

Adding a task: add_task

Adds a task.

Format: add_task n/TASK_NAME [d/DESCRIPTION] [dl/DEADLINE] [c/CONTACT_INDEX]…​

Examples:

• add_task n/CS2103T iP d/Finish milestones dl/12-12-2022 2359 c/1 adds a task assigned to the 1st displayed contact. The task has a name of CS2103T, description of Finish milestones, and deadline of 12 December 2022 23:59.
• add_task n/CS2101 Assignment dl/12-12-2022 2359 c/2 c/3 adds a task assigned to the 2nd and 3rd displayed contact. The task has a name of CS2101 Assignment and deadline of 12 December 2022 23:59.

Listing all tasks: list_task

Shows a list of all tasks in the main panel and a list of all contacts in the sidebar.

Format: list_task

Example:

• list_task displays a list of all tasks, as shown in the diagram below. Note that the first 3 tasks with deadlines are ordered chronologically and placed at the top. The last 2 tasks without deadlines are placed below.

Finding tasks by name: find_task

Finds tasks whose names contain any of the given keywords.

Format: find_task KEYWORD [MORE_KEYWORDS]

Examples:

• find_task Book returns book and Book.
• find_task read book returns read novel and sell book.

Editing tasks: edit_task

Edits an existing task.

Format: edit_task TASK_INDEX [n/TASK_NAME] [d/DESCRIPTION] [dl/DEADLINE]

Examples:

• edit_task 1 n/Client meeting d/Gather user stories edits the task name and description of the 1st task to Client meeting and Gather user stories respectively.
• edit_task 2 dl/06-12-2022 1200 edits the deadline of the 2nd task to be 06-12-2022 1200.

Deleting tasks: delete_task

Deletes an existing task in task list.

Format: delete_task TASK_INDEX

Examples:

• delete_task 1 deletes the task at index 1.
• delete_task 3 deletes the task at index 3.

Selecting a task: select_task

Selects the specified task and displays the contacts assigned to the task.

Format: select_task TASK_INDEX

Examples:

• list_task followed by select_task 1 selects the 1st task in the entire task list and shows all contacts assigned to that task.
• find_task discuss followed by select_task 1 selects the 1st task in the results of the find_task discuss command and shows all contacts assigned to that task.
  e.g. In the screenshot below, we can see the selected task on the main panel and its assigned contacts on the sidebar.

Marking a task as complete: mark

Marks the specified task as completed.

Format: mark TASK_INDEX

Examples:

• list_task followed by mark 1 marks the 1st task in the entire task list as completed.
• find_task sleep followed by mark 1 marks the 1st task in the results of the find_task sleep command as completed.

Marking a task as incomplete: unmark

Marks the specified task as incomplete.

Format: unmark TASK_INDEX

Examples:

• list_task followed by unmark 1 marks the 1st task in the entire task list as incomplete.
• find_task sleep followed by unmark 1 marks the 1st task in the results of the find_task sleep command as incomplete.

Assigning a task to a contact: assign

Assigns a task to a contact.

Format: assign c/CONTACT_INDEX t/TASK_INDEX

Examples:

• assign c/1 t/1 assigns the task at index 1 to the contact at index 1.
• assign c/3 t/2 assigns the task at index 2 to the contact at index 3.

Unassign a task from a contact: unassign

Removes a contact from a task.

Format: unassign c/CONTACT_INDEX t/TASK_INDEX

Examples:

• unassign c/1 t/1 removes the contact at index 1 from the task at index 1.
• unassign c/3 t/2 removes the contact at index 3 from the task at index 2.

General Commands

Toggling between contacts and tasks tabs: Ctrl + Tab

Toggles the view between the contacts and tasks tabs.

Format: Ctrl + Tab

Viewing help: help

Shows a message explaining how to access the user guide.

Format: help

Clearing all data: clear

Deletes all data in the application.

Format: clear

Exiting the program : exit

Exits the program.

Format: exit

Command suggestion and autocomplete

To help you familiarize with the commands, Swift+ prompts you with command suggestions as you type and can autocomplete your commands until the next user-required input.

1. Type the first few letters of a command you hope to use and Swift+ will display a suggested command. e.g. lis.
   

2. Press Tab to autocomplete your command with the prompted suggestion.

Saving the data

Swift+ 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

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

---

FAQ

Q: How do I transfer my data to another computer?
A: Install Swift+ in the other computer. Replace the default data file addressbook.json with the file that contains the data of your previous Swift+.

Q: Why does autocomplete not complete the whole suggestion after pressing Tab?
A: If multiple commands are possible with the current input, autocomplete only completes up to the longest matching prefix. e.g. pressing Tab after lis will autocomplete the command to list_, since there are two commands (list_contact and list_task) that start with lis.

---

Command Summary

This section contains a summary of all commands in Swift+ listed in alphabetical order.

Action	Format
Add Contact	add_contact n/CONTACT_NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​
Add Task	add_task n/TASK_NAME [d/DESCRIPTION] [dl/DEADLINE] [c/CONTACT_INDEX]…​
Assign Task	assign c/CONTACT_INDEX t/TASK_INDEX
Clear Data	clear
Delete Contact	delete_contact CONTACT_INDEX
Delete Task	delete_task TASK_INDEX
Edit Contact	edit_contact CONTACT_INDEX [n/CONTACT_NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​
Edit Task	edit_task TASK_INDEX [n/TASK_NAME] [d/DESCRIPTION] [dl/DEADLINE]
Find Contacts	find_contact KEYWORD [MORE_KEYWORDS]
Find Tasks	find_task KEYWORD [MORE_KEYWORDS]
Help	help
List Contacts	list_contact
List Tasks	list_task
Mark Task	mark TASK_INDEX
Select Contact	select_contact CONTACT_INDEX
Select Task	select_task TASK_INDEX
Unassign Task	unassign c/CONTACT_INDEX t/TASK_INDEX
Unmark Task	unmark TASK_INDEX