Added a a section about the feedback child in README.md

ff2c7a07 · Alan Boudreault · 1a76c1b0 · ff2c7a07
Commit ff2c7a07 authored Apr 07, 2014 by Alan Boudreault
Hide whitespace changes
Inline Side-by-side

Showing with 17 additions and 0 deletions

README.md
+17 -0

No files found.
--- a/README.md
+++ b/README.md
@@ -96,6 +96,7 @@ Second XBlock instance:
        <html><p>Congratulations!</p></html>
    </message>
 </mentoring>
+```

 ### Tables

@@ -121,6 +122,22 @@ Second XBlock instance:
 </vertical>
 ```

+### Custom feedback popup window
+
+You can use the `feedback` child to have a custom popup window. Currently, only the *width* and
+*height* can be modified. The value of those attribute should be valid CSS.
+
+```xml
+<mentoring url_name="mcq_1" enforce_dependency="false">
+    <mrq name="mrq_1_1" type="choices" max_attempts="3">
+        <question>What do you like in this MRQ?</question>
+        <choice value="elegance">Its elegance</choice>
+        ...
+        <feedback width="100px" height="50px"/>
+    </mrq>
+</mentoring>
+```
+
 Installing dependencies
 -----------------------