manual_teachbooks/book/features/overview.md
2024-03-05 10:09:33 +01:00

35 lines
1.7 KiB
Markdown

# CEG-book Features
We collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is esential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching!
This chapter provides a list of commonly used book features together with sub-pages that provide additional information on:
- the purpose
- how to install them
- how to use them
- where to find the source code
Overview of features covered:
- Interaction on the website: Adding comments and feedback to content on the website
- Grasple Questions: Explanation how to embed Grasple questions in the book.
- Adding interactive h5p elements: Embedding interactive HTML-blocks in the book
- Exclude parts of book from published book
- Page download options
- Python-enabled interactivity: Run Python code live in the browser
- Widgets
- Exercise checking using check-answer button
- JupyterLite-Sphinx: Including interactive pieces of content in the book.
- Configuration
- How to add `JupyterLite` to a page
To see examples for these features, go to the Example chapter.
The {guilabel}`books-CEG` label indicates a feature developed by us.
List:
- sphinx-thebe int {guilabel}`books-CEG`
- figure inverter
- one
- two
- free
- look at me!