Skip to content

Commit

Permalink
Merge pull request AY2324S2-CS2103T-W11-3#196 from jerremyng/UG-forma…
Browse files Browse the repository at this point in the history
…t-bug

Fix UG formatting issues
  • Loading branch information
ChrysanthemumT authored Apr 10, 2024
2 parents f6e9a9d + d098114 commit a6f87fa
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ Below shows the contact list upon executing `list`:

![List Command Contact Success](images/ListCommandContacts.png)

### Editing a contact : `edit`
#### Editing a contact : `edit`

You just had a catchup with an old friend and realised he changed his phone number because after
migrating overseas.
Expand Down Expand Up @@ -562,7 +562,9 @@ Please use this command with caution!

</div>

### Changing themes in Dook : `theme`
### Other features

#### Changing themes in Dook : `theme`

Dook comes preinstalled with a light and dark theme.

Expand Down Expand Up @@ -592,36 +594,39 @@ Below shows the error message upon executing an invalid theme:

New themes are currently being added.

</div>
#### Adding aliases in Dook : `alias`

### Adding aliases in Dook : `alias`
For commands that you use often, Dook allows the aliasing of them to any input of your choice.

<div markdown="block" class="alert alert-danger">
```
-al NEW_COMMAND -r COMMAND_TO_REPLACE
```

**:exclamation: For advanced users only!**<br>
* For example, if you like swapping between themes, you can enter `-al light -r theme -bg light`
* This results in `theme -bg light` being shortened to `light`

</div>

Dook allows the aliasing of whole commands to any input of the users choice:
<div markdown="block" class="alert alert-danger">
:exclamation: **Warning** <br>

Format: `-al NEW_COMMAND -r COMMAND_TO_REPLACE`
**This feature is meant for advanced users, please be careful**

* Commands like *theme -bg light* can be aliased to just *light* for convenience
This feature is still in beta, note:
* Aliases **cannot** be deleted as of the current version
* Aliases immediately tries to execute the replaced command, *does not work as a macro*
* Aliases such as replacing **add -n** to **addn** does not work as intended
* Aliases must be for the entire command (i.e. cannot replace `add -n` with `addn`)
</div>


### Exiting the program : `exit`
#### Exiting the program : `exit`

Exits the program.

Format: `exit`

### Saving the data
#### Saving the data

AddressBook data are saved automatically after any command that changes the data. There is no need to save manually.

### Editing the data file
#### Editing the data file

AddressBook data are saved automatically as a JSON file:<br> `[JAR file location]/data/addressbook.json`. <br>Advanced users are welcome to update data directly by editing that data file.

Expand Down

0 comments on commit a6f87fa

Please sign in to comment.