diff --git a/book/_config.yml b/book/_config.yml index 03274cc..eaa1a16 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -51,7 +51,7 @@ sphinx: tex: macros: "newcolor": ['\definecolor{newcolor}{RGB}{111, 29, 119}{\color{newcolor}#1}',1] - named_colors_custom_colors: {'onlylight':[165,21,160],'lightanddark':[45,180,117,204,158,110],'hyphen-color':[45,180,117,165,21,160]} + named_colors_custom_colors: {'onlylight':[165,21,160],'lightanddark':[45,180,117,204,158,110],'hyphen-color':[45,180,117,165,21,160],'attributiongrey':[150,150,150]} local_extensions: apastyle: _ext/ bracket_citation_style: _ext/ diff --git a/book/_static/attribution.css b/book/_static/attribution.css new file mode 100644 index 0000000..3c23cc3 --- /dev/null +++ b/book/_static/attribution.css @@ -0,0 +1,4 @@ +/* Attribution */ +div.attribution > .admonition-title::after { + content: "\f10d"; +} \ No newline at end of file diff --git a/book/external/Download-Link-Replacer b/book/external/Download-Link-Replacer index f69e970..b658d1c 160000 --- a/book/external/Download-Link-Replacer +++ b/book/external/Download-Link-Replacer @@ -1 +1 @@ -Subproject commit f69e970a8da7d85e5473c7e5f58299a2ee3cf331 +Subproject commit b658d1c6e1791097b225357025ebe7267d4dccb5 diff --git a/book/external/JupyterBook-Patches b/book/external/JupyterBook-Patches index aa93fc5..1a8e996 160000 --- a/book/external/JupyterBook-Patches +++ b/book/external/JupyterBook-Patches @@ -1 +1 @@ -Subproject commit aa93fc51bf95876f8034005ffcd777045ea9ddc6 +Subproject commit 1a8e9960f0a37ce210df51198e0079430f1a2c6e diff --git a/book/external/Nested-Books b/book/external/Nested-Books index 134fcc3..dcdecc4 160000 --- a/book/external/Nested-Books +++ b/book/external/Nested-Books @@ -1 +1 @@ -Subproject commit 134fcc3384f0e01591881b59265a58b4eeee849b +Subproject commit dcdecc4a7335163ce0f5a8975bfd366a17d5fb94 diff --git a/book/external/Sphinx-Grasple-public b/book/external/Sphinx-Grasple-public index f4eff8d..e13743c 160000 --- a/book/external/Sphinx-Grasple-public +++ b/book/external/Sphinx-Grasple-public @@ -1 +1 @@ -Subproject commit f4eff8d1565eaf127898f2fe216cf5208684fb27 +Subproject commit e13743c7dd2d1de8a0dd7137da2841344ea0f330 diff --git a/book/external/Sphinx-Image-Inverter b/book/external/Sphinx-Image-Inverter index 250103c..8365d4a 160000 --- a/book/external/Sphinx-Image-Inverter +++ b/book/external/Sphinx-Image-Inverter @@ -1 +1 @@ -Subproject commit 250103c723aa782bcec785ae3d241cb1ffebd3d0 +Subproject commit 8365d4a366433bbbdfe7d7d0fbd617270c0e7130 diff --git a/book/external/Sphinx-Named-Colors b/book/external/Sphinx-Named-Colors index 191c2f4..6c5a0f4 160000 --- a/book/external/Sphinx-Named-Colors +++ b/book/external/Sphinx-Named-Colors @@ -1 +1 @@ -Subproject commit 191c2f4ac1755d3b50c6a63950eb6c2e5c035d75 +Subproject commit 6c5a0f4aa9a11b0ba9d5a8f68929ba5773c3312a diff --git a/book/external/Sphinx-PRIME-applets b/book/external/Sphinx-PRIME-applets index 43ea44c..29b5b48 160000 --- a/book/external/Sphinx-PRIME-applets +++ b/book/external/Sphinx-PRIME-applets @@ -1 +1 @@ -Subproject commit 43ea44ccdc917234513fcd0ea1b9d5159a7dc81f +Subproject commit 29b5b48126fadde3839ef20a6256bdbda72d4ef9 diff --git a/book/external/Sphinx-TUDelft-theme b/book/external/Sphinx-TUDelft-theme index e4b71f8..5f26d31 160000 --- a/book/external/Sphinx-TUDelft-theme +++ b/book/external/Sphinx-TUDelft-theme @@ -1 +1 @@ -Subproject commit e4b71f810a66e302243377876f39e1dc4c4a8a6b +Subproject commit 5f26d318bf0696229041d20518900695d6ff935f diff --git a/book/external/Sphinx-launch-buttons b/book/external/Sphinx-launch-buttons index ccec26f..5acbe14 160000 --- a/book/external/Sphinx-launch-buttons +++ b/book/external/Sphinx-launch-buttons @@ -1 +1 @@ -Subproject commit ccec26fd77d3b6f1bb3415b5eb824b3155a397f1 +Subproject commit 5acbe14ac0bfa4ab532b9b7c64e6462f16a7dbda diff --git a/book/external/Useful_python_code b/book/external/Useful_python_code index 7fbdbbf..1fb335f 160000 --- a/book/external/Useful_python_code +++ b/book/external/Useful_python_code @@ -1 +1 @@ -Subproject commit 7fbdbbf720c27112fb58bcf7826225197e39357b +Subproject commit 1fb335fb81ec9b88186161352f379e315a19d2f8 diff --git a/book/external/annotater b/book/external/annotater index 9340b4e..832cee0 160000 --- a/book/external/annotater +++ b/book/external/annotater @@ -1 +1 @@ -Subproject commit 9340b4e2856b6f2de331c31d2b74bd9dc286d276 +Subproject commit 832cee034927c9a51efd328e6e1d5c9157b94e32 diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index 26afa87..4415690 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit 26afa87f90a4191de0e07f89c6de674ea8b81b8d +Subproject commit 44156900a23360478983a0920340ff2298110b78 diff --git a/book/external/sphinx-iframes b/book/external/sphinx-iframes index 077ba23..0ebb0ed 160000 --- a/book/external/sphinx-iframes +++ b/book/external/sphinx-iframes @@ -1 +1 @@ -Subproject commit 077ba23fa29ef1f0dd454f2ebf93c107923d1068 +Subproject commit 0ebb0edea5f14144c6548e417f5b79c6d7721d77 diff --git a/book/external/teachbooks-sphinx-tippy b/book/external/teachbooks-sphinx-tippy index 338ad14..e37225d 160000 --- a/book/external/teachbooks-sphinx-tippy +++ b/book/external/teachbooks-sphinx-tippy @@ -1 +1 @@ -Subproject commit 338ad14d39115c620c57476931ce8fa177cf20d8 +Subproject commit e37225de883df69e0933849dfc4880d41e7c75b0 diff --git a/book/external/template b/book/external/template index 82b2de6..17b99b2 160000 --- a/book/external/template +++ b/book/external/template @@ -1 +1 @@ -Subproject commit 82b2de6a80b824482dd38f350a9aaf5f4a7a5fe0 +Subproject commit 17b99b2de4edbcbf4d8a92fed52c3d335431699b diff --git a/book/installation-and-setup/copyright.md b/book/installation-and-setup/copyright.md index f825244..1deaa0d 100644 --- a/book/installation-and-setup/copyright.md +++ b/book/installation-and-setup/copyright.md @@ -1,7 +1,10 @@ (copyright)= # Copyright and Licenses checklist -> 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.` +```{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.` +``` ```{admonition} User types :class: tip diff --git a/book/installation-and-setup/copyright/considerations.md b/book/installation-and-setup/copyright/considerations.md index b507d7f..80fa6aa 100644 --- a/book/installation-and-setup/copyright/considerations.md +++ b/book/installation-and-setup/copyright/considerations.md @@ -1,7 +1,10 @@ (copyright_considerations)= # Copyright Considerations -> This page reuses adapted CC BY content from {cite:t}`tud_cip_24`. {fa}`quote-left`{ref}`Find out more here.` +```{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 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 40fb5d7..1cd3f4d 100644 --- a/book/installation-and-setup/copyright/licenses.md +++ b/book/installation-and-setup/copyright/licenses.md @@ -1,7 +1,10 @@ (copyright_licenses)= # Licenses -> This page reuses adapted CC BY content from {cite:t}`hall21`. {fa}`quote-left`{ref}`Find out more here.` +```{attributiongrey} Attribution +:class: attribution +This page reuses adapted CC BY content from {cite:t}`hall21`. {fa}`quote-left`{ref}`Find out more here.` +``` 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 16ea6b8..118283a 100644 --- a/book/installation-and-setup/copyright/recommendations.md +++ b/book/installation-and-setup/copyright/recommendations.md @@ -52,20 +52,67 @@ Note that there are several types of pages and files that can be incorporated in (copyright_recc_content)= ### Content Pages -Make sure you show the source of your content where it is provided. We adopt a standard icon and link to help readers recognize this: {fa}`quote-left`{ref}`Find out more here.` +Make sure you show the source of your content where it is provided. We adopt a standard icon and link to help readers recognize this: {fa}`quote-left`{ref}`Find out more here.`. This can be used to provide attribution to authors for specific pages too #### How to implement this in your book -Copy the following line into your content file -```md -> This page reuses content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.` -``` - Some examples can be found in this manual: - [](../../external/deploy-book-workflow/README.md): a content page which is taken fully from another repository - Figure {ref}`fig_license_types`: a single licensed figure added to a page taken from another website - [](../copyright.md): a content page which adapts material from another website +##### Format as citation +Copy the following line into your content file + +```md +> Written by `` +> This page reuses content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.` +``` + +This produces + +> This page reuses CC BY content from {cite:t}`jason_moore`. {fa}`quote-left`{ref}`Find out more here.` + +##### Format as custom admonition +The previous syntax might be used for other purposes as well. An alternative is a custom attribution admonition: + +```{attributiongrey} Attribution +:class: attribution +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 content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.` +``` +```` + +`````md +````{margin} +```{attributiongrey} Attribution +:class: attribution +Written by +This page reuses content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.` +``` +```` +````` +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: ` + + (copyright_recc_credits)= ### Credits and License Page diff --git a/book/references.bib b/book/references.bib index 3b54aed..fd81c05 100644 --- a/book/references.bib +++ b/book/references.bib @@ -142,3 +142,19 @@ year = {2025}, note = {Retrieved February 2025. CC BY 3.0.} } + +@misc{sphinx-iframes, + author = {{TeachBooks}}, + title = {Sphinx iframes}, + url = {https://github.com/TeachBooks/sphinx-iframes}, + year = {2025}, + note = {Retrieved April 2025. MIT.} +} + +@misc{sphinx-prime-applets, + author = {{TeachBooks}}, + title = {Sphinx PRIME applets}, + url = {https://github.com/TeachBooks/Sphinx-PRIME-applets}, + year = {2025}, + note = {Retrieved April 2025. MIT.} +} \ No newline at end of file