By: Team Rolodex      Since: Sep 2017      Licence: MIT

1. Introduction

Rolodex is a desktop contact management application for people who have many social circles and wish to organise different groups of contacts separately and efficiently.
If you are a businessmen with a long list of clients to keep in touch with, a teacher with the contact information of hundreds of students in your phone, a freelancer with multiple groups of co-workers or customers, or just anyone with a need for fast and easy contact management, Rolodex is perfect for you.

2. Quick Start

This section serves as a tutorial for you to familiarize yourself with the usage of Rolodex. By following the steps below, getting started with Rolodex should be a fast and smooth process.

2.1. Installation

  1. Ensure you have Java version 1.8.0_60 or later installed in your Computer.

    Having any Java 8 version is not enough.
    Rolodex will not work with earlier versions of Java 8.

  2. Download the latest rolodex.jar here.

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

  4. Double-click the file to start the app. You should see the GUI (Graphical User Interface) in a few seconds as shown below.

    Ui

2.2. User Interface

The following picture labels the main components of the application.

UiLabeled

The table below summarises the function of each component.

Command Box

This is where you type in your commands to tell Rolodex to perform actions.

Command Result Panel

After entering a command, the feedback/result will be displayed here.
This is to notify you whether the command is valid, and to inform you if the action has been executed successfully.

Contact List

All contacts are listed here in alphabetical order by default.
When you perform a search action, the search result will be displayed here.

Contact Detail Panel

When you select a contact in Contact List, his/her details (name, phone number, email, address, tags and remark) will be displayed here.

2.3. Executing Commands

  1. Type the command (case insensitive) 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 contacts

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

    • addn/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 : adds a contact named John Doe to Rolodex.

The standard format for keying in person details is PREFIX/PERSON_DETAIL (e.g. n/John Doe for keying in a name).
The following table summarizes the prefixes and the corresponding person details they represent.
Prefix Person Detail

n/

Name

p/

Phone

e/

Email

a/

Address

r/

Remark

t/

Tag

For the details of each command, you may refer to the Features section below.

3. Features

To get a full understanding of the capabilities of your Rolodex, we recommend following this guide.

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.

3.1. add, a or +: Adding a Person (Since v1.3)

Adds a person to Rolodex.
Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [r/REMARK] [t/TAG]…​

Press Tab after typing add to generate the required field(s). See 3.2. Auto-completion for more details.

Alternatives: add can be replaced by a or +
Keyboard shortcut: Ctrl++

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

Examples:

  • add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01

  • a n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 r/Stole my house key t/criminal

Add commands are undoable with the undo command.

3.2. Auto-completion (Since v1.2)

For commands that require additional field(s), auto-completion can be triggered by pressing Tab after keying in the command word.

Commands with auto-completion enabled: add, delete, edit, email, find, new, open, select and remark.
These are commands that required additonal field(s).

Example:

  • Type add in the command box

  • Press Tab

  • You will see the full format displayed in the command box as shown below.

AutoCompletionAfterTab

  • Note that the placeholder for the name field has been auto-selected. Now you can directly type in the name.

AutoCompleteTypeName

  • After you are done typing the name, press Tab again to go to the next field.

AutoCompletionNextField

  • After you are done with the entire command, press Enter to execute the command as usual.

In addition to using Tab to navigate to the next field, you can press Shift+Tab to navigate to the previous field.

3.3. clear or c: Clearing All Persons (Since v1.3)

Clears all entries from Rolodex.
Format: clear or c
Keyboard shortcut: Ctrl+Shift+C

Clear commands are undoable with the undo command.

3.4. delete, d or -: Deleting a Person (Since v1.3)

Deletes the specified person from Rolodex.
Format: delete INDEX

Press Tab after typing delete to generate the required field(s). See 3.2. Auto-completion for more details.

Alternatives: delete can be replaced by d or -
Keyboard shortcut: Ctrl+Shift+D

  • Deletes the person 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 person in Rolodex.

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

Delete commands are undoable with the undo command.

With the help of the drop-down list of suggestions, you do not need to memorise any command.

When you type your commands inside the command box, you will notice that a drop-down list appears.

For example, if you type the letter "e", a drop-down list consisting of three options edit, email and exit appears, as shown in the screenshot below.

DropDownList1

The list will get updated as you type, to only display commands that match your input. Following the previous example, if you type the letter "m" after having typed in "e", the list should only consist of the email command now.

DropDownList2

When the drop-down list is shown, you can:

  • Use ↑ and ↓ arrow keys to navigate through the list

  • Press Enter to select the highlighted option

or

  • Use your mouse to click on the option to select it

After you have selected the command you wish to enter, you should see it displayed in the command box. For example, you should see the following when you select email in the drop-down list.

DropDownList3

Now you can:

  • press Enter to execute the command if no additional fields are required, or

  • continue to type in the rest of the command input, or

  • press Tab to activate auto-completion, see 3.2. Auto-completion for details.

If you want to see the list of all commands, simply type Space in an empty command box. The following list should appear.

DropDownList4

3.6. edit, e, change or modify: Editing a Person (Since v1.3)

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

Press Tab after typing edit to generate the required field(s). See 3.2. Auto-completion for more details.

Alternatives: edit can be replaced by change, modify or e
Keyboard shortcut: Ctrl+E

  • Edits the person at the specified INDEX. The index refers to the index number shown in the last person listing. 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 toggled i.e if a similar tag exists in the person, that tag would be removed, or added otherwise.

Examples:

  • edit 1 p/91234567 e/johndoe@example.com
    Edits the phone number and email address of the 1st person to be 91234567 and johndoe@example.com respectively.

  • e 2 n/Betsy Crower t/friends
    Edits the name of the 2nd person to be Betsy Crower and adds the tag friends if the tag friends does not exist in the 2nd person, or removes it otherwise.

Edit commands are undoable with the undo command.

3.7. email, mail, mailto, send or m: Composing an email (Since v1.5rc)

Opens the 'compose new email' window of the default email client, with the recipient’s email address and subject (optional) filled in.
Format: email INDEX [s/SUBJECT]

Press Tab after typing email to generate the required field(s). See 3.2. Auto-completion for more details.

Alternatives: email can be replaced by mail, mailto, send or m
Keyboard shortcut: Ctrl+M

3.8. exit, quit, close, bye or esc: Exiting the Program (Since v1.3)

Exits the program.
Format: exit
Alternatives: exit can be replaced by quit, close, bye or esc
Keyboard shortcut: Alt+F4

3.9. find, filter, search or f: Locating Persons in Rolodex (Since v1.4)

Finds persons in Rolodex.
Format: find KEYWORD [MORE_KEYWORDS] [SORT_ARGUMENTS]

Press Tab after typing find to generate the required field(s). See 3.2. Auto-completion for more details.

Alternatives: find can be replaced by filter, search or f
Keyboard shortcut: Ctrl+F

  • Only the name and tags are searched.

  • The name is searched fuzzily.

  • The tags is searched exactly.

  • The search will only find distinct persons. e.g. han solo han solo will only return han solo

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

  • The search is case sensitive for tags. e.g. only School will match School

  • The search is fuzzy for name words of 4 or more characters. e.g Hnas will match Hans

  • The search is exact for name words of less than 4 characters. e.g. hans will not match Han but han will match Han

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

  • The order of the keywords does not matter. e.g. Hans school Bo will match Bo Hans and others with the school tag

Examples:

  • find John or find jhon
    Returns john and John Doe

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

  • find School
    Returns any person having tag School

  • find School werk
    Returns any person having tag School or tag werk

  • [SORT_ARGUMENTS] can be none, some, any or all of n/ p/ e/ a/ n/desc p/desc e/desc a/desc n/asc p/asc e/asc a/asc, delimited by spaces, in no particular fixed order.

  • The sort argument prefix for sorting by name is n/.

  • The sort argument prefix for sorting by phone is p/.

  • The sort argument prefix for sorting by email is e/.

  • The sort argument prefix for sorting by address is a/.

  • The sort argument postfix desc denotes that the sort field is to be sorted in descending lexicographical order.

  • The sort argument postfix asc denotes that the sort field is to be sorted in ascending lexicographical order.

  • Sort arguments without a postfix are sorted by ascending lexicographical order.

  • The order of the SORT_ARGUMENTS are left-prioritized.

Sort arguments do not count as search arguments.

Examples:

  • find John p/ or find jhon p/asc
    Returns john and John Doe, sorted by ascending phone number.

  • search Betsy Tim John n/ p/desc
    Returns any person having names Betsy, Tim, or John, sorted by name then by descending phone if names are equal.

  • find School a/desc
    Returns any person having tag School, sorted by descending address.

  • find School werk e/
    Returns any person having tag School or tag werk, sorted by email.

  • find e/ p/desc
    Returns an error (do not count as search arguments).

3.10. help, assist, faq or h: Viewing Help (Since v1.4)

Format: help
Alternatives: help can be replaced with assist, faq or h
Keyboard shortcut: F1

3.11. history, his or past: Listing Entered Commands (Since v1.3)

Lists all the commands that you have entered in reverse chronological order.
Format: history, his or past
Keyboard shortcut: Ctrl+H

Pressing the ↑ and ↓ arrows will display the previous and next input respectively in the command box.

3.12. list, show, display or l: Listing All Persons (Since v1.3)

Shows a list of all persons in Rolodex, sorted by the specified sort order or default sort order.
Format: list [SORT_ARGUMENTS]
Alternatives: list can be replaced by show, display or l
Keyboard shortcut: Ctrl+L

  • [SORT_ARGUMENTS] can be none, some, any or all of n/ p/ e/ a/ n/desc p/desc e/desc a/desc n/asc p/asc e/asc a/asc, delimited by spaces, in no particular fixed order.

  • The sort argument prefix for sorting by name is n/.

  • The sort argument prefix for sorting by phone is p/.

  • The sort argument prefix for sorting by email is e/.

  • The sort argument prefix for sorting by address is a/.

  • The sort argument postfix desc denotes that the sort field is to be sorted in descending lexicographical order.

  • The sort argument postfix asc denotes that the sort field is to be sorted in ascending lexicographical order.

  • Sort arguments without a postfix are sorted by ascending lexicographical order.

  • The order of the SORT_ARGUMENTS are left-prioritized.

Examples:

  • list or l displays all persons by the default sort order.

  • l n/desc displays all persons sorted by descending name.

  • list p/ a/desc or list p/asc a/desc displays all persons sorted by ascending phone, then by descending address.

3.13. new, n, touch or >: Creating a New Rolodex Storage File (Since v1.3)

Creates a new Rolodex at the specified filepath and reloads the application with new sample data.
Format: new FILEPATH or n FILEPATH
Keyboard Shortcut: Ctrl+N

  • Creates the rolodex at the specified FILEPATH.

  • The FILEPATH can be project-relative or any directory on the system.

  • The FILEPATH must end with a file extension .rldx in order for data to be created and saved.

  • If FILEPATH already exists, use the open command instead.

  • The command recognizes directories in formats / or \ as valid filepaths

After creating a new Rolodex, verify that you have correctly created the Rolodex at the correct directory by checking the status bar of your application:

OpenNewStatusBar

The new command will refresh your session and all existing undoable commands will be cleared. It is recommended that you confirm you are satisfied with your changes before opening a new file.

Examples:

  • new C:/Users/Rolodex/downloads/myOwn.rldx
    n C:/Users/Rolodex/downloads/myOwn.rldx
    n C:\Users\Rolodex\downloads\myOwn.rldx
    Creates a new Rolodex file myOwn.rldx at the directory C:\Users\Rolodex\downloads and reloads the application with sample data created for the new Rolodex.

  • new data/default.rldx
    new data\default.rldx
    Creates a new Rolodex file default.rldx at the relative directory data and reloads the application with sample data created for the new Rolodex.

3.14. open, o, cd, ls or <: Opening an Existing Rolodex Storage File (Since v1.3)

Reloads the application with data from a rolodex at the specified filepath.
Format: open FILEPATH or o FILEPATH
Keyboard Shortcut: Ctrl+O

  • Loads the rolodex at the specified FILEPATH.

  • The FILEPATH can be project-relative or any directory on the system.

  • The FILEPATH must be a file with xml formatted data.

  • The FILEPATH must end with a file extension .rldx in order for data to be saved.

  • If FILEPATH does not exist, use the new command instead.

  • The command recognizes directories in formats / or \ as valid filepaths

When the application is opened, Rolodex will load the last accessed Rolodex directory.

After opening the Rolodex, verify that you have correctly opened the Rolodex at the correct directory by checking the status bar of your application:

OpenNewStatusBar

Opening a file without a .rldx extension will not save your changes.

The open command will refresh your session and all existing undoable commands will be cleared. It is recommended that you confirm you are satisfied with your changes before opening a new file.

Examples:

  • open C:/Users/Rolodex/downloads/myOwn.rldx
    o C:/Users/Rolodex/downloads/myOwn.rldx
    o C:\Users\Rolodex\downloads\myOwn.rldx
    Loads the application with the data at the directory C:/Users/Rolodex/downloads/myOwn.rldx.

  • open data/default.rldx
    open data\default.rldx
    Loads the application with the data in default.rldx in the folder data.

3.15. redo or r: Redoing the Previously Undone Command (Since v1.3)

Reverses the most recent undo command.
Format: redo or r
Keyboard shortcut: Ctrl+Y

Examples:

  • delete 1
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)

  • delete 1
    r
    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)
    r (reapplies the clear command)

Redo commands are undoable with the undo command.

3.16. remark, rmk, note or comment : Adding a Remark (Since v1.4)

Adds a remark to the specified person in Rolodex.
Format: remark INDEX [r/REMARK]
Alternatives: remark can be replaced by note or rmk or comment
Keyboard shortcut: Ctrl+R

  • Adds a remark to the person 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, …​

  • An existing remark will be replaced.

Examples:

  • remark 1 r/Likes fishing
    Sets the remark of the 1st person to Likes fishing.

  • note 1 r/
    Removes the remark for the 1st person.

  • Remarks can also be added using the add command, and modified with the edit command.

  • Remark commands are undoable with the undo command.

3.17. Saving the Data (Since v1.0)

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

3.18. select or s: Selecting a Person (Since v1.3)

Selects the person identified by the index number used in the last person listing.
Format: select INDEX or s INDEX

Press Tab after typing select to generate the required field(s). See 3.2. Auto-completion for more details.

Keyboard shortcut: Ctrl+S

  • Selects the person and view the complete details of the person 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 person in Rolodex.

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

3.19. Tagging a Person

  • You can directly add tag(s) to a person when you are adding him/her to Rolodex for the first time. See 3.1. Adding a Person for more details.

  • To add tag(s) to existing contacts in Rolodex, you use the edit INDEX t/TAG command. See 3.6. Editing a Person for more details.

3.20. undo or u: Undoing a Previous Command (Since v1.3)

Some commands in rolodex are undoable. If you accidentally executed an undoable command, you can restore Rolodex to the previous state using the undo command.
Format: undo or u
Keyboard Shortcut: Ctrl+Z

Undoable commands: add, clear, delete, edit, redo and remark.
These are commands that modify Rolodex’s content.

Examples:

  • delete 1
    list
    undo (reverses the delete 1 command)

  • select 1
    list
    u
    The undo command fails as there are no undoable commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    u (reverses the delete 1 command)

3.21. y or yes or k or ok or yea or yeah: Confirming a suggested command (Since v1.5)

Confirms a command suggested by Rolodex.
Format: y or yes or ok or yea or yeah

A command will be suggested by Rolodex if you make a typo in your command.

Examples:

  • s3, a typo for the command s 3 will be suggested. y or yes or k or ok or yea or yeah executes s 3 as normal and Charlotte Oliviero will be selected:

SuggestionSelect

  • rmke3 Likes to swim will be suggested as the formatted command, rmk 3 r/Likes to swim. y or yes or k or ok or yea or yeah executes rmk 3 r/Likes to swim as normal and Likes to swim will be added to Charlotte Oliviero:

SuggestionRemark

  • add Hansel Black 410 Madison Avenue NY 10029 friends neighbours ab@de.fg 98437653 will be suggested as the formatted command, add n/Hansel Black p/98437653 e/ab@de.fg a/410 Madison Avenue NY 10029 t/friends t/neighbours. y or yes or k or ok or yea or yeah executes the add command as normal and Hansel Black with appropriate fields will be added to the Rolodex:

SuggestionAdd

4. Upcoming Features

4.1. Adding a Profile Picture: picture or pic (Coming in v2.0)

Adds a profile picture to the specified person in Rolodex.
Format: picture INDEX FILE_DIRECTORY or pic INDEX FILE_DIRECTORY

  • Adds a profile picture to the person 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, …​

  • The FILE_DIRECTORY indicates the location of the profile picture to be added.

  • An existing profile picture will be replaced.

Examples:

  • picture 1 C:\Users\John\Pictures\my_pic.png
    Sets the profile picture of the 1st person to my_pic.png.

  • pic 6 C:\Users\Alice\Pictures\Contacts\john.png
    Sets the profile picture of the 6th person to john.png.

The second example is illustrated in greater detail here:

  1. Before the addition of profile pictures, the contact list is loaded with the default avatar image as shown below.

    profile pic before

  2. pic 6 C:\Users\Alice\Pictures\Contacts\john.png is entered in the command box with the valid FILE_DIRECTORY.

  3. If the command is entered correctly, you should see the updated profile picture as specified in the FILE_DIRECTORY of the command.

    profile pic after

5. Command Summary

Command Format

Add

add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [r/REMARK] [t/TAG]…​

a n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [r/REMARK] [t/TAG]…​

+ n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [r/REMARK] [t/TAG]…​

E.g. add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague

Clear

clear

c

Delete

delete INDEX

d INDEX

- INDEX

E.g. delete 3

Edit

edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…​

e INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…​

change INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…​

modify INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…​

E.g. edit 2 n/James Lee e/jameslee@example.com

Email

email INDEX [s/SUBJECT]

mail INDEX [s/SUBJECT]

mailto INDEX [s/SUBJECT]

send INDEX [s/SUBJECT]

m INDEX [s/SUBJECT]

E.g. email 1 s/Long time no see

Exit

exit

quit

close

bye

esc

Find

find KEYWORD [MORE_KEYWORDS] [SORT_ARGUMENTS]

filter KEYWORD [MORE_KEYWORDS] [SORT_ARGUMENTS]

search KEYWORD [MORE_KEYWORDS] [SORT_ARGUMENTS]

f KEYWORD [MORE_KEYWORDS] [SORT_ARGUMENTS]

E.g. find James Jake Jhon or find friends n/desc

Help

help

h

History

history

his

past

List

list [SORT_ARGUMENTS]

show [SORT_ARGUMENTS]

display [SORT_ARGUMENTS]

l [SORT_ARGUMENTS]

E.g. list or list n/desc

New

new FILEPATH

n FILEPATH

touch FILEPATH

> FILEPATH

E.g. new data\default.rldx

Open

open FILEPATH

o FILEPATH

cd FILEPATH

ls FILEPATH

< FILEPATH

E.g. open data\default.rldx

Redo

redo

r

Remark

remark INDEX r/REMARK

note INDEX r/REMARK

rmk INDEX r/REMARK

comment INDEX r/REMARK

E.g. remark 1 r/Loves to sing

Select

select INDEX

s INDEX

E.g. select 2

Undo

undo

u

6. Keyboard Shortcuts

6.1. Auto-complete Command Shortcuts (Since v1.3)

Using the keyboard shortcut is equivalent to typing in the corresponding command followed by pressing Tab
Shortcut Purpose

Ctrl++

Display the add command format in command box

Ctrl+D or Ctrl+-

Display the delete command format in command box

Ctrl+E

Display the edit command format in command box

Ctrl+F

Display the find command format in command box

Ctrl+M

Display the email command format in command box

Ctrl+N

Display the new command format in command box

Ctrl+O

Display the open command format in command box

Ctrl+R

Display the remark command format in command box

Ctrl+S

Display the select command format in command box

6.2. Quick Command Shortcuts (Since v1.2)

Shortcut Purpose

Ctrl+Shift+C

Clear contact list

Ctrl+H

View history

Ctrl+L

List all contacts

Ctrl+Z

Undo last command

Ctrl+Y

Redo last command

F1

View help window
Shortcut Purpose

Enter

Select the command box

Esc or Ctrl+←

Select the contact list panel

Ctrl+→

Select the result display panel

When the command box is not in selection:

↑ and ↓

Scroll the contact list

Ctrl+D

Delete the selected contact (Coming in V2.0)

Alt+F4

Exit the application

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

Q: How do I know if there is a newer version of the application?
A: You may follow our release page to check for any new updates.

Q: Help! This guide did not solve my problem.
A: You may raise any enquires at our issues page by creating a new issue. We will do our best to answer to your queries.

Q: I found a bug, where do I report it?
A: As similar to above, you may create a new issue at our issues page.

Q: Can I contribute to the code?
A: Of course! We welcome new contributors. You can contribute by creating a new Pull Request here. To get started, you may want to check out our Developer’s Guide.

Appendix A: Glossary

Application Programming Interface (API)

An Application Programming Interface specifies the interface through which other programs can interact with a software component. It is a contract between the component and its clients.

Command Line Interface (CLI)

A user interface to a computer’s operating system or an application in which the user responds to a visual prompt by typing in a command on a specified line, receives a response back from the system, and then enters another command, and so forth.

Continuous Integration (CI)

The practice of merging all developer working copies to a shared mainline several times a day.

Fuzzy Finding

In computer science, approximate string matching (often colloquially referred to as fuzzy string searching) is the technique of finding strings that match a pattern approximately (rather than exactly).

Java

A general-purpose computer programming language that is used in many products today.

JavaFX

A software platform for creating and delivering desktop applications, as well as rich internet applications (RIAs) that can run across a wide variety of devices.

Lexicographical order

In mathematics, the lexicographic or lexicographical order (also known as lexical order, dictionary order, alphabetical order or lexicographic(al) product) is a generalization of the way words are alphabetically ordered based on the alphabetical order of their component letters. This generalization consists primarily in defining a total order over the sequences (often called words in computer science) of elements of a finite totally ordered set, often called alphabet.

Mainstream OS

Windows, Linux, Unix, OS-X

Percent-encoding

A mechanism for translating unprintable or special characters to a universally accepted format by web servers and browsers.

Private contact detail

A contact detail that is not meant to be shared with others

Rolodex

The name of this application is Rolodex. It is used to refer to the java object of a similar name developed for this application under the application’s model component. A Rolodex is also a rotating file device used to store business contact information. Its name is a combination of the words rolling and index.

Uniform Resource Identifier (URI)

  • Click here to see the full document on URI generic syntax.

A compact sequence of characters that identifies an abstract or physical resource.