<commit_before># User Guide

At this point, we know you are just as excited as we are [about Jimi](https://github.com/CS2103AUG2016-T09-C2/main/blob/master/README.md). But before you start throwing your money at us (even though Jimi is entirely free), you should first learn **how to use Jimi properly**. What follows should guide you on how to setup, install and use Jimi easily. 

<br><br>

## Guide Map

* [Quick Start](#quick-start)
* [Command Summary](#command-summary)
* [Features](#features)
* [FAQ](#faq)

<br><br>

## Quick Start

0. Ensure you have Java version `1.8.0_60` or later installed in your Computer.<br>
   > Having any Java 8 version is not enough. <br>
   This app will not work with earlier versions of Java 8.
   
1. Download the latest `jimi.jar` from the [releases](../../../releases) tab.
2. Copy the file to the folder you want to use as the home folder for Jimi.
3. Double-click the file to start the app. The GUI should appear in a few seconds. 
> <img src="images/WelcomeScreenUi.png" width="800">

4. Type the command in the command box below and press <kbd>Enter</kbd> to execute it. <br>
   e.g. typing **`help`** and pressing <kbd>Enter</kbd> will open this user guide in another window.
5. Some example commands you can try: 
   * **`add`**` "do laundry" `**`due`**` tomorrow` : 
     adds a task named `do laundry` due `tomorrow` to Jimi.
   * **`delete`**` t1` : deletes the 1st task shown in the current task list
   * **`exit`** : exits the app
6. Refer to the [Features](#features) section below for details of each command.<br>

<br>
<br>

<!--- @@author A0148040R -->
## Command Summary
Command | Format  
-------- | :-------- 
[Help](#help) | `help [COMMAND_WORD]`
[Add](#add) | `add "TASK_DETAILS" [t/TAG] [p/PRIORITY]`
&nbsp;| `add "TASK_DETAILS" due DATE_TIME [t/TAG] [p/PRIORITY]`
&nbsp;| `add "EVENT_DETAILS" on|from START_DATE_TIME [to END_DATE_TIME] [t/TAG] [p/PRIORITY]`
[Complete](#com)| `complete INDEX`
[Delete](#del) | `delete INDEX`
[Edit](#edit) | `edit INDEX NEW_DETAILS`
[Show](#show) | `show SECTION`
[Undo](#undo) | `undo`
[Redo](#redo) | `redo`
[Find](#find) | `find KEYWORD [MORE_KEYWORDS]`
[SaveAs](#saveas) | `saveas NEW_DIRECTORY`
[Clear](#clear) | `clear`
[Exit](#exit) | `exit`

<br>

<!--- @@author A0140133B -->
### General Information About Command Format

* Commands have to follow a certain format as shown in the table above.
* Replace words in `UPPER_CASE` with your input.
* Items in `[]` are optional.
* Items seperated by `|` simply means any of the items will work. E.g. `on|from`, typing `on` instead of `from` and vice versa are fine.
* The order of your input text is fixed. For instance, `add DATE_TIME due "TASK_DETAILS"` is invalid. 
* Some commands allow shorter command words for advanced users. Some commands, due to their critical nature e.g. `exit` or `clear`, you are required to type the full command word.
* Command words are also all case-insensitive i.e. `add` works as well as `ADD`.
* Below are accepted shortcuts of all commands.

Command | Default Command Word | Shortcuts  
-------- | :-------- | :--------
[Help](#help) | `help` | `h`, `he`, `hel`
[Add](#add) | `add` | `a`, `ad`
[Complete](#com) | `complete` | `c`, `co`, `com`, ... , `complet`
[Delete](#del) | `delete` | `d`, `de`, `del`, ... , `delet`
[Edit](#edit) | `edit` | `e`, `ed`, `edi`
[Show](#show) | `show` | `s`, `sh`, `sho`
[Undo](#undo)  | `undo` | `u`, `un`, `und`
[Redo](#redo) | `redo` | `r`, `re`, `red`
[Find](#find) | `find` | `f`, `fi`, `fin`
[SaveAs](#saveas) | `saveas` | None
[Clear](#clear) | `clear` | None
[Exit](#exit) | `exit` | None

<br>

**Input of Task/Event Name**
* You have to always surround task/event names with double quotation marks, `"`.
* Other than that, you can type anything within those double quotation marks.

<!--- @@author --><commit_msg>Update UserGuide.md<commit_after># User Guide

At this point, we know you are just as excited as we are [about Jimi](https://github.com/CS2103AUG2016-T09-C2/main/blob/master/README.md). But before you start throwing your money at us (even though Jimi is entirely free), you should first learn **how to use Jimi properly**. What follows should guide you on how to setup, install and use Jimi easily. 

<br><br>

## Guide Map

* [Quick Start](#quick-start)
* [Command Summary](#command-summary)
* [Features](#features)
* [FAQ](#faq)

<br><br>

## Quick Start

0. Ensure you have Java version `1.8.0_60` or later installed in your Computer.<br>
   > Having any Java 8 version is not enough. <br>
   This app will not work with earlier versions of Java 8.
   
1. Download the latest `jimi.jar` from the [releases](../../../releases) tab.
2. Copy the file to the folder you want to use as the home folder for Jimi.
3. Double-click the file to start the app. The GUI should appear in a few seconds. 
> <img src="images/WelcomeScreenUi.png" width="800">

4. Type the command in the command box below and press <kbd>Enter</kbd> to execute it. <br>
   e.g. typing **`help`** and pressing <kbd>Enter</kbd> will open this user guide in another window.
5. Some example commands you can try: 
   * **`add`**` "do laundry" `**`due`**` tomorrow` : 
     adds a task named `do laundry` due `tomorrow` to Jimi.
   * **`delete`**` t1` : deletes the 1st task shown in the current task list
   * **`exit`** : exits the app
6. Refer to the [Features](#features) section below for details of each command.<br>

<br>
<br>

<!--- @@author A0148040R -->
## Command Summary
Command | Format  
-------- | :-------- 
[Help](#help) | `help [COMMAND_WORD]`
[Add](#add) | `add "TASK_DETAILS" [t/TAG] [p/PRIORITY]`
&nbsp;| `add "TASK_DETAILS" due DATE_TIME [t/TAG] [p/PRIORITY]`
&nbsp;| `add "EVENT_DETAILS" on|from START_DATE_TIME [to END_DATE_TIME] [t/TAG] [p/PRIORITY]`
[Complete](#com)| `complete INDEX`
[Delete](#del) | `delete INDEX`
[Edit](#edit) | `edit INDEX NEW_DETAILS`
[Show](#show) | `show SECTION`
[Undo](#undo) | `undo`
[Redo](#redo) | `redo`
[Find](#find) | `find KEYWORD [MORE_KEYWORDS]`
[SaveAs](#saveas) | `saveas NEW_DIRECTORY`
[Clear](#clear) | `clear`
[Exit](#exit) | `exit`

<br>

<!--- @@author A0140133B -->
### General Information About Command Format

* Commands have to follow a certain format as shown in the table above.
* Replace words in `UPPER_CASE` with your input.
* Items in `[]` are optional.
* Items seperated by `|` simply means any of the items will work. E.g. `on|from`, typing `on` instead of `from` and vice versa are fine.
* The order of your input text is fixed. For instance, `add DATE_TIME due "TASK_DETAILS"` is invalid. 
* Some commands allow shorter command words for advanced users. Some commands, due to their critical nature e.g. `exit` or `clear`, you are required to type the full command word.
* Command words are also all case-insensitive i.e. `add` works as well as `ADD`.
* Below are accepted shortcuts of all commands.

Command | Default Command Word | Shortcuts  
-------- | :-------- | :--------
[Help](#help) | `help` | `h`, `he`, `hel`
[Add](#add) | `add` | `a`, `ad`
[Complete](#com) | `complete` | `c`, `co`, `com`, ... , `complet`
[Delete](#del) | `delete` | `d`, `de`, `del`, ... , `delet`
[Edit](#edit) | `edit` | `e`, `ed`, `edi`
[Show](#show) | `show` | `s`, `sh`, `sho`
[Undo](#undo)  | `undo` | `u`, `un`, `und`
[Redo](#redo) | `redo` | `r`, `re`, `red`
[Find](#find) | `find` | `f`, `fi`, `fin`
[SaveAs](#saveas) | `saveas` | None
[Clear](#clear) | `clear` | None
[Exit](#exit) | `exit` | None

<br>

**Input of Task/Event Name**
* You have to always surround task/event names with double quotation marks, `"`.
* Other than that, you can type anything within those double quotation marks.

<br>

**Input of Tags and Priorities**
* For tags, you can only type single words made up of numbers and letters. E.g. `t/IMPT`.
* For priorities, you can only type the following: `low`, `med`, `high`, `none`. E.g. `p/low`.
* Priorities are also case-insensitive i.e. `p/LoW`.
* A priority of `low` highlights your item in green; `med`, in yellow; and `high` in red.
* If you fail to specify a priority when adding an item, Jimi defaults it to `none`.
* For both, you cannot leave out the prefixes i.e. `t/` and `p/`. 

<!--- @@author -->
{'fraction_non_alphanumeric': 0.1762843925006087, 'fraction_numerical': 0.010713416118821524, 'mean_word_length': 3.9132775119617227, 'pattern_counts': {'":': 0, '<': 44, '<?xml version=': 0, '>': 48, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '574547', 'n_tokens_mistral': 2946, 'n_tokens_neox': 2783, 'n_words': 1078}