Migrate UserGuide.md from markdown to asciidoc (#435)

README.md

@@ -20,7 +20,7 @@
 
 
 #### Site Map
-* [User Guide](docs/UserGuide.md)
+* [User Guide](docs/UserGuide.adoc)
 * [Developer Guide](docs/DeveloperGuide.adoc)
 * [Learning Outcomes](docs/LearningOutcomes.md)
 * [About Us](docs/AboutUs.md)

docs/DeveloperGuide.adoc

@@ -290,7 +290,7 @@ We use https://www.google.com/chrome/browser/desktop/[Google Chrome] for convert
 Here are the steps to convert the project documentation files to PDF format.
 
 .  Make sure you have set up GitHub Pages as described in link:UsingGithubPages.md#setting-up[UsingGithubPages.md].
-.  Using Chrome, go to the link:UsingGithubPages.md#viewing-the-project-site[GitHub Pages version] of the documentation file. e.g. For link:UserGuide.md[UserGuide.md], the URL will be `\https://<your-username-or-organization-name>.github.io/addressbook-level4/docs/UserGuide.html`.
+.  Using Chrome, go to the link:UsingGithubPages.md#viewing-the-project-site[GitHub Pages version] of the documentation file. e.g. For link:UserGuide.adoc[UserGuide.adoc], the URL will be `\https://<your-username-or-organization-name>.github.io/addressbook-level4/docs/UserGuide.html`.
 .  Click on the `Print` option in Chrome's menu.
 .  Set the destination to `Save as PDF`, then click `Save` to save a copy of the file in PDF format. For best results, use the settings indicated in the screenshot below.
 

docs/UserGuide.adoc

@@ -0,0 +1,185 @@
+= AddressBook Level 4 - User Guide
+:toc:
+:toc-title:
+:toc-placement: preamble
+:sectnums:
+:imagesDir: images
+:experimental:
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+endif::[]
+
+By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+
+== Quick Start
+
+.  Ensure you have Java version `1.8.0_60` or later installed in your Computer.
++
+[NOTE]
+Having any Java 8 version is not enough. +
+This app will not work with earlier versions of Java 8.
++
+.  Download the latest `addressbook.jar` from the link:../../../releases[releases] tab.
+.  Copy the file to the folder you want to use as the home folder for your Address Book.
+.  Double-click the file to start the app. The GUI should appear in a few seconds.
++
+image::Ui.png[width="790"]
++
+.  Type the command in the command box and press kbd:[Enter] to execute it. +
+e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
+.  Some example commands you can try:
+
+* *`list`* : lists all contacts
+* **`add`**`John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` : adds a contact named `John Doe` to the Address Book.
+* **`delete`**`3` : deletes the 3rd contact shown in the current list
+* *`exit`* : exits the app
+
+.  Refer to the link:#features[Features] section below for details of each command.
+
+== Features
+
+====
+*Command Format*
+
+* Words in `UPPER_CASE` are the parameters.
+* Items in `SQUARE_BRACKETS` are optional.
+* Items with `...` after them can have multiple instances.
+* Parameters can be in any order.
+====
+
+=== Viewing help : `help`
+
+Format: `help`
+
+=== Adding a person: `add`
+
+Adds a person to the address book +
+Format: `add NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...`
+
+[TIP]
+Persons can have any number of tags (including 0)
+
+Examples:
+
+* `add John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01`
+* `add Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal`
+
+=== Listing all persons : `list`
+
+Shows a list of all persons in the address book. +
+Format: `list`
+
+=== Editing a person : `edit`
+
+Edits an existing person in the address book. +
+Format: `edit INDEX [NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]...`
+
+****
+* Edits the person at the specified `INDEX`. The index refers to the index number shown in the last person listing. The index *must be a positive integer* 1, 2, 3, ...
+* At least one of the optional fields must be provided.
+* Existing values will be updated to the input values.
+* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
+* You can remove all the person's tags by typing `t/` without specifying any tags after it.
+****
+
+Examples:
+
+* `edit 1 p/91234567 e/[email protected]` +
+Edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively.
+* `edit 2 Betsy Crower t/` +
+Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
+
+=== Finding all persons containing any keyword in their name: `find`
+
+Finds persons whose names contain any of the given keywords. +
+Format: `find KEYWORD [MORE_KEYWORDS]`
+
+****
+* The search is case insensitive. e.g `hans` will match `Hans`
+* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
+* Only the name is searched.
+* Only full words will be matched e.g. `Han` will not match `Hans`
+* Persons matching at least one keyword will be returned (i.e. `OR` search). e.g. `Hans` will match `Hans Bo`
+****
+
+Examples:
+
+* `find John` +
+Returns `John Doe` but not `john`
+* `find Betsy Tim John` +
+Returns Any person having names `Betsy`, `Tim`, or `John`
+
+=== Deleting a person : `delete`
+
+Deletes the specified person from the address book. Irreversible. +
+Format: `delete INDEX`
+
+****
+* Deletes the person at the specified `INDEX`.
+* The index refers to the index number shown in the most recent listing.
+* The index *must be a positive integer* 1, 2, 3, ...
+****
+
+Examples:
+
+* `list` +
+`delete 2` +
+Deletes the 2nd person in the address book.
+* `find Betsy` +
+`delete 1` +
+Deletes the 1st person in the results of the `find` command.
+
+=== Select a person : `select`
+
+Selects the person identified by the index number used in the last person listing. +
+Format: `select INDEX`
+
+****
+* Selects the person and loads the Google search page the person at the specified `INDEX`.
+* The index refers to the index number shown in the most recent listing.
+* The index *must be a positive integer* 1, 2, 3, ...
+****
+
+Examples:
+
+* `list` +
+`select 2` +
+Selects the 2nd person in the address book.
+* `find Betsy` +
+`select 1` +
+Selects the 1st person in the results of the `find` command.
+
+=== Clearing all entries : `clear`
+
+Clears all entries from the address book. +
+Format: `clear`
+
+=== Exiting the program : `exit`
+
+Exits the program. +
+Format: `exit`
+
+=== Saving the data
+
+Address book data are saved in the hard disk automatically after any command that changes the data. +
+There is no need to save manually.
+
+== FAQ
+
+*Q*: How do I transfer my data to another Computer? +
+*A*: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Address Book folder.
+
+== Command Summary
+
+* *Add* `add NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...` +
+e.g. `add James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
+* *Clear* : `clear`
+* *Delete* : `delete INDEX` +
+e.g. `delete 3`
+* *Find* : `find KEYWORD [MORE_KEYWORDS]` +
+e.g. `find James Jake`
+* *List* : `list`
+* *Help* : `help`
+* *Select* : `select INDEX` +
+e.g.`select 2`

docs/UsingGithubPages.md

@@ -27,7 +27,7 @@ e.g. `https://se-edu.github.io/addressbook-level4`.
 By default, the [README](../README.md) file is displayed on this page.
 
 For the other pages, the structure of the site follows the structure of the repository. <br>
-For example, `docs/UserGuide.md` is published at `https://<username-or-organization-name>.github.io/addressbook-level4/docs/UserGuide.html`.
+For example, `docs/UserGuide.adoc` is published at `https://<username-or-organization-name>.github.io/addressbook-level4/docs/UserGuide.html`.
 
 ## Updating the Project Site