From 4178edb95653f6f5ff1c8c43f4d96aa89679ae95 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 2 Dec 2024 10:24:37 +0100 Subject: [PATCH 01/23] Initial commit --- book/_config.yml | 3 ++ book/_toc.yml | 6 +++- book/credits.md | 33 ++++++++++++++++++++++ book/external/latex-to-markdown-conversion | 2 +- book/references.bib | 6 ++++ book/references.md | 9 ++++++ 6 files changed, 57 insertions(+), 2 deletions(-) create mode 100644 book/credits.md create mode 100644 book/references.bib create mode 100644 book/references.md diff --git a/book/_config.yml b/book/_config.yml index d16b980..fbf91c9 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -37,3 +37,6 @@ sphinx: thebe: true html_show_copyright: false html_last_updated_fmt: '%B %-d, %Y' + +bibtex_bibfiles: + - references.bib \ No newline at end of file diff --git a/book/_toc.yml b/book/_toc.yml index 257e1e3..174352a 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -94,4 +94,8 @@ parts: - 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 + + - caption: Miscallaneous + chapters: + - file: references.md + - file: credits \ No newline at end of file diff --git a/book/credits.md b/book/credits.md new file mode 100644 index 0000000..1540e27 --- /dev/null +++ b/book/credits.md @@ -0,0 +1,33 @@ +(credits)= +# Credits and License + +You can refer to this book as: + +> Teachbooks Team (2024) _TeachBooks Manual_. https://github.com/TeachBooks/manual + +The introduction, structure of the book and formatting of contents is done by the Editors. Some chapters and pages have additional primary authors who are identified within the book either at the bottom of the first page in a chapter, or at the bottom of an individual page, as necessary. If an author is not listed on a particular page, it is by the Editors. + +We anticipate that the content of this book will change significantly. Therefore, if you'd like to refer to a specific chapter, we recommend using the source code directly with the citation 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. You can refer to individual chapters or pages within this book as: + +> `` (2024) ``. In TeachBook Team (Ed.), _TeachBooks Manual_. https://github.com/TeachBooks/manual (`./book/intro/` chapter, accessed `<date>`). + +## How the book is made + +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](https://github.com/TeachBooks/manual). + +(editor)= +## Editor + +- Tom van Woudenberg + +Contact the editor at TeachBooks@tudelft.nl. + +## Authors + +- Tom van Woudenberg +- Robert Lanzafame +- Freek Pols +- Julie Kirsch + +### Acknowledgements +Big thanks to the various colleagues and teaching assistant part of the [TeachBooks](https://teachbooks.io/) for developing tools and providing support to improve this book. \ No newline at end of file diff --git a/book/external/latex-to-markdown-conversion b/book/external/latex-to-markdown-conversion index f71092b..fa0c472 160000 --- a/book/external/latex-to-markdown-conversion +++ b/book/external/latex-to-markdown-conversion @@ -1 +1 @@ -Subproject commit f71092bfdb2e3d5d2f580bac5e31ff695806e7d3 +Subproject commit fa0c47239eb7f454ab0825e4975adf8838fd0c1a diff --git a/book/references.bib b/book/references.bib new file mode 100644 index 0000000..9fde9ae --- /dev/null +++ b/book/references.bib @@ -0,0 +1,6 @@ +@misc{timon_latex, + title={LaTeX to Markdown conversion}, + author={Idema, Timon}, + howpublished={\url{https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}}, + year={2024} +} \ No newline at end of file diff --git a/book/references.md b/book/references.md new file mode 100644 index 0000000..2d82592 --- /dev/null +++ b/book/references.md @@ -0,0 +1,9 @@ +# References +:::{bibliography} +::: + +## Linked external recourses + +Parts of this book are linked to other external resources. The following are not edited by the TeachBooks Team: + +- [](external/latex-to-markdown-conversion/README.md) {cite:ts}`timon_latex` \ No newline at end of file From cbe029cf90b18ad48e33b908522c334d416c7804 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 10:28:15 +0100 Subject: [PATCH 02/23] moved contact, contribute info to credits page --- book/credits.md | 19 +++++++++++++------ book/intro.md | 14 -------------- 2 files changed, 13 insertions(+), 20 deletions(-) diff --git a/book/credits.md b/book/credits.md index 1540e27..a10c12e 100644 --- a/book/credits.md +++ b/book/credits.md @@ -11,17 +11,11 @@ We anticipate that the content of this book will change significantly. Therefore > `<Primary Author>` (2024) `<Title of Chapter or Page>`. In TeachBook Team (Ed.), _TeachBooks Manual_. https://github.com/TeachBooks/manual (`./book/intro/` chapter, accessed `<date>`). -## How the book is made - -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](https://github.com/TeachBooks/manual). - (editor)= ## Editor - Tom van Woudenberg -Contact the editor at TeachBooks@tudelft.nl. - ## Authors - Tom van Woudenberg @@ -29,5 +23,18 @@ Contact the editor at TeachBooks@tudelft.nl. - Freek Pols - Julie Kirsch +## Contact +If you encounter any issues report it by clicking {octicon}`mark-github` on the top right corner of this page. + +If you have questions, contact the editors at TeachBooks@tudelft.nl. TU Delft account holder can also contact us in the [MS Teams Open Interactive Textbooks Community](https://teams.microsoft.com/l/team/19%3Ah9-uRcP_yYauh-VuoPFozJVUvHVOB4a0mz1ZWvh4q4Q1%40thread.tacv2/conversations?groupId=3e88c1f3-4a4f-483a-a366-7e617de9ba99&tenantId=096e524d-6929-4030-8cd3-8ab42de0887b) + +## Contribute +This book will continue to develop, so feel free to contribute https://github.com/TeachBooks/manual! You can do so directly by forking this repository and creating a pull request. + +The released book can be found on on https://teachbooks.io/manual. This page shows the built book of the `release` branch. All branches will also be visible online, as pointed to in the actions summaries: https://github.com/TeachBooks/mirror_teachbook_manual/actions + +Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](https://github.com/TeachBooks/manual/tree/release/book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this book including its submodules, clone using: `git clone --recurse-submodules git@github.com:TeachBooks/manual.git` + + ### Acknowledgements Big thanks to the various colleagues and teaching assistant part of the [TeachBooks](https://teachbooks.io/) for developing tools and providing support to improve this book. \ No newline at end of file diff --git a/book/intro.md b/book/intro.md index ba7005f..67e557a 100644 --- a/book/intro.md +++ b/book/intro.md @@ -2,18 +2,4 @@ This manual assists you in creating and collaborating on <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="images/logo-wide.svg" alt="Jupyter book"></a> for educational purposes. Some parts are specifically aimed for teachers at Delft University of Technology, although all material and tools are openly available. This manual aims at providing an easy start and advanced usages for new and existing users with or without skills on this topic. it is part of TeachBooks, for more information visit [https://teachbooks.io/](https://teachbooks.io/). -## Contact -If you encounter any issues and you have a TU Delft account, report it by clicking <svg class="svg-inline--fa fa-gitlab" aria-hidden="true" focusable="false" data-prefix="fab" data-icon="gitlab" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" data-fa-i2svg=""><path fill="currentColor" d="M503.5 204.6L502.8 202.8L433.1 21.02C431.7 17.45 429.2 14.43 425.9 12.38C423.5 10.83 420.8 9.865 417.9 9.57C415 9.275 412.2 9.653 409.5 10.68C406.8 11.7 404.4 13.34 402.4 15.46C400.5 17.58 399.1 20.13 398.3 22.9L351.3 166.9H160.8L113.7 22.9C112.9 20.13 111.5 17.59 109.6 15.47C107.6 13.35 105.2 11.72 102.5 10.7C99.86 9.675 96.98 9.295 94.12 9.587C91.26 9.878 88.51 10.83 86.08 12.38C82.84 14.43 80.33 17.45 78.92 21.02L9.267 202.8L8.543 204.6C-1.484 230.8-2.72 259.6 5.023 286.6C12.77 313.5 29.07 337.3 51.47 354.2L51.74 354.4L52.33 354.8L158.3 434.3L210.9 474L242.9 498.2C246.6 500.1 251.2 502.5 255.9 502.5C260.6 502.5 265.2 500.1 268.9 498.2L300.9 474L353.5 434.3L460.2 354.4L460.5 354.1C482.9 337.2 499.2 313.5 506.1 286.6C514.7 259.6 513.5 230.8 503.5 204.6z"></path></svg> --> {fa}`lightbulb` on the top right corner of this page. Or contribute directly by creating a merge request in the [repository](https://github.com/TeachBooks/manual). - -If you have questions, contact Tom van Woudenberg, Robert Lanzafame or our TA Julie Kirsch at TeachBooks@tudelft.nl, also for non-TU Delft account holders. TU Delft account holder can also contact us in the [MS Teams Open Interactive Textbooks Community](https://teams.microsoft.com/l/team/19%3Ah9-uRcP_yYauh-VuoPFozJVUvHVOB4a0mz1ZWvh4q4Q1%40thread.tacv2/conversations?groupId=3e88c1f3-4a4f-483a-a366-7e617de9ba99&tenantId=096e524d-6929-4030-8cd3-8ab42de0887b) - -We really value your feedback on this manual. This helps us improving it. Please keep using the manual as you build your own Jupyter Book and come back to fill out this short [survey](https://forms.gle/hXbFUQgN95H8ftxt9). - -## Contribute -This book will continue to develop, so feel free to contribute https://github.com/TeachBooks/manual! You can do so directly by forking this repository and creating a merge request. - -The released book can be found on on https://teachbooks.io/manual. This page shows the built book of the `release` branch. All branches will also be visible online, as pointed to in the actions summaries: https://github.com/TeachBooks/mirror_teachbook_manual/actions - -Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](https://github.com/TeachBooks/manual/tree/release/book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this boko including its submodules, clone using: `git clone --recurse-submodules git@github.com:TeachBooks/manual.git` - Happy book building! \ No newline at end of file From 14d1ab60324dad449b2757255d6448498d8b1dce Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 10:29:43 +0100 Subject: [PATCH 03/23] Update latex-to-markdown-conversion --- book/external/latex-to-markdown-conversion | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/external/latex-to-markdown-conversion b/book/external/latex-to-markdown-conversion index fa0c472..4057c31 160000 --- a/book/external/latex-to-markdown-conversion +++ b/book/external/latex-to-markdown-conversion @@ -1 +1 @@ -Subproject commit fa0c47239eb7f454ab0825e4975adf8838fd0c1a +Subproject commit 4057c31d9c4134c617a46b5e394526b650ae8b94 From ed902f6ae5b00b00f66813fe9f3df8832fe9eecf Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 10:31:12 +0100 Subject: [PATCH 04/23] typo --- book/credits.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/book/credits.md b/book/credits.md index a10c12e..060159b 100644 --- a/book/credits.md +++ b/book/credits.md @@ -9,11 +9,10 @@ The introduction, structure of the book and formatting of contents is done by th We anticipate that the content of this book will change significantly. Therefore, if you'd like to refer to a specific chapter, we recommend using the source code directly with the citation 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. You can refer to individual chapters or pages within this book as: -> `<Primary Author>` (2024) `<Title of Chapter or Page>`. In TeachBook Team (Ed.), _TeachBooks Manual_. https://github.com/TeachBooks/manual (`./book/intro/` chapter, accessed `<date>`). +> `<Primary Author>` (2024) `<Title of Chapter or Page>`. In TeachBook Team, _TeachBooks Manual_. https://github.com/TeachBooks/manual (`./book/intro/` chapter, accessed `<date>`). (editor)= ## Editor - - Tom van Woudenberg ## Authors From 342b868cd40b84fb7336877fb96eb1780314df4d Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 10:31:32 +0100 Subject: [PATCH 05/23] typos --- book/credits.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/credits.md b/book/credits.md index 060159b..56329f6 100644 --- a/book/credits.md +++ b/book/credits.md @@ -3,13 +3,13 @@ You can refer to this book as: -> Teachbooks Team (2024) _TeachBooks Manual_. https://github.com/TeachBooks/manual +> Teachbooks Team (2024), _TeachBooks Manual_. https://github.com/TeachBooks/manual The introduction, structure of the book and formatting of contents is done by the Editors. Some chapters and pages have additional primary authors who are identified within the book either at the bottom of the first page in a chapter, or at the bottom of an individual page, as necessary. If an author is not listed on a particular page, it is by the Editors. We anticipate that the content of this book will change significantly. Therefore, if you'd like to refer to a specific chapter, we recommend using the source code directly with the citation 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. You can refer to individual chapters or pages within this book as: -> `<Primary Author>` (2024) `<Title of Chapter or Page>`. In TeachBook Team, _TeachBooks Manual_. https://github.com/TeachBooks/manual (`./book/intro/` chapter, accessed `<date>`). +> `<Primary Author>` (2024), `<Title of Chapter or Page>`. In TeachBook Team, _TeachBooks Manual_. https://github.com/TeachBooks/manual (`./book/intro/` chapter, accessed `<date>`). (editor)= ## Editor From 037f04115b4d44248a700dca48a7706af9f0c01e Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 10:33:15 +0100 Subject: [PATCH 06/23] clarification --- book/credits.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/book/credits.md b/book/credits.md index 56329f6..7b42085 100644 --- a/book/credits.md +++ b/book/credits.md @@ -15,8 +15,7 @@ We anticipate that the content of this book will change significantly. Therefore ## Editor - Tom van Woudenberg -## Authors - +## Authors: TeachBooks Team - Tom van Woudenberg - Robert Lanzafame - Freek Pols From 7ace2fb21f7790683c6c18aa5e64be8673b861b3 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 10:36:40 +0100 Subject: [PATCH 07/23] 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 7b42085..aacfb5e 100644 --- a/book/credits.md +++ b/book/credits.md @@ -1,5 +1,5 @@ (credits)= -# Credits and License +# Credits You can refer to this book as: From e1fe6218a113c3aa110ab89c236abb256543d5a3 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 10:48:19 +0100 Subject: [PATCH 08/23] Update references.md --- book/references.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/book/references.md b/book/references.md index 2d82592..d4e42f1 100644 --- a/book/references.md +++ b/book/references.md @@ -2,8 +2,8 @@ :::{bibliography} ::: -## Linked external recourses +## External recourses -Parts of this book are linked to other external resources. The following are not edited by the TeachBooks Team: +Parts of this book are taken from other external resources. The following are not edited by the TeachBooks Team: -- [](external/latex-to-markdown-conversion/README.md) {cite:ts}`timon_latex` \ No newline at end of file +- [](external/latex-to-markdown-conversion/README.md) {cite:ts}`timon_latex`, not licensed. \ No newline at end of file From 86c8ba05e8c2f9dda2d89dec28a5a841adea9930 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 11:08:23 +0100 Subject: [PATCH 09/23] Add mention of license back in --- book/credits.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/book/credits.md b/book/credits.md index aacfb5e..4717291 100644 --- a/book/credits.md +++ b/book/credits.md @@ -1,16 +1,18 @@ (credits)= -# Credits +# Credits and license You can refer to this book as: > Teachbooks Team (2024), _TeachBooks Manual_. https://github.com/TeachBooks/manual -The introduction, structure of the book and formatting of contents is done by the Editors. Some chapters and pages have additional primary authors who are identified within the book either at the bottom of the first page in a chapter, or at the bottom of an individual page, as necessary. If an author is not listed on a particular page, it is by the Editors. +The introduction, structure of the book and formatting of contents is done by the Editors. Some chapters and pages have additional primary authors who are identified at the top of an individual page, as necessary. If an author is not listed on a particular page, it is by the Editors. -We anticipate that the content of this book will change significantly. Therefore, if you'd like to refer to a specific chapter, we recommend using the source code directly with the citation 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. You can refer to individual chapters or pages within this book as: +We anticipate that the content of this book will change continuously. Therefore, if you'd like to refer to a specific chapter, we recommend using the source code directly with the citation 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. You can refer to individual chapters or pages within this book as: > `<Primary Author>` (2024), `<Title of Chapter or Page>`. In TeachBook Team, _TeachBooks Manual_. https://github.com/TeachBooks/manual (`./book/intro/` chapter, accessed `<date>`). +This manual 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. + (editor)= ## Editor - Tom van Woudenberg From 1861b3c0838f66789a50af514071554a1f95af2e Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 12:53:54 +0100 Subject: [PATCH 10/23] add TU Delft --- book/credits.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/book/credits.md b/book/credits.md index 4717291..7aadea6 100644 --- a/book/credits.md +++ b/book/credits.md @@ -15,13 +15,17 @@ This manual is [CC BY 4.0 licensed](https://creativecommons.org/licenses/by/4.0/ (editor)= ## Editor -- Tom van Woudenberg +- Tom van Woudenberg from Delft University of Technology ## Authors: TeachBooks Team - Tom van Woudenberg - Robert Lanzafame - Freek Pols - Julie Kirsch +- Caspar Jungbacker +All from Delft University of Technology + +Ths doesn't include small contributions from various people from within and outside Delft University of Technology. ## Contact If you encounter any issues report it by clicking {octicon}`mark-github` on the top right corner of this page. From 0140e792479b66014057eaf3c5d7640765b8a332 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 12:55:09 +0100 Subject: [PATCH 11/23] Moved to credits --- book/credits.md | 6 ++++++ book/references.md | 8 +------- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/book/credits.md b/book/credits.md index 7aadea6..5f430de 100644 --- a/book/credits.md +++ b/book/credits.md @@ -27,6 +27,12 @@ All from Delft University of Technology Ths doesn't include small contributions from various people from within and outside Delft University of Technology. +## External recourses + +Parts of this book are taken from other external resources. The following are not edited by the TeachBooks Team: + +- [](external/latex-to-markdown-conversion/README.md) {cite:ts}`timon_latex`, not licensed. + ## Contact If you encounter any issues report it by clicking {octicon}`mark-github` on the top right corner of this page. diff --git a/book/references.md b/book/references.md index d4e42f1..836a842 100644 --- a/book/references.md +++ b/book/references.md @@ -1,9 +1,3 @@ # References :::{bibliography} -::: - -## External recourses - -Parts of this book are taken from other external resources. The following are not edited by the TeachBooks Team: - -- [](external/latex-to-markdown-conversion/README.md) {cite:ts}`timon_latex`, not licensed. \ No newline at end of file +::: \ No newline at end of file From 13f6ff8b415a92352f7677c33311d27e0983506c Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 12:58:14 +0100 Subject: [PATCH 12/23] Updated exernal resoruces --- book/credits.md | 3 ++- book/external/latex-to-markdown-conversion | 2 +- book/references.bib | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/book/credits.md b/book/credits.md index 5f430de..5a3878b 100644 --- a/book/credits.md +++ b/book/credits.md @@ -27,7 +27,8 @@ All from Delft University of Technology Ths doesn't include small contributions from various people from within and outside Delft University of Technology. -## External recourses +(external_resources)= +## External resources Parts of this book are taken from other external resources. The following are not edited by the TeachBooks Team: diff --git a/book/external/latex-to-markdown-conversion b/book/external/latex-to-markdown-conversion index 4057c31..cb81691 160000 --- a/book/external/latex-to-markdown-conversion +++ b/book/external/latex-to-markdown-conversion @@ -1 +1 @@ -Subproject commit 4057c31d9c4134c617a46b5e394526b650ae8b94 +Subproject commit cb8169156e5c0150848cf52fb177d0d40934522e diff --git a/book/references.bib b/book/references.bib index 9fde9ae..08bb4b2 100644 --- a/book/references.bib +++ b/book/references.bib @@ -1,6 +1,7 @@ @misc{timon_latex, title={LaTeX to Markdown conversion}, author={Idema, Timon}, + institution ={Delft University of Technology}, howpublished={\url{https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}}, year={2024} } \ No newline at end of file From 39d45d090b00cd9fd7fa246159c40553a5c9c0f8 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 13:05:55 +0100 Subject: [PATCH 13/23] moved contatc to something separate --- book/_toc.yml | 3 ++- book/contact.md | 15 +++++++++++++++ book/credits.md | 15 +-------------- 3 files changed, 18 insertions(+), 15 deletions(-) create mode 100644 book/contact.md diff --git a/book/_toc.yml b/book/_toc.yml index 174352a..1f8a2c8 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -98,4 +98,5 @@ parts: - caption: Miscallaneous chapters: - file: references.md - - file: credits \ No newline at end of file + - file: credits + - file: contact \ No newline at end of file diff --git a/book/contact.md b/book/contact.md new file mode 100644 index 0000000..cf77ec0 --- /dev/null +++ b/book/contact.md @@ -0,0 +1,15 @@ +# Contact + +## Contact +If you encounter any issues report it by clicking {octicon}`mark-github` on the top right corner of this page. + +If you have questions, contact the editors at TeachBooks@tudelft.nl. TU Delft account holder can also contact us in the [MS Teams Open Interactive Textbooks Community](https://teams.microsoft.com/l/team/19%3Ah9-uRcP_yYauh-VuoPFozJVUvHVOB4a0mz1ZWvh4q4Q1%40thread.tacv2/conversations?groupId=3e88c1f3-4a4f-483a-a366-7e617de9ba99&tenantId=096e524d-6929-4030-8cd3-8ab42de0887b) + +## Contribute +This book will continue to develop, so feel free to contribute https://github.com/TeachBooks/manual! You can do so directly by forking this repository and creating a pull request. + +The released book can be found on on https://teachbooks.io/manual. This page shows the built book of the `release` branch. All branches will also be visible online, as pointed to in the actions summaries: https://github.com/TeachBooks/mirror_teachbook_manual/actions + +Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](https://github.com/TeachBooks/manual/tree/release/book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this book including its submodules, clone using: `git clone --recurse-submodules git@github.com:TeachBooks/manual.git` + + diff --git a/book/credits.md b/book/credits.md index 5a3878b..a0526dd 100644 --- a/book/credits.md +++ b/book/credits.md @@ -34,18 +34,5 @@ Parts of this book are taken from other external resources. The following are no - [](external/latex-to-markdown-conversion/README.md) {cite:ts}`timon_latex`, not licensed. -## Contact -If you encounter any issues report it by clicking {octicon}`mark-github` on the top right corner of this page. - -If you have questions, contact the editors at TeachBooks@tudelft.nl. TU Delft account holder can also contact us in the [MS Teams Open Interactive Textbooks Community](https://teams.microsoft.com/l/team/19%3Ah9-uRcP_yYauh-VuoPFozJVUvHVOB4a0mz1ZWvh4q4Q1%40thread.tacv2/conversations?groupId=3e88c1f3-4a4f-483a-a366-7e617de9ba99&tenantId=096e524d-6929-4030-8cd3-8ab42de0887b) - -## Contribute -This book will continue to develop, so feel free to contribute https://github.com/TeachBooks/manual! You can do so directly by forking this repository and creating a pull request. - -The released book can be found on on https://teachbooks.io/manual. This page shows the built book of the `release` branch. All branches will also be visible online, as pointed to in the actions summaries: https://github.com/TeachBooks/mirror_teachbook_manual/actions - -Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](https://github.com/TeachBooks/manual/tree/release/book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this book including its submodules, clone using: `git clone --recurse-submodules git@github.com:TeachBooks/manual.git` - - -### Acknowledgements +## Acknowledgements Big thanks to the various colleagues and teaching assistant part of the [TeachBooks](https://teachbooks.io/) for developing tools and providing support to improve this book. \ No newline at end of file From 5d1b99750d8727e5a949ca6b94b10da0df90cd46 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 13:08:10 +0100 Subject: [PATCH 14/23] Update credits.md --- book/credits.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/book/credits.md b/book/credits.md index a0526dd..d818d6d 100644 --- a/book/credits.md +++ b/book/credits.md @@ -5,14 +5,12 @@ You can refer to this book as: > Teachbooks Team (2024), _TeachBooks Manual_. https://github.com/TeachBooks/manual -The introduction, structure of the book and formatting of contents is done by the Editors. Some chapters and pages have additional primary authors who are identified at the top of an individual page, as necessary. If an author is not listed on a particular page, it is by the Editors. +The introduction, structure of the book and formatting of contents is done by the Editor. The content is written by the Authors. We anticipate that the content of this book will change continuously. Therefore, if you'd like to refer to a specific chapter, we recommend using the source code directly with the citation 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. You can refer to individual chapters or pages within this book as: > `<Primary Author>` (2024), `<Title of Chapter or Page>`. In TeachBook Team, _TeachBooks Manual_. https://github.com/TeachBooks/manual (`./book/intro/` chapter, accessed `<date>`). -This manual 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. - (editor)= ## Editor - Tom van Woudenberg from Delft University of Technology @@ -30,9 +28,12 @@ Ths doesn't include small contributions from various people from within and outs (external_resources)= ## External resources -Parts of this book are taken from other external resources. The following are not edited by the TeachBooks Team: +Parts of this book are taken from other external resources. If an author is not listed on a particular page, it is by the Authors. The following pages are not edited by the TeachBooks Team: - [](external/latex-to-markdown-conversion/README.md) {cite:ts}`timon_latex`, not licensed. ## Acknowledgements -Big thanks to the various colleagues and teaching assistant part of the [TeachBooks](https://teachbooks.io/) for developing tools and providing support to improve this book. \ No newline at end of file +Big thanks to the various colleagues and teaching assistant part of the [TeachBooks](https://teachbooks.io/) for developing tools and providing support to improve this book. + +## License +This manual 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. Additional licenses may be applicable for external resources. \ No newline at end of file From e1728c3c37c657470878b098cc3272f0a7558861 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 2 Dec 2024 13:10:30 +0100 Subject: [PATCH 15/23] Update credits.md --- book/credits.md | 1 + 1 file changed, 1 insertion(+) diff --git a/book/credits.md b/book/credits.md index d818d6d..970190e 100644 --- a/book/credits.md +++ b/book/credits.md @@ -21,6 +21,7 @@ We anticipate that the content of this book will change continuously. Therefore, - Freek Pols - Julie Kirsch - Caspar Jungbacker + All from Delft University of Technology Ths doesn't include small contributions from various people from within and outside Delft University of Technology. From bac5afa06aa32174680d9fdaa198dd3cc6317d33 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Tue, 3 Dec 2024 10:14:36 +0100 Subject: [PATCH 16/23] added license to timons stuff --- book/credits.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/credits.md b/book/credits.md index 970190e..a46413e 100644 --- a/book/credits.md +++ b/book/credits.md @@ -31,7 +31,7 @@ Ths doesn't include small contributions from various people from within and outs Parts of this book are taken from other external resources. If an author is not listed on a particular page, it is by the Authors. The following pages are not edited by the TeachBooks Team: -- [](external/latex-to-markdown-conversion/README.md) {cite:ts}`timon_latex`, not licensed. +- [](external/latex-to-markdown-conversion/README.md) {cite:ts}`timon_latex`, [BSD 3-clause license](https://opensource.org/license/BSD-3-Clause). ## Acknowledgements Big thanks to the various colleagues and teaching assistant part of the [TeachBooks](https://teachbooks.io/) for developing tools and providing support to improve this book. From e54c589fc56b14476dfc3291f49f3f892e2194c1 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Tue, 3 Dec 2024 10:39:29 +0100 Subject: [PATCH 17/23] test unpublished tool --- book/references.bib | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/references.bib b/book/references.bib index 08bb4b2..abb89b4 100644 --- a/book/references.bib +++ b/book/references.bib @@ -1,4 +1,4 @@ -@misc{timon_latex, +@unpublished{timon_latex, title={LaTeX to Markdown conversion}, author={Idema, Timon}, institution ={Delft University of Technology}, From a40ad3527b9b6b9d99f7ca87a05087666550a933 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Tue, 3 Dec 2024 11:12:52 +0100 Subject: [PATCH 18/23] fix references --- book/references.bib | 1 + 1 file changed, 1 insertion(+) diff --git a/book/references.bib b/book/references.bib index abb89b4..4fc0c3f 100644 --- a/book/references.bib +++ b/book/references.bib @@ -4,4 +4,5 @@ institution ={Delft University of Technology}, howpublished={\url{https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}}, year={2024} + note={Shared on TU Delft GitLab} } \ No newline at end of file From 62200b20f498083f650d7e76942863cb8089c44b Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Tue, 3 Dec 2024 11:16:35 +0100 Subject: [PATCH 19/23] fix again --- book/references.bib | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/references.bib b/book/references.bib index 4fc0c3f..8e306d6 100644 --- a/book/references.bib +++ b/book/references.bib @@ -3,6 +3,6 @@ author={Idema, Timon}, institution ={Delft University of Technology}, howpublished={\url{https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}}, - year={2024} + year={2024}, note={Shared on TU Delft GitLab} } \ No newline at end of file From 4028adfcffb1e3c7d8aede2abbc6e7fcd9a93551 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Tue, 3 Dec 2024 11:19:47 +0100 Subject: [PATCH 20/23] Revert "fix again" This reverts commit 62200b20f498083f650d7e76942863cb8089c44b. --- book/references.bib | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/references.bib b/book/references.bib index 8e306d6..4fc0c3f 100644 --- a/book/references.bib +++ b/book/references.bib @@ -3,6 +3,6 @@ author={Idema, Timon}, institution ={Delft University of Technology}, howpublished={\url{https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}}, - year={2024}, + year={2024} note={Shared on TU Delft GitLab} } \ No newline at end of file From a5b63bddfb987c66587ae8c7258d0f4f2bf47fc4 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Tue, 3 Dec 2024 11:19:51 +0100 Subject: [PATCH 21/23] Revert "fix references" This reverts commit a40ad3527b9b6b9d99f7ca87a05087666550a933. --- book/references.bib | 1 - 1 file changed, 1 deletion(-) diff --git a/book/references.bib b/book/references.bib index 4fc0c3f..abb89b4 100644 --- a/book/references.bib +++ b/book/references.bib @@ -4,5 +4,4 @@ institution ={Delft University of Technology}, howpublished={\url{https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}}, year={2024} - note={Shared on TU Delft GitLab} } \ No newline at end of file From eaac315a9c383fe6b7bf9127ced4486b7464a4a3 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Tue, 3 Dec 2024 11:20:28 +0100 Subject: [PATCH 22/23] Back to old stuff and hardcode TU Delft into it --- book/references.bib | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/references.bib b/book/references.bib index abb89b4..5d64dc5 100644 --- a/book/references.bib +++ b/book/references.bib @@ -1,6 +1,6 @@ -@unpublished{timon_latex, +@misc{timon_latex, title={LaTeX to Markdown conversion}, - author={Idema, Timon}, + author={Idema (Delft University of Technology, Timon}, institution ={Delft University of Technology}, howpublished={\url{https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}}, year={2024} From 4c78e4fb5a738c8e575b52bff99cf049df7ddb6d Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Tue, 3 Dec 2024 11:22:43 +0100 Subject: [PATCH 23/23] fix --- book/references.bib | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/references.bib b/book/references.bib index 5d64dc5..865406e 100644 --- a/book/references.bib +++ b/book/references.bib @@ -1,6 +1,6 @@ @misc{timon_latex, title={LaTeX to Markdown conversion}, - author={Idema (Delft University of Technology, Timon}, + author={Idema (Delft University of Technology), Timon}, institution ={Delft University of Technology}, howpublished={\url{https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}}, year={2024}