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

Updated user types

Browse source
This commit is contained in:
Tom van Woudenberg 2024-04-18 11:34:48 +02:00
parent ea54aab6c4
commit 5ab1977c92
6 changed files with 18 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

5
book/features/HTML_javascript.md
View file

@ -1,5 +1,10 @@
# Interactive HTML/JavaScript elements
```{admonition} User types
:class: tip
This section is useful for user type 5.
```
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/custom_download.md
View file

@ -2,7 +2,7 @@
```{admonition} User types
:class: tip
This section is useful for user type 4-6.
This section is useful for user type 4-5.
```
You can control the download option of the book in two ways:

2
book/features/custom_toc.md
View file

@ -2,7 +2,7 @@
```{admonition} User types
:class: tip
This section is useful for user type 3-6.
This section is useful for user type 3-5.
```
A new feature is added to enable testing of all interactive features on the web server (i.e., in the draft book) while preventing students from seeing it. Pages in the draft book (`main` branch) can be manually stripped out of the table of contents when a merge request from `main` to `publish` is made using a tag `REMOVE-FROM-PUBLISH`. Pages marked with this feature are still visible in the draft book and books build from source on personal computers. The tag is applied as follows:

5
book/features/grasple.md
View file

@ -1,5 +1,10 @@
# Grasple questions
```{admonition} User types
:class: tip
This section is useful for user type 3-5.
```
[Grasple](https://app.grasple.com/) gives you an embed code for each exercise which looks like this, which can be added cirectly to your markdown-file.
```html
<iframe height="560" src="https://embed.grasple.com/exercises/767782d5-023a-4b49-a1f3-874fca626c8e?id=79907" title="Grasple Exercise 79907" width="100%" allow="clipboard-read; clipboard-write"></iframe>

5
book/features/h5p.md
View file

@ -1,5 +1,10 @@
# Adding interactive h5p elements
```{admonition} User types
:class: tip
This section is useful for user type 3-5.
```
## Instruction
H5p elements are interactive HTML-blocks which can be imbeded in a Jupyter Book using an iframe. 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/installation-and-setup/user_types.md
View file

@ -20,7 +20,7 @@ Different types of users will interact with the website or the Jupyter Books dif
4. **Colleague making text adjustments to multiple files at the same time locally**. <br>
User 4 is a hybrid between type 3 and 5. Basically this user is making changes by editing the .md files locally using, for example, VS Code. Therefore, this user requires a little bit more knowledge on git (think of pulling and pushing changes) but their main focus remains to make adjustments to the content of the book by editing .md files whereas user type 4 has more knowledge to make changes to python files the book as well. This user can build the book online.
5. **Colleague making text and python adjustments to multiple files at the same time locally**. <br>
5. **Colleague making text and code (especially Python) adjustments to multiple files at the same time locally**. <br>
<img src="figures/type 5.jpg" alt="Example Image" align="left" width="120" style="margin: 10px;">
This user has more knowledge in GitLab/GitHub than the previous user and can basically take care of branching and merging by themselves. They know how to work with software for editing .md and .ipynb files. They can use the draft book online to view their changed in the book, or build the book locally.