Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Formatting for UG #196

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
**Account Management**

1) [Registering an account](#registering-an-account-register)
2) [Log in to account](#login-into-account-login)
2) [Log in to account](#log-in-to-account-login)
3) [Logout from account](#logout-from-account-logout)
---
**Essential Features**
Expand Down Expand Up @@ -48,14 +48,15 @@
**Additional information**

- [Built-In Features](#built-in-features)
- [Design Methodology](#design-methodology)
- [Design Philosophy](#design-philosophy)
- [FAQ](#faq)
- [Known Issues](#known-issues)
- [Command Summary](#command-summary)
- [Future Integrations](#future-integrations)
- [Support and Feedback](#support-and-feedback)

---
<div style="page-break-after: always; visibility: hidden"> \pagebreak </div>

## Welcome Note
Greetings HR executives, managers and employees!
Expand All @@ -67,7 +68,7 @@ Greetings HR executives, managers and employees!

*Hi:Re, our one-stop employee profiling application is for you!*

<div style="page-break-after: always; visibility: hidden"> \pagebreak </div>


#### User Guide Purpose:

Expand Down Expand Up @@ -166,6 +167,7 @@ Contacts are also required to be labelled with <u>minimally one</u> mandatory ta
back to top
</a>
</div>

---
<div style="page-break-after: always; visibility: hidden"> \pagebreak </div>

Expand Down Expand Up @@ -433,31 +435,31 @@ Upon successful log out, you will see a similar GUI as illustrated below.<br>

* Invalid name

<img src="images/ui/add/invalidname.png" width="452.5"><br><br>
<img src="images/ui/add/invalidname.png" width="452.5"><br>
</box>
<div style="page-break-after: always; visibility: hidden"> \pagebreak </div>

<box type="wrong">
* Invalid phone number

<img src="images/ui/add/invalidhp.png" width="452.5"><br><br>
<img src="images/ui/add/invalidhp.png" width="452.5"><br>

* Invalid ID

<img src="images/ui/add/invalidid.png" width="452.5"><br><br>
<img src="images/ui/add/invalidid.png" width="452.5"><br>

* Invalid tag (tag not in tag list)

<img src="images/ui/add/invalidtag.png" width="452.5"><br><br>
<img src="images/ui/add/invalidtag.png" width="452.5" height="350"><br>
</box>



<div style="text-align: right;">
<a href=#table-of-contents>
back to top
</a>
</div>

---
<div style="page-break-after: always; visibility: hidden"> \pagebreak </div>


### Deleting a contact: `-`

Expand Down Expand Up @@ -672,13 +674,13 @@ E.g `? jo a` will give `John` and `Ali` if both of them exists in the address bo

Example:
<box type="definition">
Finding with one `(keyword)`: <code> ? al </code><br><br>
<img src="images/ui/find/1.png" width="452.5" height="360.5"><br><br>
Finding with one `(keyword)`: <code> ? al </code><br>
<img src="images/ui/find/1.png" width="452.5" height="350.5"><br>
</box>

<box type="definition" theme="info">
Finding with more than one `(keyword)`: <code> ? al ch </code><br><br>
<img src="images/ui/find/2.png" width="452.5" height="360.5"><br><br>
Finding with more than one `(keyword)`: <code> ? al ch </code><br>
<img src="images/ui/find/2.png" width="452.5" height="350.5"><br>
</box>

<div style="text-align: right;">
Expand All @@ -687,8 +689,6 @@ Example:
</a>
</div>

---

### Listing all matching information: `ls`

Similar to the find, `?`, function, you can add filter the contacts by tags!
Expand Down Expand Up @@ -1033,6 +1033,8 @@ By adding your first contact into Hi:Re, the sample data will be deleted! This f
<img src="images/ui/sampledata/before.png" width="452.5" height="350.5"><br><br>
</box>

<div style="page-break-after: always; visibility: hidden"> \pagebreak </div>

<box type="definition" theme="info">
After:<br><br>
<img src="images/ui/sampledata/after.png" width="452.5" height="350.5"><br><br>
Expand Down
Loading