Skip to content

Latest commit

 

History

History
523 lines (395 loc) · 15.4 KB

UserGuide.adoc

File metadata and controls

523 lines (395 loc) · 15.4 KB
Raw

Tourist-Book - User Guide

By: Team F09-B2 Since: Aug 2017 Licence: MIT

1. Quick Start

  1. Ensure you have Java version 1.8.0_60 or later installed in your Computer.

    ℹ️
    		 Having any Java 8 version is not enough.
    This app will not work with earlier versions of Java 8.

  2. Download the latest touristbook.jar here.

  3. Copy the file to the folder you want to use as the home folder for your Address Book.

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

    Ui

  5. Type the command in the command box and press Enter to execute it.
    e.g. typing help and pressing Enter will open the help window.

  6. Some example commands you can try:

    • list : lists all places

    • addn/Marina Bay Sands a/10 Bayfront Avenue, Singapore 018956 : adds a place named Marina Bay Sands to the Tourist Book.

    • delete3 : deletes the 3rd place shown in the current list

    • exit : exits the app

2. Features in v1.0

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add n/NAME, NAME is a parameter which can be used as add n/Marina Bay Sands.

  • Items in square brackets are optional e.g n/NAME [t/TAG] can be used as n/Marina Bay Sands t/attractions or as n/Marina Bay Sands.

  • Items with …​ after them can be used multiple times including zero times e.g. [t/TAG]…​ can be used as   (i.e. 0 times), t/attractions, t/onestar t/twostars etc.

  • Parameters can be in any order e.g. if the command specifies n/NAME a/ADDRESS, a/ADDRESS n/NAME is also acceptable.

  • All the commands are case-sensitive.

2.1. Viewing help : help or h

Format: help or h

Warning

Please close the help window once check. The application cannot perform other tasks when help window is still running. This is a bug that is found in the base Addressbook-level 4.

2.2. Adding a place: add or a

Adds a place to the Tourist Book
Format: add n/NAME [ph/PHONE] [w/WEBSITE] [a/ADDRESS] p/POSTALCODE [t/TAG]…​

or

Format: a n/NAME p/POSTALCODE [t/TAG]…​

💡
 A place can have any number of tags (including 0)
💡
 A place can have null for Address, Website, Tag and Phone fields.
💡
 It is compulsory for a place to have Name and Postalcode.

  • The command will reject if following requirement does not meet -

    • Phone numbers can only contain numbers, and should be at least 3 digits long

    • Postal codes need to be exactly 6 digits.

    • Websites need to include http://www or https://www in front.

Examples:

  • add n/Marina Bay Sands a/10 Bayfront Avenue p/018956

  • a n/Marina Bay Sands a/10 Bayfront Avenue p/018956 t/attractions

2.3. Listing all places : list or l

Shows a list of all places in the Tourist Book.
Format: list or l

2.4. Editing a place : edit or ed

Edits an existing place in the Tourist-Book
Format: edit INDEX [n/NAME] [a/ADDRESS] [p/POSTALCODE] [t/TAG]…​

or

Format: ed INDEX [n/NAME] [a/ADDRESS] [p/POSTALCODE] [t/TAG]…​

  • Edits the place at the specified INDEX. The index refers to the index number shown in the last place listing. The index must be a positive integer, e.g 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 place will be removed i.e adding of tags is not cumulative.

  • You can remove all the place’s tags by typing t/ without specifying any tags after it.

Examples:

  • edit 1 a/20 Bayfront Avenue p/000001 t/bookmarks
    Edits the address and tag of the 1st place to be 20 Bayfront Avenue and bookmarks respectively.

  • ed 2 n/Singapore Zoo t/
    Edits the name of the 2nd place to be Singapore Zoo and clears all existing tags.

2.5. Locating places by name or tag: find or fd

Finds places whose names or tags contain any of the given keywords.
Format: find [PREFIX]KEYWORD [MORE_KEYWORDS] or fd [PREFIX]KEYWORD [MORE_KEYWORDS]

  • The search is case insensitive. e.g zoo will match Zoo

  • The prefix will determine which field you are searching for.
    n/ is the prefix for name, while t/ is the prefix for tag.

  • The order of the keywords does not matter. e.g. Singapore Zoo will match Zoo Singapore

  • Only the name or tag is searched.

  • Only one field can be searched at a time, i.e. you cannot search both tag and name at the same time.

  • Only full words will be matched e.g. Singa will not match Singapore

  • Places matching at least one keyword will be returned (i.e. OR search). e.g. Singapore Gardens will return Singapore Zoo, Singapore Botanical Gardens

Examples:

  • find n/Singapore
    Returns Singapore Zoo and Singapore Flyer

  • fd n/Singapore Sands Botanic
    Returns any place having names Singapore, Sands, or Botanic

  • find t/attractions
    Returns a list of places tagged as attractions

  • fd t/onestar
    Returns a list of places tagged as onestar

2.6. Deleting a place : delete or del

Deletes the specified place from the Tourist Book.
Format: delete INDEX or del INDEX

  • Deletes the place at the specified INDEX.

  • The index refers to the index number shown in the most recent listing.

  • The index must be a positive integer, e.g 1, 2, 3, …​

Examples:

  • list
    Show all locations available. delete 2
    Deletes the 2nd place in the address book.

  • find n/Bay
    Show all locations whose names containing 'Bay'. del 1
    Deletes the 1st place in the results of the find command.

2.7. Selecting a place : select or s

Selects the place identified by the index number used in the last place listing.
Format: select INDEX or s INDEX

  • Selects the place and loads the Google search page the place at the specified INDEX.

  • The index refers to the index number shown in the most recent listing.

  • The index must be a positive integer, e.g 1, 2, 3, …​

Examples:

  • list
    Show all locations available. select 2
    Selects the 2nd place in the address book.

  • find n/Bay
    Show all locations whose names containing 'Bay'. select 1
    Selects the 1st place in the results of the find command.

2.8. Listing entered commands : history or hy

Lists all the commands that you have entered in reverse chronological order.
Format: history or hy

ℹ️

Pressing the ↑ and ↓ arrows will display the previous and next input respectively in the command box.

2.9. Undoing previous command : undo or un

Restores the Tourist Book to the state before the previous undoable command was executed.
Format: undo or un

ℹ️

Undoable commands: those commands that modify the Tourist Book’s content (add, delete, edit and clear).

Examples:

  • delete 1
    list
    undo (reverses the delete 1 command)

  • select 1
    list
    undo
    The undo command fails as there are no undoable commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)

2.10. Redoing the previously undone command : redo or re

Reverses the most recent undo command.
Format: redo or re

Examples:

  • delete 1
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)

  • delete 1
    redo
    The redo command fails as there are no undo commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)
    redo (reapplies the clear command)

2.11. Clearing all entries : confirm_clear

Clears all entries from the Tourist Book.
Format: confirm_clear

2.12. Exiting the program : exit or ex

Exits the program.
Format: exit or ex

2.13. Saving the data

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

3. Changes in v1.1

3.1. Logic component

Added a shorthand equivalent alias for each of the individual commands. For example, besides typing add, the user can also type a to remove all places in the list.

3.2. Storage component

Added a backup method in AddressBookStorage.

4. Changes from v1.2

4.1. Displaying MRT map of Singapore

Display MRT map of Singapore by clicking on MRT Map → MRT Map

or

Display MRT map of Singapore by using the CLI.
Format: mrt

or

Using the shortcut key F3

ℹ️

  • The browser window must be closed before proceeding with any other command. This is a bug that is found in
    the base Addressbook-level 4.

  • The command is case sensitive

  • The command will ignore any other parameters after the command word.

  • It is also not an undoable command, hence the undo command will not work.

4.2. Useful contact numbers in Singapore

Display a list of useful contact numbers by clicking on Help → Useful Contacts

or

Display a list of useful contact numbers by using the CLI.
Format: emergency or sos

or

Using the shortcut key. Format: F2

4.3. Bookmark a place: bookmark

Adds a bookmark tag to the specified place from the address book.
Format: bookmark INDEX

  • Bookmarks the place 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
    bookmark 1
    Bookmarks the first place in the address book.

  • find n/attractions
    bookmark 3
    Bookmarks the 3rd place in the results of the find command.

4.4. Clearing all bookmarks: clear_bookmark

Clears all bookmarks from the address book.
Format: clear_bookmark

4.5. Displaying Weather of Singapore

Display Weather of Singapore by typing in Command Line weather Format: weather

5. Changes in v1.3

5.1. Display the location of the place

Display the location of the place in Google Map by typing in Command 'goto' followed by the INDEX of the place.
Format: goto + INDEX (must be positive)
Examples: goto 1

6. Changes in v1.4

6.1. Allowing the tourist to just input 2 compulsory fields

Tourist can opt to leave Address, Email and Phone field empty when adding in new attraction.

For Example: * Instead of: add n/Marina Bay Sands ph/698837 /https://www.marinabay.com.sg a/10 Bayfront Avenue p/018956 * User to can key in: add n/Marina Bay Sands p/018956

If the user left as blank the default values are as follow:
- Phone: 000
- Address: -
- Website http://www.-.com

6.2. Get directions to selected destination

Displays the directions from location A to selected destination.
Format: dir [INDEX_FROM] [INDEX_TO]

  • Displays the location from INDEX_FROM to INDEX_TO. The index refers to the index number shown in the last place listing.

  • Both fields must be provided.

  • The index must be a positive integer >= 1 and within the range of the list shown

Examples:

  • dir 1 2
    Returns the directions from the location at index 1 to index 2 of the places listing.

  • dir 4 1
    Returns the directions from the location at index 4 to index 1 of the places listing.

6.3. Default list of places

Populated a default list of places for the user with 38 places.

7. Changes in v1.5rc

7.1. View current PSI

Displays the current PSI levels in Singapore.
Format: psi

ℹ️

  • The command is case sensitive

  • The command will ignore any other parameters after the command word.

  • It is also not an undoable command, hence the undo command will not work.

7.2. Tourist Book save files are now exportable to .csv format

Export your data to .csv file format for printing purposes. A data file TouristBookData.csv will be created in the same folder as the touristbook.jar.
Format: export

7.3. Tourist book save files can now be backed-up

Backup a copy of your data, addressbook-backup.xml, to the data folder.
Format: backup

ℹ️
 Running the command again if you already have a previous backup will overwrite the previous
backup file!

7.4. Display bookmarks: show_bookmark

List all bookmarked places in Tourist Book
Format: show_bookmark

7.5. Changed Email to Website

The previous versions had Email attached to place details, we changed it to Website to better align our product with the user needs.

7.6. Sort Command sort

Sort command allows you to sort the places in alphabetical order.
Format: sort

ℹ️

  • The sort command is temporary and does not permanently sort the places by alphabetical order.

  • The command is case sensitive

  • The command will ignore any other parameters after the command word.

8. Coming in v2.0

8.1. Changing the display color of a tag

Changes the color of a selected tag to a colour of choice.
Format: color /t TAG or col t/TAG

8.2. Common statutes/laws in Singapore

Display a list of common statutes/laws for quick reference.

8.3. Rating system

Add and edit a rating to a place in the Tourist Book.
Format: rate [INDEX] [RATING]

8.4. Exchange Rate

Get the latest exchange rates of currencies in Singaore.
Format: [VALUE] [CURRENCY] to [DESIRED_CURRENCY]

8.5. Description for places

Be able to view a short description of each place in the place list

9. 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 Tourist Book folder.

10. Command Summary

  • Add add n/NAME [a/ADDRESS] p/POSTALCODE [t/TAG]…​
    e.g. add n/Marina Bay Sands p/018956 or a n/Marina Bay Sands a/10 Bayfront Avenue p/018956 t/attractions

  • Bookmark : bookmark INDEX
    e.g. bookmark 2

  • Show Bookmarks : show_bookmark

  • Clear Bookmarks: clear_bookmark

  • Clear : confirm_clear

  • Delete : delete INDEX or del INDEX
    e.g. delete 3

  • Direction : dir INDEX_FROM INDEX_TO
    e.g dir 1 3

  • Edit : edit INDEX [n/NAME] [a/ADDRESS] [p/POSTALCODE] [t/TAG]…​
    e.g. edit 2 a/20 Bayfront Avenue t/bookmarks or `ed 2 a/20 Bayfront Avenue

  • Find : find [PREFIX]KEYWORD [MORE_KEYWORDS]
    e.g. find n/Bay Park or find t/outdoors

  • Go to : goto
    e.g. goto 2

  • List : list or l

  • Help : help or h

  • Weather : weather

  • Select : select INDEX or s
    e.g.select 2

  • History : history or hy

  • Undo : undo or un

  • Redo : redo or re

  • MRT Map : mrt

  • PSI Value : psi

  • Export : export

  • Backup : backup

  • Sort : sort

  • Useful Contacts : emergency or sos