CardiB - User Guide

1. Introduction

Cardi Buddy (CardiB) is for students who prefer to use a desktop app to store their revision materials as flashcards. More importantly, CardiB 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, CardiB can help you to store revision materials quickly. The self-testing features will definitely help you to ace your examinations as opposed to traditional ways of revision by re-reading lecture notes. Interested? Jump to Section 2, Section 2, “Quick Start” to get started. Enjoy!

2. Quick Start

Ensure you have Java 11 or above installed in your Computer.
Download the latest cardibuddy.jar here.
Copy the file to the folder you want to use as the home folder for your Cardi Buddy.
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. typing help and pressing Enter will open the help window.
Some example commands you can try:
- list : lists all decks
- addd/CS1101S t/Basics : adds an empty deck titled CS1101S to the Cardi Buddy.
- open 1 : opens the 1st deck shown in the current list
- delete deck3 : deletes the 3rd deck shown in the current list
- exit : exits the app
Refer to Section 3, “Features” for details of each command.

3. Features

Application-specific Terminologies

Decks are the containers that contain the flashcard. A flashcard can only exist in a deck.
Flashcards are cards that contain revision materials, specifically a question and an answer.

Common Terminologies

File path specifies the unique location of a file in a file system from the root directory.

Command Format

Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add d/TITLE, TITLE is a parameter which can be used as add d/CS1101S.
Items in square brackets are optional e.g d/TITLE [t/TAG] can be used as d/CS1101S t/Basics or as d/CS1101S.
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/Easy, t/Easy t/Basics etc.
Parameters can be in any order e.g. if the command specifies d/TITLE t/TAG, t/TAG d/TITLE is also acceptable.

Special Icons

:bulb: is used to signal information that is helpful for the users to know.

3.1. Basic Features

3.1.1. Viewing help : `help`

Lists all the available commands that a user can enter.
Format: help

3.1.2. Saving data

The data is automatically saved into the hard disk after the user enters any command that changes the data

There is no need to save manually.

3.1.3. Exiting program: `exit`

Exits the program. Format: exit

3.2. Adding

3.2.1. Adding a deck: `add d/TITLE`

Creates a new deck to be added to the library. Format: add d/TITLE [t/TAG]…

Tag names are alphanumeric with no spaces E.g. t/Core Module is an invalid tag while t/CoreModule is valid.

[Tip] :bulb: A deck can have any number of tags (including 0)

Examples:

add d/CS2103
Returns a new deck titled CS2103
add d/CS1101S t/Easy t/Basics
Adds a new deck titled CS1101S with the tags Easy and Basics

3.2.2. Adding a card: `add c/DECK_TITLE q/QUESTION a/ANSWER`

Creates a new card to be added to the deck. Format: add c/DECK_INDEX q/QUESTION a/ANSWER

The deck specified in DECK_INDEX must be open for you to add a card.

Examples:

open 1
add c/1 q/How does one go about solving recursion problems? a/Wishful thinking
Adds a new card belonging to the deck indexed at 1.

3.3. Opening

3.3.1. Opening a deck: `open`

Opens an existing deck in the library. Format: open DECK_INDEX

Shows a list of all the cards in the deck.
Format: open 1

3.4. Editing

3.4.1. Editing a deck: `edit`

Edits an existing deck in the library. Format: edit DECK_INDEX [d/TITLE] [t/TAG]…

Edits the decks at the specified DECK_INDEX. The index refers to the index number shown in the complete list of decks. 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 deck will be removed i.e adding of tags is not cumulative.
You can remove all the deck’s tags by typing t/ without specifying any tags after it. If not, the tags will not be removed.

Examples:

edit 1 d/CS2103T
Edits the title of the 1st deck to be CS2103T without removing existing tags.
edit 2 d/CS2040 t/
Edits the title of the 2nd deck to be CS2040 and clears all existing tags.

3.4.2. Editing a card: `edit card` [coming in v2.0]

Edits an existing card in the deck. Format: edit card CARD_INDEX [q/QUESTION] [a/ANSWER] [t/TAG]…

Edits the card at the specified CARD_INDEX. The index refers to the index number shown in the complete list of decks. 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 card will be removed i.e adding of tags is not cumulative.
You can remove all the card’s tags by typing t/ without specifying any tags after it.

Examples:

edit card 1 q/What does MVC stand for?
Edits the question of the 1st card to be What does MVC stand for?.
edit card 2 a/cs2040 t/
Edits the answer of the 2nd card to be cs2040 and clears all existing tags.

3.5. Listing

3.5.1. Listing all decks: `list`

Shows a list of all the decks in the library and hides the displayed cards (if any).
Format: list

3.6. Clearing

3.6.1. Clearing all decks: `clear`

Clears all entries (both decks and cards) from the library.
Format: clear

3.7. Deleting

3.7.1. Deleting a deck: `delete deck`

Deletes the specified deck from the library. Format: delete deck DECK_INDEX

Deletes the deck at the specified DECK_INDEX.
The index refers to the index number shown in the complete list of decks.
The index must be a positive integer 1, 2, 3, …

Examples:

list decks
delete deck 2
Deletes the 2nd deck in the library.
search deck cs2030
delete deck 1
Deletes the 1st deck in the results of the search command.

3.7.2. Deleting a card: `delete card`

Deletes the specified card from a specific deck. Format: delete INDEX d/DECK_TITLE

Deletes the card at the specified INDEX of the deck.
The index refers to the index number shown in the complete list of flashcards in the deck.
The index must be a positive integer 1, 2, 3, …

Examples:

list cards
delete card 2 d/2030
Deletes the 2nd flash card in the cs2030 deck.
search card java
delete card 1
Deletes the 1st card in the results of the search card command.

3.8. Searching

3.8.1. Searching for a deck: `search deck`

Searches for the decks with titles that contain any of the given keywords or all of the keywords concatenated with the & symbol. Format: search deck KEYWORD [&] [MORE_KEYWORDS]

If the search has a & symbol, only decks with the words concatenated before and after the symbol will be returned.
The search is case insensitive. e.g cs2040 will match CS2040
The order of the keywords does not matter. e.g. Science Module will match Module Science
Only titles of the decks are searched.
The keyword needs to match a word within the deck’s title exactly . e.g. cs will not match with cs2030

Examples:

search deck database
Displays decks with the word database in the titles.
search deck database & relational
Displays decks with both of the words database and relational in the titles.

3.8.2. Searching for a card: `search card`

Finds the cards with a question that contain any of the given keywords. Format: search card KEYWORD [&] [MORE_KEYWORDS]

A deck needs to be opened for the search card command to work. The command will only search for cards in the opened deck.
If the search has a & symbol, only cards with the words concatenated before and after the symbol, in the question, will be returned.
The search is case insensitive. e.g programming will match Programming.
The order of the keywords does not matter. e.g. Javascript programming language will match with programming language Javascript.
The keyword needs to match a word within the question exactly. e.g. Java will not match with Javascript.

Examples:

search card principle
Displays cards with the word principle in the questions.
search card diagram & UML
Displays decks with both of the words diagram and UML in the questions.

3.9. Filtering

3.9.1. Filtering by tags: `filter`

Filters across all decks and only displays the decks with the specific tag. Format: filter TAGNAME [&] [MORE_TAGNAMES]

If the search has a & symbol, only decks with the tags concatenated before and after the symbol will be returned.
Filtering by tag is case insensitive. e.g hard will match Hard

Examples:

filter hard
Displays decks with the tag hard.
filter hard & coremodule
Displays decks with both the tags hard and coremodule.

3.10. Prioritising

Cards that the user has answered wrongly to (user input does not match with answer) is automatically moved to the back of the testing session. The user will be able to reattempt the same flashcard again later in the testing session.

There is no need to prioritise manually.

3.11. Testing

3.11.1. Starting a test session for a deck: `test INDEX`

Replace INDEX with the index number of the deck you wish to test, which can be found in the list view of all your decks.

What it does: * A test session will immediately replace the normal deck and flashcard list view. * The first question of the test session will be displayed.

Example Usage:

test 1
Creates a test session for the 1st deck.

3.11.2. Answering a question: `ans YOUR ANSWER`

Replace YOUR ANSWER with your answer to the displayed question.

What it does: * Submits your answer, and checks your answer against the flashcard’s stored answer * Displays the result of your answer (CORRECT or WRONG) * Displays your answer and the flashcard’s answer

Example Usage:

ans CardiBuddy
To answer the question: "What is the name of this application?"

3.11.3. Don’t want to answer? Use: `skip`

What it does:

If you already know the answer to the question, and don’t want to waste your time answering it, just type skip to go to the next question.
CardiB will not note down this flashcard in your test history, and will merely remove it from your current test session.

3.11.4. Force correct an answer: `force`

What it does:

CardiB takes your answer word for word when checking against the flashcard’s model answer.
If your answer differs by the model answer, it will be marked as wrong.
After viewing the model answer, if you feel that your answer still captures the gist of what the question wants, you can force your answer to be marked as correct.

3.11.5. Go to the next question: `next`

What it does:

After submitting your answer, type next to go to the next question (if there are any left to test).
You can only type next once you have submitted your answer.

3.11.6. Quit the test session halfway: `quit`

What it does:

Allows you to quit the current test session even before it is completed.

3.12. Displaying History

3.12.1. Displaying the command history: 'history'

Displays all the commands that has been inputted by the user during the current session. Format: 'history'

3.13. Undo/Redo [Still in Working Progress]

3.13.1. Undoing command: `undo`

Undoes latest command. Format: undo

3.13.2. Redoing command: `redo`

Redoes latest command. Format: redo

3.14. Detecting duplicates

3.14.1. Detecting duplicate deck

Upon adding a new deck, the application automatically checks if there are any existing decks with the same title. Only decks with unique titles can be successfully added.

3.14.2. Detecting duplicate card

Upon adding a new card to a specific deck, the application automatically checks if there are any existing cards with the same question in that deck. Only cards with unique questions can be successfully added.

If there is a card with the same question but it is in a different deck, the card can still be successfully added.

3.15. Statistics

Shows the number of Decks/Cards created and deleted, number of Test Sessions played, average correct percentage, average number of tries for each question.
Includes a line graph of the history of test previous test results.

3.15.1. Displaying all statistics: `statistics`

Displays the statistics across all decks. Format: statistics

3.15.2. Displaying statistics of a certain Deck: `statistics`

Displays the statistics of a specific deck. Format: statistics INDEX

Example:

statistics 2
Shows the statistics of the deck with the shown index of 2.

3.15.3. Displaying statistics of a test session of a certain Deck: `statistics`

Displays the statistics of a test session of a specific deck. Format: statistics INDEX TEST_SESSION_INDEX

Example:

statistics 2 3
Shows the statistics of the 3rd test session of the deck with the shown index of 2.

3.16. Syncing across multiple platforms: sync [coming in v2.0]

3.17. Playing memory games: game [coming in v2.0]

3.18. Customising flashcards: custom [coming in v2.0]

3.19. Replacing image [coming in v2.0]

3.19.1. Replacing a deck image: `replace deck image`

Replaces the photo of an existing deck in the library. By default, all decks will have a default logo as shown in our wireframe. Format: replace deck photo INDEX p/PHOTO_PATH

Replaces the photo of the deck at the specified INDEX. The index refers to the index number shown in the complete list of decks. The index must be a positive integer 1, 2, 3, …
The application will display a text label that reads ‘You can enter the path of your image into the command field or drag and drop your image into the command field.’

Examples:

replace deck image 1 d/src/resources/images/img.PNG.
Replaces the photo of the 1st deck to the photo that the file path directs to.

3.19.2. Replacing a card image: `replace card image`

Replaces the photo of an existing card in a specified deck. By default, all cards will have a default image as shown in our wireframe. Format: replace card image d/DECK_TITLE INDEX p/PHOTO_PATH

Replaces the photo of the card belonging to the deck with that DECK_TITLE, whereby the card is at the specified INDEX. The index refers to the index number shown in the complete list of decks. The index must be a positive integer 1, 2, 3, …
The application will display a text label that reads ‘You can enter the path of your image into the command field or drag and drop your image into the command field.’

Examples:

replace card image d/cs3230 1 p/src/resources/images/img.PNG.
Replaces the photo of the 1st card of the cs3230 deck with the photo that the file path directs to.

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 Cardi Buddy folder.

5. Command Summary

Add deck : add d/TITLE [t/TAG]…
e.g. add d/CS2030 t/Fundamentals t/Medium
Add card : add c/TITLE q/QUESTION a/ANSWER
e.g. add c/CS2030 q/What does OOP stand for? a/Object Oriented Programming
Clear : clear
Delete deck/card : delete deck/card INDEX
e.g. delete deck 3
Edit : edit INDEX [d/TITLE] [t/TAG]…
e.g. edit 2 d/CS2103T t/
Search deck/card : search deck/card KEYWORD [&] [MORE_KEYWORDS]
e.g. search database & relational
Test : test INDEX
e.g. test 1
List : list
Help : help