XML Support

Author: bnmnetp

runestone/clickableArea/clickable.py

@@ -24,12 +24,14 @@
     maybeAddToAssignment,
 )
 from runestone.common.runestonedirective import RunestoneIdDirective, RunestoneIdNode
+from runestone.common.xmlcommon import write_substitute, substitute_visitor, substitute_departure
 
 
 def setup(app):
     app.add_directive("clickablearea", ClickableArea)
 
-    app.add_node(ClickableAreaNode, html=(visit_ca_html, depart_ca_html))
+    app.add_node(ClickableAreaNode, html=(visit_ca_html, depart_ca_html),
+                 xml=(substitute_visitor, substitute_departure))
 
     app.add_config_value("clickable_div_class", "runestone alert alert-warning", "html")
 

runestone/codelens/visualizer.py

@@ -31,7 +31,8 @@ def setup(app):
 
     app.add_config_value("codelens_div_class", "alert alert-warning cd_section", "html")
     app.add_config_value("trace_url", "http://tracer.runestone.academy:5000", "html")
-    app.add_node(CodeLensNode, html=(visit_codelens_html, depart_codelens_html))
+    app.add_node(CodeLensNode, html=(visit_codelens_html, depart_codelens_html),
+                 xml=(visit_codelens_xml, depart_codelens_xml))
 
 
 #  data-tracefile="pytutor-embed-demo/java.json"
@@ -65,6 +66,27 @@ class CodeLensNode(nodes.General, nodes.Element, RunestoneIdNode):
     pass
 
 
+def visit_codelens_xml(self, node):
+    html = VIS
+    if "caption" not in node["runestone_options"]:
+        node["runestone_options"]["caption"] = node["runestone_options"]["question_label"]
+    if "tracedata" in node["runestone_options"]:
+        node["runestone_options"]["tracedata"] = node["runestone_options"]["tracedata"].replace(
+            "<", "&lt;").replace(">", "&gt;")
+        html += DATA
+    else:
+        html += "</div>"
+    html = html % node["runestone_options"]
+
+    self.output.append(
+        "<exercise runestone='{divid}' />".format(**node["runestone_options"]))
+    with open("rs-substitutes.xml", "a") as subfile:
+        subfile.write("<substitute xml:id='{divid}'>".format(
+            **node["runestone_options"]))
+        subfile.write(html)
+        subfile.write("</substitute>")
+
+
 def visit_codelens_html(self, node):
     html = VIS
     if "caption" not in node["runestone_options"]:
@@ -85,6 +107,10 @@ def depart_codelens_html(self, node):
     pass
 
 
+def depart_codelens_xml(self, node):
+    pass
+
+
 # Some documentation to help the author.
 # Here's and example of a single stack frame.
 # you might ask a qestion about the value of a global variable

runestone/common/xmlcommon.py

@@ -0,0 +1,25 @@
+# Common routines for converting to PreTeXt
+
+from asyncore import write
+
+
+def write_substitute(self, node, html=None):
+    self.output.append(
+        "<exercise runestone='{divid}' />".format(**node["runestone_options"]))
+    with open("rs-substitutes.xml", "a") as subfile:
+        subfile.write("<substitute xml:id='{divid}'>".format(
+            **node["runestone_options"]))
+        if html:
+            subfile.write(f"""{html}""")
+        else:
+            subfile.write(
+                f"""<dbfetch>{node["runestone_options"]["divid"]}</dbfetch>""")
+        subfile.write("</substitute>")
+
+
+def substitute_visitor(self, node):
+    write_substitute(self, node)
+
+
+def substitute_departure(self, node):
+    pass

runestone/dragndrop/dragndrop.py

@@ -27,6 +27,7 @@
     RunestoneIdDirective,
     RunestoneIdNode,
 )
+from runestone.common.xmlcommon import write_substitute
 
 
 def setup(app):
@@ -60,13 +61,11 @@ class DragNDropNode(nodes.General, nodes.Element, RunestoneIdNode):
 
 
 def visit_dnd_xml(self, node):
-    res = visit_dnd_common(self, node)
-    self.output.append(res)
+    write_substitute(self, node)
 
 
 def depart_dnd_xml(self, node):
-    res = depart_dnd_common(self, node)
-    self.output.append(res)
+    pass
 
 
 def visit_dnd_html(self, node):

runestone/fitb/fitb.py

@@ -39,6 +39,7 @@
     RunestoneIdNode,
     get_node_line,
 )
+from runestone.common.xmlcommon import substitute_departure, substitute_visitor
 
 
 def setup(app):
@@ -47,7 +48,8 @@ def setup(app):
     app.add_node(FITBNode, html=(visit_fitb_html, depart_fitb_html))
     app.add_node(BlankNode, html=(visit_blank_html, depart_blank_html))
     app.add_node(
-        FITBFeedbackNode, html=(visit_fitb_feedback_html, depart_fitb_feedback_html)
+        FITBFeedbackNode, html=(visit_fitb_feedback_html, depart_fitb_feedback_html),
+        xml=(substitute_visitor, substitute_departure)
     )
 
     app.add_config_value("fitb_div_class", "runestone", "html")

runestone/poll/poll.py

@@ -16,15 +16,18 @@
 
 __author__ = "isaiahmayerchak"
 
+from asyncore import write
 from docutils import nodes
 from docutils.parsers.rst import directives
 from runestone.common.runestonedirective import RunestoneIdDirective, RunestoneIdNode
 from runestone.server.componentdb import addQuestionToDB, addHTMLToDB
+from runestone.common.xmlcommon import write_substitute, substitute_departure
 
 
 def setup(app):
     app.add_directive("poll", Poll)
-    app.add_node(PollNode, html=(visit_poll_html, depart_poll_html))
+    app.add_node(PollNode, html=(visit_poll_html, depart_poll_html),
+                 xml=(visit_poll_xml, substitute_departure))
 
     app.add_config_value("poll_div_class", "alert alert-warning", "html")
 
@@ -57,6 +60,11 @@ def visit_poll_html(self, node):
     self.body.append(res)
 
 
+def visit_poll_xml(self, node):
+    html = visit_poll_common(self, node)
+    write_substitute(self, node, html)
+
+
 def depart_poll_html(self, node):
     """ This is called at the start of processing a poll node.  If poll had recursive nodes
         etc and did not want to do all of the processing in visit_poll_html any finishing touches could be

runestone/server/componentdb.py

@@ -22,6 +22,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 from __future__ import print_function
+import pdb
 
 from datetime import datetime, timedelta
 
@@ -120,6 +121,8 @@ def setup(app):
 
     app.connect("env-before-read-docs", reset_questions)
     app.connect("build-finished", finalize_updates)
+    app.connect("env-before-read-docs", init_subs_file)
+    app.connect("build-finished", finalize_subs_file)
     # the `qbank` option is for the QuestionBank
     # it allows us to populate the database from the question bank
     # but we don't care about populating chapter and subchapter tables and others
@@ -174,13 +177,26 @@ def get_table_meta():
     return table_info
 
 
+def init_subs_file(app, env, docnames):
+    if app.builder.name == "xml":
+        with open("rs-substitutes.xml", "w") as subfile:
+            subfile.write("<substitutes>")
+
+
+def finalize_subs_file(app, excpt):
+    if app.builder.name == "xml":
+        with open("rs-substitutes.xml", "a") as subfile:
+            subfile.write("</substitutes>")
+
 # Reset Questions
 # ---------------
 # We need to be able to tell the difference between questions that are
 # part of the book and questions that are contributed by instructors
 # so wheenver we build the book, we mark all questions for this base course
 # with ``from_source = 'F'`` Then as the book is built and questions are updated
 # those in the book get ``from_source = 'T'`` set.
+
+
 def reset_questions(app, env, docnames):
     if sess:
         logger.info("Resetting questions")

runestone/showeval/showeval.py

@@ -15,10 +15,13 @@
 #
 __author__ = "tconzett"
 
+from asyncore import write
 from docutils import nodes
 from docutils.parsers.rst import directives
+from runestone.common.xmlcommon import substitute_departure
 from runestone.server.componentdb import addQuestionToDB, addHTMLToDB
 from runestone.common.runestonedirective import RunestoneIdDirective, RunestoneIdNode
+from runestone.common.xmlcommon import substitute_departure, write_substitute
 
 
 def setup(app):
@@ -27,7 +30,8 @@ def setup(app):
     app.add_config_value(
         "showeval_div_class", "runestone explainer alert alert-warning", "html"
     )
-    app.add_node(ShowEvalNode, html=(visit_showeval_html, depart_showeval_html))
+    app.add_node(ShowEvalNode, html=(visit_showeval_html, depart_showeval_html),
+                 xml=(visit_showeval_xml, substitute_departure))
 
 
 # Create visitors, so we can generate HTML after the doctree is resolve (where the question label is determined).
@@ -43,6 +47,11 @@ def visit_showeval_html(self, node):
     )
 
 
+def visit_showeval_xml(self, node):
+    html = CODE % node["runestone_options"]
+    write_substitute(self, node, html)
+
+
 def depart_showeval_html(self, node):
     pass
 
@@ -72,7 +81,8 @@ class ShowEval(RunestoneIdDirective):
    more code
    ~~~~
    more {{code}}{{what code becomes in step 1}}
-   more {{what code becomes in step 1}}{{what code becomes in step2}}  ##Optional comment for step 2
+   ##Optional comment for step 2
+   more {{what code becomes in step 1}}{{what code becomes in step2}}
    as many steps as you want {{the first double braces}}{{animate into the second}} wherever.
 
 
@@ -108,7 +118,8 @@ def run(self):
        ~~~~
 
        ''.join({{eggs}}{{['dogs', 'cats', 'moose']}}).upper().join(eggs)
-       {{''.join(['dogs', 'cats', 'moose'])}}{{'dogscatsmoose'}}.upper().join(eggs)  ##I want to put a comment here!
+       ##I want to put a comment here!
+       {{''.join(['dogs', 'cats', 'moose'])}}{{'dogscatsmoose'}}.upper().join(eggs)
        {{'dogscatsmoose'.upper()}}{{'DOGSCATSMOOSE'}}.join(eggs)
        'DOGSCATSMOOSE'.join({{eggs}}{{['dogs', 'cats', 'moose']}})
        {{'DOGSCATSMOOSE'.join(['dogs', 'cats', 'moose'])}}{{'dogsDOGSCATSMOOSEcatsDOGSCATSMOOSEmoose'}}