User Guide by zhouwenjuan

VIEWS: 16 PAGES: 6

									User Guide
1.1 Product Vision

JustDoIt aims to be software which is an easy to use Graphical User Interface, with an integrated
Command Line Interface (CLI), for daily use by geeks.

It is a ToDo Manager, which allows us to add events for a specific date/time or without a date/time, edit
details for a particular event, set reminders to remind us for selected events, delete events, postpone a
particular event, search for a particular event, display events for a particular day, week, or month, or to
view the help menu to see the function and format of each command.

We also have an inbuilt calendar, and the user can click on any particular date to see the events added
to that date, or add an event to that particular date. Special features include a help button to view the
help menu to guide the user, our “Reminders” window to remind you of the important events, our
“Events This Month” window to ensure you plan out your month well, and our and our “map” function
to help you find a particular event location on Google Maps if you are lost!

The features are implemented efficiently and the commands are intuitive and user friendly.

1.2 Using our features:

On starting our program, all previous events are read into the database. JustDoIt V0.2 comes with a
simple, easy to use GUI, integrated with the CLI to provide more flexibility to the user.

1.3 Quick Start Guide

Add an event
To add an event, simply enter the ‘add’ command in the CLI. Format is as follows:
        add;event name;event date/time;event venue;reminder/not;reminder when
You can also add a event by selecting a date in the calendar, and type in the same command without the
event date/time in the CLI.

Deleting an event
You can delete an event by entering the ‘delete’ command in the CLI. Format is as follows:
        delete;event name
Alternately, all events added can be deleted by giving the following command:
        delete;all
You can also delete the event by searching for it and then using the search index. Format is:
        delete; search index
Editing an event
You can edit an event by using the ‘edit’ command. The format is as follows:
         edit;event name;event detail to edit;new event detail
You can also edit after searching for the particular event and then using the search index, as follows:
         edit;search index;event detail to edit; new event detail


Searching for an event
You can search for a particular event using a keyword, which can occur in either event name/event
venue. The format is as follows:
        search;keyword

Events on a date
You can see all the events occurring on a particular day by using the ‘goto’ command. Format is as
follows:
         goto;date
Alternately, you can also click on a date on the calendar to see all the events occurring on that date.

Show Reminders
The reminders added for upcoming events can be shown by using the ‘showrem’ command as follows:
       showrem

Postponing an event
You can postpone an event by using the ‘postpone’ command as follows:
       postpone;event name;new date OR postpone;event name;old date;new date

Displaying an event
You can display events by using the command as follows:
        display OR display;all OR display;today OR display;tomorrow OR display;month

Past events
You can see past event by using the ‘showpast’ command
        showpast
Events whose date is passed can be cleared by using the ‘clearpast’ command:
        clearpast

Map an event location
An event location can be seen though Google Maps using the search index returned after searching for
the event. The format is as follows:
       map;search index

Minimising the screen
You can minimize the JustDoIt screen using a simple command:
       min
Exiting JustDoIt
You can exit JustDoIt by using the following command:
         exit

1.4 User Manual

1.4.1 Main parts of the JustDoIt window




   1. Input box – this is the place you can type all the commands for adding an event, removing,
      editing, searching etc.
   2. Dynamic Help – this is a dynamic help for the user which will be shown as soon as the user
      enters a command, to display the format of the particular command entered.
   3. Result window – this window is the CLI output screen, which displays the output of each CLI
      entered by the user.
   4. Events for this month – this window will show all the upcoming events for the particular month.
   5. Calendar – you can browse through the calendar, and select a date to see all the events on that
      particular date, as well as to add any event to that day.
   6. Upcoming reminders – this window will show you the reminders for the upcoming events,
      according the time set for the reminder to be shown.
    7. Timer – it shows the current system time.
    8. Help – it displays all the commands for the Command Line box for the user’s reference.

1.4.2 Add an Event
The events can be added in various ways:
    a. CLI box - The user can add an event by simply typing it in the text box at the centre of the
        JustDoIt window. Our add command has been made quite flexible keeping in mind the user’s
        convenience. The format is as follows:

    add;eventName;eventDate;eventVenue;showRem/notShowRem;showRemWhen

    For example:


    It will add a event with name “2103 submission”, for the date 7th November 2011 at location “nus”
    and will not set any reminders for the event.

    b. Calendar and CLI box – the user can select the date where he/she wanst to add a event from the
       calendar and then type out other details in the CLI box. Format is as follows:

    add;eventName;eventVenue;showRem/notShowRem;showRemWhen

    For example:


    It will add an event with name “production party”, for the date chosen by user, at location
    “vivocity”, and set a reminder for the event to be shown a day in advance.

The user can choose not to add a particular detail of the event and leave it blank. In that case, the
software will add a NULL value/not specified for that detail. For example:

     add;eventName;eventDate;;showRem/notShowRem;showRemWhen

 To provide flexibility to the user, there are several simple formats for adding date and time provided by
the DateTime Class. For simplicity sake its recommended that you use HH MM(24 hour scale) or
hh:mm tt (12 hour scale) that is you either enter a time like 23 00 or 11 00 PM.

1.4.3 Editing/Updating a event
The user can edit or update an event by our edit command. The format is as follows:

edit;event name;event detail;new event detail
For example:

It will change the venue of the event “production party” to “city hall” from “vivocity”.

An event can be postponed by our postpone command. The format is as follows:
postpone;event name;new date OR postpone;event name;old date;new date

For example:

It will postpone the event date from 7th November 2011 to 9th November 2011.


1.4.4 Deleting events
Events can be deleted in various ways:
        a. Using event name – you can simply delete an event by using the event name. the format is
            as follows:
                delete;event name
        For example,


        It will delete the event “2103 submission” from the event list.

        b. After searching the event – You can search for an event using a keyword if you do not
           remember the event name, and then delete the event using the index returned by the
           search results. The format is as follows:
               delete; search index
        c. Deleting all events - all the events entered by the user can be deleted by using the following
           format:
               delete;all

1.4.5 Search for an event
To search for an event, simply type in a keyword of the event you want to search for. The keyword can
be from the event date or event venue. The format is as follows:

                search;keyword

The result box will display the “event venue” and “event time” for the event you have searched for, with
an index for the event in the Result box.

For example:

The software will search for events with the name “2103 submission”, index “1” and display the event
details – “11/7/2011” and “nus” in the result box.
1.4.7 Mapping an event location
You can map an event location by using our ‘map’ command, using the search index returned after
searching for the event. The format is as follows:
        map;search index OR map;event name

For example:


It will open up Google Maps and display the location “NUS”.

1.4.6 Display Events
The events can be displayed in various ways:
    a. CLI display – the user can enter the command “display” to display all the events with their event
        IDs and other information in the Result Window. We have provided more flexibility by adding a
        few formats to display events:
             I.   Display;today – it will display all the events for that day
            II.   Display;tomorrow – will display all events for the next day
           III.   Display;month – will display all the events for that month
           IV.    Display;all /display – will display all events added by the user
    b. Calendar – the user can click on a particular date to see all the events added for that particular
        date. The events will be shown in the Result Box.
    c. Display by date – the user can use the ‘goto’ command to display all the events occurring on
        that particular date. the format is as follows:
                goto;date
    d. Events box – the events for that particular month are being shown in the ‘Events for this month’
        window.

1.4.7 Miscellaneous

       Show reminders – simply type the command ‘showrem’ to view all the reminders.Also, our
        reminder box keeps showing you the reminder for the upcoming events.
       Show past events – type in the command ‘showpast’ to view all the past events
       Clear past events – to clear passed events, type in the command ‘clearpast’
       Minimizing the window – To minimize the JustDoIt window, type in ‘min;’ in the CLI box
       Click on the icon in the task bar to maximize the the JustDoIT Application.
       Exit the window – To exit from the JustDoIt window, simply enter ‘exit’ in the CLI box

								
To top