From a251b6996fa889be550eaec306b8ed605307f313 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Wed, 7 Aug 2024 14:52:51 +0200 Subject: [PATCH] inspiring examples final --- book/_toc.yml | 10 ++++------ book/examples/coding_theory_widgets.ipynb | 4 ++-- book/examples/example_gumbel.ipynb | 6 +++++- book/examples/example_quiz_interactive.ipynb | 3 ++- book/examples/overview.md | 11 ++--------- book/examples/parametric_questions.ipynb | 2 +- book/examples/theory_questions.md | 2 +- 7 files changed, 17 insertions(+), 21 deletions(-) diff --git a/book/_toc.yml b/book/_toc.yml index 3b24308..f4f86e0 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -68,10 +68,8 @@ parts: - file: examples/book_structure.md - file: examples/h5p_examples.md - file: examples/live_code.md + - file: examples/example_gumbel.ipynb - file: examples/theory_questions.md - - file: examples/interactive_templates.md - sections: - - file: examples/example_gumbel.ipynb - - file: examples/example_quiz_interactive.ipynb - - file: examples/coding_theory_widgets.ipynb - - file: examples/parametric_questions.ipynb \ No newline at end of file + - file: examples/example_quiz_interactive.ipynb + - file: examples/coding_theory_widgets.ipynb + - file: examples/parametric_questions.ipynb \ No newline at end of file diff --git a/book/examples/coding_theory_widgets.ipynb b/book/examples/coding_theory_widgets.ipynb index 81c8255..ad2f770 100644 --- a/book/examples/coding_theory_widgets.ipynb +++ b/book/examples/coding_theory_widgets.ipynb @@ -4,9 +4,9 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# Combining coding theory with interactive questions and potential live coding\n", + "# Coding theory, interactive quizzes & live code\n", "\n", - "This page shows an example of how to combine the introduction of a certain coding implementation with interactive questions. Automatic executation of the thebe live coding has been enables and the download button has been replaced by a custom notebook file." + "This page shows an example on how to combine the introduction of a certain coding implementation with interactive questions. Compared to the previous template, the learning objective is to learn a new skill in programming using the live coding feature whereas before programming was used to illustrate a theoretic concept unrelated to coding (for example statistics)." ] }, { diff --git a/book/examples/example_gumbel.ipynb b/book/examples/example_gumbel.ipynb index e23cc7a..b366c19 100644 --- a/book/examples/example_gumbel.ipynb +++ b/book/examples/example_gumbel.ipynb @@ -8,7 +8,11 @@ "source": [ "# Programming assignment\n", "\n", - "This page shows how you can convert the classical Jupyter Notebook assignment to a jupyter book format with live coding. A widget has been implemented to check the answers, of which the data is included in a separate python file. The page automatically loads and a custom download page has been added\n", + "This page shows how you can recreate the classical Jupyter Notebook assignments that are given in many courses to a Jupyter Book format with live coding. A widget has been implemented to check the answers, of which the data is included in a separate python file. The page automatically loads and a custom download page has been added\n", + "\n", + "```{Note}\n", + "Keep in mind that Jupyter Book sections might not be the best environment for programming assignments you have in mind for your course due to the limitation posed by jupyter book. In fact, in jupyter book, python runs in the browser of the students' laptop. Nothing needs to be installed which can be an advantage but also a disadvantage depending on the learning goals of your course. TeachBooks suggests using it's live coding feature to support the theory in textbooks and not as a replacement for Jupyter Notebook.\n", + "```\n", "\n", "```{custom_download_link} ./example_gumbel_stripped.ipynb\n", ":replace_default: \"True\"\n", diff --git a/book/examples/example_quiz_interactive.ipynb b/book/examples/example_quiz_interactive.ipynb index 3cc70d9..72354fc 100644 --- a/book/examples/example_quiz_interactive.ipynb +++ b/book/examples/example_quiz_interactive.ipynb @@ -4,7 +4,8 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# Combining theory with interactive questions and extensive coding assignment\n", + "# Theory, interactive quizzes & live code\n", + "\n", "This page shows an example of how to combine theory, quizzes and code on one page. With headings and boxes, the interactive parts can be indicated (for now only if part of one cell). Automatic execution has been activated and a custom ipynb.file has replaced the download button.\n", "\n", "```{custom_download_link} ./example_quiz_interactive_stripped.ipynb\n", diff --git a/book/examples/overview.md b/book/examples/overview.md index 6a3a39d..160131d 100644 --- a/book/examples/overview.md +++ b/book/examples/overview.md @@ -1,14 +1,7 @@ # Overview -This chapter will showcase some TeachBooks making great use of Jupyter Book and TeachBooks features. They can serve as an inspiring starting point for structuring your own TeachBook or just to get an idea of how other teachers and students are using it. - -Here is an overview of the different examples discussed: - -- Clear book structure (keeping the content organized) -- Examples of H5p questions -- Illustration of the Live Code (Rocket) feature -- Combination of theory and interactive questions -- Templates for interactive coding and non-coding elements +This chapter will showcase some TeachBooks making great use of Jupyter Book and TeachBooks features. They can serve as an inspiring starting point for structuring your own TeachBook or just to get an idea of how other teachers and students are using it. Lastly some example pages are shown which combine theory and interactive questions and coding to different degrees. + diff --git a/book/examples/parametric_questions.ipynb b/book/examples/parametric_questions.ipynb index d61f7cd..b32e660 100644 --- a/book/examples/parametric_questions.ipynb +++ b/book/examples/parametric_questions.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# Parametric question\n", + "# Parametric questions\n", "\n", "On this page an example is given for parametric questions, in which an equation is checked on equivalence with the correct answer." ] diff --git a/book/examples/theory_questions.md b/book/examples/theory_questions.md index c6b2628..05f9417 100644 --- a/book/examples/theory_questions.md +++ b/book/examples/theory_questions.md @@ -1,4 +1,4 @@ -# Combining theory and interactive questions +# Combining theory & interactive quizzes This page shows you how to combine theory with questions so there is no coding involved.