RunestoneInteractive / RunestoneInteractive/rs

eBookConfig migration

Open
#1,392 1 comment 0 reactions 2 assignees View on GitHub

@ascholerChemeketa is already working on this.

Since Aug 18, 2026.

enhancement
Dominant language
TypeScript
Stars
69
Forks
117
Avg merge
6d 4h
Merged PRs (30d)
24

Description

This is for discussion related to moving as much responsibility for eBookConfig to Runestone as possible.

Here is what the _base.html emitted by RS has:

eBookConfig property Runestone-hosted context variable / source Non-Runestone-hosted value
🟒 πŸ”΅ 🟑 useRunestoneServices Fixed: true false
πŸ”΄ host Fixed: '' http://127.0.0.1:8000
πŸ”΄ app Derived from host Not set
🟒 course course_name PTX_Course_Title_Here
🟒 termStartDate term_start_date Not set
🟒 basecourse base_course PTX_Base_Course
🟒 isLoggedIn is_logged_in (default false) false
🟒 email user_email ''
🟒 isInstructor is_instructor (default false) false
🟒 πŸ”΅ logLevel Fixed: 10 0
πŸ”΄ ajaxURL Derived from app Not set
🟒 username user_id ''
🟒 readings readings (default []) null
🟒 activities activity_info (default {}) null
🟒 🟑 downloadsEnabled downloads_enabled (default false) false
🟒 🟑 allow_pairs allow_pairs (default false) false
🟒 course_attrs course_attrs (default {}, JSON-encoded) Not set
🟒 πŸ”΅ 🟑 enableScratchAC Publisher option: $b-has-scratch-activecode Same
🟒 πŸ”΅ 🟑 acDefaultLanguage $html-scratch-activecode-language, when Scratch enabled Same
new_server_prefix Fixed: "/ns" Not set
🟑 runestone_version $runestone-version Same
πŸ”΄ build_info Not set ''
πŸ”΄ python3 Not set null
πŸ”΄ jobehost Not set ''
πŸ”΄ proxyuri_runs Not set ''
πŸ”΄ proxyuri_files Not set ''
πŸ”΄ enable_chatcodes Not set false

🟒 Definitely needed for RA
πŸ”΄ Should be removed, potentially with a bit of work
πŸ”΅ Needed for static html
🟑 Gets a value set by PreTeXt

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up β€” it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.