Skip to content

Commit 6f1e2b1

Browse files
nuyernuyer
authored
Merge pull request #240 from nuyer/ug-cleanup
Add page break to User Guide
2 parents 9e6ddf7 + 251a576 commit 6f1e2b1

File tree

1 file changed

+42
-68
lines changed

1 file changed

+42
-68
lines changed

‎docs/UserGuide.md

Lines changed: 42 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,13 @@ If you relate to this problem we identified, then NetConnect might be just right
3636
- [Exiting the program : `exit`](#exiting-the-program-exit)
3737
- [Saving the data](#saving-the-data)
3838
- [Editing the data file](#editing-the-data-file)
39-
- [Future Implementations](#future-implementations)
40-
- [Truncate text in GUI](#truncate-text-in-gui)
39+
- [Planned Enhancements](#planned-enhancements)
4140
- [FAQ](#faq)
4241
- [Known issues](#known-issues)
4342
- [Command summary](#command-summary)
4443

44+
<div style="page-break-after: always;"></div>
45+
4546
# Quick start
4647

4748
1. Ensure you have Java `11` or above installed in your Computer.
@@ -61,6 +62,7 @@ If you relate to this problem we identified, then NetConnect might be just right
6162
1. Refer to the [Features](#features) below for details of each command.
6263

6364
--------------------------------------------------------------------------------------------------------------------
65+
<div style="page-break-after: always;"></div>
6466

6567
# Features
6668

@@ -86,6 +88,8 @@ If you relate to this problem we identified, then NetConnect might be just right
8688
* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
8789
</box>
8890

91+
<div style="page-break-after: always;"></div>
92+
8993
## Data Constraints
9094

9195
**Constraints:**
@@ -105,7 +109,7 @@ Here are the constraints for each field in the application:
105109
* `TERMS OF SERVICE`: Terms of service can take any format.
106110
* `PRODUCTS`: Product names should only contain alphanumeric characters and spaces.
107111

108-
<section id="help"><br>
112+
<div style="page-break-after: always;"></div>
109113

110114
## Viewing help : `help`
111115

@@ -115,10 +119,8 @@ Format: `help`
115119

116120
![help message](images/helpMessage.png)
117121

118-
</section>
119122

120-
121-
<section id="add">
123+
<div style="page-break-after: always;"></div>
122124

123125
## Adding a person: `add`
124126

@@ -145,10 +147,8 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/ROLE [r/remark] [t/TAG
145147

146148
<box type="info">
147149
<Strong>Info:</Strong> NetConnect checks for unique profiles by its NAME, PHONE NUMBER and EMAIL. It does not allow you to create two profiles with identical name, phone number and email.
148-
</box>
149-
<br>
150150

151-
<section id="delete">
151+
<div style="page-break-after: always;"></div>
152152

153153
## Deleting a person : `delete`
154154

@@ -173,9 +173,7 @@ Examples:
173173
![Delete Warning](images/deletewarning.png)
174174
</box> <br>
175175

176-
</section>
177-
178-
<section id="list">
176+
<div style="page-break-after: always;"></div>
179177

180178
## Listing all contacts : `list`
181179

@@ -184,9 +182,7 @@ Shows a list of all contacts in the address book.
184182
Format: `list`
185183
![list](images/list.png)
186184

187-
</section>
188-
189-
<section id="edit">
185+
<div style="page-break-after: always;"></div>
190186

191187
## Editing a person : `edit`
192188

@@ -208,9 +204,7 @@ Examples:
208204
![EditResultExample](images/editExample.png)
209205
* `edit i/2 n/Betsy Crower t/` Edits the name of the person with ID of 2 to be `Betsy Crower` and clears all existing tags.
210206

211-
</section>
212-
213-
<section id="find"> <br>
207+
<div style="page-break-after: always;"></div>
214208

215209
## Locating Contacts : `find`
216210

@@ -255,9 +249,7 @@ Stacking find by role and tag example
255249

256250
![result for 'find employee friends'](images/stackEmployeeFriends.png)
257251

258-
</section>
259-
260-
<section id="clear">
252+
<div style="page-break-after: always;"></div>
261253

262254
## Clearing all entries : `clear`
263255

@@ -272,10 +264,7 @@ Format: `clear`
272264
![result for 'clear warning'](images/ClearWarning.png)
273265
</box>
274266

275-
276-
</section> <br>
277-
278-
<section id="relate">
267+
<div style="page-break-after: always;"></div>
279268

280269
## Create Relations between Profiles : `relate`
281270

@@ -287,9 +276,7 @@ Example: `relate i/1 i/3` creates a relation between the profiles with ID of 1 a
287276

288277
![result for 'relate result'](images/relateResult.png)
289278

290-
</section>
291-
292-
<section id="unrelate">
279+
<div style="page-break-after: always;"></div>
293280

294281
## Remove Relations between Profiles : `unrelate`
295282

@@ -301,10 +288,7 @@ Example: `unrelate i/1 i/23` removes a relation between the profiles with ID of
301288

302289
![result for 'unrelate result'](images/unrelateResult.png)
303290

304-
305-
</section>
306-
307-
<section id="showrelated">
291+
<div style="page-break-after: always;"></div>
308292

309293
## Show Relations Associated to a Person : `showrelated`
310294

@@ -320,17 +304,12 @@ Example: `showrelated i/1` shows all relations between the profile with ID 1 and
320304

321305
![result for 'showrelated result'](images/showrelatedResult.png)
322306

323-
</section>
324-
325-
<section id="open-on-last-state">
307+
<div style="page-break-after: always;"></div>
326308

327309
## Open on Last State
328310
With every change to the command input, NetConnect saves and updates the command input in a separate file. When the app closes and is opened again, the last command present before closure will be retrieved from the separate file and input into the command field (if any). This way, you never have to worry about losing progress!
329311

330-
</section>
331-
332-
333-
<section id="export">
312+
<div style="page-break-after: always;"></div>
334313

335314
## Export view to CSV File : `export`
336315
Retrieve information on a group of profiles at once with this function! This can be useful for consolidating all the emails or contact number at once, or to share information with third parties.
@@ -371,40 +350,31 @@ Step 2: `export client.csv`
371350
The CSV file named clients.csv containing all client contacts is exported to a folder on your laptop located within the same directory as the NetConnect application.
372351
![result for 'CSV file'](images/csvfile.png)
373352

374-
</section>
375-
376-
<section id="exit-program">
353+
<div style="page-break-after: always;"></div>
377354

378355
## Exiting the program : `exit`
379356

380357
Exits the program.
381358

382359
Format: `exit`
383360

384-
</section>
385-
386-
387-
<section id="saving-the-data">
361+
<div style="page-break-after: always;"></div>
388362

389363
## Saving the data
390364

391365
NetConnect data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
392366

393-
</section>
394-
395-
396-
<section id="editing-the-data-file">
397-
398367
## Editing the data file
399368

400369
NetConnect data are saved automatically as a JSON file `[JAR file location]/data/netconnect.json`. Advanced users are welcome to update data directly by editing that data file.
401370

402371
**Caution:**
403372
If your changes to the data file makes its format invalid, NetConnect will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br> Furthermore, certain edits can cause the NetConnect to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
404373

405-
</section>
406374
--------------------------------------------------------------------------------------------------------------------
407375

376+
<div style="page-break-after: always;"></div>
377+
408378
# Planned Enhancements
409379
The NetConnect team is working on new features and fixes for you, but they are unfortunately unavailable in this current implementation. We intend to have future fixes for these occurences below!
410380

@@ -419,6 +389,8 @@ Further details on the planned enhancements can be found in the Developer Guide.
419389

420390
--------------------------------------------------------------------------------------------------------------------
421391

392+
<div style="page-break-after: always;"></div>
393+
422394
# FAQ
423395

424396
**Q**: How do I transfer my data to another Computer?<br>
@@ -444,20 +416,22 @@ Further details on the planned enhancements can be found in the Developer Guide.
444416

445417
--------------------------------------------------------------------------------------------------------------------
446418

419+
<div style="page-break-after: always;"></div>
420+
447421
# Command summary
448-
| Action | Format | Examples |
449-
|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
450-
| **Help** | `help` | `help` |
451-
| **Add (Employee)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Employee [t/TAG] [dept/DEPARTMENT] [job/JOB] [skills/SKILL1] [skills/SKILL2] ` | `add n/Bob Ye p/8928732 e/boby@example.com a/Blk 11, Clementi Ave 1, #03-32 t/friends t/coreTeam r/requires follow up on pay raise role/employee dept/HR job/Manager skills/Java` |
452-
| **Add (Client)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Client [t/TAG] [pref/PREFERENCES] [prod/PRODUCT 1] [prod/PRODUCT 2]` | `add n/Benson Mayer p/87728933 e/mayerb@example.com a/311, Clementi Ave 2, #02-25 role/Client pref/Dairy-free prod/Sourdough bread prod/Raisin Bread` |
453-
| **Add (Supplier)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Supplier [t/TAG] [tos/TERMS OF SERVICE] [prod/PRODUCT 1] [prod/PRODUCT 2]` | `add n/Fiona Kunz p/94824272 e/lydia@example.com a/little tokyo role/Supplier tos/Delivery within 2 weeks prod/Office Supplies prod/Furniture` |
454-
| **List** | `list` | `list` |
455-
| **Delete** | `delete [i/ID] [n/NAME]` | `delete i/123`, `delete n/John Doe` |
456-
| **Edit** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/ROLE [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` |
457-
| **Find** | `find [n/NAME] [t/TAG] [p/PHONE] [role/ROLE] [r/REMARK]` | `find role/employee` , followed by `find n/Bob` to stack filters |
458-
| **Relate Profiles** | `relate i/ID i/ID` | `relate i/1 i/2` |
459-
| **Unrelate Profiles** | `unrelate i/ID i/ID` | `relate i/1 i/2` |
460-
| **Show related Profile** | `showrelated i/ID` | `showrelated i/2` |
461-
| **Export** | `export [filename]` | `export ClientInfo.csv` |
462-
| **Clear** | `clear` | `clear` |
463-
| **Exit** | `exit` | `exit` |
422+
| Action | Format | Examples |
423+
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
424+
| **Help** | `help` | `help` |
425+
| **Add (Employee)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Employee [r/REMARK] [t/TAG]... [dept/DEPARTMENT] [job/JOB] [skills/SKILL]... ` | `add n/Bob Ye p/8928732 e/boby@example.com a/Blk 11, Clementi Ave 1, #03-32 t/friends t/coreTeam r/requires follow up on pay raise role/employee dept/HR job/Manager skills/Java` |
426+
| **Add (Client)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Client [r/REMARK] [t/TAG]... [pref/PREFERENCES] [prod/PRODUCT]...` | `add n/Benson Mayer p/87728933 e/mayerb@example.com a/311, Clementi Ave 2, #02-25 role/Client pref/Dairy-free prod/Sourdough bread prod/Raisin Bread` |
427+
| **Add (Supplier)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Supplier [r/REMARK] [t/TAG].. [tos/TERMS OF SERVICE] [prod/PRODUCT]...` | `add n/Fiona Kunz p/94824272 e/lydia@example.com a/little tokyo role/Supplier tos/Delivery within 2 weeks prod/Office Supplies prod/Furniture` |
428+
| **List** | `list` | `list` |
429+
| **Delete** | `delete [i/ID] [n/NAME]` | `delete i/123`, `delete n/John Doe` |
430+
| **Edit** | `edit i/ID [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` |
431+
| **Find** | `find [n/NAME] [t/TAG] [p/PHONE_NUMBER] [role/ROLE] [r/REMARK]` | `find role/employee` , followed by `find n/Bob` to stack filters |
432+
| **Relate Profiles** | `relate i/ID i/ID` | `relate i/1 i/2` |
433+
| **Unrelate Profiles** | `unrelate i/ID i/ID` | `relate i/1 i/2` |
434+
| **Show related Profile** | `showrelated i/ID` | `showrelated i/2` |
435+
| **Export** | `export [filename]` | `export ClientInfo.csv` |
436+
| **Clear** | `clear` | `clear` |
437+
| **Exit** | `exit` | `exit` |

0 commit comments

Comments
 (0)