Skip to content

Commit

Permalink
Merge pull request #264 from AY2122S1-CS2103T-W08-1/Elton-V1.4-FixUG
Browse files Browse the repository at this point in the history 
Elton v1.4 fix ug
  • Loading branch information
@elroygohjy
elroygohjy authored Nov 8, 2021
2 parents 08b472b + 78f6b93 commit 3157a6d
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 20 deletions.
82 changes: 62 additions & 20 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Key features of Notor are:
* Table of Contents
{:toc}

<div style="page-break-after: always;"></div>

### 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.
Expand All @@ -35,7 +37,7 @@ Some terminology that might help:

Pay attention to these callouts:
<div markdown="block" class="alert alert-info">
This block is used to highlight information you should pay attention to
This block is used to highlight information you should pay attention to.
</div>

<div markdown="span" class="alert alert-primary">:bulb: <strong>Tip:</strong>
Expand All @@ -47,6 +49,7 @@ Used to highlight dangers.
</div>

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

<a name = "quick-start"></a>
## Quick Start
Expand Down Expand Up @@ -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.

<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

<a name = "features"></a>
Expand All @@ -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`.
</div>

<div style="page-break-after: always;"></div>

<a name = "general"></a>
### General Commands

Expand All @@ -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.

<div markdown="span" class="alert alert-warning">:exclamation: <strong>Caution:</strong>
Data will be deleted and **will not be saved**. The intended use of this
Expand All @@ -142,6 +149,8 @@ Exports all the data of Notor into a CSV file. The exported CSV will be located

Format: `export`

<div style="page-break-after: always;"></div>

<a name = "person-command"></a>
### 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.
Expand Down Expand Up @@ -182,6 +191,8 @@ Examples:
* `person 1 /add g:Orbital`
* `p 2 /a g:Orbital`

<div style="page-break-after: always;"></div>

#### _Adding a person to a subgroup_

Adds a person at the given index `INDEX` to a specified subgroup.
Expand All @@ -193,6 +204,8 @@ Examples:
* `person 1 /add g:Orbital sg:Artemis`
* `p 2 /a g:Orbital sg:Artemis`

<div style="page-break-after: always;"></div>

#### _Deleting a person_

Deletes an existing person.
Expand Down Expand Up @@ -239,6 +252,8 @@ Examples:
* `person 1 /remove g:Orbital`
* `p 2 /r g:Orbital`

<div style="page-break-after: always;"></div>

#### _Removing a person from subgroup_

Removes an existing person from a subgroup.
Expand Down Expand Up @@ -276,6 +291,8 @@ Examples:
* `person 1 /clearnote`
* `p 2 /cn`

<div style="page-break-after: always;"></div>

#### _Tagging a person_

Tags an existing person.
Expand Down Expand Up @@ -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.

<div style="page-break-after: always;"></div>

<a name = "archiving-people"></a>
### Archiving People
Expand Down Expand Up @@ -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.
</div>

<div style="page-break-after: always;"></div>

<a name = "group-command"></a>

### Working with groups/subgroups
Expand All @@ -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. <br>
A few ideas on how you can use groups are:<br>

* 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<br>
* Group mentees with common interests. This makes it convenient if you want to reach out to all mentees with a certain shared interest<br>
* 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.<br>

<ul>
<li>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</li>
<li>Group mentees with common interests. This makes it convenient if you want to reach out to all mentees with a certain shared interest</li>
<li>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.</li>
</ul>
</div>

#### _Creating a group_
Expand All @@ -388,6 +410,8 @@ Examples:
* `g Orbital /c`
![groupCreate](images/groupCreate.png)

<div style="page-break-after: always;"></div>

#### _Deleting a group_

Deletes an existing group at the index `INDEX` specified.
Expand All @@ -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`<br>
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`

<div style="page-break-after: always;"></div>

#### _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`<br>
Advanced user Format: `group (INDEX) /n`
Expand Down Expand Up @@ -452,6 +476,8 @@ Examples:
* `group 1 /clearnote`
* `g 2 /cn`

<div style="page-break-after: always;"></div>

## 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.
Expand Down Expand Up @@ -493,6 +519,8 @@ Examples:
* `person 1 /list`
* `p 2 /l`

<div style="page-break-after: always;"></div>

#### _Listing all subgroups in a group_

Lists all the subgroups within a group.
Expand Down Expand Up @@ -520,6 +548,8 @@ Advanced user Format: `p /lar`

![archivedList](images/archivePersonList.png)

<div style="page-break-after: always;"></div>

### 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.
Expand All @@ -544,6 +574,8 @@ Examples:

![personFind](images/personFind.png)

<div style="page-break-after: always;"></div>

#### _Finding groups or subgroups_

Finds all the groups with the keyword specified. This will search for the keyword within the group's name.
Expand All @@ -561,6 +593,7 @@ Examples of finding group:
* `g /f n:GroupA`
* `group /f n:Test`


## Miscellaneous information

### Saving the data
Expand All @@ -569,14 +602,15 @@ 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.

<div markdown="span" class="alert alert-warning">:exclamation: <strong>Caution:</strong>
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.
</div>

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

<a name = "tips-on-using-notor"></a>
## Tips on Using Notor
Expand Down Expand Up @@ -605,12 +639,14 @@ Shortcut Key | Linux/Window | MacOS
- Example: `Fri., Oct. 22 2021 00:07`
</div>

<div style="page-break-after: always;"></div>

<a name = "command-summary"></a>

## Command Summary
<div markdown="block" class="alert alert-info">
Round brackets `()` refer to COMPULSORY arguments.
Square brackets `[]` refer to optional arguments.<p>
Round brackets `()` refer to COMPULSORY arguments. <br>
Square brackets `[]` refer to optional arguments.
</div>

### Person
Expand Down Expand Up @@ -642,20 +678,23 @@ Action | Format

<div markdown="span" class="alert alert-warning">:exclamation: <b>Caution:</b>
<ul>
<li>For the <b>Add</b> and <b>Remove</b> commands, please make sure that the <code>GROUP_NAME</code> is typed exactly as how it is spelt on
the card.</li>
<li>For the <b>Add</b> and <b>Remove</b> commands, please make sure that the <code>GROUP_NAME</code> is typed exactly as how it is spelt on
the card.
</li>
</ul>
</div>

<div markdown="span" class="alert alert-primary">:bulb: <strong>Tip:</strong>
<ul>
<li> For the <strong>Create</strong> and <strong>List</strong> commands, if you want to automatically add them to a group, please use the <b>List</b> command to make sure the <code>Group</code> you want to
use the command on is displayed before using them via <code>GROUP_INDEX</code>.</li>
<li> For the <b>List</b> commands, to view list of persons in a particular subgroup, you should first use <b>List</b> command to list out all the subgroups in a Group you want to view,
then list out the persons inside that subgroup by <b>List</b> command with the <code>GROUP_INDEX</code> you want to list out. </li>
</ul>
<ul>
<li> For the <strong>Create</strong> and <strong>List</strong> commands, if you want to automatically add them to a group, please use the <b>List</b> command to make sure the <code>Group</code> you want to
use the command on is displayed before using them via <code>GROUP_INDEX</code>.</li>
<li> For the <b>List</b> commands, to view list of persons in a particular subgroup, you should first use <b>List</b> command to list out all the subgroups in a Group you want to view,
then list out the persons inside that subgroup by <b>List</b> command with the <code>GROUP_INDEX</code> you want to list out. </li>
</ul>
</div>

<div style="page-break-after: always;"></div>

### Group
Refer to the details of the group commands [here](#group-command).

Expand All @@ -678,6 +717,9 @@ for the <b>List</b> command, the `INDEX` argument can be either a <code>Group</c
Change the <code>person /list</code> or <code>group /list</code>.
</div>


<div style="page-break-after: always;"></div>

### General
Refer to the details of the general commands [here](#general).

Expand Down
0 docs/images/UI.png → docs/images/Ui.png
View file
File renamed without changes

0 comments on commit 3157a6d

Please sign in to comment.