admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

extended badges

Browse source
This commit is contained in:
Tom van Woudenberg 2024-11-29 10:46:04 +01:00
parent 5d095953f0
commit 055663cb4e
8 changed files with 21 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
book/basic-features/hypothesis.md
View file

@ -1,6 +1,6 @@
# Making comments on the website: Hypothesis
{bdg-success}`Javascript overlay` {bdg-success}`Chrome Extension`
{bdg-warning}`Javascript overlay` {bdg-success}`Chrome Extension`
Hypothesis is a third-party application that allows anyone to make publicly visible comments on a website (once you create a free account). This section explains how to use and install the extension. As this tool requires an account with a third-party, we advise to use our [local-annotator](../external/annotater/README.md) with similar capabilities but which store annotations locally. By default Hypothesis stores annotations publicly, which might confuse other students.

2
book/basic-features/utterances.md
View file

@ -1,6 +1,6 @@
# Discussions in your book: Utterances
{bdg-success}`Javascript script`
{bdg-muted}`Javascript script`
[Utterances 🔮](https://utteranc.es/) is a lightweight open-source widget which allows you, your colleages and your students to discuss stuff in a blog post in your book. It is build on GitHub issues, so requires a GitHub repository, although the book can be hosted anywhere (so also on GitLab).

2
book/external/TeachBooks vendored

@ -1 +1 @@
Subproject commit 209dc7ceae034edd8ab43c0377e77466fdf15f1c
Subproject commit 4a2e75494b213c9a03615087bab2788f6188da2f

2
book/features/HTML_javascript.md
View file

@ -5,6 +5,8 @@
This section is useful for user type 5.
```
{bdg-info}`iframe`
In this section, we will discuss how to [create](creating_basic_HTML_elements.md) and [embed](adding_HTML_elements.md) interactive HTML/Javascript elements created in HTML/JavaScript in a TeachBook. These HTML/Javascript element work very fluently and don't require a python kernel running in the background.
This could be for example interactive 3d figures:

2
book/features/adding_HTML_elements.md
View file

@ -1,5 +1,7 @@
# Adding interactive HTML/JavaScript elements
{bdg-info}`iframe`
In this section, we will discuss how to embed interactive elements created in HTML/JavaScript in a TeachBook. If you are interested in learning how to create these elements yourself, we will discuss an example in the [next article](creating_basic_HTML_elements.md). As an example, let us discuss how to embed an interactive 3D model of a subsurface environment I created:
<iframe src="../_static/element_render_box.html" width="600" height="400" frameborder="0"></iframe>

2
book/features/h5p.md
View file

@ -5,6 +5,8 @@
This section is useful for user type 3-5.
```
{bdg-info}`iframe`
## Instruction
H5p elements are interactive HTML-blocks which can be embedded in a Jupyter Book using an iframe. An H5p element can be created in the [TU Delft portal on the H5p website](https://tudelft.h5p.com/content) (sign in via Brightspace to H5p required first). The iframe code can be copied at Edit - Publish - Public - Embed code. This html code can be directly added to your markdown file:

2
book/features/live_code.ipynb
View file

@ -11,6 +11,8 @@
"This section is useful for user type 5.\n",
"```\n",
"\n",
"{bdg-primary}`Sphinx Extension`\n",
"\n",
"Our book has been enable to run Python code live in the browser (thanks Max!). This extension makes code cells in your `.ipynb` book pages editable and executable by the reader! Opposed to the original sphinx-thebe extensions, our extension runs python in the reader's browser and doesn't rely on an external webserver for the python kernel. We highly recommend this extension as it allows you to use the strength of combining text/figures and code of a jupyter book with interactivity!\n",
"\n",
"This page contains some installation instructions and the other sections show how to use this functionality to create interactive figures and feedback on code\n",

13
book/features/overview.md
View file

@ -4,9 +4,16 @@ As TeachBooks, we collect a suite of existing open-source software and keep our
Since the list of TeachBook features is getting quite long, we have grouped them in categories:
Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features.
Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features:
- {bdg-warning}`Javascript overlay`
- {bdg-success}`Chrome Extension`
- {bdg-muted}`GitHub App and Javascript script`
- {bdg-secondary}`Python Package`
- {bdg-light}`GitHub Reusable Action`
- {bdg-dark}`Git Workflow`
- {bdg-primary}`Sphinx Extension`
- {bdg-info}`iframe`
Finally, the purpose, installation process and usage of each features is elaborated on in the respective sub-sections.
To see examples for these features, go to the [Examples chapter](../examples/overview.md).
To see examples for these features, go to the [Examples chapter](../examples/overview.md).