Table of Contents

• 1. Introduction
• 2. Getting Started
  • 2.1. Overview and Developer’s First Steps
  • 2.2. Project Communications
  • 2.3. Repositories and Official Mirrors
  • 2.4. JSAV
  • 2.5. File Structure and File Naming Conventions
  • 2.6. OpenDSA Coding Standards
  • 2.7. Web Programming Resources
  • 2.8. Disabling the Browser Cache and Debugging
  • 2.9. Setting up a Local Development Environment
    • 2.9.1. Installing Docker
    • 2.9.2. Installing OpenDSA
    • 2.9.3. Running a Local Web Server
  • 2.10. Writing Visualizations and Exercises
• 3. Compiling Book Instances: OpenDSA Configuration
  • 3.1. Overview
  • 3.2. Motivation for the Configuration System
  • 3.3. Configuration Process
    • 3.3.1. Module and Exercise Removal
    • 3.3.2. Book Name
  • 3.4. Format
  • 3.5. Configuring Exercises
  • 3.6. Book Configuration GUI
    • 3.6.1. Load Existing Configuration (Optional)
    • 3.6.2. Book settings
    • 3.6.3. Book Content
    • 3.6.4. Saving Your Configuration
  • 3.7. Creating Course Offerings
    • 3.7.1. Rationale
    • 3.7.2. Process
• 4. Module Authoring
  • 4.1. Module Structure
  • 4.2. Math and Symbol Escapes
  • 4.3. Math and Code
  • 4.4. Code Snippet Support
  • 4.5. Creating Classroom Presentation Slides
  • 4.6. Internationalization Support
• 5. House Style Rules
  • 5.1. Content Types
  • 5.2. Algorithm Visualizations and slideshows
  • 5.3. Use of Gendered Pronouns in Prose
• 6. Notes for AV and Exercise Developers
  • 6.1. Configuration: Code lines and Internationalization
    • 6.1.1. File Format
    • 6.1.2. Use Case: Standalone AV or Proficiency Exercise
    • 6.1.3. Use Case: Inline Slideshow
    • 6.1.4. Use Case: No pseudocode object
    • 6.1.5. Use Case: Shared JSON file
    • 6.1.6. Using the configuration
  • 6.2. URL Parameters
  • 6.3. Equations
  • 6.4. CSS
  • 6.5. “Stand-alone” vs. “Inline” AVs and Exercises
  • 6.6. Slideshows
  • 6.7. Programming Exercises
• 7. Using OpenDSA to Create JSAV-based Proficiency Exercises
  • 7.1. Comparisons for gradeable steps
• 8. Using OpenDSA with the Khan Academy infrastructure
  • 8.1. Summary Exercises
  • 8.2. Math and Variables
  • 8.3. True/False Questions
  • 8.4. Multiple Choice Questions
  • 8.5. Fill-in-the-Blank Questions
  • 8.6. Using JavaScript and JSAV within the Khan Academy Framework
  • 8.7. Naming Conventions
  • 8.8. Common Errors
• 9. Client-side Development
  • 9.1. AV Developer Responsibilities
  • 9.2. Internationalization Support
  • 9.3. Glossary Concept Map Definition
  • 9.4. Client-side API
    • 9.4.1. ODSA.AV
    • 9.4.2. ODSA.MOD
    • 9.4.3. ODSA.UTILS
  • 9.5. Tips and Tricks
    • 9.5.1. Truthy and Falsy
    • 9.5.2. HTML5 postMessage
    • 9.5.3. Encapsulation
  • 9.6. Troubleshooting
    • 9.6.1. jQuery Selectors
    • 9.6.2. Proficiency Exercises
• 10. ReST Extensions
  • 10.1. avembed
  • 10.2. extrtoolembed
  • 10.3. avmetadata
  • 10.4. codeinclude
  • 10.5. inlineav
  • 10.6. iframe
  • 10.7. numref
  • 10.8. chap/numchap
  • 10.9. showhidecontent
  • 10.10. TODO
  • 10.11. odsalink
  • 10.12. odsascript
  • 10.13. odsafig
  • 10.14. odsatab
  • 10.15. odsatoctree
  • 10.16. ref
  • 10.17. topic (special case)
• 11. The Document Processor
  • 11.1. Overview
  • 11.2. First Pass
  • 11.3. Second Pass
  • 11.4. Integration with Sphinx
  • 11.5. Third Pass
  • 11.6. Where things are
• 12. OpenDSA-LTI Implementation
  • 12.1. Technologies Stack
  • 12.2. How OpenDSA-LTI works
  • 12.3. Making New Modules, Exercises, Visualizations Available Through LTI
  • 12.4. Canvas Course Integration
    • 12.4.1. Course Generation
    • 12.4.2. LTI Launches
    • 12.4.3. Recording Scores and Sending Scores to Canvas
    • 12.4.4. Recording User Interactions
  • 12.5. External Tools Integration
    • 12.5.1. Launching External Tools
    • 12.5.2. Receiving Scores from External Tools
  • 12.6. Integrating Stand-alone Modules, Exercises, and Visualizations
    • 12.6.1. Configuring OpenDSA as an External Tool
    • 12.6.2. Content Selection
    • 12.6.3. Serving Stand-alone Exercises and Visualizations
    • 12.6.4. Generating Stand-alone Modules
    • 12.6.5. Serving Stand-alone Modules
  • 12.7. Installation and Setup
• 13. OpenDSA-LTI Web Interfaces
  • 13.1. OpenDSA and the LMS
  • 13.2. Instructor’s Tools
• 14. OpenDSA-LTI database schema design
• 15. Client-Side Framework
  • 15.1. Responsibilities
    • 15.1.1. Login, Logout and Registration
    • 15.1.2. Dynamic iFrame Resizing for Embedded Exercises
    • 15.1.3. Dynamically Loading Exercises
    • 15.1.4. Score Management
    • 15.1.5. Proficiency Management
    • 15.1.6. Keeping Pages in Sync
    • 15.1.7. Interaction Data Collection and Transmission
    • 15.1.8. Runtime Exercise Configuration Support
  • 15.2. Data Model
    • 15.2.1. Exercises
    • 15.2.2. Event Messages Transmitted to the Server
  • 15.3. Implementation and Operation
    • 15.3.1. Data Flow
    • 15.3.2. Page Initialization
    • 15.3.3. Support Functions
  • 15.4. Debugging
  • 15.5. MathJax Support
• 16. Event Message Format
  • 16.1. Interaction Data Events
  • 16.2. Proficiency Exercise Attempt Object
  • 16.3. Khan Academy Exercise Attempt Object
• 17. Exercise Json File Documentation
  • 17.1. Exercise Json File Format
• 18. Database Implementation Details
  • 18.1. Changes for OpenDSA-DevStack
  • 18.2. Changes for OpenDSA-LTI
  • 18.3. Database controls
  • 18.4. Helpful Links