By: Team SE-EDU
Since: Jun 2016
Licence: MIT
Updated by: CS2103-F10-B1
- 1. Quick Start
- 2. Features
- 2.1. Autocompleting commands : Tab
- 2.2. Clearing the command box : Control
- 2.3. Viewing help :
help
- 2.4. Adding a person:
add
- 2.5. Adding a relationship between two persons:
addRelationship
- 2.6. Editing a relationship between two persons:
editRelationship
- 2.7. Listing all persons :
list
- 2.8. Sorting all persons :
sort
- 2.9. Editing a person :
edit
- 2.10. Locating persons:
find
- 2.11. Deleting a person :
delete
- 2.12. Deleting a relationship between two persons :
deleteRelationship
- 2.13. Removing a tag:
removeTag
- 2.14. Finding shortest relationship path between two people:
relPath
- 2.15. Setting a tag colour:
colourTag
- 2.16. Selecting a person :
select
- 2.17. Listing entered commands :
history
- 2.18. Undoing previous command :
undo
- 2.19. Redoing the previously undone command :
redo
- 2.20. Clearing all entries :
clear
- 2.21. Clearing command history :
clearHistory
- 2.22. Backing up:
backup
- 2.23. Exiting the program :
exit
- 2.24. Saving the data
- 3. Features(Coming in v2.0)
- 4. FAQ
- 5. Command Summary
1. Quick Start
-
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. -
Download the latest
Intelli.jar
here. -
Copy the file to the folder you want to use as the home folder for your Relationship Tracker.
-
Double-click the file to start the app. The GUI should appear in a few seconds.
-
Type the command in the command box and press Enter to execute it.
e.g. typinghelp
and pressing Enter will open the help window. -
Some example commands you can try:
-
list
: lists all contacts -
add
n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01
: adds a contact namedJohn Doe
to Intelli. -
delete
3
: deletes the 3rd contact shown in the current list -
exit
: exits the app
-
-
Refer to the Features section below for details of each command.
2. Features
Command Format
-
Words in
UPPER_CASE
are the parameters to be supplied by the user e.g. inadd n/NAME
,NAME
is a parameter which can be used asadd n/John Doe
. -
Items in square brackets are optional e.g
n/NAME [t/TAG]
can be used asn/John Doe t/friend
or asn/John Doe
. -
Items with
…
after them can be used multiple times including zero times e.g.[t/TAG]…
can be used ast/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.
2.1. Autocompleting commands : Tab
Completes a command by filling the command box with the first suggestion shown in the result display.
Format: INPUT
, then pressing Tab
Examples:
-
Type
a
followed by Tab -
Type
add
followed by Tab
2.2. Clearing the command box : Control
Clears the command box instantaneously.
Format: Control
2.3. Viewing help : help
Format: help
2.4. Adding a person: add
Adds a person to Intelli.
Format: add n/NAME [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…
A person can have any number of tags (including 0). A person can be added with just the name being specified. The order of name, phone number, email, address, remark and tags being added does not matter. |
Examples:
-
add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01
-
add n/Betsy Crowe e/betsycrowe@example.com
-
add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal
-
add n/Betsy Crowe a/Newgate Prison p/1234567 e/betsycrowe@example.com
-
add n/Betsy Crowe
2.5. Adding a relationship between two persons: addRelationship
Adds a relationship between two persons in Intelli.
Format: addRelationship FROM_INDEX TO_INDEX DIRECTION [n/NAME] [ce/CONFIDENCE_ESTIMATE]
Examples:
-
addRelationship 1 3 directed ce/12.32131
Adds a directed relationship from the 1st person to the 3rd person with the confidence estimate of 12.32131. -
addRelationship 2 3 undirected n/husband and wife ce/100
Adds an undirected relationship between the 2nd and 2rd with the name being 'husband and wife' and confidence estimate of 100.
2.6. Editing a relationship between two persons: editRelationship
Edits a relationship between two persons in Intelli
Format: editRelationship INDEX_ONE INDEX_TWO [n/NAME] [ce/CONFIDENCE_ESTIMATE]
Examples:
-
editRelationship 1 2
-
editRelationship 1 2 n/friends
-
editRelationship 1 2 ce/3.12082
-
editRelationship 1 2 n/friends ce/3.12082
2.7. Listing all persons : list
Shows a list of all persons in Intelli.
Format: list
2.8. Sorting all persons : sort
Shows a list of all persons in the address book sorted alphanumerically by name, phone, email, address or remark.
Format: sort PREFIX
Examples:
-
sort n/
Sorts a person alphanumerically by name. -
sort p/
Sorts a person by phone number. Numbers are compared according to their respective ASCII values. -
sort e/
Sorts a person by email alphanumerically. Non-alphabetical characters are compared according to their respective ASCII values.
2.9. Editing a person : edit
Edits an existing person in Intelli.
Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…
Examples:
-
edit 1 p/91234567 e/johndoe@example.com
Edits the phone number and email address of the 1st person to be91234567
andjohndoe@example.com
respectively. -
edit 2 n/Betsy Crower t/
Edits the name of the 2nd person to beBetsy Crower
and clears all existing tags. -
edit 3 r/
Clears the existing remark of the 3rd person.
2.10. Locating persons: find
Finds persons whose details contain any of the given keywords.
Format: find KEYWORD [MORE_KEYWORDS]
Examples:
-
find John
Returnsjohn
andJohn Doe
. -
find Jo
Returnsjohn
andJohn Doe
. -
find Betsy Tim John
Returns any person having names or email addresses containingBetsy
,Tim
, orJohn
. -
find 92334266
Returns any person having phone number/email address/address containing92334266
. -
find Alice 92334266
Returns any person having nameAlice
AND/OR having phone number/email address/address containing92334266
.
2.10.1. Locating persons by name: find n/
Finds persons whose names contain any of the given keywords.
Format: find n/[KEYWORDS]
Examples:
-
find n/John
Returnsjohn
andJohn Doe
. -
find n/Jo
Returnsjohn
andJohn Doe
. -
find n/Betsy Tim John
Returns any person having namesBetsy
,Tim
, orJohn
.
You can find multiple persons with a single name search. |
2.10.2. Locating persons by address: find a/
Finds persons whose addresses contain any of the given keywords.
Format: find a/[KEYWORDS]
Examples:
-
find a/Serangoon
Returns any persons having addresses in Serangoon. -
find a/seRangOOn
Returns any persons having addresses in Serangoon. -
find a/Ser
Returns any persons having addresses containing the phraseSer
. -
find a/Serangoon Gardens
Returns any person having addresses containing the phraseSerangoon
AND/ORGardens
.
2.10.3. Locating persons by email: find e/
Finds persons whose emails contain any of the given keywords.
Format: find e/[KEYWORDS]
Examples:
-
find e/alice@example.com
ReturnsAlice
. -
find e/AliCE@ExaMPle.com
ReturnsAlice
. -
find e/@example.com
Returns any persons having email addresses containing the suffix@example.com
. -
find e/@example.com @yahoo.com
Returns any person having email addresses containing the suffix@example.com
or@yahoo.com
.
2.10.4. Locating persons by phone: find p/
Finds persons whose phone numbers contain any of the given keywords.
Format: find p/[KEYWORDS]
Examples:
-
find p/97734225
Returns any persons having phone numbers matching97734225
. -
find p/9773
Returns any persons having phone numbers containing the sequence9773
. -
find p/97734225 90329038
Returns any persons having phone numbers matching97734225
OR90329038
.
2.10.5. Locating persons by tag: find t/
Finds persons whose tags contain any of the given keywords.
Format: find t/[KEYWORDS]
Examples:
-
find t/friends
Returns any persons having tags matchingfriends
. -
find t/FriEndS
Returns any persons having tags matchingfriends
. -
find t/frIe
Returns any persons having tags containing the phrasefrie
. -
find t/friends family
Returns any persons having tags matchingfriends
AND/ORfamily
.
2.11. Deleting a person : delete
Deletes the specified person from Intelli.
Format: delete INDEX
Examples:
-
list
delete 2
Deletes the 2nd person in Intelli. -
find Betsy
delete 1
Deletes the 1st person in the results of thefind
command.
2.12. Deleting a relationship between two persons : deleteRelationship
Deletes the relationship between two persons from Intelli.
Format: delete INDEX_FROM_PERSON INDEX_TO_PERSON
Examples:
-
list
deleteRelationship 1 2
Deletes the relationship from the first to the 2nd person in Intelli.
2.13. Removing a tag: removeTag
Removes the specific tag from Intelli.
Format: removeTag TAG
Example:
-
removeTag friend
Removes the tagfriend
from all the persons in Intelli.
2.14. Finding shortest relationship path between two people: relPath
Highlights the shortest relationship path between two people in Intelli in the graph display, if it exists.
Format: relPath FROM_INDEX TO_INDEX
Example:
-
relPath 1 2
Highlights the shortest path between the first and second person in Intelli, if it exists.
2.15. Setting a tag colour: colourTag
Sets a colour of a tag to a new colour.
Format: colourTag TAG COLOUR
Example:
-
colourTag friend red
Sets the colour of the tagfriend
to red on next program start.
2.16. Selecting a person : select
Selects the person identified by the index number used in the last person listing.
Format: select INDEX
Examples:
-
list
select 2
Selects the 2nd person in Intelli. -
find Betsy
select 1
Selects the 1st person in the results of thefind
command.
2.17. Listing entered commands : history
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. |
2.18. Undoing previous command : undo
Restores Intelli to the state before the previous undoable command was executed.
Format: undo
Undoable commands: those commands that modify Intelli’s content ( |
Examples:
-
delete 1
list
undo
(reverses thedelete 1
command) -
select 1
list
undo
Theundo
command fails as there are no undoable commands executed previously. -
delete 1
clear
undo
(reverses theclear
command)
undo
(reverses thedelete 1
command)
2.19. Redoing the previously undone command : redo
Reverses the most recent undo
command.
Format: redo
Examples:
-
delete 1
undo
(reverses thedelete 1
command)
redo
(reapplies thedelete 1
command) -
delete 1
redo
Theredo
command fails as there are noundo
commands executed previously. -
delete 1
clear
undo
(reverses theclear
command)
undo
(reverses thedelete 1
command)
redo
(reapplies thedelete 1
command)
redo
(reapplies theclear
command)
2.20. Clearing all entries : clear
Clears all entries from Intelli.
Format: clear
2.21. Clearing command history : clearHistory
Clears the command history.
Format: clearHistory
After the command history is cleared, you will not be able to undo any previous commands. |
2.22. Backing up: backup
Backs up the current address book to a fixed location (intelli.xml.bak
in the data
directory).
Any existing backup at the same location will be overwritten after running this command. |
2.23. Exiting the program : exit
Exits the program.
Format: exit
2.24. 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.
3. Features(Coming in v2.0)
3.1. Add a confidence estimate
Adds a confidence estimate for an attribute of a person.
Format: addConfidenceEstimate INDEX ATTRIBUTE_TYPE ESTIMATE
Example:
-
list
addConfidenceEstimate 2 Address 0.8
Adds a confidence estimate of 0.8 to theAddress
of the 2nd person in the list.
3.2. Delete a confidence estimate
Deletes a confidence estimate for an attribute of a person.
Format: deleteConfidenceEstimate INDEX ATTRIBUTE_TYPE
Example:
-
list
deleteConfidenceEstimate 2 Address
Deletes a confidence estimate from theAddress
of the 2nd person in the list.
3.3. List all related persons : listRelated
Shows a list of all persons in Intelli related to a given person.
Format: listRelated INDEX
3.4. User login
Enters a password to check if user is authorised to access information in Intelli.
Any data (i.e. the person list and the graph) will only be displayed after successful login.
Format: login PASSWORD
3.5. Set a password
Sets a password to protect Intelli from other users.
Format: set PASSWORD
To set a new password, a user must first be logged into Intelli with the previous password. The default password is |
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 Address Book folder.
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/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague
e.g.add n/Jane
-
AddRelationship :
addRelationship INDEX_FROM_PERSON INDEX_TO_PERSON DIRECTION [n/NAME] [ce/CONFIDENCE_ESTIMATE}
e.g.addRelationship 2 3 directed ce/1212312.2 n/is cousin of
-
Back up :
backup
-
Colour tags :
colourTag TAG COLOUR
e.g.colourTag friend red
-
Clear :
clear
-
Clear history :
clearHistory
-
Delete :
delete INDEX
e.g.delete 3
-
DeleteRelationship :
deleteRelationship FROM_PERSON_INDEX TO_PERSON_INDEX
e.g.deleteRelationship 2 3
-
Edit :
edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…
e.g.edit 2 n/James Lee e/jameslee@example.com
-
Edit relationship:
editRelationship INDEX_ONE INDEX_TWO [n/NAME] [ce/CONFIDENCE_ESTIMATE]
e.g.editRelationship 1 2 n/friends ce/3
-
Exit :
exit
-
Find :
find KEYWORD [MORE_KEYWORDS]
e.g.find James Jake
-
Find shortest relationship path :
relPath FROM_INDEX TO_INDEX
e.g.relPath 1 2
-
Help :
help
-
History :
history
-
List :
list
-
Redo :
redo
-
Remove tag :
removeTag TAG
e.g.removeTag friend
-
Find shortest relationship path :
relPath FROM_INDEX TO_INDEX
e.g.relPath 1 2
-
Sort :
sort PREFIX
e.g.sort n/
-
Select :
select INDEX
e.g.select 2
-
Undo :
undo