FlashCard Pro - User Guide

If user does not supply parameter for command: shows all the available commands and syntax in FlashCard Pro

If user supply a parameter in command: shows the specific command syntax.

The DECK_NAME must be unique and no deck that exist in FlashCard Pro library should have the same name of DECK_NAME.

If there is another deck with the same name DECK_NAME, there will be an error message and the empty deck will not be created.

The DECK_NAME must be a name of an existing deck in FlashCard Pro.

When entering the PRIORITY_LEVEL, there are only 2 valid choices HIGH and LOW. Refer to the table below to know how to use the PRIORITY_LEVEL:

If no priority/ parameter is entered, then the default priority level is LOW.

If you enter any input other than HIGH or LOW, there will be an error message and the card will not be created.

BACK_TEXT is the answer of the Front Back flashcard.

No choice should be entered under choice/.

the BACK_TEXT parameter should correspond to choice entered by the user, using the order of choice entered and should be a integer value from 1, 2, …​., Number of choices entered.

To create a Multiple Choice card, there should be at least 2 choice/ parameters entered.

If there are only 1 choice/ parameters entered, there will be an error message and the card will not be created.

Click on an existing deck.

In the deck display window click on Change name/Add question to add a new card.

In the card creation window, select either Java or JavaScript.

Enter a question that tells you what code to write. An example question would be:

Write a program to read in strings and print out each string with all alphabetical characters in uppercase.

Test cases for Java cards are as follows:

Then, in the box to the right that says Enter expected output, type what your program should print out "to the console".

Do not put whitespace behind or in front of each line of your input or output if the whitespace is not intended. The Java card’s output comparison checker is sensitive to any differences between your program’s output and expected output.

You cannot enter empty outputs but an empty input is ok.

To enter another test case, click on Add and a new row of input and output boxes will appear.

To delete a test case row, click Delete.

Once your test cases are all typed in, click on Add Card and your deck will have your brand new Java card.

The command is as follows : Suppose I have a deck named myDeck, and the question Read in lines from the console and uppercase them, type

add deck/myDeck front/Read in lines from the console and uppercase them java/

In the above command, the keyword java/ tells the command line that you want to enter some test cases. The multiline CLI will then tell you:

Enter your inputs/outputs below.

Type your test cases as such: input/[your inputs on the next line], then a newline, then output/[your expected output]. Do not modify the message Enter your inputs/outputs below.

Once you have keyed in your inputs and outputs, type CTRL+D to escape multiline mode. You should see your new Java card in your deck.

Example:

Enter your inputs/outputs below.
input/
hello
ALREADYUPPERCASE
output/
HELLO
ALREADYUPPERCASE

if you want to put a blank input, just type input/ with nothing after it to make it explicit to FlashCard Pro that you want a blank input.

Outputs still cannot be blank.

Enter a question that tells you what code to write.

Task: Write a function called addExclam(str) that takes in a string and adds a "!". Input: A string. Output: The string with a "!" at the back.

Test cases for JavaScript cards are as follows:

If your assert calls the wrong function like addexclam instead of addExclam, your asserts will fail.

If your asserts have the wrong expected output in the first place such as assert(addExclam("I love you!"), "I love you!"); where the expected output is missing an additional exclamation mark, your asserts will fail even if you have the correct function.

Advanced use case: You can technically write multiple functions in the same JavaScript card program. Then just put in asserts that call each function:

assert(addExclam("Hello"), "Hello!");
assert(addFive(123), 128);
assert(addExclam("I love you!"), "I love you!!");

The card expects you to write asserts as shown and nothing else. If you write checks like addOne(1) == 2, the JavaCard’s assert function cannot be used to check how many test cases you have, and how many you passed.

Once your test cases are all typed in, click on Add Card and your deck will have your brand new JavaScript card.

Once you have clicked Add Card, click on Done to finish your card creating session. You are now ready to test yourself.

The command is as follows : Suppose I have a deck named myDeck, and the question Make a function that adds 5 to a number, type

add deck/myDeck front/Make a function that adds 5 to a number js/

In the above command, the keyword js/ tells the command line that you want to enter some asserts. The multiline CLI will then tell you:

Enter your asserts below.

Type your asserts as described previously starting on the next line. Do not modify the message Enter your asserts below.

Once you have keyed in your asserts, type CTRL+D to escape multiline mode. You should see your new JavaScript card in your deck.

The DECK_NAME must be an existing deck in the FlashCard Pro library.

The CARD_INDEX refers to the index of a card in the deck.

If you want to edit the front of the card, FRONT_TEXT should be supplied.

If you want to edit the back of the card, BACK_TEXT should be supplied.

If you want to edit a choice of an Multiple Choice card, CHOICE_INDEX and CHOICE_TEXT should be supplied.

test deck/science_deck duration/0

test deck/science_deck duration/100