Cleaned up code and documentation.

Author: ram8647

runestone/quizly/README.txt

@@ -13,18 +13,24 @@ runestone/quizly/quizly.py   -- creates QuizlyNode from directive
 runestone/quizly/__init__.py -- imports the quizly code
 runestone/quizly/toctree.rst
 
-runestone/quizly/js   -- javascript resources
+runestone/quizly/js   -- javascript resources 
+  -- quizly.js        -- renders quizly exercise and handles interface with runestone 
+
+Quizly source files must be store in COURSE/_static.  They include:
   -- all_appinv.js    -- compressed files
   -- all_blockly.js
   -- all_quizly.js
   -- blockly.html     -- blockly iframe
   -- index.html       -- quizly UI and iframe container
   -- main.css         -- gcb style defs
-  -- media            -- image and icon files
-  -- quizly.js        -- renders quizly exercise and handles interface with runestone 
+  -- media            -- directory image and icon files 
   -- quizme-helper.js -- main quizly code
   -- quizzes.js       -- quizly quiz collection in JSON format
 
+The content files for the quizly component must stored in the course's _static folder. 
+Download the following file and unzip it in COURSE/_static, where COURSE is your course:
+  https://github.com/ram8647/quizly/blob/35ee7c945e6f240450f46f41ad9c80735215b5e0/quizly-runestone.zip
+
 runestone/quizly/test -- some test code
   -- _sources         -- test files
      -- Quizly
@@ -41,10 +47,6 @@ The files that need to be coded by the developer
 Th script that runs during runestone build. Runestone build parses the
 source document and translates the directive and its options into a QuizlyNode.
 
- - Copies resource files from quizly/js to the project/_static folder, from where
-   they are copied to build/quizly/_static during build, where they are used by
-   the _sources web pages.
-
  - QuizlyNode -- defines the node. The  only option needed for this is the quizname, 
    which is parsed from the directive. 
 
@@ -73,8 +75,8 @@ quizly.js contains the following methods and functions:
  -- class Quizly extends RunestoneBase -- constructs a Quizly object that holds the
     data from the exercise.  Calls renderQuiz() method.
 
-    -- getIFrame() -- extracts the iframe from the fully instantiated html code produced
-       by quizly.py and contained in QuizlyNode.
+    -- getIFrameAndQuizname() -- extracts the iframe from the fully instantiated html code 
+       produced by quizly.py and contained in QuizlyNode. And gets the specific quizname.
 
     -- renderQuizly() -- renders the quizly iframe inside a container <div>.
 

runestone/quizly/quizly.py

@@ -14,15 +14,20 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-# This files runs during runestone build. It generates the node data
+# This file runs during runestone build. It generates the node data
 # that is used to render the component by the  quizly.js script.
 
 # Note: An import entry for quizly must be included in runestone/__init__.py
 
+# Note: The content files for the quizly component must stored in the 
+# course's _static folder. Download the following file and unzip it in _static:
+#  https://github.com/ram8647/quizly/blob/35ee7c945e6f240450f46f41ad9c80735215b5e0/quizly-runestone.zip
+#
+
 __author__ = "rmorelli"
 
 # Debug flags
-DEBUG = True
+DEBUG = False
 VERBOSE = False
 
 import os, shutil
@@ -42,56 +47,6 @@
        </div>
        """
 
-# Resource files should be stored in the X/_static directory, from where they
-# will be automatically copied into build/x/_static, where 'x' is the project name
-STATIC_DIR = "./_static"
-
-# Copy the resource files into the _static folder, maintaining proper folder hierarchy
-# The resources should be organized as follows:
-# _static
-# |-quizly
-#   |- all_appinventor.js - compressed js files
-#   |- all_blockly.js     - compressed js files
-#   |- all_quizly.js      - compressed js files
-#   |- quizme-helper.js - main source code
-#   |- quizzes.js       - quizly quizzes
-#   |- index.html       - container for the iframe
-#   |- blockly.html     - blockly iframe
-#   |- main.css         
-#   |- media            - folder of images, etc.
-# Perhaps there's a runestone routine to copy files?
-# TODO: Test this with MobileCSP units
-# def copyfiles():
-#     CURR_DIR = os.path.dirname(os.path.realpath(__file__))
-#     QUIZLY_DIR = STATIC_DIR+'/quizly'
-#     MEDIA_DIR = QUIZLY_DIR+'/media'
-#     if not os.path.exists(QUIZLY_DIR):
-#         print('Missing directory ' + QUIZLY_DIR) if DEBUG else None
-# #        shutil.rmtree(QUIZLY_DIR)
-# #    os.mkdir(QUIZLY_DIR, mode=0o755)
-# #    os.mkdir(QUIZLY_DIR+'/media', mode=0o755)
-#     js_folder = Path(CURR_DIR).glob('js/*.js')
-#     html_folder = Path(CURR_DIR).glob('js/*.html')
-#     media_folder = Path(CURR_DIR).glob('js/media/*')
-#     css_folder = Path(CURR_DIR).glob('js/*.css')
-#     files = [x for x in js_folder]
-#     print('Copying resource files to ' + STATIC_DIR) if VERBOSE else None
-#     for f in files:
-#         print(str(f) + ' --> ' + QUIZLY_DIR) if VERBOSE else None
-#         shutil.copy(f, QUIZLY_DIR)
-#     files = [x for x in css_folder]
-#     for f in files:
-#         print(str(f) + ' --> ' + QUIZLY_DIR) if VERBOSE else None 
-#         shutil.copy(f, QUIZLY_DIR)
-#     files = [x for x in html_folder]
-#     for f in files:
-#         print(str(f) + ' --> ' + QUIZLY_DIR) if VERBOSE else None 
-#         shutil.copy(f, QUIZLY_DIR)
-#     files = [x for x in media_folder]
-#     for f in files:
-#         print(str(f) + ' --> ' + MEDIA_DIR) if VERBOSE else None
-#         shutil.copy(f, MEDIA_DIR)
-
 # Define the quizly directive
 def setup(app):
     app.add_directive("quizly", Quizly)
@@ -126,7 +81,6 @@ def visit_quizly_node(self, node):
     print('DEBUG: visit_quizly_node options = ' + str(node.runestone_options)) if DEBUG else None
 
     res = node.template % (node.runestone_options)
-#    copyfiles()  # Copy resource files
     print('DEBUG: visit_quizly_node res = ' + res) if DEBUG else None
     self.body.append(res)