edq-quizcomp-simple-gui 0.1.0

A simple GUI for the Quiz Composer meant to be run on a local server.

Quiz Composer Simple GUI

A simple and self-contained server and web GUI for the Quiz Composer.

Sample quizzes that demonstrate all question types are available in the CSE Cracks course.

Documentation Table of Contents:

• Installation / Requirements
  • Python
  • PDF Files
  • Math Equations in HTML
• Usage
  • Command Line
  • Web
    • Keyboard Shortcuts
• Known Issues
  • PDF Focus

Installation / Requirements

Python

This project requires Python >= 3.9.

The project can be installed from PyPi with:

pip install edq-quizcomp-simple-gui

Standard Python requirements are listed in pyproject.toml. The project and Python dependencies can be installed from source with:

pip3 install .

PDF Files

To compile PDF files, see the Quiz Composer documentation.

Math Equations in HTML

To output equations in HTML documents (which includes Canvas), see the Quiz Composer documentation.

Usage

Command Line

To use this project, you first need to start the web server and then navigate to the web page.

To start the server, use the qcg.cli.server Python module and point it to your Quiz Composer project. For example, to point to the sample quiz mentioned above, we could do (assuming we already downloaded the example repository):

python3 -m qcg.cli.server cse-cracks-course/quizzes/regex

This should open a web browser to our editor, but if not we can navigate to the page manually at; 127.0.0.1:12345.

You can change the port and other settings on the command line. Use the --help flag to see all the options:

python3 -m qcg.cli.server --help

Web

Once you are in the web editor, you should see your project directory displayed as a file tree on the left side of the screen. To the right of that is the code editor area. You can click directories to expand them, and double click files to open them in the editor area.

When you have an editable file related to a quiz open and selected in the editor, then the "Save & Compile" option/button above the code editor will activate with the available output options in the drop down menu to the right of the button. The "-" option means that you just want to save your current file. You may select any other available output format from the drop down menu. (Note that the "pdf" option will not be available if they cannot be compiled on your system (see this documentation)). With your format selected, the "Save & Compile" button will now save your current file and compile your current quiz or question. Once completed, the compilation output will appear in a new editor tab. Saving a file will always cause exiting output tabs to recompile.

Keyboard Shortcuts

Key	Action
control + s	Save and Compile. This is the same as clicking the "Save & Compile" button.

Known Issues

PDF Focus

How PDFs are rendered is largely handled by your browser. As such, we have less control over how exactly they are displayed and how they interact with the rest of the UI. You may find some issues when working with PDFs such as not being able to focus the PDF when clicking between editor tabs. Sometimes clicking multiple times or clicking on the tab's header can help.