From 3781065460b7e83cbe8f82e8b669480e245c2a32 Mon Sep 17 00:00:00 2001 From: Katia Gatt Date: Fri, 18 Apr 2025 18:46:42 +0200 Subject: [PATCH 01/10] Update 009.md --- book/syntax_exercises/009.md | 50 +++++++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 4 deletions(-) diff --git a/book/syntax_exercises/009.md b/book/syntax_exercises/009.md index c47122d..4165cb9 100644 --- a/book/syntax_exercises/009.md +++ b/book/syntax_exercises/009.md @@ -72,13 +72,55 @@ The displacement can be found using the equation $s = v \cdot t$. 10. Test your understanding by adding a new equation of your choice, ideally one that requires many LaTex symbols! -11. When you are ready, commit your changes to the repository by clicking on the green `Commit changes` button. -12. Add a commit message. +## Adding colours to equations -13. To see your changes, go to {octicon}`play` `Actions` - The most recent workflow run `overview.md / the commit message of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root` (getting bored of waiting? There'll be exercising on doing this locally which prevents you from waiting). +11. The TeachBooks template includes the `sphinx-named-colors` extension, which lets you add colours to parts of your equations using LaTeX. Look at the [CSS named colours](https://developer.mozilla.org/en-US/docs/Web/CSS/named-color) to explore the possible colour options. -14. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page. +12. Colours are added to equations using `\namedcolour{...}`, replacing `namedcolour` with the colour of choice. Test this out with the examples in the table below: + +::::{list-table} +:widths: auto +:header-rows: 1 + * - Color + - $\LaTeX$ Code + - Result + * - olive + - `\olive{\int_a^bf(x)dx}` + - $\olive{\int_a^bf(x)dx}$ + * - hotpink + - `1.\hotpink{\mathbf{49}}` + - $1.\hotpink{\mathbf{49}}$ + * - darkturquoise + - `\dfrac{\darkturquoise{\partial}f}{\darkturquoise{\partial}x}` + - $\dfrac{\darkturquoise{\partial}f}{\darkturquoise{\partial}x}$ + * - onlylight + - `\onlylight{\LaTeX}` + - $\onlylight{\LaTeX}$ + * - lightanddark + - `\lightanddark{\sum}_{n=1}^\infty` + - $\lightanddark{\sum}_{n=1}^\infty$ +:::: + + +13. For colours with hyphens we use need to use the class-based command `\class{named-colour}{...}. Replicate the code below: + +```md +$$ \class{hyphen-color}{\sum}_{n=1}^\infty a_n $$ +``` +14. Test your understanding by creating a block equation where each term is a different colour! + +```{tip} +This is especially helpful for highlighting changes between equations or focusing attention on specific terms — great for teaching, too! +``` + +15. When you are ready, commit your changes to the repository by clicking on the green `Commit changes` button. + +16. Add a commit message. + +17. To see your changes, go to {octicon}`play` `Actions` - The most recent workflow run `overview.md / the commit message of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root` (getting bored of waiting? There'll be exercising on doing this locally which prevents you from waiting). + +18. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page. ```{admonition} Check your understanding From 5e05882034f5724edd6939c81522eaf78134e6d9 Mon Sep 17 00:00:00 2001 From: Katia Gatt Date: Fri, 18 Apr 2025 18:59:58 +0200 Subject: [PATCH 02/10] update 2 --- book/syntax_exercises/009.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/book/syntax_exercises/009.md b/book/syntax_exercises/009.md index 4165cb9..6fc9fc2 100644 --- a/book/syntax_exercises/009.md +++ b/book/syntax_exercises/009.md @@ -77,6 +77,8 @@ The displacement can be found using the equation $s = v \cdot t$. 11. The TeachBooks template includes the `sphinx-named-colors` extension, which lets you add colours to parts of your equations using LaTeX. Look at the [CSS named colours](https://developer.mozilla.org/en-US/docs/Web/CSS/named-color) to explore the possible colour options. +12. It is also possible to use custom colours! Look [here](https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html#) for documentation about the TeachBook extension which allows custom colours. + 12. Colours are added to equations using `\namedcolour{...}`, replacing `namedcolour` with the colour of choice. Test this out with the examples in the table below: ::::{list-table} @@ -94,24 +96,19 @@ The displacement can be found using the equation $s = v \cdot t$. * - darkturquoise - `\dfrac{\darkturquoise{\partial}f}{\darkturquoise{\partial}x}` - $\dfrac{\darkturquoise{\partial}f}{\darkturquoise{\partial}x}$ - * - onlylight - - `\onlylight{\LaTeX}` - - $\onlylight{\LaTeX}$ - * - lightanddark - - `\lightanddark{\sum}_{n=1}^\infty` - - $\lightanddark{\sum}_{n=1}^\infty$ :::: -13. For colours with hyphens we use need to use the class-based command `\class{named-colour}{...}. Replicate the code below: +13. For colours with hyphens we use need to use the class-based command `\class{named-colour}{...}. Try this using the format shown below: ```md $$ \class{hyphen-color}{\sum}_{n=1}^\infty a_n $$ ``` + 14. Test your understanding by creating a block equation where each term is a different colour! ```{tip} -This is especially helpful for highlighting changes between equations or focusing attention on specific terms — great for teaching, too! +This is especially helpful for highlighting changes between equations or focusing attention on specific terms! ``` 15. When you are ready, commit your changes to the repository by clicking on the green `Commit changes` button. From b7c56ecc41e9e7b4d854f51668d090958e9e0842 Mon Sep 17 00:00:00 2001 From: Katia Gatt Date: Fri, 18 Apr 2025 19:05:25 +0200 Subject: [PATCH 03/10] Update 009.md --- book/syntax_exercises/009.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/syntax_exercises/009.md b/book/syntax_exercises/009.md index 6fc9fc2..c2d560e 100644 --- a/book/syntax_exercises/009.md +++ b/book/syntax_exercises/009.md @@ -102,7 +102,7 @@ The displacement can be found using the equation $s = v \cdot t$. 13. For colours with hyphens we use need to use the class-based command `\class{named-colour}{...}. Try this using the format shown below: ```md -$$ \class{hyphen-color}{\sum}_{n=1}^\infty a_n $$ +$$ \class{hyphen-color}{\sum}_{n=1}^\infty $$ ``` 14. Test your understanding by creating a block equation where each term is a different colour! From f65c90769897ea24d52260c3dc0bcced9afd8947 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Tue, 22 Apr 2025 08:38:29 +0200 Subject: [PATCH 04/10] removed result by sticking with exercise approach --- book/syntax_exercises/009.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/book/syntax_exercises/009.md b/book/syntax_exercises/009.md index c2d560e..a7e75fd 100644 --- a/book/syntax_exercises/009.md +++ b/book/syntax_exercises/009.md @@ -86,16 +86,12 @@ The displacement can be found using the equation $s = v \cdot t$. :header-rows: 1 * - Color - $\LaTeX$ Code - - Result * - olive - `\olive{\int_a^bf(x)dx}` - - $\olive{\int_a^bf(x)dx}$ * - hotpink - `1.\hotpink{\mathbf{49}}` - - $1.\hotpink{\mathbf{49}}$ * - darkturquoise - `\dfrac{\darkturquoise{\partial}f}{\darkturquoise{\partial}x}` - - $\dfrac{\darkturquoise{\partial}f}{\darkturquoise{\partial}x}$ :::: From 313d19b25d8eb9d48036011aff6493e70ce6c9f7 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Tue, 22 Apr 2025 08:44:09 +0200 Subject: [PATCH 05/10] Update 009.md --- book/syntax_exercises/009.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/book/syntax_exercises/009.md b/book/syntax_exercises/009.md index a7e75fd..9598393 100644 --- a/book/syntax_exercises/009.md +++ b/book/syntax_exercises/009.md @@ -79,7 +79,7 @@ The displacement can be found using the equation $s = v \cdot t$. 12. It is also possible to use custom colours! Look [here](https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html#) for documentation about the TeachBook extension which allows custom colours. -12. Colours are added to equations using `\namedcolour{...}`, replacing `namedcolour` with the colour of choice. Test this out with the examples in the table below: +13. Colours are added to equations using `\namedcolour{...}`, replacing `namedcolour` with the colour of choice. Test this out with the examples in the table below: ::::{list-table} :widths: auto @@ -95,25 +95,25 @@ The displacement can be found using the equation $s = v \cdot t$. :::: -13. For colours with hyphens we use need to use the class-based command `\class{named-colour}{...}. Try this using the format shown below: +14. For colours with hyphens we use need to use the class-based command `\class{named-colour}{...}. Try this using the format shown below: ```md $$ \class{hyphen-color}{\sum}_{n=1}^\infty $$ ``` -14. Test your understanding by creating a block equation where each term is a different colour! +15. Test your understanding by creating a block equation where each term is a different colour! ```{tip} This is especially helpful for highlighting changes between equations or focusing attention on specific terms! ``` -15. When you are ready, commit your changes to the repository by clicking on the green `Commit changes` button. +16. When you are ready, commit your changes to the repository by clicking on the green `Commit changes` button. -16. Add a commit message. +17. Add a commit message. -17. To see your changes, go to {octicon}`play` `Actions` - The most recent workflow run `overview.md / the commit message of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root` (getting bored of waiting? There'll be exercising on doing this locally which prevents you from waiting). +18. To see your changes, go to {octicon}`play` `Actions` - The most recent workflow run `overview.md / the commit message of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root` (getting bored of waiting? There'll be exercising on doing this locally which prevents you from waiting). -18. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page. +19. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page. ```{admonition} Check your understanding From 1590411d3e443e49ea806d674628a07bc8b3359b Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Tue, 22 Apr 2025 16:24:14 +0200 Subject: [PATCH 06/10] Update WAIVER --- WAIVER | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/WAIVER b/WAIVER index c679280..0099e6d 100644 --- a/WAIVER +++ b/WAIVER @@ -1,4 +1,7 @@ Technische Universiteit Delft hereby disclaims all copyright interest in the -program “TeachBooks Template” (a GitHub template repository to ease the +program "TeachBooks Template" (a GitHub template repository to ease the creation of TeachBooks) written by the Author(s). Stefan Aarninkhof, Dean of Civil Engineering & Geosciences + +This waiver does not claim copyright interest of repositories which used +the "TeachBooks Template" with a copy of this file. From dfc75e90c473e5240e1b6fcd248898d2507020b1 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 1 May 2025 08:55:02 +0200 Subject: [PATCH 07/10] Update credits.md --- book/credits.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/book/credits.md b/book/credits.md index 4363c3f..07dd2a7 100644 --- a/book/credits.md +++ b/book/credits.md @@ -12,8 +12,11 @@ You can refer to individual chapters or pages within this book as: We anticipate that the content of this book will change significantly. Therefore, we recommend using the source code directly with the citation above that refers to the GitHub repository and lists the date and name of the file. Although content will be added over time, chapter titles and URL's in this book are expected to remain relatively static. However, we make no guarantee, so if it is important for you to reference a specific location/commit within the book. ## How the book is made +This website is written in markdown and jupyter notebooks files, which are converted to html using tools from [TeachBooks](https://teachbooks.io/). The files are stored on a [public GitHub repository](``). The website can be viewed at ``. -This book is created using open source tools: it is a JupyterBook that is written using Markdown and Jupyter notebooks. Additional tooling is used from the [TeachBooks initiative](https://teachbooks.io/) to enhance the editing and reading experience. The files are stored on a [public GitHub repository](``). The website can be viewed at ``. View the repository README file or contact the authors for additional information. +To recreate the website you have two options (more information in the [teachbooks manual](https://teachbooks.io/manual/): +- In the GitHub interface: fork this repository, enable Github Pages from the source GitHub actions (Settings - Code and automation - Pages - Build and deployment - Source - GitHub Actions), enable workflows (Actions - I understand my workflows, go ahead and enable them) and run the call-deploy-book workflow (Actions - call-deploy-book - Run workflow - Run workflow). The website is released on the URL as shown on the workflow summary when the workflow has finished (Actions - call-deploy-book - call-deploy-book - Summary). +- On your own computer: clone this repository, install the required packages (`pip install -r requirements.txt`) and build the book (`teachbooks build book`). The website is stored locally in `book/_build/index.html`. ## License This book is [CC BY 4.0 licensed](https://creativecommons.org/licenses/by/4.0/) allowing you to share and adapt the material, as long as the source is named. External resources that are reused in this book are listed below. From fc08e344bc72da9664c102309e48d3b301ba70a0 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 1 May 2025 08:55:19 +0200 Subject: [PATCH 08/10] Update credits.md --- book/credits.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/credits.md b/book/credits.md index 07dd2a7..0daf82e 100644 --- a/book/credits.md +++ b/book/credits.md @@ -14,7 +14,7 @@ We anticipate that the content of this book will change significantly. Therefore ## How the book is made This website is written in markdown and jupyter notebooks files, which are converted to html using tools from [TeachBooks](https://teachbooks.io/). The files are stored on a [public GitHub repository](``). The website can be viewed at ``. -To recreate the website you have two options (more information in the [teachbooks manual](https://teachbooks.io/manual/): +To recreate the website you have two options (more information in the [TeachBooks manual](https://teachbooks.io/manual/): - In the GitHub interface: fork this repository, enable Github Pages from the source GitHub actions (Settings - Code and automation - Pages - Build and deployment - Source - GitHub Actions), enable workflows (Actions - I understand my workflows, go ahead and enable them) and run the call-deploy-book workflow (Actions - call-deploy-book - Run workflow - Run workflow). The website is released on the URL as shown on the workflow summary when the workflow has finished (Actions - call-deploy-book - call-deploy-book - Summary). - On your own computer: clone this repository, install the required packages (`pip install -r requirements.txt`) and build the book (`teachbooks build book`). The website is stored locally in `book/_build/index.html`. From f0616b640b2bfbe491e4ca4e65ce04a7297419a0 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 1 May 2025 08:56:23 +0200 Subject: [PATCH 09/10] Update _config.yml --- book/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/_config.yml b/book/_config.yml index 875faaf..8fbad43 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -1,5 +1,5 @@ title: TeachBooks template # Replace this with your own book title -author: TeachBooks Team, built with TeachBooks and Jupyter Book, CC BY 4.0 +author: TeachBooks Team, built with TeachBooks, CC BY 4.0 # Replace TeachBooks Teams with your own name in the line above execute: From 533f34828006823a606f18449cc1d9b95e4ad8f7 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 1 May 2025 09:05:41 +0200 Subject: [PATCH 10/10] Update README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 5966b0e..e2710af 100644 --- a/README.md +++ b/README.md @@ -55,3 +55,20 @@ Set the repository website as your GitHub Pages website under `Code`- `About` - ## Contribute This tool's repository is stored on [GitHub](https://github.com/TeachBooks/template). The `README.md` of the branch `manual_description` is also part of the [TeachBooks manual](https://teachbooks.io/manual/external/template/README.html) as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the [GitHub repository](https://github.com/TeachBooks/template). To update the `README.md` shown in the TeachBooks manual, create a fork and open a merge request for the [GitHub repository of the manual](https://github.com/TeachBooks/manual). If you intent to clone the manual including its submodules, clone using: `git clone --recurse-submodulesgit@github.com:TeachBooks/manual.git`. + +## Template README +> Remove all of the above after you've taken this template and followed the instructions. The following lines are a template for your own README + +# `` + +`` + +## Contributors +- `` + +## Reuse content +Feel free to reuse this content or contribute to it. Please give appropriate credit, provide a link to the license, and indicate if changes were made ([CC BY 4.0 License](https://creativecommons.org/licenses/by/4.0/)) + +The website (http://oit.tudelft.nl/Macaulays-method/) is created using the [TeachBooks Python package](https://github.com/TeachBooks/TeachBooks). To recreate it you have two options (more information in the [TeachBooks manual](https://teachbooks.io/manual/): +- In the GitHub interface: fork this repository, enable Github Pages from the source GitHub actions (Settings - Code and automation - Pages - Build and deployment - Source - GitHub Actions), enable workflows (Actions - I understand my workflows, go ahead and enable them) and run the call-deploy-book workflow (Actions - call-deploy-book - Run workflow - Run workflow). The website is released on the URL as shown on the workflow summary when the workflow has finished (Actions - call-deploy-book - call-deploy-book - Summary). +- On your own computer: clone this repository, install the required packages (`pip install -r requirements.txt`) and build the book (`teachbooks build book`). The website is stored locally in `book/_build/index.html`.