Skip to content

Latest commit

 

History

History
242 lines (180 loc) · 7.41 KB

UserGuide.adoc

File metadata and controls

242 lines (180 loc) · 7.41 KB

Xpire - User Guide

By: TeamXpire Since: Sep 2019 Licence: MIT

1. Introduction

Xpire is for those who prefer to use a desktop app for tracking expiry dates of items. More importantly, Xpire is optimised for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you have trouble tracking your items' expiry dates, Xpire can help you manage and notify you of items that are soon-expiring. Interested? Jump to the Section 2, “Quick Start” to get started!

2. Quick Start

  1. Ensure you have Java 11 or above installed in your Computer.

  2. Download the latest xpire.jar here.

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

  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:

    • view : views all items

    • check|20 : views items that is going to expire within the given number of days

    • add|Banana|25/9/2019 : adds an item named Banana with expiry date 25/9/2019 to list.

    • delete|3 : deletes the 3rd item shown in the current list

    • exit : exits the app

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

3. Features

Command Format

  • Words that are enclosed with < and > are the parameters to be supplied by the user e.g. in add|<item name>|<expiry date>, <item name> and <expiry date> are parameters which can be used as add|banana|25/09/2019.

  • Items in square brackets are optional e.g add|<item name>|<expiry date>|[#tag] can be used as add|strawberry|10/10/2019|#Fruit.

  • Items with …​ after them can be used multiple times including zero times e.g. tag|<index>|#tag…​ can be used as tag|1|#Fruit #Frozen #Cold, tag|1, or tag|1|#Fruit etc.

3.1. Viewing help : help

Format: help

3.2. Adding an item: add

Adds item to list
Format: add|<item name>|<expiry date>

Examples:

  • add|durian|30/9/2019

3.3. Listing all items : view

Shows all items in the list.
Format: view

3.4. Listing expiring items : check

Shows expiring items in the list.
Format: check|<days>

  • Lists items expiring within the specified number of <days>

  • Number of days must be a positive integer 1,2,3,..

Examples:

  • check|20
    Lists items expiring in the next 20 days.

3.5. Sorting all items : sort

Sorts all items in the list by either name or date.
Format: sort|<method>

  • Sorting by both name and date is done in ascending order.

  • For example, Apple will sort ahead of Banana, while 1/1/2000 will sort ahead of 1/1/2001.

Examples:

  • sort|name

  • sort|date

3.6. Searching item by name: search

Search items whose names contain any of the given keywords.
Format: search|<keyword>|[other keywords…​]

  • The search is case insensitive. e.g ham will match Ham

  • The order of the keywords does not matter. e.g. Turkey Ham|Apple will match Apple|Turkey Ham

  • Only the name is searched.

  • Partial words can also be matched e.g. Papa will match Papayas

  • Items matching at least one keyword will be returned (i.e. OR search). e.g. Apple|Pear will return Granny Smith Apple, Japanese Pear

Examples:

  • search|kebab
    Returns Chicken Kebab and kebab

  • search|milk|tea|pearls
    Returns any items containing the terms milk, tea, or pearls

3.7. Deleting an item : delete

Deletes the specified item from the list.
Format: delete|<index>

  • Deletes the item at the specified <index>.

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

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

Examples:

  • list
    delete|2
    Deletes the 2nd item in the list.

  • sort|name
    delete|3
    Deletes the 3rd item in the sorted list.

  • search|potato
    delete|1
    Deletes the 1st item in the results of the search command.

3.8. Tagging an item : tag

Tags an item from the list according to user input or clears item of tags.
Format: tag|<index>|#tag…​

  • Tags the item at the specified <index>.

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

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

  • If there are no valid tags (e.g. tag|<index>), item at the specified <index> will be cleared of its tags.

Examples:

  • list
    tag|2|#Nestle #Caffeine
    Tags the 2nd item in the list with #Nestle and #Caffeine.

  • search|potato
    tag|1
    Deletes all tags of the 1st item in the results of the search command.

3.9. Clearing all entries : clear

Clears all entries from the list.
Format: clear

3.10. Exiting the program : exit

Exits the program.
Format: exit

3.11. Saving the data

Items are saved in the hard disk automatically after any command that modifies the list.
There is no need to save manually.

4. 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 Xpire folder.

5. Command Summary

  • Add add|<item name>|<expiry date>
    e.g. add|durian|30/9/2019

  • Clear : clear

  • Delete : delete|<index>
    e.g. delete|3

  • List : list

  • Sort : sort|<method>+ e.g. sort|date

  • Search : search|<keyword>|[other keywords…​]
    e.g. search|milk|tea|pearls

  • Tag : tag|<index>|#tag…​

  • View : view

  • Check : check|<days>
    e.g. check|20

  • Help : help