From 01e7c002f9d38bf336cc66e137e7d1698f5bcb99 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 26 Jun 2024 09:13:03 +0200 Subject: [PATCH 1/7] Added files Freek --- .gitmodules | 3 +++ book/external/Useful_python_code | 1 + book/helper_code/intro.md | 9 ++++++++- 3 files changed, 12 insertions(+), 1 deletion(-) create mode 160000 book/external/Useful_python_code diff --git a/.gitmodules b/.gitmodules index 9b74655..64687ac 100644 --- a/.gitmodules +++ b/.gitmodules @@ -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 diff --git a/book/external/Useful_python_code b/book/external/Useful_python_code new file mode 160000 index 0000000..7f61ca6 --- /dev/null +++ b/book/external/Useful_python_code @@ -0,0 +1 @@ +Subproject commit 7f61ca6b43acec23ac36b4f569e1c9a73903b4da diff --git a/book/helper_code/intro.md b/book/helper_code/intro.md index 46c4ba7..b2d7862 100644 --- a/book/helper_code/intro.md +++ b/book/helper_code/intro.md @@ -1,3 +1,10 @@ # Scripts for automating workflow -This chapter contains a few scripts which can be useful in the book-editing process. \ No newline at end of file +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. \ No newline at end of file From faa566ce649a2ea2914035565ad6244cf4a3bd4e Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 26 Jun 2024 09:16:27 +0200 Subject: [PATCH 2/7] Seperate chapter for tools --- book/_toc.yml | 12 +++++++++--- book/basic-features/figures.md | 10 ---------- book/tools/figmaker.md | 9 +++++++++ 3 files changed, 18 insertions(+), 13 deletions(-) create mode 100644 book/tools/figmaker.md diff --git a/book/_toc.yml b/book/_toc.yml index 78b0275..dfad3fa 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -60,9 +60,15 @@ 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: Tools + - 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 - caption: Examples diff --git a/book/basic-features/figures.md b/book/basic-features/figures.md index 1c3f562..8fcf942 100644 --- a/book/basic-features/figures.md +++ b/book/basic-features/figures.md @@ -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: - -
- -
-
- -
- diff --git a/book/tools/figmaker.md b/book/tools/figmaker.md new file mode 100644 index 0000000..d4f74f8 --- /dev/null +++ b/book/tools/figmaker.md @@ -0,0 +1,9 @@ +# 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: + +
+ +
+
+ +
\ No newline at end of file From 5e4e77047da68b592b3268e98d7843299fb544ec Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 26 Jun 2024 09:18:32 +0200 Subject: [PATCH 3/7] Update _toc.yml --- book/_toc.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/book/_toc.yml b/book/_toc.yml index dfad3fa..d98f808 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -62,6 +62,7 @@ parts: - file: features/jupyterlite/including-jupyterlite - caption: Tools + chapters: - file: tools/figmaker - file: helper_code/intro.md sections: From 8bfb876752f2f88b55f96935023c5c71391fb6b1 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 26 Jun 2024 09:22:29 +0200 Subject: [PATCH 4/7] Moved part --- book/_toc.yml | 24 +++++++++++------------ book/basic-features/overview.md | 2 +- book/external/Useful_python_code | 2 +- book/installation-and-setup/user_types.md | 2 +- book/tools/figmaker.md | 6 ++++++ 5 files changed, 21 insertions(+), 15 deletions(-) diff --git a/book/_toc.yml b/book/_toc.yml index d98f808..3216a9d 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -61,17 +61,6 @@ parts: - file: features/jupyterlite/configuration - file: features/jupyterlite/including-jupyterlite - - caption: 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 - - - caption: Examples chapters: - file: examples/overview @@ -82,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 \ No newline at end of file + - file: examples/parametric_questions.ipynb + + - caption: 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 + \ No newline at end of file diff --git a/book/basic-features/overview.md b/book/basic-features/overview.md index b2d5623..5472fda 100644 --- a/book/basic-features/overview.md +++ b/book/basic-features/overview.md @@ -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: diff --git a/book/external/Useful_python_code b/book/external/Useful_python_code index 7f61ca6..c8327b3 160000 --- a/book/external/Useful_python_code +++ b/book/external/Useful_python_code @@ -1 +1 @@ -Subproject commit 7f61ca6b43acec23ac36b4f569e1c9a73903b4da +Subproject commit c8327b3e2cc68d44958974a47c940bc89f4bb32b diff --git a/book/installation-and-setup/user_types.md b/book/installation-and-setup/user_types.md index 0a92d71..3cf1168 100644 --- a/book/installation-and-setup/user_types.md +++ b/book/installation-and-setup/user_types.md @@ -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**.
Example Image 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. diff --git a/book/tools/figmaker.md b/book/tools/figmaker.md index d4f74f8..534a57d 100644 --- a/book/tools/figmaker.md +++ b/book/tools/figmaker.md @@ -1,4 +1,10 @@ # 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:
From 42a3004b37f6196668866baae98287873afff137 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 26 Jun 2024 09:22:48 +0200 Subject: [PATCH 5/7] Part name --- book/_toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/_toc.yml b/book/_toc.yml index 3216a9d..803036e 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -73,7 +73,7 @@ parts: - file: examples/coding_theory_widgets.ipynb - file: examples/parametric_questions.ipynb - - caption: Tools + - caption: Editing tools chapters: - file: tools/figmaker - file: helper_code/intro.md From 385abc9e5e69ef3f3df24dab566c2c3aeb9980a8 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 26 Jun 2024 09:23:21 +0200 Subject: [PATCH 6/7] Better title --- book/_toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/_toc.yml b/book/_toc.yml index 803036e..9f469fc 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -73,7 +73,7 @@ parts: - file: examples/coding_theory_widgets.ipynb - file: examples/parametric_questions.ipynb - - caption: Editing tools + - caption: Editing scripts chapters: - file: tools/figmaker - file: helper_code/intro.md From 4536b3b142651023ba741be3ccdfd00f4fe597be Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 26 Jun 2024 09:27:33 +0200 Subject: [PATCH 7/7] Update _toc.yml --- book/_toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/_toc.yml b/book/_toc.yml index 9f469fc..803036e 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -73,7 +73,7 @@ parts: - file: examples/coding_theory_widgets.ipynb - file: examples/parametric_questions.ipynb - - caption: Editing scripts + - caption: Editing tools chapters: - file: tools/figmaker - file: helper_code/intro.md