Connoisseur User Guide

Table of Contents

1. Introduction

2. About this Guide

   2.1 What is in Connoisseur

   2.2 How to use this Guide

3. Quick start

4. Features

   4.1 Review Mode

         4.1.1 Add a Review

         4.1.2 List Reviews

         4.1.3 Sort Reviews

         4.1.4 View a Review

         4.1.5 Edit a Review

         4.1.6 Delete a Review

   4.2 Recommendation Mode

         4.2.1 Add a Recommendation

         4.2.2 List Recommendations

         4.2.3 Edit a Recommendation

         4.2.4 Delete a Recommendation

         4.2.5 Review a Recommendation

   4.3 View Help

   4.4 Exit and Save

5. Command Summary

6. FAQ

1. Introduction

Welcome to the user guide for our application, Connoisseur!

Connoisseur is a desktop application for managing and storing personal reviews on experiences and recommendations to try next. It is a revolutionary app that not only provides an organised user-friendly database, but provides customisable categories to enhance your experience. Through its intuitive command line interface, you will be able to store and access your reviews & recommendation easily!

2. About this Guide

This guide gives you an overview of the features in Connoisseur and shows you how to get started using Connoisseur. Simply click on any link in our Features list to get step-by-step instructions on how to use them.

2.1 What is in Connoisseur

In our Review mode, you can add a review about an experience, delete or edit a review, view the entire list of your reviews or if you want the full details, just view a particular review. You can also sort the list from the highest to the lowest rating, by category, title, earliest or latest date.

For our Recommendation mode, you can have a list of things you would like to try, the location and the approximate cost of the experience. Already tried out the experience? You can now move it to your review list and record your thoughts on the experience!

2.2 How to use this Guide

The following formats are used in this document:

• A highlight (called a mark-up) indicates a keyword. It is often used to indicate i) a field or command that can be typed into the command line and executed by Connoisseur; or ii) the prompts displayed by Connoisseur.
  e.g.list [SORTING METHOD]
• Words in UPPER CASE in square bracket [USER INPUT] are the fields to be supplied by the user.
  e.g. in list [SORTING METHOD] SORTING METHOD is the field input by the user and examples of valid commands are:list rating,list title etc.
• Word in lower case are given commands.
  e.g. in new [quick | full] the user can input either the command new quickor new full
• ❗ symbol will be followed by additional information to take note of for that section.
• A light blue font color indicates a Hyperlink that you can click on and be transferred to the corresponding section in Connoisseur.
  e.g. How to use this Guide

3. Quick Start

If you are tired of lengthy and problematic installation processes, Connoisseur is perfect for you. The setup is minimal and can be completed in a few simple steps. Follow the instructions below to try it out!

1. Ensure that you have Java 11 or above installed. The latest version of Java can be found here

2. Download the latest version of Connoisseur from here. To do so, look for the file CS2113T-F08-3.Connoisseur.jar and click on it. Please refer to Figure 1 if you require assistance with locating the file. Figure 1 shows how to download version 2.1 of Connoisseur. CS2113T-F08-3.Connoisseur.jar has been highlighted in red for your convenience.
   

   Figure 1. How to download Connoisseur

3. Copy the file to the folder you want to use as the home folder for Connoisseur

   

   Figure 2. Copying connoisseur.jar into a folder

4. Open terminal and navigate to the directory of the folder you just copied into.

5. In your terminal, type java -jar CS2113T-F08-3.Connoisseur.jar and press enter. This should start Connoisseur.

   

   Figure 3. Starting Connoisseur

6. You may now use Connoisseur by typing in commands and pressing Enter to execute it. Refer to the Command summary for a list of recognised commands.
7. You should notice a new data folder created in the home folder you have chosen in step 3 The data for Connoisseur is saved in connoisseur.json in the data folder.

4. Features

This section covers all the commands that you can type into the Command Box of Connoisseur when it prompts you - Please enter a command:

The commands are categorised into the two modes offered by Connoisseur, Review and Recommendation mode. If it is the first time that you are using the commands, we recommend that you refer to How to use the Guide to better interpret the format of the commands.

4.1 Review Mode

Connoisseur is in Review mode by default. In this mode you can maintain a list of reviews of experiences of any category. The review mode can be accessed using the review command as shown in the figure below.

Figure 4. Entering 'Review' mode

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ This command is case-insensitive.

4.1.1 Add a Review

This feature allows you to add a new review. There is a choice of quick review or full review.

Command: add [quick | full], new [quick | full]
[quick | full] Optional arguments to specify quick or full review.

❗ Connoisseur will ignore extra blank spaces that are typed in between the two words in the command.

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

If quick review is specified, Connoisseur will then prompt you to enter the title, category and rating of the review, as shows in Figure 5.

Figure 5. Adding a quick review

If full review is specified, there is an additional prompt to input description of the experience as shown in Figure 6

Figure 6. Adding a full review

If you do not specify [quick | full] and simply input the command: add or new, Connoisseur will ask you to specify if you would like to input a quick review. Input the command: y for quick review or n for full review as shown in Figure 7.

Figure 7. Adding a quick or full review

❗ Ensure the rating is an integer whole number from 0 to 5. Inputting -0 is treated as 0. If you input an invalid number Connoisseur will prompt you until a valid number is input.

❗ Ensure the title of the review added is unique and does not already exist in the list. Connoisseur checks for duplicate by comparing spelling, and the number of blank spaces in between words in the title. Refer to table 1 below for examples. If you attempt to add a pre-existing review title, Connoisseur will prompt you of the existence of duplicate in the list and ask you to enter a unique title.

Table 1. Guidelines on duplicate and unique title

4.1.2 List Reviews

This feature allows you to view a list of all your reviews. You can specify a one-off sorting method by which to sort the reviews.

Command: list [SORTING METHOD]

[SORTING METHOD] (optional argument) temporary sort method by which to sort the reviews. Leaving this blank would allow Connoisseur to use the saved sort method (refer to 4.1.3) as shown in Figure 8. Currently, supported methods are:

• title
• category
• rating
• earliest
• latest

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ For usage, Connoisseur commands are case insensitive.
For example, list is equivalent to LiSt.

❗ Connoisseur will ignore extra blank spaces that are typed in between the two words in the command.

Figure 8. Listing reviews

❗ Some terminals may not support the ★ and ✰ symbols. So if you face the error as shown in Figure 9a or in Figure 9b, where the ratings and partitions are not displayed correctly, input the command display asterisks as shown in Figure 10. The error should be resolved, and the ratings will now be displayed using * symbol instead. To switch back to displaying ★ and ✰ symbols input the command display stars

Figure 9a. ★ and ✰ symbols not displayed

Figure 9b. Partitions misaligned

Figure 10. Display asterisks command

❗ The command ‘display’ is case-insensitive. On the other hand, when inputting display method (either ‘asterisks’ or ‘stars’) ensure it is in lower case.

❗ Connoisseur will ignore extra blank spaces that are typed in between the two words in the command.

4.1.3 Sort Reviews

This feature allows you to change the saved sorting method as shows in Figure 11.

Command: sort [SORTING METHOD]

[SORTING METHOD] Sort method to be used. Default sorting method is latest. Refer above for

a list of recognised sorting methods.

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ The command ‘sort’ is case-insensitive. On the other hand, when inputting sorting method ensure it is in lower case.

Figure 11. Changing sorting method to title

❗ Ensure you do not enter a sorting method that does not exist. Otherwise Connoisseur will warn you that with an invalid sorting method message.

4.1.4 View a Review

This feature allows you to view all the details of the specified review as shown in Figure 12.

Command: view [TITLE_OF_REVIEW]

[TITLE_OF_REVIEW] Title of review that you want to view.

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ The command ‘view’ is case-insensitive.

❗ Connoisseur will ignore extra blank spaces that are typed in between the ‘view’ and ‘TITLE_OF_REVIEW’ in the command.

Figure 12. Viewing a review

❗ Ensure the title of the review you want to view already exists in your lists of reviews. Otherwise, Connoisseur will prompt you saying that no such review exits. When typing the title you want to view, ensure spelling, and the number of blank spaces in between words is the same as the title in the list.

❗ When adding a review, if you did not put in a description for it, the text “Invalid command. Please do not enter extra parameters or less parameters than required.” will appear when viewing the review.

4.1.5 Edit a Review

This feature allows you to make edits to the Title / Category / Rating / Description of the review in your list.

Command : edit [TITLE_OF_REVIEW]

[TITLE_OF_REVIEW] Title of review that you want to edit.

❗ Ensure the title of the review you want to edit already exists in your lists of reviews. Otherwise, Connoisseur will prompt you saying that no such review exits. When typing the title you want to edit, ensure spelling and the number of blank spaces in between words is the same as the title in the list.

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ The command ‘edit’ is case-insensitive.

❗ Connoisseur will ignore extra blank spaces are typed in between the ‘edit’ and ‘TITLE_OF_REVIEW’ in the command.

As shown in Figure 13 below, Connoisseur will prompt you asking whether you would like to make changes to Title / Category / Rating / Description. Input either Title,Category, Rating or Description.

❗ These inputs are case-insensitive and Connoisseur will ignore black spaces typed before or after the inputs.

❗ When editing the title, Connoisseur will check for duplicates in the review list. If the changes made is a duplicate, Connoisseur will prompt you to enter a unique title.

If you would like to continue to make edits to the review, input y. Otherwise, input n.

Before exiting the edit feature, you have the option to update the date of entry to reflect the date and timing in which the edit was made. Input y if you would like to do so. Otherwise, inputn.

❗ Inputs ‘y’ and ‘n’ are case-insensitive and Connoisseur will ignore blank spaces before or after the command.

Figure 13. Editing a review

4.1.6 Delete a Review

This feature allows you to delete a review from your list as shown in Figure 14.

Command: delete [TITLE_OF_REVIEW]

[TITLE_OF_REVIEW] Title of review that you want to delete.

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ The command ‘delete’ is case-insensitive.

❗ Connoisseur will ignore extra blank spaces that are typed in between the ‘delete’ and ‘TITLE_OF_REVIEW’ in the command.

Figure 14. Deleting a review

❗ Ensure the title of the review you want to delete already exists in your lists of reviews. Otherwise, Connoisseur will prompt you saying that no such review exits. When typing the title you want to delete, ensure spelling and the number of blank spaces in between words is the same as the title in the list.

4.2 Recommendation Mode

Connoisseur is in Review mode by default. The Recommendation mode can be accessed using the reco command when Connoisseur prompts - Please enter a command: as shown in Figure 15. In this mode you can maintain a list of recommendation of experiences you would like to try in the future. To go back to Review mode, you can use the review command.

❗ This command is case-insensitive.

Figure 15. Switching between review and recommendation mode

4.2.1 Add a Recommendation

This feature allows you to add a new recommendation.

Command: add or new

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ Commands ‘add’ and ‘new’ are case-insensitive.

Connoisseur will then prompt you to enter the title, category, price range of recommendation, recommended by and where it is located at as shown in Figure 16.

Figure 16. Adding a recommendation

❗Price range should be numbers up to 2 decimal places between 0.00 to 9999.99 and separated by ‘-‘. If you input more than 2 decimal places, Connoisseur will round up to the nearest 2 decimal places. Your input will be rejected if it is out of range after rounding.

❗ Ensure the title of the recommendation added is unique and does not already exist in the list. Connoisseur checks for duplicate by comparing spelling, and the number of blank spaces in between words in the title. Refer to table 1 in section 4.1.1 for examples. If you attempt to add a pre-existing recommendation title, Connoisseur will prompt you of the existence of duplicate in the list and ask you to enter a unique title.

❗ If you try to add a Recommendation title that already exists in your Review list, Connoisseur will warn you. Perhaps you had forgotten that you have already experienced and reviewed the item in the past! Not to worry, Connoisseur will ask you if you want to exit adding a recommendation. Input y to exit. Input n to continue adding a recommendation.

4.2.2 List Recommendations

This feature allows you to view a list of all your recommendations as shown in Figure 17.

Command: list

Figure 17. Listing recommendations

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ ‘list’ command is case-insensitive.

4.2.3 Edit a Recommendation

This feature allows you to make edits to the Title/ Category/ Price range/ Location/ Recommended By of the recommendation in your list.

Command : edit [TITLE_OF_RECOMMENDATION]

[TITLE_OF_RECOMMENDATION] Title of recommendation that you want to edit.

❗Ensure the title of the recommendation you want to edit already exists in your lists of recommendations. Otherwise, Connoisseur will prompt you saying that no such recommendation exists. When typing the title you want to edit, ensure spelling and the number of blank spaces in between words is the same as the title in the list.

❗ The command ‘edit’ is case-insensitive.

❗ Connoisseur will ignore the extra blank spaces typed in between the ‘edit’ and ‘TITLE_OF_RECOMMENDATION’ in the command.

As shown in Figure 18 below, Connoisseur will prompt you asking which field you would like to edit. Input either Title,Category, Price range,Location or RecBy.

❗ These inputs are case-insensitive and Connoisseur will ignore black spaces typed before or after the inputs.

❗ When editing the title, Connoisseur will check for duplicates in the review list. If the changes made to the recommendation title is a duplicate and already exists in the review list, Connoisseur will prompt you to enter a unique title.

If you would like to continue to make edits to the recommendation, input y. Otherwise, input n.

❗ Inputs ‘y’ and ‘n’ are case-insensitive and Connoisseur will ignore any extra blank spaces typed.

Figure 18. Editing recommendations

4.2.4 Delete a Recommendation

This feature allows you to delete a recommendation from your list as shown in Figure 19.

Command: delete [TITLE_OF_RECOMMENDATION]

[TITLE_OF_RECOMMENDATION] Title of recommendation that you want to delete.

Figure 19. Deleting a recommendation

❗Ensure the title of the recommendation you want to delete already exists in your lists of recommendations. Otherwise, Connoisseur will prompt you saying that no such recommendation exits. When typing the title you want to delete, ensure spelling and the number of blank spaces in between words is the same as the title in the list.

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ The command ‘delete’ is case-insensitive.

❗ Connoisseur will ignore extra blank spaces that are typed in between the ‘delete’ and ‘TITLE_OF_RECOMMENDATION’ in the command.

4.2.5 Review a Recommendation

This feature allows you to review an item in the recommendation list once you have tried it and transfer it to the review list.

Command: done [TITLE_OF_RECOMMENDATION]

As shown in Figure 20, Connoisseur will prompt you to rate the experience out of 5. You can also add in a description by inputting y or n otherwise. Figure 20 shows that the title ‘Tipo Pasta’ has been successfully transferred from recommendation to review list.

❗Ensure the title of the recommendation you want to review already exists in your lists of recommendations. Otherwise, Connoisseur will prompt you saying that no such recommendation exits. When typing the title you want to review, ensure spelling and the number of blank spaces in between words is the same as the title in the recommendation list.

❗ Connoisseur will ignore extra blank spaces that are typed before or after the command.

❗ The command ‘done’ is case-insensitive.

❗ Connoisseur will ignore extra blank spaces that are typed in between the ‘done’ and ‘TITLE_OF_RECOMMENDATION’ in the command.

Figure 20. Reviewing a recommendation

4.3 View Help

Command: help[COMMAND_NAME] eg. help reco help list etc.

If you encounter any issues using Connoisseur simply key in help for a generic help message as show in Figure 21.

Figure 21. Generic help message

If you want help with a specific command simple key in help followed by the [COMMAND_NAME] as show in Figure 22.

Figure 22. Help message for commands

❗ The command ‘help’ is case-insensitive. On the other hand, when inputting command name ensure it is in lower case.

4.4 Exit and Save Connoisseur

This feature allows you to exit Connoisseur. All you reviews and recommendations are automatically stored in connoisseur.json in the data folder as shown in Figure 23.

Command: exit or bye

Figure 23. Exiting Connoisseur

❗ The commands are case-insensitive.

5. Command Summary

Action	Command	Examples
Enter Review Mode	review	review
Add a Review	add [quick | full] new[quick | full]	add new add quick new full
List Reviews	list [SORTING_METHOD]	list list title
Display ratings using Asterisks	display [stars | asterisks]	display asterisks
View Current Sorting Method	sort	sort
Change Sorting Method	sort [SORTING_METHOD]	sort title
View a Review	view [TITLE_OF_REVIEW]	view Captain America
Edit a Review	edit [TITLE_OF_REVIEW]	edit Armageddon
Delete a Review	delete [TITLE_OF_REVIEW]	delete Armageddon 2
Enter Recommendation Mode	reco	reco
Add a Recommendation	add new	add new
List Recommendations	list	list
Edit a Recommendation	edit [TITLE_OF_RECOMMENDATION]	edit Tipo Pasta
Delete a Recommendation	delete [TITLE_OF_RECOMMENDATION]	delete Armageddon 3
Review a Recommendation	done [TITLE_OF_RECOMMENDATION]	done Universal Studios
Help for General usage	help	help
Help for a Specific function	help [COMMAND_NAME]	help reco help list
Exit & Save	exit bye	exit bye

6. FAQ

Q: How do I transfer my data to another computer?

A: Simply move the jar file and data/connoisseur.json into the same directory.