Skip to content

Latest commit

 

History

History
436 lines (310 loc) · 13.9 KB

UserGuide.adoc

File metadata and controls

436 lines (310 loc) · 13.9 KB

JitHub - User Guide

By: CS2113-AY1819S1-W12-1 Since: Aug 2018

1. Introduction

JitHub is for students who prefer to use a desktop app for managing contacts, email, and calendar. More importantly, JitHub is optimized 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 can type fast, JitHub can get your daily tasks such as checking schedule 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 addressbook.jar here.

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

  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 or h and pressing Enter will open the help window.

  6. Some example commands you can try:

    • list : lists all contacts

    • addn/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01 : adds a contact named John Doe to the Address Book.

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

    • exit : exits the app

    • h : access the help document

  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/John Doe.

  • Items in square brackets are optional e.g n/NAME [t/TAG] can be used as n/John Doe t/friend or as n/John Doe.

  • Items with …​ after them can be used multiple times including zero times e.g. [t/TAG]…​ can be used as   (i.e. 0 times), t/friend, t/friend t/family etc.

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

  • Commands argument can be in any order e.g. 'AddCommand' Format: 'add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]' can also be 'n/NAME p/PHONE_NUMBER a/ADDRESS e/EMAIL add' [available in V1.4]

3.1. Viewing help : help / h

Format: help

3.2. Adding a person: add / a

Adds a person to the address book
Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​

💡
 A person can have any number of tags (including 0)

Examples:

3.3. Listing all persons : list / ls

Shows a list of all persons in the address book.
Format: list

3.4. Editing a person : edit / e

Edits an existing person in the address book.
Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​

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

  • When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.

  • You can remove all the person’s tags by typing t/ without specifying any tags after it.

Examples:

  • edit 1 p/91234567 e/[email protected]
    Edits the phone number and email address of the 1st person to be 91234567 and [email protected] respectively.

  • edit 2 n/Betsy Crower t/
    Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

3.5. Locating persons by name: find / f

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

  • The search is case insensitive. e.g hans will match Hans

  • The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans

  • Only the name is searched.

  • Only full words will be matched e.g. Han will not match Hans

  • Persons matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Examples:

  • find John
    Returns john and John Doe

  • find Betsy Tim John
    Returns any person having names Betsy, Tim, or John

3.6. Deleting a person : delete / d

Deletes the specified person from the address book.
Format: delete INDEX

  • Deletes the person at the specified INDEX.

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

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

Examples:

  • list
    delete 2
    Deletes the 2nd person in the address book.

  • find Betsy
    delete 1
    Deletes the 1st person in the results of the find command.

3.7. Selecting a person : select / s

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

  • Selects the person and loads the Google search page the person at the specified INDEX.

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

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

Examples:

  • list
    select 2
    Selects the 2nd person in the address book.

  • find Betsy
    select 1
    Selects the 1st person in the results of the find command.

3.8. Listing entered commands : history / hs

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.9. Undoing previous command : undo / z

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

ℹ️

Undoable commands: those commands that modify the address book’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.10. Redoing the previously undone command : redo / y

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.11. Clearing all entries : clear / c

Clears all entries from the address book.
Format: clear

3.12. Searching for person’s photograph

Searches for the person’s photograph on Google.

  • Person must have an online presence eg. Facebook/LinkedIn for the search to work.

Format:

  • The selected person will be searched on google. Refer to select on how to select a person.

3.13. Exporting all contacts : exportall

Export the name, phone, address and email of all persons in the addressbook under the specified filetype.
Format: exportall FILETYPE

Examples:

  • exportall csv

  • exportall vcf [coming in v1.4]

ℹ️

  1. The file will be located in /data/addressbook.csv.

  2. This command overwrites the previous /data/addressbook.csv.

3.14. Exporting all contacts displayed: export [coming in v1.4]

3.15. Exporting contact details of a selected person: export

Export the name, phone, address and email of the specified person from the addressbook under the specified filetype.
Format: export INDEX FILETYPE

  • Export the person at the specified INDEX.

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

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

Examples:

  • list
    export 2 csv
    Exports the 2nd person in the address book as a csv file.

  • find Betsy
    export 1 csv
    Exports the 1st person starting from the 1st person in the results of the find command as a csv file.

3.16. Add personal schedule : schedule / sc

This function enables you to add the scheduled events of a person into the selected person’s card.

Format:

schedule INDEX-OF-PERSON d/DATE(DDMMYYYY) st/START-TIME et/END_TIME en/EVENT-NAME

Examples:

  • schedule 1 d/09092018 st/1200 et/1400 en/CS1231 Exam

  • schedule 2 d/08072018 st/1000 et/1900 en/CS2040C Practical Exam

Currently, the adding of scheduled events allows for events of the same name to be added, at the same time slot. This issue will be fixed in V2.0.

3.17. Clear personal weekly schedule : clearSchedule / cs

Format:

clearSchedule IndexOfPerson

Examples:

  • clearSchedule 1

3.18. List Common Schedule : matchSchedule / ms

Shows a list of common meeting time for a group of contacts and the user in that given that given period of time.
Format: matchSchedule d/SELECTED-DATE st/START-TIME et/END-TIME i/INDEX-OF-PERSON…​[INDEX]

Examples:

  • matchSchedule d/01012018 st/0800 et/1800 i/1 i/2 i/3

3.19. Add To-do task: todo

Adds a to-do task, the to-do list panel will display the task’s title and its content.
Format: todo tt/TITLE c/CONTENT

Examples:

  • todo tt/Write tests c/Need to write test for this command

  • todo tt/Buy grocery c/Buy tomato and potato on the way back home

3.20. Add Reminder: reminder [coming in v1.4]

Adds a Reminder for your next meeting, along with details to be displayed

Format: reminder d/DDMMYY tm/TIME lc/LOCATION tp/TOPIC

Examples:

  • reminder d/031118 tm/1900 lc/COM2 tp/CS2113T Milestone 1.4

3.21. Meeting Minutes: minutes [coming in v1.4]

Opens up a text box to take meeting minutes

Format: minutes

3.22. Exiting the program : exit / x

Exits the program.
Format: exit

3.23. Saving the data

Address book data are saved in the hard disk automatically after any command that changes the data.
There is no need to save manually.
The storage file 'addressbook.xml' is located in the project root folder.

3.24. Getting Smart Suggestions

Receive smart suggestions while typing in your commands. Press the TAB key while typing a command halfway to get suggestions on possible commands without having to navigate to the help window. If only one command is available, pressing TAB will auto-complete the command for you without the need to type it in manually.

Examples:

  • While typing his to get history command, press TAB. The history command will automatically be filled in for you as it is the only suggestion available. The command parameters would then be shown as a prompt to help you with your input.

  • While typing e, press TAB. The system will suggest to you all possible commands that start with e, which would be exportall, exit, and edit.

3.25. Getting Wrong Command Suggestions

Should you type in a wrong command, fear not, as our system will automatically suggest to you what you have typed wrongly, by giving you a closest approximation of word through the message box after you press enter.

Examples:

  • If you wanted to type select but you typed salect instead, the system will tell you that it is an invalid command, and would suggest to you the command select instead.

3.26. Calendar to view schedule [Coming in V2.0]

When selecting a person, the scheduled events are to be displayed on the calendar panel. Command type: select INDEX

When matching schedules, the common time slots found are to be displayed on the calendar panel. Command type: matchSchedule d/SELECTED-DATE st/START-TIME et/END-TIME i/INDEX-OF-PERSON…​[INDEX]

3.27. Encryption [Coming in V2.0]

When exporting contacts for the purpose of information transfer to another computer, encryption can be enabled before the export command to prevent data misuse.

Command type: encrypt for export

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 JitHub folder.

Q: How do I export my contacts to my phone?
A: Use the exportall command to generate a csv/vcf file and transfer that file to your phone. Use your phone contacts app to import that file.

5. Command Summary

  • Add add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​
    e.g. add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague

  • Clear : clear

  • Delete : delete INDEX
    e.g. delete 3

  • Edit : edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​
    e.g. edit 2 n/James Lee e/[email protected]

  • Find : find KEYWORD [MORE_KEYWORDS]
    e.g. find James Jake

  • List : list

  • Help : help

  • Select : select INDEX
    e.g.select 2

  • History : history

  • Undo : undo

  • Redo : redo

  • ExportAll : exportall FILETYPE

  • Export : export INDEX FILETYPE

  • Mail : mail [i/INDEX] (to be added)

  • Todo : todo tt/TITLE c/CONTENT

  • Schedule : schedule INDEX-OF-PERSON d/DATE(DDMMYYYY) st/START-TIME et/END_TIME en/EVENT-NAME

  • Clear Schedule : clearSchedule IndexOfPerson

  • Match Schedule : matchSchedule d/SELECTED-DATE st/START-TIME et/END-TIME i/INDEX-OF-PERSON…​[INDEX]

  • Mail : mail [i/INDEX]