diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 85eab0231d5..b0be200954b 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -21,6 +21,8 @@ Key features of Notor are: * Table of Contents {:toc} +
+ ### Using this User Guide If you're new to Notor, hop over to [Quick Start](#quick-start) to install and begin using it. If you already know what you want, use the Table of Contents to find the feature you are looking for, or the [Command Summary](#command-summary) to view all commands available. @@ -35,7 +37,7 @@ Some terminology that might help: Pay attention to these callouts:
-This block is used to highlight information you should pay attention to +This block is used to highlight information you should pay attention to.
:bulb: Tip: @@ -47,6 +49,7 @@ Used to highlight dangers.
-------------------------------------------------------------------------------------------------------------------- +
## Quick Start @@ -77,6 +80,8 @@ Some example commands you can try sequentially to get familiarise with Notor: Refer to the [Features](#features) below for details of each command. +
+ -------------------------------------------------------------------------------------------------------------------- @@ -102,6 +107,8 @@ Here is a detailed breakdown of all the commands Notor has available. All the co e.g. if the command specifies `help 123`, it will be interpreted as `help`. +
+ ### General Commands @@ -122,7 +129,7 @@ Format: `help` Clears all entries from Notor. Format: `clear` -* Take care not to confuse this command with the more specific`/clearnote` command. +* Take care not to confuse this command with the more specific `/clearnote` command.
:exclamation: Caution: Data will be deleted and **will not be saved**. The intended use of this @@ -142,6 +149,8 @@ Exports all the data of Notor into a CSV file. The exported CSV will be located Format: `export` +
+ ### 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. @@ -182,6 +191,8 @@ Examples: * `person 1 /add g:Orbital` * `p 2 /a g:Orbital` +
+ #### _Adding a person to a subgroup_ Adds a person at the given index `INDEX` to a specified subgroup. @@ -193,6 +204,8 @@ Examples: * `person 1 /add g:Orbital sg:Artemis` * `p 2 /a g:Orbital sg:Artemis` +
+ #### _Deleting a person_ Deletes an existing person. @@ -239,6 +252,8 @@ Examples: * `person 1 /remove g:Orbital` * `p 2 /r g:Orbital` +
+ #### _Removing a person from subgroup_ Removes an existing person from a subgroup. @@ -276,6 +291,8 @@ Examples: * `person 1 /clearnote` * `p 2 /cn` +
+ #### _Tagging a person_ Tags an existing person. @@ -315,6 +332,7 @@ Advanced user Format: `p (INDEX) /ct` * Tags the person with specified `INDEX` with `TAG1, TAG2, ...`. * Please specify at least one tag to be added. +
### Archiving People @@ -352,6 +370,8 @@ Advanced user Format:`p (INDEX) /uar` You must be on the list of archived persons in order to use this command, as it needs the index of the person to unarchive.
+
+ ### Working with groups/subgroups @@ -362,10 +382,12 @@ of a group to organize people based on a more specific category. You can sort your contacts in Notor by the group that they are in, as well as taking general notes on the group.
A few ideas on how you can use groups are:
-* Group people you tend to talk to together. When meeting them, you can sort your Notor by that group, so that you can reference just their contacts
-* Group mentees with common interests. This makes it convenient if you want to reach out to all mentees with a certain shared interest
-* Group mentees who you need to achieve certain checkpoints with. For example, if in your job as a mentor you must find out from every mentee a certain list of goals, you can put this checklist into Notor as a group note, then reference it as you contact each mentee.
- + #### _Creating a group_ @@ -388,6 +410,8 @@ Examples: * `g Orbital /c` ![groupCreate](images/groupCreate.png) +
+ #### _Deleting a group_ Deletes an existing group at the index `INDEX` specified. @@ -410,21 +434,21 @@ This command only works when groups are listed in the list pane, and not when su 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`. * This name cannot start with a number, and may contain `-` or `.` characters * The new subgroup must not have the same name as other existing subgroups in the same group. -* The new subgroup's name must not include any 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 or subgroup_ -* Pops up a note window to add note to group or subgroup. +Pops up a note window to add note to group or subgroup. Format: `group (INDEX) /note`
Advanced user Format: `group (INDEX) /n` @@ -452,6 +476,8 @@ Examples: * `group 1 /clearnote` * `g 2 /cn` +
+ ## Filtering with Notor Sometimes, you will want to view all people, groups, subgroups 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. @@ -493,6 +519,8 @@ Examples: * `person 1 /list` * `p 2 /l` +
+ #### _Listing all subgroups in a group_ Lists all the subgroups within a group. @@ -520,6 +548,8 @@ Advanced user Format: `p /lar` ![archivedList](images/archivePersonList.png) +
+ ### 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. @@ -544,6 +574,8 @@ Examples: ![personFind](images/personFind.png) +
+ #### _Finding groups or subgroups_ Finds all the groups with the keyword specified. This will search for the keyword within the group's name. @@ -561,6 +593,7 @@ Examples of finding group: * `g /f n:GroupA` * `group /f n:Test` + ## Miscellaneous information ### Saving the data @@ -569,7 +602,7 @@ Notor data are saved in the hard disk automatically after any command that chang ### 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 +Notor data are saved as a JSON file at Notor's Directory. Advanced users are welcome to update data directly by editing that data file.
:exclamation: Caution: @@ -577,6 +610,7 @@ If your changes to the data file makes its format invalid, Notor will discard al
-------------------------------------------------------------------------------------------------------------------- +
## Tips on Using Notor @@ -605,12 +639,14 @@ Shortcut Key | Linux/Window | MacOS - Example: `Fri., Oct. 22 2021 00:07` +
+ ## Command Summary
-Round brackets `()` refer to COMPULSORY arguments. -Square brackets `[]` refer to optional arguments.

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

### Person @@ -642,20 +678,23 @@ Action | Format
:exclamation: Caution:
:bulb: Tip: - +
+
+ ### Group Refer to the details of the group commands [here](#group-command). @@ -678,6 +717,9 @@ for the List command, the `INDEX` argument can be either a Groupperson /list or group /list. + +
+ ### General Refer to the details of the general commands [here](#general). diff --git a/docs/images/UI.png b/docs/images/Ui.png similarity index 100% rename from docs/images/UI.png rename to docs/images/Ui.png