From 748f68d6d9523b48bf78fb744a5f250986a26ca4 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Tue, 1 Apr 2025 13:57:19 +0200 Subject: [PATCH] attributions in margin --- book/external/Download-Link-Replacer | 2 +- book/external/JupyterBook-Patches | 2 +- book/external/Nested-Books | 2 +- book/external/Sphinx-Grasple-public | 2 +- book/external/Sphinx-Image-Inverter | 2 +- book/external/Sphinx-Named-Colors | 2 +- book/external/Sphinx-PRIME-applets | 2 +- book/external/Sphinx-TUDelft-theme | 2 +- book/external/Sphinx-launch-buttons | 2 +- book/external/Useful_python_code | 2 +- book/external/annotater | 2 +- book/external/deploy-book-workflow | 2 +- book/external/sphinx-iframes | 2 +- book/external/teachbooks-sphinx-tippy | 2 +- book/installation-and-setup/copyright.md | 9 +++++--- .../copyright/considerations.md | 10 ++++++--- .../copyright/licenses.md | 8 ++++--- .../copyright/recommendations.md | 22 ++++--------------- 18 files changed, 36 insertions(+), 41 deletions(-) diff --git a/book/external/Download-Link-Replacer b/book/external/Download-Link-Replacer index b658d1c..6318fd9 160000 --- a/book/external/Download-Link-Replacer +++ b/book/external/Download-Link-Replacer @@ -1 +1 @@ -Subproject commit b658d1c6e1791097b225357025ebe7267d4dccb5 +Subproject commit 6318fd9db4b465bf56b06085ca55c79a8a818471 diff --git a/book/external/JupyterBook-Patches b/book/external/JupyterBook-Patches index 1a8e996..8346c8c 160000 --- a/book/external/JupyterBook-Patches +++ b/book/external/JupyterBook-Patches @@ -1 +1 @@ -Subproject commit 1a8e9960f0a37ce210df51198e0079430f1a2c6e +Subproject commit 8346c8c3c8be3d221a62a2f18c4ee1d4570ee003 diff --git a/book/external/Nested-Books b/book/external/Nested-Books index dcdecc4..70dfd28 160000 --- a/book/external/Nested-Books +++ b/book/external/Nested-Books @@ -1 +1 @@ -Subproject commit dcdecc4a7335163ce0f5a8975bfd366a17d5fb94 +Subproject commit 70dfd28f5f288118bb75d219b809f03474aa89a2 diff --git a/book/external/Sphinx-Grasple-public b/book/external/Sphinx-Grasple-public index e13743c..ce057a2 160000 --- a/book/external/Sphinx-Grasple-public +++ b/book/external/Sphinx-Grasple-public @@ -1 +1 @@ -Subproject commit e13743c7dd2d1de8a0dd7137da2841344ea0f330 +Subproject commit ce057a20bb234006ddebc80c9894842d125a5b1b diff --git a/book/external/Sphinx-Image-Inverter b/book/external/Sphinx-Image-Inverter index 8365d4a..573bb66 160000 --- a/book/external/Sphinx-Image-Inverter +++ b/book/external/Sphinx-Image-Inverter @@ -1 +1 @@ -Subproject commit 8365d4a366433bbbdfe7d7d0fbd617270c0e7130 +Subproject commit 573bb66332f682bdfe1d7936048780199e4a0e2d diff --git a/book/external/Sphinx-Named-Colors b/book/external/Sphinx-Named-Colors index 6c5a0f4..b4b1a2e 160000 --- a/book/external/Sphinx-Named-Colors +++ b/book/external/Sphinx-Named-Colors @@ -1 +1 @@ -Subproject commit 6c5a0f4aa9a11b0ba9d5a8f68929ba5773c3312a +Subproject commit b4b1a2e5d087336108bc15b176af1999b61dc86a diff --git a/book/external/Sphinx-PRIME-applets b/book/external/Sphinx-PRIME-applets index 29b5b48..14dc36b 160000 --- a/book/external/Sphinx-PRIME-applets +++ b/book/external/Sphinx-PRIME-applets @@ -1 +1 @@ -Subproject commit 29b5b48126fadde3839ef20a6256bdbda72d4ef9 +Subproject commit 14dc36bfdbf89d2d363ea2bdcbc30a64c0f7b00f diff --git a/book/external/Sphinx-TUDelft-theme b/book/external/Sphinx-TUDelft-theme index 5f26d31..103caec 160000 --- a/book/external/Sphinx-TUDelft-theme +++ b/book/external/Sphinx-TUDelft-theme @@ -1 +1 @@ -Subproject commit 5f26d318bf0696229041d20518900695d6ff935f +Subproject commit 103caecd4844353c68c166fa6ebed24a868c848c diff --git a/book/external/Sphinx-launch-buttons b/book/external/Sphinx-launch-buttons index 5acbe14..f6435cb 160000 --- a/book/external/Sphinx-launch-buttons +++ b/book/external/Sphinx-launch-buttons @@ -1 +1 @@ -Subproject commit 5acbe14ac0bfa4ab532b9b7c64e6462f16a7dbda +Subproject commit f6435cb0a795062a7d695a246a332ff79f3f74b9 diff --git a/book/external/Useful_python_code b/book/external/Useful_python_code index 1fb335f..81e9235 160000 --- a/book/external/Useful_python_code +++ b/book/external/Useful_python_code @@ -1 +1 @@ -Subproject commit 1fb335fb81ec9b88186161352f379e315a19d2f8 +Subproject commit 81e923516e06441fb0c04f4946819f5dae9b0a68 diff --git a/book/external/annotater b/book/external/annotater index ff37537..d1f41f9 160000 --- a/book/external/annotater +++ b/book/external/annotater @@ -1 +1 @@ -Subproject commit ff3753731bd65f4351fb09e88327aba15383b1d2 +Subproject commit d1f41f93ffe87a305956de405dac47daaad3bc69 diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index 4415690..ea450f3 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit 44156900a23360478983a0920340ff2298110b78 +Subproject commit ea450f3c0c4f9aba6438333c122543fca02c472d diff --git a/book/external/sphinx-iframes b/book/external/sphinx-iframes index 0ebb0ed..062c54a 160000 --- a/book/external/sphinx-iframes +++ b/book/external/sphinx-iframes @@ -1 +1 @@ -Subproject commit 0ebb0edea5f14144c6548e417f5b79c6d7721d77 +Subproject commit 062c54a679c6dd44b948549498e755c7c5df1d73 diff --git a/book/external/teachbooks-sphinx-tippy b/book/external/teachbooks-sphinx-tippy index e37225d..e4166e1 160000 --- a/book/external/teachbooks-sphinx-tippy +++ b/book/external/teachbooks-sphinx-tippy @@ -1 +1 @@ -Subproject commit e37225de883df69e0933849dfc4880d41e7c75b0 +Subproject commit e4166e1389ab48ea9059e6576e56d270e66199dd diff --git a/book/installation-and-setup/copyright.md b/book/installation-and-setup/copyright.md index 1deaa0d..82b60a0 100644 --- a/book/installation-and-setup/copyright.md +++ b/book/installation-and-setup/copyright.md @@ -1,6 +1,4 @@ -(copyright)= -# Copyright and Licenses checklist - +````{margin} ```{attributiongrey} Attribution :class: attribution This page reuses adapted CC BY content from the TU Delft Library. {cite:p}`tud_cip_24`. {fa}`quote-left`{ref}`Find out more here.` @@ -10,6 +8,11 @@ This page reuses adapted CC BY content from the TU Delft Library. {cite:p}`tud_c :class: tip This page is useful for all user types. ``` +```` + +(copyright)= +# Copyright and Licenses checklist + The previous sections have familiarized you with the necessary software for your user type, the basics of Git, and how to collaborate with your team using Git. Now it's time to create your own content. This section will provide an overview of the copy right laws which need to be taking into account when creating and including content at TU Delft! diff --git a/book/installation-and-setup/copyright/considerations.md b/book/installation-and-setup/copyright/considerations.md index 80fa6aa..4180108 100644 --- a/book/installation-and-setup/copyright/considerations.md +++ b/book/installation-and-setup/copyright/considerations.md @@ -1,10 +1,14 @@ -(copyright_considerations)= -# Copyright Considerations - +````{margin} ```{attributiongrey} Attribution :class: attribution This page reuses adapted CC BY content from {cite:t}`tud_cip_24`. {fa}`quote-left`{ref}`Find out more here.` ``` +```` + +(copyright_considerations)= +# Copyright Considerations + + Copyright law dictates how online book material can and should be created, maintained and shared. An author should understand a few key concepts, as well as best practices, in order to create a book that not only is a useful resource, but, also fairly reuses the work of others and, if provided with an open license, enables original content to also be reused. diff --git a/book/installation-and-setup/copyright/licenses.md b/book/installation-and-setup/copyright/licenses.md index 1cd3f4d..05033af 100644 --- a/book/installation-and-setup/copyright/licenses.md +++ b/book/installation-and-setup/copyright/licenses.md @@ -1,10 +1,12 @@ -(copyright_licenses)= -# Licenses - +````{margin} ```{attributiongrey} Attribution :class: attribution This page reuses adapted CC BY content from {cite:t}`hall21`. {fa}`quote-left`{ref}`Find out more here.` ``` +```` + +(copyright_licenses)= +# Licenses Here we present an overview of various license types, with a particular focus on the preference of TeachBooks to use Permissive Open Licenses, regardless of whether material is _content, code or data_ (described below). diff --git a/book/installation-and-setup/copyright/recommendations.md b/book/installation-and-setup/copyright/recommendations.md index 0f446ca..c018533 100644 --- a/book/installation-and-setup/copyright/recommendations.md +++ b/book/installation-and-setup/copyright/recommendations.md @@ -76,31 +76,16 @@ This produces ##### Format as custom admonition The previous syntax might be used for other purposes as well. An alternative is a custom attribution admonition: +````{margin} ```{attributiongrey} Attribution :class: attribution +Written by This page reuses CC BY 4.0 licensed content from {cite:t}`jason_moore`. {fa}`quote-left`{ref}`Find out more here.` ``` +```` Therefore, use the following syntax: -`````md -```{attributiongrey} Attribution -:class: attribution -Written by -This page reuses content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.` -``` -````` - -Or to place this attribution in the margin: - -````{margin} -```{attributiongrey} Attribution -:class: attribution -Written by -This page reuses CC BY 4.0 licensed content from {cite:t}`jason_moore`. {fa}`quote-left`{ref}`Find out more here.` -``` -```` - `````md ````{margin} ```{attributiongrey} Attribution @@ -110,6 +95,7 @@ This page reuses content from {cite:t}`bib_id`. {fa}`quote-left`{ref}` ``` ```` ````` + To make this possible we use the custom admonitions of [the custom named colors sphinx extension](https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html#admonitions) in combination with a [custom css file](../../_static/attribution.css) in `book/_static/` and the line `named_colors_custom_colors: {'attributiongrey':[150,150,150]}` in `book/_config.yml` under `sphinx: config: `