Skip to content

UserGuide.md

Latest commit

 

History

History
502 lines (333 loc) · 19 KB

UserGuide.md

File metadata and controls

502 lines (333 loc) · 19 KB
layout page
title User Guide

Overview

Notor is a desktop application for mentors to keep tabs on their mentees, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type faster than the average typing speed, Notor allows you to take notes quickly and efficiently, while keeping them in an easy to reference format, which is vital if you are taking notes during meetings with mentees.

  • Table of Contents {:toc}

Quick Start

1. Setup

Ensure you have Java 11 or above installed in your computer. You can install Java 11 from here.

2. Installing the project

Download the latest notor.jar here, and copy the file to the folder you want to use as the home folder for your Notor.

3. Running the application

Double-click the file to start the application. If you have set up Java 11 correctly, the application should open, and the GUI similar to below should appear in a few seconds. Note how the app contains some sample data.
Ui

4. Try Running Examples!

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:

  • person /list : Lists all contacts.
  • person 3 /delete : Deletes the 3rd contact (contact with index number 3) shown in the current list.
  • person User /create : Creates a person named User.
  • group 1 /create t:Students : Creates a group at index 1tagged withStudents`.
  • person 3 /add g:Orbital : Adds the person with index 3 to the group Orbital.
  • group /list : Lists all groups.
  • group 1 /note : Edits the group note for the group with index number 1.
  • group 1 /create n:Artemis : Creates a subgroup Artemis inside the group with index number 1.
  • group 1 /untag t:Students : Removes the tag Students from the group with index number 1.
  • clear : Deletes all contacts.
  • exit : Exits the application.

Refer to the Features below for details of each command.

Features

**Information_source: Notes about the command format:**
* Words in `UPPER_CASE` are the parameters to be supplied by the user.
e.g. in `person /create n:NAME`, `NAME` is a parameter which can be used as `/create n:John Doe`. * Round brackets `()` refer to COMPULSORY arguments.
e.g `g:(GROUP_NAME)` means that the group name must be entered a that position.
  • Items in square brackets are optional.
    e.g n:NAME [g:GROUP_NAME] can be used as n:Elton g:Orbital or as n:Elton.
  • Items with …​ after them can be used multiple times including zero times, with a comma separating terms.
    e.g. [t/TAG…​] can be used as (i.e. 0 times), t:tag1, tag2, tag3 etc.
  • Parameters can be in any order.
    e.g. if the command specifies g:GROUP_NAME sg:SUBGROUP_NAME, sg:SUBGROUP_NAME g:GROUP_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, exit and clear) will be ignored.
    e.g. if the command specifies help 123, it will be interpreted as help.
## General Commands #### Viewing help : `help`

Shows a message explaining how to access the help page.

help message

Format: help

Clearing all entries : clear

Clears all entries from Notor. Be warned; data will be deleted and will not be saved. The intended use of this command is to clear the dummy starting data, but you can also use it to reset your Notor from within the program.

Format: clear

  • Take care not to confuse this command with the more specific/clearnote command.

Exiting the program : exit

Exits the program and saves your data.

Format: exit

Working with people

The base functionality of Notor is to allow you to maintain notes on people who you mentor. These are the commands you can use with the person prefix to manage your contacts.

Adding a person: person (NAME) /create

Creates a person.

Format: person (NAME) /create [p:PHONE] [e:EMAIL] [t:TAG1,TAG2,...] [g:GROUP_INDEX]
Advanced user Format: p (NAME) /c [p:PHONE] [e:EMAIL] [t:TAG1,TAG2,...] [g:GROUP_INDEX]

  • Creates a person with the NAME.
  • Optional arguments:
    • PHONE: Phone number of the person.
    • EMAIL: Email of the person.
    • TAG1,TAG2..: Tag(s) that describe the person.
    • GROUP_INDEX: Index of the group in notor to add the person to.

Examples:

  • person John Lim /create p:91119111 e:notor@notor.com t:Loves Dancing g:1
  • p Michael Joe /c p:92229222 e:notor@notor.com t:Loves Singing g:2

Adding a person to a group: person (INDEX) /add (g:GROUP_NAME)

Adds a person at the given index to a specified group.

Format: person (INDEX) /add (g:GROUP_NAME)
Advanced user Format: p (INDEX) /a (g:GROUP_NAME)

  • Adds a person with the NAME to GROUP_NAME.

Examples:

  • p John /add Lim g:CS2103T
  • p Mary /a g:CS2103T

Deleting a person : person (INDEX) /delete

Deletes an existing person.

Format: person (INDEX) /delete
Advanced user Format: p (INDEX) /d

  • Deletes an existing person at the given INDEX.

Examples:

  • person 1 /d
  • p 2 /d

Editing a person : person (INDEX) /edit [n:NAME] [p:PHONE] [e:EMAIL]

Edit an existing person's data.

Format: person (INDEX) /edit [n:NAME] [p:PHONE] [e:EMAIL]
Advanced user Format:p (INDEX) /e [n:NAME] [p:PHONE] [e:EMAIL]

  • Edits the person at the index INDEX and replaces the fields specified with the new parameters.

  • Please specify at least one field to be edited.

  • Optional arguments:

    • NAME: Name of the person.
    • PHONE: Phone number of the person.
    • EMAIL: Email of the person.

Examples:

  • person 1 /edit n:John Cena e:notor@notor.com
  • p 2 /e n:Little Lamb p:93339333

Removing a person from group: person (INDEX) /remove (g:GROUP_NAME)

Removes an existing person from a group.

Format: person (INDEX) /remove (g:GROUP_NAME)
Advanced user Format:p (INDEX) /r (g:GROUP_NAME)

  • Removes an existing person at the given INDEX from a GROUP_NAME.

Examples:

  • person 1 /remove g:CS2103T
  • p 2 /r g:CS2103T sg:W08

Taking notes for a person : person (INDEX) /note

Pops up a note window to take note for an existing person.

Format: person (INDEX) /note
Advanced user Format:p (INDEX) /n

  • Pops up a note window for an existing person at the given INDEX to take note.

Examples:

  • person 1 /note
  • p 2 /n

Clearing notes of a person : person (INDEX) /clearnote

Removes note of an existing person.

Format: person (INDEX) /clearnote
Advanced user Format:p (INDEX) /cn

  • Removes note of an existing person at the given INDEX.

Examples:

  • person 1 /clearnote
  • p 2 /cn

Working with groups/subgroups

⚠️ **These commands will work only when groups or subgroups are listed.** ⚠️

Creating a group: group (GROUP_NAME) /create

Creates a group.

Format: group (GROUP_NAME) /create
Advanced user Format: g (GROUP_NAME) /c

  • Creates a new group with the name GROUP_NAME.
  • The new group must not have a same name with other existing groups.
  • The new group's name must not include backslash (/) or underscore (_).

Examples:

  • group CS2103T /create will create a new group called CS2103T.
  • g CS2103T /c

Deleting a group: group (INDEX) /delete

Deletes an existing group.

Format: group (INDEX) /delete
Advanced user Format: g (INDEX) /d

  • Deletes the group at the index specified.

Examples :

  • group 1 /delete will delete the group at index 1.
  • g 1 /d

Editing a group: group (INDEX) /edit [n:NEW_NAME]

Edits the name of an existing group.

Format: group (INDEX) /edit [n:NEW_NAME]
Advanced user Format: group (INDEX) /e [n:NEW_NAME]

  • Renames an existing group at the index specified to NEW_NAME .
  • The new group must not have a same name with other existing groups.
  • The new group's name must not include backslash (/) or underscore (_).

Examples :

  • group 1 /edit n:CS2101 will rename the group at index 1 to CS2101.
  • g 1 /e CS2101

Creating a subgroup: group (INDEX) /create n:SUBGROUP_NAME

Creates a new subgroup. This command only works when group are listed and not when subgroups are listed.

Format: group (INDEX) /create n:SUBGROUP_NAME
Advanced user Format: g (INDEX) /c n:SUBGROUP_NAME

  • Creates a new subgroup of group at the index specified with the name SUBGROUP_NAME.
  • The new subgroup must not have a same name with other existing subgroups in the same group.
  • The new subgroup's name must not include backslash (/) or underscore (_).

Examples :

  • group 1 /create n:Artemis will create a new subgroup Artemis in group at index 1.
  • g 1 /create n:Artemis

Adding notes to a group: group (INDEX) /note

Add notes on a group and saves the time when the note is added.

Format: group (INDEX) /note
Advanced user Format: group (INDEX) /n

  • Add notes on a group at the index specified.
  • Entering the command will lead to a popup window where the user can edit notes for group at that index`.
  • The time when the note is edited will be saved.

Examples :

  • group 1 /note will prompt a popup window where the user can edit the notes for group at index 1.
  • g 1 /n

Adding tags to a group: group (INDEX) /tag [t:TAG1,TAG2,...]

Add tags to a group.

Format: group (INDEX) /tag [t:TAG1,TAG2,...]
Advanced user Format: g (INDEX) /t [t:TAG1,TAG2,...]

  • Add tags to a group at the index specified.
  • The tags must not have a same name with other existing tags in the same group.

Examples :

  • group 1 /tag t:orbital,CS2103 add tags orbital and CS2103 to group 1.
  • g 1 /t t:orbital,CS2103

Untag tags from a group: group (INDEX) /untag [t:TAG1,TAG2,...]

Untag tags from a group.

Format: group (INDEX) /untag [t:TAG1,TAG2,...]
Advanced user Format: g (INDEX) /u [t:TAG1,TAG2,...]

  • Remove tags from a group at the index specified.

Examples :

  • group 1 /untag t:orbital,CS2103 remove tags orbital and CS2103 to group 1.
  • g 1 /ut t:orbital,CS2103

Clear tags from a group: group (INDEX) /cleartags

Clear tags from a group.

Format: group (INDEX) /cleartags
Advanced user Format: g (INDEX) /ct

  • Clear all tags from a group at the index specified.

Examples :

  • group 1 /cleartags clears all tags from group 1.
  • g 1 /ct

Filtering with Notor

Sometimes, you will want to view all people, groups, subgroups, or tags to understand what you have saved in your Notor. At other times, you will want to find those which fit into certain parameters. Here are the ways to view a subset of your data.

List

List can show all persons, groups, subgroups, or tags which you have added to Notor.

Listing all persons : person /list

Lists all persons.

Format: person /list
Advanced user Format:p /l

List all groups : group /list

Format: group /list
Advanced user Format: g /l

Listing all persons in a group : group (INDEX) /list

Use after you have listed out all groups (so you can select the index). Lists all persons in that group.

Format: group (INDEX)/list
Advanced user Format:g (INDEX) /l

  • Lists all persons of a group that is at the given INDEX .

Examples:

  • group 1 /list
  • g 2 /l

List all subgroups in a group : group (INDEX) /listsubgroup

List all the subgroups within a group. Use after you have listed out all groups (so you can select the index)

Format: group (INDEX) /listsubgroup
Advanced user Format: g (INDEX) /lsg

Examples:

  • group 3 /listsubgroup
  • g 2 /lsg

List all tags : tag /list

Lists out all tags which you have used so far, so that you can understand what metadata you are tracking.

Format: tag /list
Advanced Format: t /l

Find

Find allows you to obtain the results that match with the keyword specified. You can filter in this way on people, groups, and subgroups. In addition, you may add additional parameters to your search, in order to narrow the search further.

Finding persons : person /find (n:QUERY)

Finds all persons that match your search term. This will search for the term within the person's name.

Format: person /find (n:QUERY)
Advanced user Format:p /f (n:QUERY)

  • Finds all persons that match with given QUERY.
  • Substrings will match: jo will match John and joanne.

Examples:

  • person /find n:John
  • p /f n:Mary

Find a group or subgroup : group /find (g:KEYWORD)

Find all the groups with the keyword specified. This will search for the keyword within the group's name.

Format: group /find g:KEYWORD
Advanced user Format: g /f g:KEYWORD

  • Find all the groups that match the KEYWORD.
  • The keyword must not include backslash (/) or underscore (_).
  • Substrings will match: art will match Art Jammers, Smart cookie, and Artemis

Examples of finding group:

  • group /find g:Orbital_Team_1
  • g /f g:W08
  • group /f sg:W08 g:CS2103T
  • g /f sg:Artemis g:Orbital

Miscellaneous information

Saving the data

Notor 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

Notor data are saved as a JSON file [JAR file location]/data/Notor.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, Notor will discard all data and start with an empty data file at the next run.

Archiving data files [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 data file it creates with the file that contains the data of your previous Notor home folder.

Command summary

Round brackets () refer to COMPULSORY arguments. Square brackets [] refer to optional arguments.

TODO: Make command action words below link to their entries above.

Person

Note:

  • For the Create and List commands, if you want to automatically add them to a group, please use the List command to make sure the Group you want to use the command on is displayed before using them via GROUP_INDEX.
  • For the Add and Remove commands, please make sure that the GROUP_NAME is typed exactly as how it is spelt on the card.
Action Format Advanced Format
Create person (NAME) /create [p:PHONE] [e:EMAIL] [t:TAG1,TAG2,...] [g:GROUP_INDEX] p (NAME) /c [p:phone] [e:email] [t:TAG1,TAG2,...] [g:GROUP_INDEX]
Edit person (INDEX) /edit [n:NAME] [p:PHONE] [e:EMAIL] p (INDEX) /e [n:NAME] [p:phone] [e:email]
Delete person (INDEX) /delete p (INDEX) /d
Add person (INDEX) /add (g:GROUP_NAME) p (INDEX) /a (g:GROUP_NAME)
Remove person (INDEX) /remove (g:GROUP_NAME) p (INDEX) /r (g:GROUP_NAME)
Note person (INDEX) /note p (INDEX) /n
Clear Note person (INDEX) /clearnote p (INDEX) /cn
Tag person (INDEX) /tag [t:TAG1,TAG2,...] p (INDEX) /t [t:TAG1,TAG2,...]
Untag person (INDEX) /untag [t:TAG1,TAG2,...] p (INDEX) /ut [t:TAG1,TAG2,...]
Clear Tags person (INDEX) /cleartags p (INDEX) / ct
List Persons person /list p /l
List Persons in Group person [INDEX] /list p [INDEX] /l
Find person /find (n:QUERY) p /f (n:QUERY)

Group

Action Format Short Format
Create Group group (GROUP_NAME) /create [t:TAG1,TAG2,...] g (GROUP_NAME) /c [t:TAG1,TAG2,...]
Create Subgroup group (INDEX) /create n:SUBGROUP_NAME g (INDEX) /c n:SUBGROUP_NAME
Edit group (INDEX) /edit [n:NEW_NAME] g (INDEX) /e [n:NEW_NAME]
Delete group (INDEX) /delete g (INDEX) /d
Note group (INDEX) /note g (INDEX) /n
Tag group (INDEX) /tag [t:TAG1,TAG2,...] g (INDEX) /t [t:TAG1,TAG2,...]
Untag group (INDEX) /untag [t:TAG1,TAG2,...] g (INDEX) /ut [t:TAG1,TAG2,...]
Clear Tags group (INDEX) /cleartags g (INDEX) / ct
List Groups group /list g /l
List Out Subgroups group (INDEX) /list g (INDEX) /l
Find group /find (n:QUERY) g /f (n:QUERY)

Note: for the List command, the INDEX argument can be either a Group or a Person, depending on what you have listed after using person /list or group /list.

Action Format Short Format
List tag [INDEX] /list t [INDEX] /l

General

Action Format Advanced Format
Help help h
Exit exit e
Clear clear c