DoIt User Guide

Table of Contents

1. Introduction
   • 1.1 About DoIt
   • 1.2 Terminologies Used
2. Getting Started
3. Quick Start
   • Visual Walkthrough
4. Features
   • Command Format
   • 4.1 Getting Help
   • 4.2 Adding an Task
   • 4.3 Undoing a Command
   • 4.4 Redoing an Undone Command
   • 4.5 Editing an Task
   • 4.6 Finding an Task
   • 4.7 Viewing All Uncompleted Tasks
   • 4.8 Marking Task as Done
   • 4.9 Viewing Completed Tasks
   • 4.10 Marking Tasks as Uncompleted
   • 4.11 Delete an Task
   • 4.12 Clear All Tasks
   • 4.13 Sorting The Tasks
   • 4.14 Setting a Customized Command Word
   • 4.15 Saving to New Location
   • 4.16 Loading of Existing data
   • 4.17 Exiting The Program
   • 4.18 Saving at Local file
   • 4.19 Using Input Stack
5. FAQ
6. Command Summary

1. Introduction

1.1 About DoIt

Do you have problem organising your life? Stop procrastinating and use DoIt !!!

DoIt is a personal task management software that helps you to organise your task by providing an overview of the different tasks that you may have at a glance

DoIt is simple to use as all functions can be executed with just a single line of command meaning that you will only need a keyboard to fully navigate this software

1.2 Terminologies Used

Here are some terminologies used in this user guide:

• Task: A task to be done that has a deadline
• Event: An type of task that has a start and end time
• Floating Task: A task to be done that has no deadline
• GUI : Graphical User Interface

2. Getting Started

• Ensure that you have Java version 1.8.0_121 or later installed on your computer
  

  Just having any Java 8 version is not enough
  DoIt will not work with earlier versions of Java 8.
  You can download the latest version of Java 8 at http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html

• Download the latest DoIt.jar from the releases tab
• Copy DoIt.jar to a folder as the home folder for DoIt
• To launch the DoIt application, double-click on DoIt.jar
• The main interface should appear as shown in figure 1 in a few seconds

Figure 1 : Main GUI

3. Quick Start

Visual Walkthrough

1. Figure 2 shows DoIt with a few tasks added
   Figure 2 : Example of a GUI Instance
   

2. DoIt has 3 columns “Deadline”, “Event” and “Anytime”
   • The “Deadline” Column shows you tasks which have to be completed by a certain deadline
   • The “Event” Column shows you events that take place between a certain time period
   • The “Anytime” Column shows you floating tasks which can be completed anytime

3. You can type a command in the command box at the bottom and press Enter to execute it
   e.g. typing help and pressing Enter will open the help window

4. Here are some sample commands that you may try:
   • help : Displays help prompt

   • add completeUserGuide e/28-Feb-2017 23:59 d/description p/high #Important

     Adds a task named completeUserGuide to the task manager

   • delete3 : Deletes the third task shown in the UI
   • help : Displays help prompt
   • exit : Exits the app
5. You can refer to the Features section below for the details of each command
   

4. Features

Command Format

Syntax used to differentiate command types:

• Words in Bold are the commands
• Words in UPPER_CASE are the parameters which are values passed to a command
• Words in [SQUARE_BRACKETS] are optional parameters
• Words with ... after them can have multiple instances
• Parameters & optional parameters can be in any order
• Commands must be at the start and they are case-insensitive

4.1 Getting Help : help

Not sure where to start? Enter help to view the help window as shown in Figure 3 below:

Figure 3: Help window popup

Format: help Keyboard Shortcut: [F1]

• Help window shows the command summary for all feature. This is so that you can easily pick up the tools you need to use DoIt
  

4.2 Adding an task: add

If you have an task you want DoIt to track, add it! Enter add into the command box followed by the relevant parameters. You can refer below for the correct format of the parameters

Format: add NAME [s/STARTTIME] [e/ENDTIME] [d/DESCRIPTION] [p/PRIORITY] [t/TAG]...

• OnlyNAME that is not in DoIt can be added so you will not be confused with similar names
  
• NAME is a compulsory parameter
  
• [s/STARTTIME], [e/ENDTIME], [d/DESCRIPTION], [p/PRIORITY] and [t/TAG] are optional parameters
  
• Tasks without both STARTTIME and ENDTIME specified are considered as floating tasks. They will be add under the “Anytime” list
  
• Tasks with ENDTIME specified without specifying STARTTIME are considered tasks. They will be added under the “Deadline” list
  
• Tasks with both STARTTIME and ENDTIME or only STARTTIME specified are considered as events. They will be added under the “Event” list
  
• Priority only has 3 types: low, med, high
  
• Tasks with no PRIORITY are by default set to low
  
• You will be no ENDTIME allocated for events without specified ENDTIME so you can add your own end time at a later time
  
• The optional parameters s/ e/ d/ p/ and t/ can be in any order e.g. add NAME [e/ENDTIME] [s/STARTTIME] [p/PRIORITY] [d/DESCRIPTION] e.g. add NAME [t/TAG1] [e/ENDTIME] [d/DESCRIPTION] [s/STARTTIME] [t/TAG2]
  
• Only NAME must be right after the add

Examples:

• If you wish to add a task that can be done anytime such learning to speak a new language:
  • addLearn to speak a new language
    
• If you wish to add a task that must be completed before a deadline such as submitting a progress report by tomorrow:
  • addSubmit progress report e/tomorrow
    
• If you wish to add a task that starts and end at a specified time such as a compulsory staff meeting on the 28 Feb from 1300 to 1500:
  • addStaff meeting s/28-Feb-2017 13:00 e/28-Feb-2017 15:00
    

4.3 Undoing the Previous Commands : undo

Made a mistake? No worries, you can undo your previous commands up to 10 times by typing undo into the command box

Format: undo Keyboard Shortcut: [Control-Z]

• You can undo a number of commands that is allowed (e.g. 3 commands) by typing undo that number of times (e.g. 3 times)
  
• Commands that can be undone are add, delete, edit, clear and done

4.4 Redoing the Undone Commands : redo

Want to redo what you have undone? Fear not as you can redo what you have previously undone up multiple times by typing redo into the command box
Format: redo Keyboard Shortcut: [Control-Y]

• You can redo a number of commands that is undone (e.g. 3 commands) by typing redo that number of times (e.g. 3 times)
  
• Commands that can be redone are only those undone previously without other commands
  
• If you used non-undo commands just before redo, you will not be able to redo
  

4.5 Editing an task : edit

Want to edit an existing task? Well you can do so by typing edit followed by the task index number into the command box

Format: editINDEX [NAME] [s/STARTTIME] [e/ENDTIME] [d/DESCRIPTION] [p/PRIORITY] [t/TAG]...

• Edits the task at the specified INDEX.
  
• The index refers to the index number as displayed in the current UI
  
• The index must be a positive integer 1, 2, 3, …
  
• At least one of the optional fields must be provided
  
• [NAME] might be optional but it must be the first parameter if it is present as it did not have any prefix
  
• Existing values will be updated to the input values
  
• When editing tags, the existing tags of the task will be removed i.e adding of tags is not cumulative
  
• You can delete the field of a parameter by specifying the parameter syntax without anything behind it
  
• You can remove all the task’s tags by typing t/ without specifying any tags after it
  

Examples:

• If you want to edits the end time ,priority and tag of the first task to be 9pm , high and #CS1010 respectively while deleting the description
  • edit1 e/9pm p/high t/CS1010 d/
    
• If you want to edits the second task’s deadline to 9pm and priority to high and clears all existing tags
  
  • edit2 e/9pm p/high t/
    
• • If you want to edits the name of the second task to CS2100 Homework
    
    • edit2 CS2100 Homework
      

4.6 Finding all tasks Containing any Keywords in Their Names, Priority, Description and Tags: find

Need to find a specific task? Use the find command to get what you are looking for. Just type find followed by a keyword into the command box

Format: find[n/NAME...][s/STARTTIME...][e/ENDTIME...][p/PRIORITY...][d/DESCRIPTION...][t/TAG...]

• The search is case in-sensitive for NAME and DESCRIPTION only e.g cs1231 will match CS1231
  
• Only the task name is searched
  
• Only full words will be matched e.g. CS2103T will not match CS2103
  
• KEYWORD can be names, priority, description or tags
  
• When you find NAME..., DESCRIPTION... and TAG..., tasks matching all keywords will be returned (i.e. AND search) e.g. n/Test will match tasks with the nameMidterm Test and Final Test e.g. n/Test Midterm will match task with the nameMidterm Test e.g. n/Test Midterm will not match task with the nameMidterm e.g. n/Test Midterm will not match task with the nameTest
  
• When you find STARTTIME..., ENDTIME... and PRIORITY... tasks matching one of the keywords will be returned (i.e. OR search) e.g. p/high low will match task with priority high e.g. p/high low will match task with priority low e.g. s/13:00 14:00 will match task with start time04/07/2020 13:00
  
• STARTTIME and ENDTIME must use the DD/MM/YYYY format for dates and HH:MM for time
  

Examples:

• If you wish to find tasks with low priority:
  • findp/high
    
  • UI will display tasks having low priority
    
• If you wish to find all tasks with descriptions containing Meeting;
  • findd/Meeting
    
  • UI will display tasks having descriptions containing Meeting
    
• If you wish to find all tasks with names containing Staff Meeting;
  • findn/Staff Meeting
    
  • UI will only display tasks having names containing both Staff and Meeting
    
• If you wish to find all tasks named Report and tags containing urgent
  • findn/Report t/urgent
    
  • UI will display tasks that contain Report in their name and have the urgent tag
    

4.7 Viewing all uncompleted tasks: list

Want to see all the tasks you have yet to complete? Simply type list to clear all find filters

Format: list

4.8 Marking specified tasks from DoIt as completed: mark

Completed a task? Celebrate by marking it as done on DoIt by typing mark followed by the task index into the command box

Format: markINDEX

• Marks the task at the specified INDEX as completed
  
• The index refers to the index number of the task shown in the currently displayed UI
• The index must be a positive integer 1, 2, 3, …
  

Examples:

• If you have filed your taxes which happens to be the second task on the list:
  • mark2
  • The second task in the UI will be marked as completed and will disappear
    
• You can also perform command operations after a find command. In this case:
  • findMA1521
    
  • mark1
    
  • The first task in the results of the find command will be marked as completed

4.9 Viewing completed tasks: done

Sometimes it’s good to look back on our past achievements. This can be accomplished by typing done into the command box

Format: done

4.10 Marking tasks as uncompleted: unmark

Want to mark a completed task as uncompleted? First display all completed task using done and type unmark followed by the task index displayed into the command box

Format: unmarkINDEX

• Marks the task at the specified INDEX as uncompleted
  
• The index refers to the index number of the task shown in the currently displayed UI
• The index must be a positive integer 1, 2, 3, …
  

Examples:

• If you have submitted an assignment but was asked to redo it and it happens to be the second task in the display:
  • done
  • unmark2
  • The second task in the UI will be marked as uncompleted
    

4.11 Deleting specified tasks from DoIt: delete

Have an task that is not needed anymore? Delete it from DoIt by typing delete followed by the task indexes or range of index into the command box

Format: deleteINDEX... and deleteSTARTINDEX-ENDINDEX

• Deletes the task at the specified INDEX
  
• The index refers to the index number shown in the currently displayed UI
  
• The index must be a positive integer 1, 2, 3, …
  
• The range of STARTINDEX and ENDINDEX must be displayed
  

Examples:

• If your meeting was cancelled which happens to be the second task on the UI
  • delete2
    
  • The second task displayed in the UI will be deleted
    
• If you want to clear up today’s events which happens to be the from the index 1 to 5 task on the UI
  • delete1-5
    
  • delete1 2 3 4 5
    
  • The first to fifth tasks displayed in the UI will be deleted
    
• You can also perform command operations after a find command. In this case:
  • findMA1521 Tutorial 1
    
  • delete1
    
  • The first task in the result of thefind command will be deleted
    

4.12 Clearing all entries : clear

Want to start afresh? Type clear into the command box to erase all entries from DoIt

Format: clear

CAUTION: YOU WILL NOT BE ABLE TO UNDO THIS ACTION IF YOU CLOSE THE APP

4.13 Sorting tasks by name, priority, start time or end time : sort

Want to control what you see first in the list? You can do so by sorting through priority, deadline or start time
Format: sortSORT_CHOICE

• SORT_CHOICE includes name, priority, end time or start time
  
• The tasks will be sorted lexicographically if they are similar in your sorting choice
  

Examples:

• To sort the tasks by name:
  
  • sortname
    
• To sort the tasks by priority:
  
  • sortpriority
    
• To sort the tasks by start time:
  
  • sortstart time
    
• To sort the tasks by end time:
  
  • sortend time
    

4.14 Setting a customized command word : set

Want to set your own command shortcuts? DoIt allows this by typing set into the command box followed by the old command and the new command to reference it
Format: setOLD_COMMAND NEW_COMMAND

Default commands are not deleted when you set a new command Default commands refer to those in section 4.1 to 4.15 of this user guide OLD_COMMAND can be default commands or commands you have set previously NEW_COMMAND set will all be converted to lower case this is to allow all commands to be case-insensitive.

Examples

• To set a shortcut for delete:
  
  • setdelete Del
  • Del will be converted to del
  • This allows del to be used in the future as a delete command
  • Since commands are case-insensitive DEL can also be used as a delete command
• To set another shortcut for delete:
  
  • setdel -
  • This allows - to be used in the future as a delete command if you find the previous delete command del still too long to your liking

4.15 Specifying the filename and location for data saving : save

Saves the data into a specified filename and location

Format: saveFILE_PATH/FILE_NAME.xml

• Saves the data file with your own file name in the layers of folder you declare yourself
  
• Saved file must be of type xml. Hence, it must end with .xml
  
• / can be replaced with \
• Saved file location will be limited in the DoIt Application folder if the full directory is not used
  
• Saved file location can be outside of the DoIt Application folder if you used the full directory path name forFILE_PATH

Examples:

• To change the save location to a file called savefile.xml at C:\Users\USER\Desktop:
  
  • saveC:\Users\USER\Desktop\savefile.xml
    
• To save the data file in a file named savefile.xml in the DoIt Application folder:
  
  • savesavefile.xml
    

4.16 Loading of data from the specified the file: load

Loads the data from specified filename and location

Format: loadFILE_PATH/FILE_NAME.xml

• Loads existing data file with the file name in the layers of folder
  
• Loaded file must be of type xml. Hence, it must end with .xml
  
• / can be replaced with \
• Loaded file location will be limited in the DoIt Application folder if the full directory is not used
  
• Loaded file location can be outside of the DoIt Application folder if you used the full directory path name forFILE_PATH

Examples:

• To load a file called savefile.xml at C:\Users\USER\Desktop:
  
  • loadC:\Users\USER\Desktop\savefile.xml
    
• To load a file named savefile.xml in the DoIt Application folder:
  
  • loadsavefile.xml
    

4.17 Exiting the program : exit

Want to exit the program? Type exit into the command box
Format: exit

4.18 Saving local data

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

4.19 Input stack for efficiency

Keyboard Shortcuts:[Up] and [Down]

Do you find typing again and again a similar command tedious? Just press [Up] and [Down] on the keyboard to u can scroll through the inputs you have previously used. They are automatically filled into the command box for you so you do not have to retype them. This make it easier for you since you only have to make minor changes for similar command inputs

• [Up] is used to scroll up the previous command inputs
  
• [Down] is used to scroll down the previous command inputs
  
• if you want to scroll multiple time (e.g. 3 times) to your previous input(e.g. 3rd last input) press [Up] that number of times (e.g. 3 times)
• if your scrolled too much press [Down] to scroll back down e.g. You are at the 3rd last input add after you have pressed [Up] 3 times. However, you want to use the 2nd last input done instead. You just need to press [Down] 1 times to scroll to that input
  

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 DoIt folder

6. Command Summary