# 1️ Roman-Numeral Analysis

In this example, we will build a basic assignment for roman-numeral analysis. When complete, it'll look like this.

<figure><img src="/files/J4GsxQIsfRo6frn4O9Ic" alt=""><figcaption><p>Completed Assignment</p></figcaption></figure>

### Step 1: Create the Assignment

After creating a course (see [Setup](https://github.com/Brian-Hofmann/Rameau/blob/develop/docs/user-guide/setup.md) & [Courses](https://github.com/Brian-Hofmann/Rameau/blob/develop/docs/user-guide/courses.md)) click on the <mark style="color:orange;">**Assignments**</mark> button to open the course assignment view. Click the <mark style="color:orange;">**Create Assignment**</mark> button and type in the following information:

* Name: `Roman-Numeral Analysis`
* Due Date: (enter the desired date and time)
* Points Per Answer: `3`
* Instructions: (leave blank)

Click the <mark style="color:orange;">**Save | Go to Builder**</mark> button to open the assignment builder view.

### Step 2: Upload Resources

Download the Roman-Numeral Analysis PDF file below.

{% embed url="<https://shared-assets.adobe.com/link/96b4263d-519d-429e-6f55-a05239bfe229>" %}

Click the <mark style="color:orange;">**Add Resource**</mark> button. In the manage resources window, click the <mark style="color:orange;">**Upload File**</mark> button and upload the Roman-Numeral Analysis file.

Once uploaded, click the <mark style="color:orange;">**Add to Assignment**</mark> icon to upload the file to the assignment builder. Exit the manage resources window. The PDF file should now appear in the assignment builder.

### Step 3: Add Answer Boxes

Click the <mark style="color:orange;">**Box Tool**</mark> icon to activate the cursor (leave the default width, height, input type, and color settings).

With the cursor loaded (a white box should appear with the mouse pointer), click once for each box as seen in the example image.

<figure><img src="/files/k1MxlK03z5QwbvJFAyM5" alt=""><figcaption><p>Answer Box Input</p></figcaption></figure>

{% hint style="info" %}
As students answer boxes, they can press tab to advance the cursor to the next box. The order in which boxes are added to the assignment determines the order of how the cursor advances when the tab key is pressed. We recommend a logical left-to-right approach when adding boxes.
{% endhint %}

The boxes may not be perfectly aligned (as in the example image above). Click the <mark style="color:orange;">**Select Tool**</mark> and marquee select the entire row of boxes above the music. Once selected, click the align to top or align to bottom icon to tidy the vertical alignment. Follow the same procedure for the row of boxes below the music.

The boxes above are for guitar chords and the boxes below for roman numerals. Since each pair of boxes refer to each other, aligning them horizontally will help keep everything organized. Marquee select one pair of boxes (above and below the music) and then click the align left or align right button in the right-side panel to align the boxes horizontally. Continue aligning each pair of answer boxes.

{% hint style="info" %}
With one or more boxes selected, you can nudge the boxes in any direction by pressing the arrow keys on the keyboard.
{% endhint %}

### Step 4: Color the Boxes

Though optional, coloring the boxes can help students differentiate between answer types. In this example, give the boxes these following HEX colors:

* Key signature: blue `#d1e4f7`
* Guitar chords: gray `#f1f1f1`
* Roman numerals: white `#ffffff`

To color a box, select the box (or select multiple boxes by clicking and dragging) then click the **Color** swatch in the right-side panel. You can select a color using the hue slider, the color dropper (to match a color from your anywhere on your computer screen), or type the desired HEX, RGB, or HSL value. To match the example assignment colors, use the hex values listed above.

### Step 5: Input Answers

Select a box, in this case the blue key signature box, and then click <mark style="color:orange;">**Grading**</mark> in the right-side panel. Type `D:` in the **Value** text field. Continue entering answers for all the guitar chords. From left to right: `D` `A7` `D` `e/G` `A7` `D`

{% hint style="info" %}
To speed up answer entry, the following keyboard shortcut is recommended: with a box selected and the **Grading** view active in the right-side panel, press tab to load the cursor into the **Value** text field. Type the answer then press shift+arrow (left or right) to select the adjacent box. This method reduces the need to mouse to and from the right-side panel.
{% endhint %}

Follow the same procedure to input the answers, as seen in the image below, for the roman numeral boxes.

#### Inversion Boxes

To input answers for inversions, click the <mark style="color:orange;">**Show Inversions**</mark> toggle then type the desired numbers into the top, middle, or bottom inversion text fields.

{% hint style="info" %}
The inversion boxes will only be visible when you preview the assignment. Students will not see the inversion boxes until they toggle inversion boxes to input the correct answer.
{% endhint %}

### Step 6: Add Grading Rules

By default, Rameau applies a match grading rule to each answer box. For this assignment, that means each answer must match exactly to receive full credit. If a student gave a partially correct answer they would receive no credit. You can always manually adjust a student's grade to give partial, full, or no credit. However, Rameau can assign partial credit automatically using the grading rules feature.

In this assignment, we want to give partial credit to students who correctly identify either the roman numeral or the inversion. With a box selected, click the <mark style="color:orange;">**Add Custom Grading Rule**</mark> button in the right-side panel. Click the <mark style="color:orange;">**Add Rule**</mark> button to open the <mark style="color:orange;">**Add Grading Rule**</mark> window. Enter the following for the new rule:

* Name: `Inverted Chord`
* Properties: `Inversion Top` and `Inversion Middle`
* Operator: `Equals`
* Points: `1`

Click the **Add Evaluation** button and enter the following:

* Properties: `Value`
* Operator: `Equals`
* Points: `2`

Click the <mark style="color:orange;">**Save Rule**</mark> button. From the <mark style="color:orange;">**Add Grading Rule**</mark> window click the <mark style="color:orange;">**Use Rule**</mark> button next to Inverted Chords. The rule will appear in the right-side panel below the Value and Inversion text fields. You can edit this rule by clicking the pencil icon or remove the rule from this box.

Apply this rule to each answer box that contains an inversion so that partial credit may be awarded.

### Step 7: Save & Preview

Click outside of a box to deselect the box and return the view to the full tool panel. Click the <mark style="color:orange;">**Save Assignment**</mark> button to save the assignment. A green confirmation popover should appear at the bottom right corner of the browser window.

Click the <mark style="color:orange;">**Preview Assignment**</mark> button to see all the answers. Double check to make sure they match the example assignment.

You can test the grading by editing the correct answers in preview mode. Select a box and change one or more values.

{% hint style="info" %}
Right-click on a box to toggle inversion boxes.
{% endhint %}

When ready, submit the edited answers. Rameau will calculate the grade based on your inputs. Hover over red answer boxes to see what points, partial or otherwise, are awarded.

### Step 8: Open & Edit the Assignment

Click the back arrow in the upper toolbar to go back to the course assignment view.

{% hint style="danger" %}
All *unsaved* edits to the assignment will be lost when clicking the back arrow.
{% endhint %}

Click the <mark style="color:orange;">**Open**</mark> toggle for this assignment. Students can now see the assignment and can work on it until the due date.

{% hint style="warning" %}
The assignment can be edited while it is open. However, if students have already begun inputting answers, edits may render the affected answers incorrect. Editing the title, due date, or other non-answer parameters will not impact the students answers.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://info.rameaumusic.com/example-assignments/roman-numeral-analysis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
