admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update attributions

Browse source
This commit is contained in:
Tom van Woudenberg 2025-04-01 13:36:53 +02:00
parent f48ce67247
commit e41e6744dc
22 changed files with 101 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

2
book/_config.yml
View file

@ -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/

4
book/_static/attribution.css Normal file
View file

@ -0,0 +1,4 @@
/* Attribution */
div.attribution > .admonition-title::after {
content: "\f10d";
}

2
book/external/Download-Link-Replacer vendored

@ -1 +1 @@
Subproject commit f69e970a8da7d85e5473c7e5f58299a2ee3cf331
Subproject commit b658d1c6e1791097b225357025ebe7267d4dccb5

2
book/external/JupyterBook-Patches vendored

@ -1 +1 @@
Subproject commit aa93fc51bf95876f8034005ffcd777045ea9ddc6
Subproject commit 1a8e9960f0a37ce210df51198e0079430f1a2c6e

2
book/external/Nested-Books vendored

@ -1 +1 @@
Subproject commit 134fcc3384f0e01591881b59265a58b4eeee849b
Subproject commit dcdecc4a7335163ce0f5a8975bfd366a17d5fb94

2
book/external/Sphinx-Grasple-public vendored

@ -1 +1 @@
Subproject commit f4eff8d1565eaf127898f2fe216cf5208684fb27
Subproject commit e13743c7dd2d1de8a0dd7137da2841344ea0f330

2
book/external/Sphinx-Image-Inverter vendored

@ -1 +1 @@
Subproject commit 250103c723aa782bcec785ae3d241cb1ffebd3d0
Subproject commit 8365d4a366433bbbdfe7d7d0fbd617270c0e7130

2
book/external/Sphinx-Named-Colors vendored

@ -1 +1 @@
Subproject commit 191c2f4ac1755d3b50c6a63950eb6c2e5c035d75
Subproject commit 6c5a0f4aa9a11b0ba9d5a8f68929ba5773c3312a

2
book/external/Sphinx-PRIME-applets vendored

@ -1 +1 @@
Subproject commit 43ea44ccdc917234513fcd0ea1b9d5159a7dc81f
Subproject commit 29b5b48126fadde3839ef20a6256bdbda72d4ef9

2
book/external/Sphinx-TUDelft-theme vendored

@ -1 +1 @@
Subproject commit e4b71f810a66e302243377876f39e1dc4c4a8a6b
Subproject commit 5f26d318bf0696229041d20518900695d6ff935f

2
book/external/Sphinx-launch-buttons vendored

@ -1 +1 @@
Subproject commit ccec26fd77d3b6f1bb3415b5eb824b3155a397f1
Subproject commit 5acbe14ac0bfa4ab532b9b7c64e6462f16a7dbda

2
book/external/Useful_python_code vendored

@ -1 +1 @@
Subproject commit 7fbdbbf720c27112fb58bcf7826225197e39357b
Subproject commit 1fb335fb81ec9b88186161352f379e315a19d2f8

2
book/external/annotater vendored

@ -1 +1 @@
Subproject commit 9340b4e2856b6f2de331c31d2b74bd9dc286d276
Subproject commit 832cee034927c9a51efd328e6e1d5c9157b94e32

2
book/external/deploy-book-workflow vendored

@ -1 +1 @@
Subproject commit 26afa87f90a4191de0e07f89c6de674ea8b81b8d
Subproject commit 44156900a23360478983a0920340ff2298110b78

2
book/external/sphinx-iframes vendored

@ -1 +1 @@
Subproject commit 077ba23fa29ef1f0dd454f2ebf93c107923d1068
Subproject commit 0ebb0edea5f14144c6548e417f5b79c6d7721d77

2
book/external/teachbooks-sphinx-tippy vendored

@ -1 +1 @@
Subproject commit 338ad14d39115c620c57476931ce8fa177cf20d8
Subproject commit e37225de883df69e0933849dfc4880d41e7c75b0

2
book/external/template vendored

@ -1 +1 @@
Subproject commit 82b2de6a80b824482dd38f350a9aaf5f4a7a5fe0
Subproject commit 17b99b2de4edbcbf4d8a92fed52c3d335431699b

5
book/installation-and-setup/copyright.md
View file

@ -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.<external_resources>`
```{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.<external_resources>`
```
```{admonition} User types
:class: tip

5
book/installation-and-setup/copyright/considerations.md
View file

@ -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.<external_resources>`
```{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.<external_resources>`
```
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.

5
book/installation-and-setup/copyright/licenses.md
View file

@ -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.<external_resources>`
```{attributiongrey} Attribution
:class: attribution
This page reuses adapted CC BY content from {cite:t}`hall21`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
```
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).

59
book/installation-and-setup/copyright/recommendations.md
View file

@ -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.<external_resources>`
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.<external_resources>`. 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 <license> content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.<link to external resources section on credits and license page>`
```
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 `<author(s)>`
> This page reuses <license> content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.<link to external resources section on credits and license page>`
```
This produces
> This page reuses CC BY content from {cite:t}`jason_moore`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
##### 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.<external_resources>`
```
Therefore, use the following syntax:
`````md
```{attributiongrey} Attribution
:class: attribution
Written by <author(s)>
This page reuses <license> content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.<link to external resources section on credits and license page>`
```
`````
Or to place this attribution in the margin:
````{margin}
```{attributiongrey} Attribution
:class: attribution
Written by <author(s)>
This page reuses <license> content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.<link to external resources section on credits and license page>`
```
````
`````md
````{margin}
```{attributiongrey} Attribution
:class: attribution
Written by <author(s)>
This page reuses <license> content from {cite:t}`bib_id`. {fa}`quote-left`{ref}`Find out more here.<link to external resources section on credits and license page>`
```
````
`````
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

16
book/references.bib
View file

@ -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.}
}