StudyBuddyPro - User Guide

Do refer to the signs below that will be used across the documents for references. These will prove to be useful when you are reading this document.

Upon startup, you will be prompted to enter one of the modes before you can proceed.

A pop-up dialog box will display a URL link to a help document.

Displays to you a full list of all tags you have currently in StudyBuddyPro.

Expected output:

Lists all StudyBuddyPro items with matching tags in the application.

Let’s say the user wishes to view the definition of pipelining. Pipelining is taught in CS2100, a Computer Organization module taught in the School of Computing at NUS. Hence, the user can make use of filterall to find all flashcards, cheatsheets and notes that are tagged “CS2100”. Note that for simplicity, all tags will be converted to lowercase upon input. Hence, ‘CS2100’ will be read as ‘cs2100’ by our application.

Example usage:

Expected output:

The user is also able to specify a multiple number of tags. For example,

will list all items that match all of the specified tags.

Clears the data in a specific feature. Depending on the mode that the user is in, the clear command will only clear the specific feature’s data.

Example usage:

Expected output:

Clears all the data in the application.

Example usage:

Expected output:

Checks if there are any remaining flashcards to revise for the day or overdue flashcards to revise before exiting the application.

Example usage:

If there are flashcards due for revision today but no overdue flashcards:

Expected output:

If there are no flashcards due for revision today but there are overdue flashcards:

Expected output:

If there are both flashcards due for revision today and overdue flashcards:

Expected output:

Edits a tag by the specified index.

Example usage:

Expected output:

This allows the user to easily modify the tags of all the items with a single command.

For instance, if the user has items that are tagged [cs2100] and [midterm], and the user wishes to make use of such items to include in a cheatsheet for CS2100 finals, the user can input

to conveniently change, for instance, all notes tagged with [midterm] to be tagged with [finals].

This then allows the user to more conveniently generate a cheatsheet for his/her final exams.

Adds a flashcard from user input question <QUESTION> and answer <ANSWER>.

Example usage:

Expected output:

Displays flashcard <FLASHCARD_INDEX> to user without answer.

Example usage:

will view the Flashcard at Index 6.

Expected output:

Displays the answer of the flashcard currently loaded.

Example usage:

Expected output:

Edits a flashcard’s question, answer, title, or tags. The flashcard will be referred to by their original title ORIGINAL_TITLE.

Example usage:

Expected output:

Lists all flashcards.

Example usage:

Expected output:

Deletes the flashcard by <FLASHCARD_INDEX> provided by the user.

The user will be prompted again to confirm their deletion.

Example usage:

Expected output:

Upon keying in delete 6 again, then the flashcard will be deleted.

Expected output:

Starts a time trial for flashcards with specified tags.

Example usage:

Expected output:

All of the flashcards containing the specified tags will be then displayed sequentially in the activity below.

Example usage:

Expeted output:

This feature helps the user check which flashcards are due for revision today and which flashcards overdue for revision. StudyBuddyPro automatically sets the date the flashcard should next be viewed at for optimal learning. These increments also scale with time i.e. newer flashcards will have to be viewed more often.

Example usage:

If no flashcards due for revision today and no overdue flashcards:

Expected output:

If there are flashcards due for revision today but no overdue flashcards:

Expected output:

If there are no flashcards due for revision today but there are overdue flashcards:

Expected output:

If there are both flashcards due for revision today and overdue flashcards:

Expected output:

Adds a note from user input with title TITLE and content CONTENT, that you can conveniently access later. The title of the note cannot be a duplicate of an existing note title.

Example usage:

Expected output:

More advanced usage: This is where our Notes feature stands out from the others! Tagging of note fragments is also supported. The note fragment tagging is added at the same time as the note is created.

Note fragments can be visualised as a form of highlighting your notes. Its tags are added with content FRAGMENT_CONTENT, at least one tag FRAGMENT_TAG, and any number of additional tags ADDITIONAL_FRAGMENT_TAG:

In the following example, two note fragment tags are added to the same note fragment:

Example usage:

Expected output:

This adds a note with content "Notes can be highlighted if needed.", and a note fragment tag with content "highlighted" and two tags "cs2100" and "important".

Multiple note fragment tags are allowed. These do not interfere with the other tags of the Note.

Simply get rid of any unwanted notes and make your life easier using delete.

Deletes the note of index NOTE_INDEX.

The user will be prompted once to confirm their deletion.

Example usage:

Expected output:

Upon using delete 3 again, then the note will be deleted.

Views the note of index NOTE_INDEX. If the note contains any note fragment tags, those tags will be hidden.

Example usage:

Expected output:

Views the note of index NOTE_INDEX. The note is shown exactly as written, including all note fragment tags.

Example usage:

Expected output:

Lists all notes found in StudyBuddyPro.

Expected output:

Example output:

filter allows you to quickly search for your notes by their specified tags.

Example usage:

Expected output:

Edits a note’s title, content, or tags. The note will be referred to by their original title ORIGINAL_TITLE.

Example usage:

Expected output:

Adds a cheatsheet from user input title <TITLE> and content <CONTENT>. Voila! To your convenience, flashcards and notes in StudyBuddyPro that have the specified tag upon creation of the cheatsheet will be used as contents.

Example usage:

Expected output:

Oh no! It appears that you might have accidentally misspelled something during creating a cheatsheet. Fret not, edit allows you to edit a cheatsheet’s title or remove tag or content by a specified <CHEATSHEET_INDEX>. At least one of the optional fields must be specified to edit.

Example CheatSheet of index 8:

Example usage:

Expected output:

Deletes a cheatsheet by the specified index.

The user will be prompted once to confirm their deletion.

Example usage:

Expected output:

Upon hitting enter, then the specified cheatsheet will be deleted.

Expected output:

Views a cheatsheet and its contents by the specified index.

Example CheatSheet of index 1:

Example usage:

Expected output:

The above screenshot shows the cheatsheet with index 1 in the GUI of StudyBuddyPro.

Views a cheatsheet’s content for a specified tag. User must be in a view command before using show command.

Example usage:

Expected output:

The above screenshot shows the cheatsheet’s content with tag index 1 in the GUI of StudyBuddyPro.

Lists all cheatsheets found in StudyBuddyPro.

Want to quickly acccess your items? filter helps to list the cheatsheet library by the user specified tag(s).

Example usage:

Expected output:

Ever wanted to re-use your midterm cheatsheet by adding more contents into it and then use it for your final examinations? Our update feature updates cheatsheet’s contents by a specified <CHEATSHEET_INDEX>. Tags specified are added into the list of tags for the cheatsheet if it not already exist.

Example CheatSheet of index 8:

Example usage 1:

Expected output:

Example usage 2:

Expected output: