Skip to content

Latest commit

 

History

History
467 lines (341 loc) · 12.9 KB

UserGuide.adoc

File metadata and controls

467 lines (341 loc) · 12.9 KB
Raw

Fashion Match - User Guide

By: CS2103-AY1819S2-W15-1 Since: Feb 2019 Licence: MIT

1. Introduction

Fashion Match (FM) is for those who prefer to use a desktop app for managing dresswear. More importantly, FM is optimized for those who prefer to work with a Command Line Interface (CLI). If you can type fast, AB4 can get your contact management tasks done faster than traditional GUI apps. Interested? Jump to the Section 2, “Quick Start” to get started. Enjoy!

2. Quick Start

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

  2. Download the latest main.jar here.

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

  4. Double-click the jar file to start FM. The GUI will appear shortly after.

    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 apparels

    • addn/Cool Tshirt c/Green t/Top : adds an apparel named Cool Tshirt to Fashion Match.

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

    • exit : exits Fashion Match

  7. Refer to Section 3, “Features” for details of each command.

3. Features

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/Formal Shirt.

  • Items in square brackets are optional e.g n/NAME [c/COLOR] can be used as n/Formal Shirt c/White or as n/Formal Shirt.

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

3.1. Viewing help : help

Format: help

3.2. Listing all apparels that matches the given option : list [OPTION] [OPTION-VALUE]

Shows a list of all apparels in FM that matches the given option.

Valid options:
all, top, bottom, belt, shoes, color

Format: list options List all valid list options.

Format: list all List all apparels.

Format: list top List all apparels of clothing type top.

Format: list bottom List all apparels of clothing type bottom.

Format: list belt List all apparels of clothing type belt.

Format: list shoes List all apparels of clothing type shoes.

Format: list color red List all red colored apparels.

3.3. Adding a piece of Apparel: add

Add a piece of apparel to wardrobe
Format: add n/NAME c/COLOR t/CLOTHINGTYPE

Examples:

  • add n/Zara Shirt c/Red t/Top

  • add n/Desigual Tailored Pants c/Grey t/Bottom

3.4. Sort all apparels that matches the given option : sort [OPTION]

Sort all apparels in the FM based on the option supplied.

Valid options:
name, color, type

Format: sort options
List all valid sorting options.

Format: sort [OPTION]
Sort all apparels according to the option supplied.

Example: sort the apparels by color
Format: sort color

3.5. Swap any two apparels : sort [INDEX_X] [INDEX_Y]

Swap the position of two apparels.

Format: swap 2 5
Swap the position for apparels at index 2 and 5.

3.6. Editing an apparel : edit

Edits an existing apparel in FM.
Format: edit INDEX [n/NAME] [c/COLOUR] [t/CLOTHINGTYPE]

  • Edits the apparel at the specified INDEX. The index refers to the index number shown in the displayed apparel list. 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.

Examples:

  • edit 1 n/TSHIRT c/ORANGE
    Edits the name and colour of the 1st apparel to be TSHIRT and Orange respectively.

  • edit 2 n/Brown Belt t/Belt
    Edits the name of the 2nd apparel to be Brown Belt and changes type to Belt.

3.7. Washing a piece of apparel : wash or available

Makes an existing listed apparel available.
Format: wash INDEX or available INDEX

  • Makes available the apparel at the specified INDEX.

  • Does not allow the user to clean an already clean apparel.

  • The index refers to the index number shown in the displayed apparel list.

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

  • Apparel will be made clean if it was worn before the command.

Examples:

  • wash 5
    Resets cleanliness status of the fifth apparel in the list if it was worn.

    washWornBefore
    washWornAfter

  • wash 5
    Does not allow cleaning if the fifth apparel in the list is already clean.

    washClean

3.8. Wearing a piece of apparel : wear or unavailable

Makes an existing apparel in FM worn and increases times worn by 1.
Format: wash INDEX or unavailable INDEX

  • Makes the apparel’s status worn at the specified INDEX. The index refers to the index number shown in the displayed apparel list.

  • Apparel will be made worn whether it was worn or clean before the command.

  • Feedback message gently advices you to not be a dirty bum if you wear a worn apparel even if its belts or shoes.

  • Random message guilting you for being dirty is shown to user.

  • Increases the 'Times Worn' counter by 1.

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

Examples:

  • wear 5
    Sets status of the fifth apparel in the list to 'Worn'. Increases its times worn by 1.

    wearCleanBefore
    wearCleanAfter

  • wear 5
    Sets status of the fifth apparel in the list to 'Worn' even if it’s already worn. Increases its times worn by 1. One of the seven random messages shown below.

    wearAgainBefore
    wearAgainAfter

3.9. Locating apparels by name: find

Finds apparels whose names contain any of the given keywords.
Format: find KEYWORD [MORE_KEYWORDS]

  • The search is case insensitive. e.g Zara will match zara

  • The order of the keywords does not matter. e.g. Nice Shirt will match Shirt Nice

  • Only the name is searched.

  • Only full words will be matched e.g. Nice will not match Nices

  • Apparels matching at least one keyword will be returned (i.e. OR search). e.g. Zara Uniqlo will return Zara Belt, Uniqlo shoes

Examples:

  • find Zara
    Returns zara and Zara

  • find Zara Uniqlo Shirt
    Returns any apparel having names Zara, Uniqlo or Shirt.

3.10. Deleting an apparel : delete

Deletes the specified apparel from FM.
Format: delete INDEX

  • Deletes the apparel at the specified INDEX.

  • The index refers to the index number shown in the displayed apparel list.

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

Examples:

  • list
    delete 2
    Deletes the 2nd apparel in FM.

  • find Uniqlo
    delete 1
    Deletes the 1st apparel in the results of the find command.

3.11. Selecting a apparel : select

Selects the apparel identified by the index number used in the displayed apparel list.
Format: select INDEX

  • Selects the apparel and loads a picture of the apparel at the specified INDEX.

  • The index refers to the index number shown in the displayed apparel list.

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

Examples:

  • list
    select 2
    Selects the 2nd apparel in FM.

  • find Uniqlo
    select 1
    Selects the 1st apparel in the results of the find command.

3.12. Listing entered commands : history

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

ℹ️

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

3.13. Undoing previous command : undo

Restores FM to the state before the previous undoable command was executed.
Format: undo

ℹ️

Undoable commands: those commands that modify the FM’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)

3.14. Redoing the previously undone command : redo

Reverses the most recent undo command.
Format: redo

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)

3.15. Clearing all entries : clear

Clears all entries from FM.
Format: clear

3.16. Recommend outfit : recommendation

Lists a recommended outfit based on what matches in your closet. The matching is done based on what colors match. The matching matrix is displayed below. Green means match and red means not match. The algorithm will search for a random outfit that meets the color requirements. The outfit must have a TOP, BOTTOM, SHOES. If a matching belt exists, an outfit may be recommended with a BELT.
Format: recommendation

3.17. Something color : something [COLOR]

CM

Returns random apparel of specified COLOR FM.
Format: something COLOR

  • Returns random apparel from specified COLOR.

  • The color refers to the color of apparel.

  • The color must be a one of RED, BLUE, GREEN, WHITE, BLACK, …​

Examples:

  • something RED
    Returns a RED apparel from FM.

  • something BLACK
    Returns a BLACK apparel from FM.

3.18. Random item type : random [TYPE]

Returns random specified TYPE of apparel from FM.
Format: random TYPE

  • Returns random apparel from specified TYPE.

  • The type refers to the type of apparel.

  • The type must be a one of TOP, BOTTOM, BELT, SHOES

Examples:

  • random TOP
    Returns a random TOP in FM.

  • random BOTTOM
    Returns a random BOTTOM in FM.

3.19. Calculating statistics : stats or statistics

Gives an overview of the various statistics of the apparels/wardrobe.
Format: stats or statistics

Typing stats or statistics will give you the following several information about your wardrobe:

  • Your favorite apparel

  • Your favorite color

  • Total number of apparel in wardrobe

  • Total number of different colored apparels

  • Your least favorite apparel (a reminder for you to wear them more often!)

  • How clean or dirty is your wardrobe

An example output is shown in the screenshot below:

stats

3.20. Exiting the program : exit

Exits the program.
Format: exit

3.21. Saving the data

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

4. Coming in v2.0

4.1. Know suitable apparels based on occasions

Fashion Match would be able to recommend suitable apparels based on whatever occasion the user is preparing for. For example, if the user is preparing for a formal event, FM will only recommend apparels that match the formal occasion.

4.2. Matched colors

Fashion Match would also be able to establish relations between certain colors so that it will not recommend conflicting colors.
Examples: red on red, yellow on yellow, etc

4.3. Save favourite apparels/outfits

Users would be able to save their favourite outfits or apparels so that they can quickly identify their favourite clothes for future use.

5. 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 FM folder.

6. Command Summary

  • Add add n/NAME c/COLOR t/CLOTHINGTYPE
    e.g. add n/Bright Tshirt c/Yellow t/Top

  • Clear : clear

  • Delete : delete INDEX
    e.g. delete 3

  • Edit : edit INDEX [n/NAME] [c/COLOR] [t/CLOTHINGTYPE]
    e.g. edit 2 n/Formal Belt c/Brown

  • Find : find KEYWORD [MORE_KEYWORDS]
    e.g. find Formal

  • History : history

  • Help : help

  • List : list [OPTION] [OPTION-VALUE]
    e.g. list top

  • Random : random TYPE
    e.g. random TOP

  • Redo : redo

  • Recommendation : recommendation

  • Select : select INDEX
    e.g. select 2

  • Something : something COLOR
    e.g. something RED

  • Sort : sort [OPTION]
    e.g. sort color

  • Swap : swap [INDEX_X] [INDEX_Y]
    e.g. swap 2 5

  • Stats : stats

  • Undo : undo

  • Wash : wash INDEX
    e.g. wash 1

  • Wear : wear INDEX
    e.g. wear 1