User Guide

Table of Contents

• Table of Contents
• Introduction
  • How to use the User Guide
• Graphical User Interface
  • Meeting Card
  • Module Card
• Quick Start
• Using LinkyTime
• Command Format
  • Command Parameters
• Features
  • Meeting Management
    • Add a meeting : add
    • List all meetings : list
    • List all archived meetings : archive
    • Find a meeting : find
    • Open a meeting URL : open
    • Edit a meeting : edit
    • Delete a meeting : delete
  • Module Management
    • Add a module : madd
    • Edit a module : medit
    • Delete a module : mdelete
  • General
    • Viewing help : help
    • Clearing all data : clear
    • Exiting the program : exit
    • Saving the data
    • Editing the data file
    • Clearing archived meetings : [coming in v2.0]
• FAQ
• Command summary
• Interpreting errors

---

Introduction

LinkyTime is a meetings link management system tailored for NUS students. It serves as a centralized platform for students to easily organize their online classes.

As NUS students, a common problem we face during this era of home-based learning is that the online lecture and tutorial links are disseminated across different platforms, such as via emails and LumiNUS. LinkyTime solves this problem by providing a platform for students to easily keep track of these meetings in one place.

The app is optimized for use via a Command-Line Interface while still having the benefits of a Graphical User Interface.

If you’re not familiar with using a Command-Line Interface, this User Guide can help you get up and running in no time.

How to use the User Guide

You may refer to the Table of Contents to quickly navigate the User Guide.

The LinkyTime User Guide utilizes various visual cues to supplement the information presented. The following table provides an overview of all the typographical conventions used.

Convention	Description
Monospace	Command inputs and syntax, file paths.
Hyperlink	Hyperlinks to external websites or within the user guide itself.
Bold text	Important keywords to take note of.
Note	Information of special interest or importance.
Warning	Potentially irreversible action that may result in loss of data.

Graphical User Interface

LinkyTime’s graphical user interface consists of 4 main components:

• Command Box
• Result Display
• Meeting List Panel
  • Meeting List State
• Module List Panel

You may type your commands in the Command Box and press Enter to execute it. The result message is displayed in the Result Display box.

Your meetings are displayed on the left in the Meeting List Panel, and your modules are displayed on the right in the Module List Panel.

At the top of the Meeting List Panel, the Meeting List State label indicates whether you are viewing your ongoing and upcoming meetings or your archived meetings.

Meeting Card

Each meeting is displayed as shown in the example above.

Module Card

Each module is displayed as shown in the example above.

---

Quick Start

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

2. Download the latest linkytime.jar from here.

3. Copy the file to the folder you want to use as the home folder for the app.

4. Double-click the file to start the app. A GUI similar to the one shown below should appear in a few seconds. Note how the app contains some sample data.
   

   

5. Type a command in the command box and press Enter to execute it. e.g. typing list and pressing Enter will list all upcoming meetings.
   

   Some example commands you can try:

   • list : Lists all upcoming meetings.
   • madd n/CS2105 : Adds a module called CS2105 to the list of modules.
   • add n/Tutorial u/https://www.zoom.com d/25-04-2022 1400 dur/2 m/1 r/Y t/Quiz : Adds a meeting named Tutorial, tagged as Quiz, on 25 April 2022 at 2:00pm for 2 hours, and is assigned to the 1st module in the module list. The meeting is set to repeat weekly.
   • delete 3 : Deletes the 3rd meeting shown in the current list.
   • exit : Exits the app.

6. Refer to the Features below for details of each command, Command Parameters for details on the available command parameters, or Using LinkyTime for how to set up for a new semester.

---

Using LinkyTime

Here are the steps to follow if you are using LinkyTime for the first time. You may refer to the Features for additional details on the specific commands. Before following this guide, you may try the example commands in the Quick Start section on the sample data.

1. Run the clear command to clear the sample data.

2. Add all the modules that you are taking with the madd command.

3. Add your upcoming meetings for each module with the add command. Your meetings will be listed in chronological order, and will automatically be moved to your archive once they’re over.

4. You can use the list or archive commands to view upcoming meetings or meetings that have passed respectively.

5. You can also use other commands such as find and open to help you search for and open your desired zoom meetings.

6. If you need to update a meeting information or remove a meeting, you can use the edit and delete commands.

7. If you need to update a module information or remove a module, use the medit or mdelete commands. Note that modules cannot be deleted if there are meetings assigned to it.

8. When you are done with LinkyTime, use the exit command to close the program.

9. If you need help at any time, you can access this User Guide using the help command and follow the link shown.

---

Command Format

The commands in this user guide follow this format:

• Words in UPPER_CASE are parameters that you can specify.
  e.g. in add n/MEETING_NAME, MEETING_NAME is a parameter which can be specified, such as add n/Lecture.

• Items in square brackets are optional.
  e.g. n/MEETING_NAME [t/TAG] can be used as n/Lecture t/midterm or as n/Lecture.

• 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/recorded, t/recorded t/lecturequiz etc.

• Parameters can be in any order.
  e.g. if the command specifies n/MEETING_NAME u/URL, u/URL n/MEETING_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 n/Lecture n/Tutorial, only n/Tutorial 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.

Command Parameters

Most LinkyTime commands use various parameters. Their formats and constraints are provided in the table below.

Parameter	Prefix	Used in	Description
MEETING_NAME	n/	add edit	The name of a meeting. Accepts only alphanumeric characters and spaces. Must not be blank.
MODULE_NAME	n/	madd medit	The name of a module. Must be unique. Accepts only alphanumeric characters and spaces. Must not be blank.
URL	u/	add edit	The URL/link to a meeting. Must include the full URL link, i.e. starts with https://. Must not be blank.
DATETIME	d/	add edit	The date and time of a meeting. Must be of the following format: dd-MM-yyyy HHmm. dd - 2 digit day, e.g. 01, 28. MM - 2 digit month, e.g. 01, 12. yyyy - 4 digit year, e.g. 2022. HHmm - 24-hour time, e.g. 0800, 1430, 2359. Must not be blank.
DURATION	dur/	add edit	The duration of a meeting in hours. Must be a decimal number greater than 1 minute and less than or equal to 24 hours, i.e. between 0.0167 to 24. Accepts up to 4 decimal places. Must not be blank. For inputs such as 2 and 2.0001, although LinkyTime will show them both as a 2 hour duration, they are in fact different.
MODULE_INDEX	m/	add edit	The index number of a module as shown in the displayed list. Must be a positive integer, e.g. 1, 2, 3, ... Must not be blank.
IS_RECURRING	r/	add edit	The recurrence of a meeting. If specified as Y, i.e. set to recur every week, the meeting will not expire and will be set to automatically repeat weekly. Must be given as Y or N. Input is not case-sensitive. Must not be blank.
INDEX	-	edit delete medit mdelete	The index number shown in the displayed list. Must be a positive integer: 1, 2, 3...
MODULE_INDEX	m/	edit delete	The module’s index number shown in the displayed list. Must be a positive integer: 1, 2, 3...
KEYWORD	-	find	A keyword used in the find command. Must be given as a single word without spaces. Input is not case-sensitive.
TAG	t/	add edit	The tag(s) assigned to a meeting. Accepts only alphanumeric characters, and must not be blank. Length is limited to a maximum of 25 characters. Spaces are not allowed. Duplicate tags are accepted as input, but they will be treated as a singular tag.

Features

This section describes each of the commands and features available in LinkyTime.

Meeting Management

Add a meeting : add

Adds a meeting into the meeting list.

Format: add n/MEETING_NAME u/URL d/DATETIME dur/DURATION m/MODULE_INDEX r/IS_RECURRING [t/TAG]...

Parameters:

• MEETING_NAME The name of the meeting.
• URL The URL to the online meeting.
• DATETIME The date and starting time of the meeting.
• DURATION The duration of the meeting in hours. Must be a decimal number between 1 minute to 24 hours, both inclusive.
• MODULE_INDEX The index of the module in the module list that the meeting is for.
• IS_RECURRING Whether the meeting recurs every week. Given as Y or N.
• TAG The tags associated with the meeting.

Examples:

• add n/Lecture u/https://www.zoom.com d/25-04-2022 1400 dur/2 m/1 r/Y t/recorded t/lecturequiz creates a meeting called Lecture with the tags recorded and lecturequiz, set to start on 25 April 2022 at 2:00pm for 2 hours, and is assigned to the first module in the module list. This meeting is set to repeat weekly.
• add n/Midterm u/https://meet.google.com d/13-05-2022 1000 dur/1.5 m/2 r/N creates a meeting called Midterm on 13 May 2022 at 10:00am for 1.5 hours, and is assigned to the second module in the module list. This meeting does not repeat.

List all meetings : list

View all recurring, ongoing, and upcoming meetings in the meeting list and display their respective details.

Format: list

Some details include:

• Meeting URL
• Meeting name
• Meeting date and time
• Module the meeting is assigned to

List all archived meetings : archive

View all expired/elapsed meetings in the meeting list and display their respective details.

Format: archive

• Only non-recurring meetings will be archived. Recurring meetings do not expire, and will repeat on a weekly basis until it is deleted or set to stop recurring.
• Meetings are archived only when the meeting has ended. Ongoing meetings will remain in your upcoming list.
• When attempting to create a recurring meeting with a date that is set in the past, LinkyTime will compute the next recurrence relative to the current date and override the meeting date.

Find a meeting : find

Finds meetings whose fields contain the provided keywords.

Format: find KEYWORD [MORE_KEYWORDS]...

• Only the name, module, and tags are searched.
• The find command is applied to the current list state of meetings, e.g. archive followed by find KEYWORD will perform the search on archived meetings only.
• The search is case-insensitive, e.g. lecture will match Lecture.
• The order of the keywords does not matter, e.g. cs2100 aaron will match aaron cs2100.
• Keywords are partially matched, e.g. tut will match tutorial.
• Only meetings that match all keywords will be returned (i.e. AND search), e.g. recorded lecture will return meetings that contain both recorded and lecture in its name, module, and/or tags.
• If no meeting matching the search criteria is found, the resulting meeting list will be blank.

Parameters:

• KEYWORD The keyword to search for in the meeting list.

Examples:

• list followed by find CS2101 Aaron displays all upcoming meetings with fields that matches CS2101 and Aaron.
• archive followed by find recorded lecture displays all archived meetings with fields that matches recorded and lecture.

Open a meeting URL : open

Opens a meeting URL link in the default web browser.

Format: open INDEX

• Opens 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, …​ that is within the range of the meeting list.

Parameters:

• INDEX The index of the meeting URL to open.

Examples:

• list followed by open 2 opens the 2nd meeting’s URL in the meeting list.

Edit a meeting : edit

Edits a meeting in the meeting list.

Format: edit INDEX [n/MEETING_NAME] [u/URL] [d/DATETIME] [dur/DURATION] [m/MODULE_INDEX] [r/IS_RECURRING] [t/TAG]...

• 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.
• When editing tags, the existing tags of the meeting will be removed, i.e., adding of tags is not cumulative.
• You can remove all the meeting’s tags by typing t/ without specifying any tags after it.

Examples:

• edit 1 t/ removes all tags from the meeting at INDEX 1.
• edit 2 n/Midterm changes the name of the meeting at INDEX 2 to Midterm.
• edit 3 n/Recitation dur/1 t/Optional t/Recorded changes the name of the meeting at INDEX 3 to Recitation, duration of the meeting to 1 hour, and the tags to be Optional and Recorded.

Delete a meeting : delete

Deletes the specified meeting from the meeting list.

Format: delete INDEX

• Deletes 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, …​ that is within the range of the meeting list.

Examples:

• list followed by delete 2 deletes the 2nd meeting in the meeting list.

Module Management

Add a module : madd

Adds a module into the module list.

Format: madd n/MODULE_NAME

Parameters:

• MODULE_NAME The name or identifier of the module.

Examples:

• madd n/CS2103T creates a module named CS2103T in the module list.
• madd n/Internship creates a module named Internship in the module list.

Edit a module : medit

Edits the module specified in the module list.

Format: medit INDEX n/MODULE_NAME

• Edits the module at the specified INDEX.
• The index refers to the index number shown in the displayed module list.
• The index must be a positive integer 1, 2, 3, …​ that is within the range of the module list.
• The existing value will be updated to the input value.

Examples:

• medit 1 n/CS2101 changes the name of the module at INDEX 1 to CS2101.
• medit 2 n/Side Hustle changes the name of the module at INDEX 2 to Side Hustle.

Delete a module : mdelete

Deletes the specified module from the module list.

Format: mdelete INDEX [f/]

• Deletes the module at the specified INDEX.
  • If there are meetings that are currently assigned to the specified module, deletion would fail due to dependent meetings.
• The index refers to the index number shown in the displayed module list.
• The index must be a positive integer 1, 2, 3, …​ that is within the range of the module list.
• Use the f/ flag to force delete the module and all its associated meetings.

Examples:

• mdelete 2 deletes the 2nd module in the module list, provided there are no associated meetings.
• mdelete 1 f/ deletes the 1st module in the module list and all associated meetings, if any.

General

Viewing help : help

Shows a message explaining how to access the help page.

Format: help

Clearing all data : clear

Clears all meetings and modules from the application.

Format: clear

Exiting the program : exit

Exits the program.

Format: exit

Saving the data

Your meetings are saved to your computer automatically upon running any command that changes the data. There is no need to save manually.

Editing the data file

The meetings are saved in a JSON file at [JAR file location]/data/app.json. Advanced users are welcome to update their meetings directly by editing that file.

Clearing archived meetings : [coming in v2.0]

Details coming soon…

---

FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty app.json data file it creates with the equivalent app.json data file from your previous LinkyTime installation.

---

Command summary

Action	Format, Examples
Add a meeting	add n/MEETING_NAME u/URL d/DATETIME dur/DURATION m/MODULE_INDEX r/IS_RECURRING [t/TAG]... e.g., add n/Lecture u/https://www.zoom.com d/25-03-2022 1400 dur/1.5 m/1 r/Y t/recorded t/lecturequiz
List all meetings	list
Find meetings	find [keyword] [more keywords...] e.g., find CS2103T lecture
Open a meeting URL	open INDEX e.g. open 2
Edit a meeting	edit INDEX [n/MEETING_NAME] [u/URL] [d/DATETIME] [dur/DURATION] [m/MODULE_INDEX] [r/IS_RECURRING] [t/TAG]... e.g., edit 1 n/Recitation dur/1
Delete a meeting	delete INDEX e.g., delete 3
List all archived meetings	archive
Add a module	madd n/MODULE_NAME
Edit a module	medit INDEX n/MODULE_NAME e.g., medit 1 n/CS2101
Delete a module	mdelete INDEX e.g., mdelete 3
Show help	help
Clear all data	clear
Exit	exit

Interpreting errors

The error messages you may encounter while using LinkyTime should be mostly self-explanatory. This sub-section aims to clear up any possible ambiguity related to invalid arguments and/or parameters.

Error	What it means
Unknown Command	An unrecognised command word was supplied. E.g., The command word was given in upper case.
Invalid Command	The command format entered is incorrect. Missing one or more compulsory parameters.
The meeting index provided is invalid	The index provided is out of the range of the list of meetings.
The module index provided is invalid	The index provided is out of the range of the list of modules.
Names should only contain alphanumeric characters and spaces, and it should not be blank	Check that the name is entered after the n/ prefix.
URLs should be a valid link, and it should not be blank	The URL provided should be in one of the following formats: https://www.example.com http://example.com www.example.com example.com
DateTime should be formatted as dd-MM-yyyy HHmm; e.g. 30-04-2022 1400	The dateTime given is invalid. Giving a date that does not exist, e.g. 30th of February. Giving a time that does not exist, e.g. 2500.
Duration should be a decimal number (4dp) given in hours, and range from 1 minute to 24 hours inclusive	As written. Note that both 1 minute and 24 hours are accepted.
Meeting recurrence status can only be a single letter Y or N	As written.
Tags names should be alphanumeric	The tags entered contained spaces and/or special characters, which are not allowed.
Tags names are limited to at most 25 characters each	One or more of the tags entered exceeded the limit of 25 characters per tag.
At least one field to edit must be provided.	No fields were supplied together with the edit/medit command.
Unable to delete Module: [MODULE_NAME] There are meetings assigned to this module.	The module is unable to be deleted as there are still meetings that exist in LinkyTime that are assigned to this module. Please refer to the features section in this User Guide on how to force delete a module.
This meeting already exists in LinkyTime.	You have tried to either add a duplicate meeting with all the same fields, or edited a meeting such that all of its fields are a duplicate of an existing meeting.
This module already exists in LinkyTime.	Same as the above.
Unable to launch default system browser!	You might not have the permissions to open the default browser.
Unable to interact with device desktop capabilities	Your System does not support the java.awt.Desktop library.