nice overview

This commit is contained in:
Julie Kirsch 2024-06-10 00:35:57 +02:00
parent 10df49e2b7
commit 2bf6964168
7 changed files with 65 additions and 1 deletions

View file

@ -65,6 +65,7 @@ parts:
- caption: Examples
chapters:
- file: examples/overview
- file: examples/book_overview.md
- file: examples/h5p_examples.md
- file: examples/theory_questions.md
- file: examples/interactive_templates.md

View file

@ -0,0 +1,58 @@
# Well-structured Overview
In this section some nice examples for ther overview of your book are covered. You might not judge a book by its cover but perhaps by its introduction:)
One thing students love is having all practical information about a course collected and updated on one page. <br>
No more scrolling through the introduction lecture on Brightspace while veryfing assessment methods on the online studyguide or finding out about the schedule on MyTimetable.
The crossover module Data Science and Artifical Intelligence for Engineers, or in short DSAIE, aims to teach powerful data science tools to 2nd master students from the Civil Engineering and Geosciences faculty. In order to do that they use a combination of practical projects and theory provided to the students through their online interactive [book](https://interactivetextbooks.citg.tudelft.nl/dsaie/intro.html). Let's have a look at it.
## Logistics
```{figure} figures/nice_overview1.PNG
---
width: 650
name: nice_overview1
align: center
figclass: "margin"
---
DSAIE Overview Page
```
While the left menu shows the first two chapters of the table of contents, the right hand side menu shows the contents of the current page which in this case is called `Home` where an introduction is given on the different units of the course, the responsible lecturers and the schedule. Additionally the book layout is explained to the students which can help clarify hot to use the interactive sections.
## Tagged content
Clicking on `Assessment` in the contents menu will bring you to the corresponding paragrapgh.
```{figure} figures/nice_overview2.PNG
---
width: 650
name: nice_overview1
align: center
figclass: "margin"
---
DSAIE Assessment methods + Tags
```
Logically, the assessment of the course are explained in a concise manner. Additionally, the lecturers have introduced some tags such as `written-exam` and `group-assignment`. Likewise, the reading material is also tagged with different sources so that student sknow where they can find more information.
Throughout the book, those tags might be used as follows:
```{figure} figures/nice_overview4.PNG
---
width: 650
name: nice_overview1
align: center
figclass: "margin"
---
Additional reading reference
```
+++
{bdg-primary}`my_new_tag`
+++
{bdg-primary}`my_new_tag`
These badges as they are called are provided by the `spinx-design extension`. Different colours can be found through a bit of research online or [here](https://github.com/executablebooks/sphinx-design/blob/main/docs/badges_buttons.md) as a starting point.
## Table of contents

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

View file

@ -1,6 +1,11 @@
# Overview
This chapter includes examples for jupyter book pages with features. Here is an overview of the different examples:
This chapter will be all showcase some TeachBooks making great use of Jupyter Book and TeachBooks features. They can serve as an inspiring strting point for structuring your own TeachBook or just to get an idea of how other teachers are using it.
extra:
includes examples for jupyter book pages with features. Here is an overview of the different examples:
- H5p: examples of H5p questions
- Combining theory with interactive questions