User Guide

• Introduction
• How to use this guide?
• Quick start
• Navigating CodeConnect
• Features
  • Notes about the command format:
  • Managing tasks
    • Adding a task: add
    • Editing a task: edit
    • Deleting a task: del
    • Deleting all completed tasks: clean
    • Marking a task: mark
    • Unmarking a task: unmark
    • Finding tasks: find
    • Listing all tasks : list
  • Managing contacts
    • Adding a contact: addc
    • Listing all contacts : listc
    • Deleting a contact : delc
    • Editing a contact : editc
    • Finding contacts: findc
    • Quick-search for contacts: saveme
    • Clearing all contacts : clear
  • Getting help
    • Viewing help : help
  • Finishing up
    • Exiting the program : exit
  • Saving the data
  • Editing the data file
• FAQ
• Command summary
• List of Prefixes

Introduction

CodeConnect is a desktop app specially designed for Computer Science students from NUS. With this app, not only can you manage your tasks and contacts effectively in one unified place, you can also conveniently search for peers to seek help or collaboration on a particular task.

This app is optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).

How to use this guide?

For new users, it is strongly recommended that you look through this User Guide to gain a comprehensive understanding of CodeConnect.

However, you may also choose to head over to the relevant sections as described below:

• Quick start - To learn how to set up CodeConnect on your computer
• Features - To learn the different features and commands used in CodeConnect
• Command Summary - To have a complete overview of all the features and their respective command.

Caution: Boxes like this indicate gotchas that you might wish to watch out for.

Quick start

CodeConnect works on all major OSes (Windows, Mac, Linux) and only requires Java 11 or above installed on your computer.

1. Ensure you have Java 11 or above installed in your computer.
   • Instructions for doing this are available on the internet.
   • If not, install it.

2. Download the latest CodeConnect.jar from here.

3. Copy the file to the folder you want to store CodeConnect’s data in.

4. Double-click the file to start the app. The 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:

   • listc : Lists all contacts.

   • add Finish homework by/tomorrow 5pm m/CS2040S : Adds a task named Finish homework to the Task Manager.

   • del 1 : Deletes the 1^st task shown in the current list.

   • clear : Deletes all contacts. Good for removing the sample data before adding your own.

   • exit : Exits the app.

2. Refer to the Features below for details of all available commands.

Navigating CodeConnect

This section explains the various graphical components of CodeConnect’s interface.

Features

CodeConnect has 2 main sets of commands, one set to manage your contacts and one set to manage your tasks.

Notes about the command format:

• Words in {curly_braces} are the parameters to be supplied by the user.
  e.g. In addc n/{name}, {name} is a parameter which can be used as addc n/John Doe.

• Items in square brackets are optional.
  e.g. When adding a contact, it is optional to tag them. Hence, the tag parameter is presented as [t/{tag}]

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

• If a parameter is expected only once in the command, but you specified it multiple times, only the last occurrence of the parameter will be taken.
  e.g. If you specify p/12341234 p/56785678, only p/56785678 will be taken.

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

Managing tasks

This section contains all the commands for the Task features.

Adding a task: add

Adds a task and its deadline to the task list. Specifying the module the task belongs to is optional.

Format: add {task_name} by/{deadline} [m/{module_code}]

Examples:

• add finish problem set 5 by/tomorrow 5pm m/CS2040S - adds a new task “finish problem set 5” with the given deadline and module.
• add finish SEP application by/2022-12-25 23:59 - adds a new task “finish SEP application” with the given deadline.

Editing a task: edit

Edits the specified task.

Format: edit {task_index} {field_prefix + field_description}

Examples:

• edit 2 n/Rewatch lecture 6 - edits the task at index 2 to “Rewatch lecture 6”.
• edit 3 m/CS2040S by/2022-12-12 23:59 - edits the module and deadline of the task at index 3.

Deleting a task: del

Deletes the specified task.

Format: del {task_index}

Example: del 5 - deletes the task at index 5 from the task list.

Deleting all completed tasks: clean

Deletes all completed tasks.

Format: clean

Caution: This command has similar spelling to the clear command, which deletes all contacts.

Marking a task: mark

Marks the specified task as complete.

Format: mark {task_index}

Example: mark 2 - marks the task at index 2 as done shown by a tick beside the task description.

Unmarking a task: unmark

Marks the specified task as incomplete.

Format: unmark {task_index}

Example: unmark 3 - undo the marking of the task at index 2 shown by a cross beside the task description.

Finding tasks: find

Find tasks by their name or module.
Finding tasks by module makes it convenient for you to see what tasks you have for a particular module at one look, while finding them by name helps you to look for a specific task quickly rather than scrolling through the entire task list.

Format: find n/{keyword} find m/{module}

Examples:

• find n/home - returns all tasks with name that matches “home”. E.g. Science homework, Math homework
• find n/lab assignment - returns all tasks with name that matches “lab” or “assignment”. E.g. lab 1, assignment 2
• find m/CS2030S CS2040S - returns all tasks with module that matches “CS2030S” or “CS2040S”.
• find m/20 - returns all tasks with module that matches “20”.

find m/CS2103T returns this:

Listing all tasks : list

Shows a list of all tasks.

Format: list list time

• list - displays a list of all tasks in the order of most recent task added.
• list time - displays a list of all tasks in the order of the earliest deadline.

Click here to return to the top of the page.

Managing contacts

This section contains all the commands for the Contacts features.

Adding a contact: addc

Adds a contact to the contact list.

Format: addc n/{name} p/{phone_number} [e/{email}] [a/{address}] [t/{tag_1}]... [m/{module}...] [gh/{github}] [tele/{telegram}]

Examples:

• addc n/Bob Martin p/98765432 e/bobbymartini@gmail.com m/CS1101S CS1231S gh/bobby tele/bmartin - adds a contact with the given name, phone number, email, modules, Github username and Telegram handle.
• addc n/Betsy Crowe p/89985432 tele/croweybetty - adds a contact with the given name, phone number and Github username.

Caution: Due to the limitations of the code, the adding of same names is currently not supported. To distinguish between two contacts with the same name, you may add a descriptor after the name to differentiate the contacts. Additionally, only alphanumeric characters are allowed for names.
E.g. addc n/John Lim p/80009123 will not work if there is already a contact with name John Lim. To add this contact, you can try adding a descriptor such as (school) by doing addc n/John Lim (school) p/80009123, or simply make the name of the contact to be added different from John Lim.

Listing all contacts : listc

Shows a list of all contacts.

Format: listc

Deleting a contact : delc

Deletes the specified contact.

Format: delc {contact_index}

Examples:

• delc 2 - deletes the contact at index 2 from the contact list.

Editing a contact : editc

Edits the specified contact.

Format: editc {contact_index} {field prefix}{field description}

Examples:

• editc 4 gh/alicey - edits the Github username of the contact at index 4 in the contact list to “alicey”.

Finding contacts: findc

Finds contacts by their name, modules they are taking, or a specified task.
Contacts can be found by their names, or by the modules that they take. Finding contacts via module makes it very convenient to see who are your options if you need help for a that module.

Format: findc n/{name} findc m/{module} findc ts/{task_index}

Examples:

• findc n/John - returns all contacts with name that matches “John”. E.g. john, John Doe
• findc n/jo - returns all contacts with name that matches “jo”. E.g. john, John Doe
• findc n/jo ja - returns all contacts with name that matches “jo” or “ja”. E.g. john, james
• findc m/CS1231S CS1101S - returns all contacts that are taking at least one module that matches “CS1231S” or “CS1101S”.
• findc m/1S - returns all contacts that are taking at least one module that matches “1S”.
• findc ts/2 -returns contacts that are taking the module that the task at index 2 belongs to

Quick-search for contacts: saveme

Finds contacts that can help with the task at the first index of the task list.

Example:

1. The task at index 1 belongs to the CS1101S module.
2. Entering saveme will display all contacts that take the CS1101S module.

Clearing all contacts : clear

Deletes all contacts.

Format: clear

Caution: Deleted contacts are unrecoverable!

Click here to return to the top of the page.

Getting help

Viewing help : help

Provides the link to this User Guide.

Format: help

Finishing up

Exiting the program : exit

Exits the program.

Format: exit

Saving the data

CodeConnect 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

CodeConnect data are saved as a JSON file either in [JAR file location]/data/contacts.json for your contacts or [JAR file location]/data/tasks.json for your tasks. 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, CodeConnect will discard all data and start with an empty data file at the next run.

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

Q: Why does CodeConnect switch between the task list and contact list?
A: For a smoother user experience, CodeConnect automatically switches to the list that is associated with the previous command type (task or contact command). You can also switch list views manually by clicking the tabs above the lists.

Command summary

List of Prefixes

Click here to return to the top of the page.