Dieses interaktive Lehrbuch führt in die Erstellung von Open Educational Resources (OER) nach den Empfehlungen und Vorgaben des Datenkompetenzzentrumgs QUADRIGA als Jupyter Book ein. Diese Empfehlungen und Vorgaben sind einerseits inhaltlicher und didaktischer andererseits technischer Natur. Diese OER richtet sich vorrangig an OER-Erstellende und kann als Startpunkt (Template) für die Erstellung eigener OER genutzt werden. Einzelne (Unter-)Kapitel bieten zudem Erläuterungen zu Funktionalitäten für Lernende.
\nQUADRIGA ist das Datenkompetenzzentrum der Wissenschaftsregion Berlin-Brandenburg. Für die beiden Anwendungsdomänen Digital Humanities und Verwaltungswissenschaft entstehen unter der Einbindung der Expertise der beiden Disziplinen Informatik und Informationswissenschaft Selbstlernangebote, die als OER in Form von Jupyter Books zur freien Nachnutzung zur Verfügung gestellt werden. Um den Forschungsprozess möglichst realistisch abzubilden, basieren die OER auf Fallstudien, denen wiederum ein eigens für das Projekt entwickeltes Datenkompetenzframework zugrunde liegt. Die Fallstudien nehmen drei für die Anwendungsdomänen repräsentativen Datentypen in den Blick: Bewegtes Bild, Tabelle und Text.
\nZu den Zielgruppen von QUADRIGA zählen insbesondere promovierende und promovierte Wissenschaftler*innen der genannten Disziplinen, die den Umgang mit digitalen Daten, Methoden und Werkzeugen erlernen und weiterentwickeln wollen.
\nDieses interaktive Lehrbuch führt in die Erstellung von Open Educational Resources (OER) nach den Empfehlungen und Vorgaben des Datenkompetenzzentrumgs QUADRIGA als Jupyter Book ein. Diese Empfehlungen und Vorgaben sind einerseits inhaltlicher und didaktischer andererseits technischer Natur. Diese OER richtet sich vorrangig an OER-Erstellende und kann als Startpunkt (Template) für die Erstellung eigener OER genutzt werden. Einzelne (Unter-)Kapitel bieten zudem Erläuterungen zu Funktionalitäten für Lernende.
\nQUADRIGA ist das Datenkompetenzzentrum der Wissenschaftsregion Berlin-Brandenburg. Für die beiden Anwendungsdomänen Digital Humanities und Verwaltungswissenschaft entstehen unter der Einbindung der Expertise der beiden Disziplinen Informatik und Informationswissenschaft Selbstlernangebote, die als OER in Form von Jupyter Books zur freien Nachnutzung zur Verfügung gestellt werden. Um den Forschungsprozess möglichst realistisch abzubilden, basieren die OER auf Fallstudien, denen wiederum ein eigens für das Projekt entwickeltes Datenkompetenzframework zugrunde liegt. Die Fallstudien nehmen drei für die Anwendungsdomänen repräsentativen Datentypen in den Blick: Bewegtes Bild, Tabelle und Text.
\nZu den Zielgruppen von QUADRIGA zählen insbesondere promovierende und promovierte Wissenschaftler*innen der genannten Disziplinen, die den Umgang mit digitalen Daten, Methoden und Werkzeugen erlernen und weiterentwickeln wollen.
\n
@@ -16,7 +17,7 @@ def create_answer_box(question_id, rows=4):
class DragDropQuiz:
"""
A simple drag-and-drop quiz generator for Jupyter Books.
-
+
Usage:
quiz = DragDropQuiz()
quiz.create_matching_quiz(
@@ -26,14 +27,23 @@ class DragDropQuiz:
correct_mapping={"Description 1": "Option A", "Description 2": "Option B", "Description 3": "Option C"}
)
"""
-
- def __init__(self):
+
+ def __init__(self) -> None:
self.quiz_counter = 0
-
- def create_matching_quiz(self, title, descriptions, options, correct_mapping, show_feedback=True, feedback_messages=None):
+
+ def create_matching_quiz(
+ self,
+ title: str,
+ descriptions: list[str],
+ options: list[str],
+ correct_mapping: dict,
+ *,
+ show_feedback: bool = True,
+ feedback_messages: dict | None = None,
+ ) -> HTML:
"""
Create a drag-and-drop matching quiz.
-
+
Parameters:
- title (str): The quiz title/question
- descriptions (list): List of items to be matched (static labels)
@@ -44,76 +54,92 @@ def create_matching_quiz(self, title, descriptions, options, correct_mapping, sh
"""
self.quiz_counter += 1
quiz_id = f"drag_drop_quiz_{self.quiz_counter}_{uuid.uuid4().hex[:8]}"
-
+
# Set default feedback messages if none provided
if feedback_messages is None:
feedback_messages = {
"correct": "Perfekt! Alle {total} Zuordnungen sind korrekt!",
"incorrect": "Leider sind keine Zuordnungen korrekt. Versuchen Sie es noch einmal!",
- "partial": "Teilweise richtig: {correct} von {total} Zuordnungen sind korrekt."
+ "partial": "Teilweise richtig: {correct} von {total} Zuordnungen sind korrekt.",
}
-
+
# Convert correct mapping to use indices for easier JavaScript handling
desc_to_idx = {desc: i for i, desc in enumerate(descriptions)}
opt_to_idx = {opt: i for i, opt in enumerate(options)}
-
+
correct_pairs = []
for desc, opt in correct_mapping.items():
if desc in desc_to_idx and opt in opt_to_idx:
correct_pairs.append([desc_to_idx[desc], opt_to_idx[opt]])
-
+
html_content = self._generate_html(
- quiz_id, title, descriptions, options, correct_pairs, show_feedback, feedback_messages
+ quiz_id,
+ title,
+ descriptions,
+ options,
+ correct_pairs,
+ show_feedback=show_feedback,
+ feedback_messages=feedback_messages,
)
-
+
return HTML(html_content)
-
- def _generate_html(self, quiz_id, title, descriptions, options, correct_pairs, show_feedback, feedback_messages):
+
+ def _generate_html(
+ self,
+ quiz_id: str,
+ title: str,
+ descriptions: list[str],
+ options: list[str],
+ correct_pairs: list[list[int]],
+ *,
+ show_feedback: bool,
+ feedback_messages: dict,
+ ) -> str:
"""Generate the complete HTML for the drag-and-drop quiz."""
-
+
# Generate static description labels with drop zones
description_zones = ""
for i, desc in enumerate(descriptions):
- description_zones += f'''
+ description_zones += f"""
- '''
-
+ """
+
# Generate draggable options
draggable_options = ""
for i, option in enumerate(options):
- draggable_options += f'''
+ draggable_options += f"""
{option}
- '''
-
- return f'''
+ """
+
+ return f"""
{title}
-
+
-
+
Ziehen Sie diese zu den passenden Beschreibungen
{draggable_options}
-
+
Antwort prüfen
Zurücksetzen
-
+
- '''
-
-
\ No newline at end of file
+ """
diff --git a/quadriga/metadata/create_rdfxml.py b/quadriga/metadata/create_rdfxml.py
index e075256..af9584e 100644
--- a/quadriga/metadata/create_rdfxml.py
+++ b/quadriga/metadata/create_rdfxml.py
@@ -17,8 +17,8 @@
from pathlib import Path
from typing import Any
-from rdflib import RDF, Graph, Literal, Namespace, URIRef # type: ignore[import-not-found]
-from rdflib.namespace import DCTERMS, SKOS, XSD # type: ignore[import-not-found]
+from rdflib import RDF, Graph, Literal, Namespace, URIRef
+from rdflib.namespace import DCTERMS, SKOS, XSD
from .utils import extract_keywords, get_file_path, get_repo_root, load_yaml_file
@@ -153,9 +153,7 @@ def add_person(
graph.add((orcid_node, RDF.type, SCHEMA.PropertyValue))
graph.add((orcid_node, SCHEMA.propertyID, Literal("ORCID")))
graph.add((orcid_node, SCHEMA.value, Literal(clean_orcid_id)))
- graph.add(
- (orcid_node, SCHEMA.url, URIRef(f"https://orcid.org/{clean_orcid_id}"))
- )
+ graph.add((orcid_node, SCHEMA.url, URIRef(f"https://orcid.org/{clean_orcid_id}")))
graph.add((person_uri, SCHEMA.identifier, orcid_node))
# affiliation -> schema:affiliation (mapped in both author and contributor)
@@ -290,9 +288,7 @@ def add_chapter(
# learning-objectives -> educationalAlignment with AlignmentObject
if chapter_data.get("learning-objectives"):
for obj_index, obj_data in enumerate(chapter_data["learning-objectives"]):
- obj_uri = add_learning_objective(
- graph, obj_data, base_uri, chapter_index, obj_index
- )
+ obj_uri = add_learning_objective(graph, obj_data, base_uri, chapter_index, obj_index)
if obj_uri:
graph.add((chapter_uri, SCHEMA.educationalAlignment, obj_uri))
diff --git a/quadriga/metadata/create_zenodo_json.py b/quadriga/metadata/create_zenodo_json.py
index dd63bd1..e24eb24 100644
--- a/quadriga/metadata/create_zenodo_json.py
+++ b/quadriga/metadata/create_zenodo_json.py
@@ -250,15 +250,15 @@ def create_zenodo_json() -> bool | None:
return False
# description
- description = "
" + metadata.get("description") + "
"
+ description = "
" + metadata.get("description", "TODO TODO TODO") + "
"
description_base = f"""
Dieses interaktive Lehrbuch kann als Web-Version verwendet, zur individuellen Anpassung heruntergeladen werden und steht darüber hinaus auch auf GitHub zur Verfügung.
-
Die QUADRIGA-OER sind nach einem einheitlichen Template gestaltet, werden nach einem standardisierten Verfahren qualitätsgeprüft und mit Metadaten nach dem QUADRIGA-Metadatenschema ausgezeichnet.
+
Die QUADRIGA-OER sind nach einem einheitlichen Template gestaltet, werden nach einem standardisierten Verfahren qualitätsgeprüft und mit Metadaten nach dem QUADRIGA-Metadatenschema ausgezeichnet.
QUADRIGA Datenkompetenzzentrum
QUADRIGA ist das Datenkompetenzzentrum der Wissenschaftsregion Berlin-Brandenburg. Für die beiden Anwendungsdomänen Digital Humanities und Verwaltungswissenschaft entstehen unter der Einbindung der Expertise der beiden Disziplinen Informatik und Informationswissenschaft Selbstlernangebote, die als OER in Form von Jupyter Books zur freien Nachnutzung zur Verfügung gestellt werden. Um den Forschungsprozess möglichst realistisch abzubilden, basieren die OER auf Fallstudien, denen wiederum ein eigens für das Projekt entwickeltes Datenkompetenzframework zugrunde liegt. Die Fallstudien nehmen drei für die Anwendungsdomänen repräsentativen Datentypen in den Blick: Bewegtes Bild, Tabelle und Text.
Zu den Zielgruppen von QUADRIGA zählen insbesondere promovierende und promovierte Wissenschaftler*innen der genannten Disziplinen, die den Umgang mit digitalen Daten, Methoden und Werkzeugen erlernen und weiterentwickeln wollen.
-
QUADRIGA ist eins von 11 Datenkompetenzzentren in Deutschland und wird vom Bundesministerium für Forschung, Technologie und Raumfahrt (BMFTR) und von der Europäischen Union im Rahmen von NextGenerationEU finanziert. Zu den Verbundpartnern zählen:
+
QUADRIGA ist eins von 11 Datenkompetenzzentren in Deutschland und wird vom Bundesministerium für Forschung, Technologie und Raumfahrt (BMFTR) und von der Europäischen Union im Rahmen von NextGenerationEU finanziert. Zu den Verbundpartnern zählen:
Universität Potsdam (Verbundkoordination) (Förderkennzeichen: 16DKZ2034A)
Filmuniversität Babelsberg KONRAD WOLF (Förderkennzeichen: 16DKZ2034B)
diff --git a/quadriga/metadata/extract_from_lernziele.py b/quadriga/metadata/extract_from_lernziele.py
index 90a7892..0cbc664 100644
--- a/quadriga/metadata/extract_from_lernziele.py
+++ b/quadriga/metadata/extract_from_lernziele.py
@@ -1,11 +1,14 @@
"""Extract learning objectives with metadata from Lernziele.md files."""
from __future__ import annotations
+
import logging
import re
+import sys
from pathlib import Path
from typing import Any
-from .utils import get_repo_root, save_yaml_file, get_file_path, load_yaml_file, iter_toc_files
+
+from .utils import get_file_path, get_repo_root, iter_toc_files, load_yaml_file, save_yaml_file
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
logger = logging.getLogger(__name__)
@@ -25,20 +28,20 @@ def parse_metadata_comment(comment: str) -> dict[str, str]:
"""Parse 'competency: X | bloom: Y' from the inner text of an HTML comment."""
metadata = {}
- for part in comment.split('|'):
- part = part.strip()
- if ':' not in part:
+ for part_raw in comment.split("|"):
+ part = part_raw.strip()
+ if ":" not in part:
continue
- key, value = part.split(':', 1)
- key = key.strip().lower().replace(' ', '-')
+ key, value = part.split(":", 1)
+ key = key.strip().lower().replace(" ", "-")
value = value.strip()
if not value:
continue
- if key == 'bloom':
- metadata['blooms-category'] = value
- elif key == 'competency':
+ if key == "bloom":
+ metadata["blooms-category"] = value
+ elif key == "competency":
metadata[key] = value
- metadata['data-flow'] = derive_data_flow(value)
+ metadata["data-flow"] = derive_data_flow(value)
return metadata
@@ -47,14 +50,14 @@ def validate_objective_metadata(objective_data: dict[str, Any]) -> list[str]:
"""Fill in missing competency/bloom/data-flow defaults and return names of missing fields."""
missing_fields = []
- if not objective_data.get('competency'):
- missing_fields.append('competency')
- objective_data['competency'] = DEFAULT_COMPETENCY
- objective_data['data-flow'] = DEFAULT_DATA_FLOW
+ if not objective_data.get("competency"):
+ missing_fields.append("competency")
+ objective_data["competency"] = DEFAULT_COMPETENCY
+ objective_data["data-flow"] = DEFAULT_DATA_FLOW
- if not objective_data.get('blooms-category'):
- missing_fields.append('blooms-category')
- objective_data['blooms-category'] = DEFAULT_BLOOM
+ if not objective_data.get("blooms-category"):
+ missing_fields.append("blooms-category")
+ objective_data["blooms-category"] = DEFAULT_BLOOM
return missing_fields
@@ -92,7 +95,7 @@ def extract_admonition_blocks(
validation_issues = []
# Pattern to match admonition blocks preceded by
- admonition_pattern = r'\s*\n```\{admonition\}\s+(.+?)\n((?::[^\n]+\n)*)((?:(?!```).)+)```'
+ admonition_pattern = r"\s*\n```\{admonition\}\s+(.+?)\n((?::[^\n]+\n)*)((?:(?!```).)+)```"
matches = re.finditer(admonition_pattern, content, re.DOTALL | re.MULTILINE)
@@ -102,7 +105,7 @@ def extract_admonition_blocks(
body = match.group(4).strip()
# Parse title - extract text and reference
- title_match = re.match(r'\[(.+?)\]\((.+?)\)(\s*\(\*(.+?)\*\))?', title_line)
+ title_match = re.match(r"\[(.+?)\]\((.+?)\)(\s*\(\*(.+?)\*\))?", title_line)
if not title_match:
logger.warning("Could not parse admonition title: %s", title_line)
@@ -112,7 +115,7 @@ def extract_admonition_blocks(
# Learning goal
learning_goal_match = re.search(
- r'',
+ r"",
body,
re.DOTALL,
)
@@ -120,34 +123,37 @@ def extract_admonition_blocks(
learning_goal = normalize_whitespace(learning_goal_match.group(1))
else:
learning_goal = "TODO"
- validation_issues.append({
- 'section': section_title,
- 'missing_fields': ['learning-goal']
- })
+ validation_issues.append(
+ {"section": section_title, "missing_fields": ["learning-goal"]}
+ )
# Strip all START/END markers before parsing objectives
- body_cleaned = re.sub(r'\s*', '', body)
- body_cleaned = re.sub(r'\s*', '', body_cleaned)
+ body_cleaned = re.sub(r"\s*", "", body)
+ body_cleaned = re.sub(r"\s*", "", body_cleaned)
# Parse numbered objectives with optional inline metadata comment
objectives = []
- objective_pattern = r'\d+\.\s+(.+?)(?:(?:\n\s*|(?=)?(?=\n\d+\.|\n\n|$)'
+ objective_pattern = (
+ r"\d+\.\s+(.+?)(?:(?:\n\s*|(?=)?(?=\n\d+\.|\n\n|$)"
+ )
for obj_match in re.finditer(objective_pattern, body_cleaned, re.DOTALL):
objective_text = normalize_whitespace(obj_match.group(1))
metadata_comment = obj_match.group(2)
- objective_data = {'learning-objective': objective_text}
+ objective_data = {"learning-objective": objective_text}
if metadata_comment:
objective_data.update(parse_metadata_comment(metadata_comment))
missing_fields = validate_objective_metadata(objective_data)
if missing_fields:
- validation_issues.append({
- 'section': section_title,
- 'objective': objective_text,
- 'missing_fields': missing_fields
- })
+ validation_issues.append(
+ {
+ "section": section_title,
+ "objective": objective_text,
+ "missing_fields": missing_fields,
+ }
+ )
objectives.append(objective_data)
@@ -155,11 +161,11 @@ def extract_admonition_blocks(
continue
block_data: dict[str, Any] = {
- 'learning-goal': learning_goal,
- 'objectives': objectives,
+ "learning-goal": learning_goal,
+ "objectives": objectives,
}
- block_data['chapter'] = chapter
+ block_data["chapter"] = chapter
blocks.append(block_data)
@@ -176,7 +182,7 @@ def extract_from_lernziele_file(
logger.info("Extracted %d admonition blocks from %s", len(blocks), md_file_path.name)
return blocks, issues
except FileNotFoundError:
- logger.error("File not found: %s", md_file_path)
+ logger.exception("File not found: %s", md_file_path)
return [], []
except Exception:
logger.exception("Error reading file: %s", md_file_path)
@@ -194,7 +200,7 @@ def generate_validation_report(
report = f"⚠️ Found {len(validation_issues)} issues with missing metadata:\n\n"
for i, issue in enumerate(validation_issues, 1):
report += f"{i}. Section: {issue['section']}\n"
- if 'objective' in issue:
+ if "objective" in issue:
report += f" Objective: {issue['objective'][:60]}...\n"
report += f" Missing: {', '.join(issue['missing_fields'])}\n\n"
report += "\nHow to fix:\n"
@@ -216,7 +222,7 @@ def merge_learning_objectives_into_metadata() -> bool:
md_file = None
for file_str in iter_toc_files(toc_data or {}):
p = Path(file_str)
- if re.search(r'lernziel|learning.?objective|learning.?outcome', p.stem, re.IGNORECASE):
+ if re.search(r"lernziel|learning.?objective|learning.?outcome", p.stem, re.IGNORECASE):
if p.suffix not in [".md", ".ipynb"]:
p = p.with_suffix(".md")
full_path = get_file_path(p, repo_root)
@@ -259,13 +265,16 @@ def merge_learning_objectives_into_metadata() -> bool:
chapter_objectives: dict[str, list] = {}
chapter_learning_goals: dict[str, str] = {}
for section in sections:
- chapter = section.get('chapter')
+ chapter = section.get("chapter")
if not chapter:
continue
- chapter_objectives.setdefault(chapter, []).extend(section['objectives'])
- learning_goal = section.get('learning-goal')
+ chapter_objectives.setdefault(chapter, []).extend(section["objectives"])
+ learning_goal = section.get("learning-goal")
if learning_goal:
- if chapter in chapter_learning_goals and chapter_learning_goals[chapter] != learning_goal:
+ if (
+ chapter in chapter_learning_goals
+ and chapter_learning_goals[chapter] != learning_goal
+ ):
logger.warning(
"Multiple learning goals found for chapter '%s'. Using first one.",
chapter,
@@ -314,4 +323,4 @@ def merge_learning_objectives_into_metadata() -> bool:
if __name__ == "__main__":
success = merge_learning_objectives_into_metadata()
- exit(0 if success else 1)
\ No newline at end of file
+ sys.exit(0 if success else 1)
diff --git a/quadriga/metadata/inject_all_metadata.py b/quadriga/metadata/inject_all_metadata.py
index bfbddcc..ccc3bb5 100644
--- a/quadriga/metadata/inject_all_metadata.py
+++ b/quadriga/metadata/inject_all_metadata.py
@@ -250,10 +250,10 @@ def format_author_name(author_data: dict) -> str:
if given and family:
return f"{given} {family}"
- elif name:
- return name
+ if name:
+ return str(name)
- return given or family
+ return str(given) or str(family)
def ensure_absolute_url(url: str, base_url: str) -> str:
@@ -280,6 +280,7 @@ def create_opengraph_meta_tags(
base_url: str,
book_title: str,
logo_filename: str,
+ *,
is_chapter: bool = False,
) -> str:
"""
@@ -355,14 +356,20 @@ def create_opengraph_meta_tags(
if not is_chapter:
# Root page: book:release_date
if "datePublished" in jsonld_data:
- tags.append(f' ]*>\s*)", html_content, re.IGNORECASE)
+ viewport_match = re.search(
+ r"(]*>\s*)", html_content, re.IGNORECASE
+ )
if viewport_match:
injection_point = viewport_match.end()
else:
@@ -576,10 +591,18 @@ def inject_all_metadata_into_html(
logger.warning("No tag found in %s, skipping", html_path.name)
return False
# For injection, add before the tag
- html_content = html_content[:injection_point] + f"\n{full_injection}\n" + html_content[injection_point:]
+ html_content = (
+ html_content[:injection_point]
+ + f"\n{full_injection}\n"
+ + html_content[injection_point:]
+ )
else:
# For after viewport/charset injection, insert at found position
- html_content = html_content[:injection_point] + f"\n{full_injection}\n\n" + html_content[injection_point:]
+ html_content = (
+ html_content[:injection_point]
+ + f"\n{full_injection}\n\n"
+ + html_content[injection_point:]
+ )
# Write the modified HTML back
with html_path.open("w", encoding="utf-8") as f:
@@ -737,15 +760,19 @@ def inject_all_metadata(
# Check if the redirect page has proper HTML structure
if "]*>', index_content, re.IGNORECASE)
+ meta_refresh_match = re.search(
+ r"]*>", index_content, re.IGNORECASE
+ )
meta_refresh = meta_refresh_match.group(0) if meta_refresh_match else ""
# Create proper HTML with OpenGraph metadata and meta refresh
new_index_content = f"""
-
+