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

Added user types everywhere

Browse source
This commit is contained in:
Tom van Woudenberg 2024-11-29 10:57:43 +01:00
parent 055663cb4e
commit edb7789d15
5 changed files with 28 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
book/basic-features/external-features.md
View file

@ -1 +1,8 @@
# Externally Developed Features
# Externally Developed Features
```{admonition} User types
:class: tip
This section is useful for user type 1-5.
```
This chapter includes features useful for books in the educational context, developed by various parties.

9
book/features/easy-editing.md
View file

@ -1 +1,8 @@
# Easy Editing Process
# Easy Editing Process
```{admonition} User types
:class: tip
This section is useful for user type 3-5.
```
The following tools are created by TeachBooks to ease the process of making books. We acknowledge that making books is a difficult process; it requires advanced knowledge on CLI, python packages, html-files, data-storage and website hosting. The tools in this chapter are intended for those users who lack knowledge on these topics (which includes most of the TeachBooks' community members itself).

2
book/features/interactive_element.ipynb
View file

@ -9,7 +9,7 @@
"source": [
"# Interactive content: Elements not including Python\n",
"\n",
"To add interactivity to the book, you can make use of interactive elements which are embedded in the book. You've four options:\n",
"To add interactivity to the book, you can make use of interactive elements which are embedded in the book. You've a few options:\n",
"\n",
" - Admonition: question provided in normal markdown language with answers in a drowdown menu. There's no feedback delivered to the student, only the correct answer no matter what the student's thinking/work.\n",
" - JupyterQuiz: code-based implementation of multiple-choiche questions and numerical answer questions. This is a basic open course tool which requires you to write your quiz questions in Python language as a `dict` or to a `.json` file.\n",

5
book/features/sphinx_extensions.md
View file

@ -1,5 +1,10 @@
# Sphinx Extensions
```{admonition} User types
:class: tip
This section is useful for user type 4-5.
```
Sphinx extensions are plugins developed for the Sphinx documentation ecosystem (which Jupyter Book is built upon). They extend or modify Sphinx’s capabilities and can be added to Jupyter Book for extra functionality. Since Sphinx extensions are not an integral part of jupyter-book, as opposed to original jupyter-book features, they must be installed and configured explicitly, for example in the `_config.yml` file.
At TeachBooks, we have many TA's working on developing cool and handy extensions to use in our books. Here's an overview:

7
book/features/students.md
View file

@ -1,3 +1,8 @@
# TeachBooks Student-view Features
This chapter includes some TeachBooks features which aim to improve the way students can use TeachBooks. These tools are fully student-side, they don't influence the book website and the author doesn't have to setup anything. Nevertheless, the author could point the students to the availability of these tools and use it as part of the didactical approach.
```{admonition} User types
:class: tip
This section is useful for user type 1-5.
```
This chapter includes some TeachBooks features which aim to improve the way students can use TeachBooks. These tools are fully student-side, they don't influence the book website and the author doesn't have to setup anything. Nevertheless, the author could point the students to the availability of these tools and use it as part of the didactical approach. These tools could also be useful for other users.