Merge branch 'main' into publish

This commit is contained in:
Tom van Woudenberg 2024-06-26 09:27:45 +02:00
commit 6559f5a692
8 changed files with 41 additions and 18 deletions

3
.gitmodules vendored
View file

@ -10,3 +10,6 @@
[submodule "book/external/latex-to-markdown-conversion"]
path = book/external/latex-to-markdown-conversion
url = https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion.git
[submodule "book/external/Useful_python_code"]
path = book/external/Useful_python_code
url = https://github.com/TeachBooks/Useful_python_code.git

View file

@ -60,10 +60,6 @@ parts:
sections:
- file: features/jupyterlite/configuration
- file: features/jupyterlite/including-jupyterlite
- file: helper_code/intro.md
sections:
- file: external/latex-to-markdown-conversion/README.md
- caption: Examples
chapters:
@ -75,4 +71,15 @@ parts:
- file: examples/example_gumbel.ipynb
- file: examples/example_quiz_interactive.ipynb
- file: examples/coding_theory_widgets.ipynb
- file: examples/parametric_questions.ipynb
- file: examples/parametric_questions.ipynb
- caption: Editing tools
chapters:
- file: tools/figmaker
- file: helper_code/intro.md
sections:
- file: external/latex-to-markdown-conversion/README.md
- file: external/Useful_python_code/snippit.ipynb
- file: external/Useful_python_code/extensionfildownloadreturn.ipynb
- file: external/Useful_python_code/figshrinker.ipynb

View file

@ -131,13 +131,3 @@ name: demoexample4
example 4:including figclass: margin
```
## Figure syntax maker
One might quickely forget the code for making figures, here is a useful tool to make your figures, just specify all information and the code is produced for you:
<div id="figuur_formulier">
</div>
<div id="listContainer">
</div>

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 short description on basic features is given here:

1
book/external/Useful_python_code vendored Submodule

@ -0,0 +1 @@
Subproject commit c8327b3e2cc68d44958974a47c940bc89f4bb32b

View file

@ -1,3 +1,10 @@
# Scripts for automating workflow
This chapter contains a few scripts which can be useful in the book-editing process.
This chapter contains a few scripts which can be useful in the book-editing process:
- [LaTeX to markdown conversion](../external/latex-to-markdown-conversion/README.md)
- [Snippitall](Snippitall) to insert the same code snippet at a certain point in each md file in a specific folder and all subfolder.
- [Snippitonce](Snippitonce) to insert the same code snippet at a certain point in each md file only in a specific folder.
- [Extensionchecker](extensionchecker) to identify the kind of files present in subfolder
- [Filedownloader](filedownloader) to return the downloadlink for markdown for all files with a specified extension
- [Figreturner](figreturner) to return the markdown code for a figure in a specific extension
- [Figshrinker](../external/Useful_python_code/figshrinker.ipynb) to compress JPEG images.

View file

@ -1,6 +1,6 @@
# User types
Different types of users will interact with the website or the Jupyter Books differently and will therefore need to know more or less about the composition of the book. For now we will differentiate 6 types of users.
Different types of users will interact with the website or the Jupyter Books differently and will therefore need to know more or less about the composition of the book. For now we will differentiate 5 types of users.
1. **Students providing feedback on the published website**.<br> <img src="figures/type 1.jpg" alt="Example Image" align="right" width="130" style="margin: 10px;"> There are multiple tools of providing feedback in the built book: a) using the issue button in the top-right corner to directly create issues visible to the editor team. b) Using the [hypothesis](https://jupyterbook.org/en/stable/interactive/comments/hypothesis.html)-extension which allows public/private highlighting and annotating parts of the book. An example can be seen on the [MUDE website](https://mude.citg.tudelft.nl/book/intro.html). c) Using the [Utterances](https://jupyterbook.org/en/stable/interactive/comments/utterances.html)-extension which allows commenting on pages for books which are hosted on GitHub visible for everyone. Those comments are converted to issues on GitHub for the editors to handle.

15
book/tools/figmaker.md Normal file
View file

@ -0,0 +1,15 @@
# Figure syntax maker
```{admonition} User types
:class: tip
This section is useful for user type 3-5.
```
One might quickely forget the code for making figures, here is a useful tool to make your figures, just specify all information and the code is produced for you:
<div id="figuur_formulier">
</div>
<div id="listContainer">
</div>