Skip to content

Latest commit

 

History

History
185 lines (157 loc) · 7.05 KB

UserGuide.md

File metadata and controls

185 lines (157 loc) · 7.05 KB

User Guide

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 taryapp.jar from the releases tab.
  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.

  1. 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.
  2. Some example commands you can try:
    • list : lists all tasks to be done
    • add add Visit Dentist d/18-11-2016 a/Mount Elizabeth : adds a task named Visit Dentist to the Task List.
    • delete 3 : deletes the 3rd task shown in the current list
    • exit : exits the app
  3. Refer to the 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. * The order of parameters is fixed.


Viewing help : help

Format: help

  • Help is also shown if you enter an incorrect command e.g. abcd


Adding a person: add

Format: add NAME [a/LOCATION s/START_DATE d/DEADLINE_OR_END_DATE p/PRIORITY t/TAGS]

  • Adds a task to the task list in a flexible format (in any order).
  • All parameters except name are optional.
  • This command supports 3 types of tasks: floating tasks, event tasks and deadline tasks.
  • Persons can have any number of tags (including 0)

Examples: * Floating task: `add Visit Dentist` * Event task: `add hackathon a/NUS s/tomorrow d/sunday p/3 t/preparation` * Deadline task: `add submit tutorial d/monday p/5`

Field Type Constraints

  • Task duedate or startdate is formatted like the following: Wed Nov 02 15:39:55 UTC 2016
  • Accepted formal dates: 1978-01-28, 1984/04/02, 1/02/1980, 2/28/79
  • Relaxed dates: The 31st of April in the year 2008, Fri, 21 Nov 1997, Jan 21, '97, Sun, Nov 21, jan 1st, february twenty-eighth
  • Relative dates: next thursday, last wednesday, today, tomorrow, yesterday, next week, next month, next year, 3 days from * now, three weeks ago
  • Prefixes: day after, the day before, the monday after, the monday before, 2 fridays before, 4 tuesdays after
  • Time: 0600h, 06:00 hours, 6pm, 5:30 a.m., 5, 12:59, 23:59, 8p, noon, afternoon, midnight
  • Relative times: 10 seconds ago, in 5 minutes, 4 minutes from now.


Mark task as done : done

Format: done INDEX Marks a task as done by the index displayed on the task panel.

  • tasks marked as done can be shown when using command 'list done'
  • once marked as done, cannot be undone unless using undone command immediately


Edit task by attributes: edit

Format: edit INDEX [NEW_NAME] FIELD_TYPE/NEW_FIELD_DETAILS Edits a task as done by the index displayed on the task panel.

  • to change the name only, use edit NEW_NAME without specifying field type
  • able to accept multiple field types e.g. edit 2 taskA a/NUS d/friday


Undo previous command: undo

Format: undo Undo the last command.

  • multiple undos supported.


Listing all tasks : list

Format: list [done] Shows a list of all tasks done or not done in the task list.

  • list shows all tasks not done
  • list done shows all tasks done


Finding all tasks containing any keyword in their name or attributes: find

Format: find [FIELD_TYPE] KEYWORD Finds tasks whose descriptions contain any of the given keyword.

  • The search is case sensitive. e.g hmk will not match HMK
  • The order of the keywords does not matter. e.g. Do Homework will match Homework Do
  • If field type is specified, only the field type will be matched with the keyword
  • If field type is not specified, name will be search for a match first, before searching all the other fields for the keyword.
  • Only full words will be matched e.g. Hmk will not match Hmks
  • Tasks matching at least one keyword will be returned (i.e. OR search). e.g. Hmk will match Do Hmk

Examples:

  • find p/3 : Returns any task that has priority 3
  • find a/NUS : Returns any task that occurs in NUS
  • find homework: Returns task with homework in the name, if not found, returns tasks with homework in other fields such as tags


Deleting a task : delete

Deletes the specified task from the address book. Irreversible.
Format: delete INDEX

Deletes the task 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 task in the task list.
  • find CS2101
    delete 1
    Deletes the 1st task 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 Maps for location of the task 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 task in the task list.
  • find a/NUS
    select 1
    Selects the 1st task in the results of the find command.


Clearing all entries : clear

Clears all entries from the task list.
Format: clear


Change file path of storage : setPath

Change the path of the task list to be stored to the specified file path.
Format: setPath NEW_PATH Example:

  • setPath data/newfilepath.xml


Exiting the program : exit

Exits the program.
Format: exit



Saving the data

Task List 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 Tasks folder.

Command Summary

Command Format
Add add NAME [s/startdate d/duedate a/address p/priorityrank(1- highest,5-lowest) t/TAG]...
Edit edit INDEX [NEW_NAME] FIELD_TYPE/NEW_FIELD_DETAILS where FIELD_TYPE is either d/ a/ s/ p/
Done done INDEX
Clear clear
Delete delete INDEX
Find find [FIELD_TYPE] KEYWORD FIELD_TYPE options: t/ a/ s/ d/ p/
List list [done]
Help help
Select select INDEX
SetPath setPath NEW_FILE_PATH NEW_FILE_PATH: e.g. data/newfile.xml
Exit exit