From 0298d89976a8eae4de9a06919611c1257e208419 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Wed, 27 Nov 2024 10:01:56 +0100 Subject: [PATCH 01/26] new file --- book/features/custom-launch-button.md | 51 +++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 book/features/custom-launch-button.md diff --git a/book/features/custom-launch-button.md b/book/features/custom-launch-button.md new file mode 100644 index 0000000..0c51753 --- /dev/null +++ b/book/features/custom-launch-button.md @@ -0,0 +1,51 @@ +# Sphinx Extension: Custom Launch Button + +The custom launch button extension allows you to create a customizable button in the top right of your jupyter book. +This may have many applications, one of them being that you can create different language versions of the book available for the user. + +This section will explain how to create a "Languages" button, like you might be used to seeing on just about any website. The use of the button, however, is completey customizable and may be used in many different ways. + +## Installation + +1. Install the Sphinx Launch Buttons extension from the GitHub repository. + +`pip install git+https://github.com/TeachBooks/Sphinx-launch-buttons.git` + +2. To use the extension in your book, you need to include it in your `_config.yml` file. + +``` +sphinx: + extra_extensions: + - custom-launch-buttons +``` + +3. Then you need to include a `_launch_buttons.yml` file in the same location as your `_config.yml` file. + +``` +buttons: + - type : dropdown + + - type : button +``` + +Where `buttons` is an array of launch buttons, each can be identified using 2 types: 'dropdown' or 'button'. The cell above shows 2 buttons, one of type `dropdown` and one of type `button`. + +The button/dropdown can be visualised using either an [svg icon](https://icons.getbootstrap.com/#icons) or text. + +``` +buttons: + - type : dropdown + label: Language + - type : button + label : +``` + +## Setting up your repository + +For the implementation to your book, it is handy to create a branch for each language version you want to offer. Make a new branch using for example main as a source. Assuming we want to create a dutch version of you can call this branch `Dutch` or `Nederlands`. + +You will then need to translate the content in the dutch branch to dutch which can take some time. From experience, [DeepL](https://www.deepl.com/en/translator) is a good tool for this but any AI chatbot might be helpful as well. Make sure to proofread the translation. + + + +## \ No newline at end of file From bbb49400aaca1cac2f0e6489b075a24dbbdc3336 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Wed, 27 Nov 2024 10:07:20 +0100 Subject: [PATCH 02/26] also toc --- book/_toc.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/book/_toc.yml b/book/_toc.yml index 24db80b..78206df 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -50,6 +50,7 @@ parts: - file: external/Sphinx-TUDelft-theme/README.md - file: external/teachbooks-sphinx-tippy/README.md - file: features/interactive_element.ipynb + - file: features/custom-launch-button.md sections: - file: external/Sphinx-Grasple-public/README.md - file: features/h5p.md From 2fdebc2467f3d605c8cf469529d86f3ddc34df79 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Wed, 27 Nov 2024 10:19:22 +0100 Subject: [PATCH 03/26] toc update --- book/_toc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/_toc.yml b/book/_toc.yml index 78206df..ed15777 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -49,9 +49,9 @@ parts: - file: external/JupyterBook-Patches/README.md - file: external/Sphinx-TUDelft-theme/README.md - file: external/teachbooks-sphinx-tippy/README.md - - file: features/interactive_element.ipynb - file: features/custom-launch-button.md - sections: + - file: features/interactive_element.ipynb + sections: - file: external/Sphinx-Grasple-public/README.md - file: features/h5p.md - file: features/HTML_javascript.md From 3ce323b3fcf355aeb175260b0c9bfa2611be0cff Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Wed, 27 Nov 2024 10:24:28 +0100 Subject: [PATCH 04/26] toc update 2 --- book/_toc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/_toc.yml b/book/_toc.yml index ed15777..c0a9488 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -46,12 +46,12 @@ parts: - file: external/Nested-Books/README.md - file: external/Download-Link-Replacer/README.md - file: external/Sphinx-Image-Inverter/README.md + - file: features/custom-launch-button.md - file: external/JupyterBook-Patches/README.md - file: external/Sphinx-TUDelft-theme/README.md - file: external/teachbooks-sphinx-tippy/README.md - - file: features/custom-launch-button.md - file: features/interactive_element.ipynb - sections: + sections: - file: external/Sphinx-Grasple-public/README.md - file: features/h5p.md - file: features/HTML_javascript.md From b5fa74c7345c048ef4834691981f6fb847edbdfb Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Wed, 27 Nov 2024 10:35:27 +0100 Subject: [PATCH 05/26] svg icon? --- book/features/custom-launch-button.md | 29 +++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/book/features/custom-launch-button.md b/book/features/custom-launch-button.md index 0c51753..66e67e2 100644 --- a/book/features/custom-launch-button.md +++ b/book/features/custom-launch-button.md @@ -1,15 +1,19 @@ -# Sphinx Extension: Custom Launch Button +# Sphinx extension: Custom Launch Button The custom launch button extension allows you to create a customizable button in the top right of your jupyter book. This may have many applications, one of them being that you can create different language versions of the book available for the user. -This section will explain how to create a "Languages" button, like you might be used to seeing on just about any website. The use of the button, however, is completey customizable and may be used in many different ways. +This section will explain how to create a "Languages" or + + button, like you might be used to seeing on just about any website. The use of the button, however, is completey customizable and may be used in many different ways. ## Installation 1. Install the Sphinx Launch Buttons extension from the GitHub repository. -`pip install git+https://github.com/TeachBooks/Sphinx-launch-buttons.git` +``` +pip install git+https://github.com/TeachBooks/Sphinx-launch-buttons.git +``` 2. To use the extension in your book, you need to include it in your `_config.yml` file. @@ -19,7 +23,7 @@ sphinx: - custom-launch-buttons ``` -3. Then you need to include a `_launch_buttons.yml` file in the same location as your `_config.yml` file. +3. Then you need to include a `_launch_buttons.yml` file in the same location as your `_config.yml` file. The following code cell shows the main structure of that file. ``` buttons: @@ -28,7 +32,7 @@ buttons: - type : button ``` -Where `buttons` is an array of launch buttons, each can be identified using 2 types: 'dropdown' or 'button'. The cell above shows 2 buttons, one of type `dropdown` and one of type `button`. +Here, `buttons` is an array of launch buttons, each can be identified using 2 types: 'dropdown' or 'button'. The cell above shows 2 buttons, one of type `dropdown` and one of type `button`. The button/dropdown can be visualised using either an [svg icon](https://icons.getbootstrap.com/#icons) or text. @@ -48,4 +52,17 @@ You will then need to translate the content in the dutch branch to dutch which c -## \ No newline at end of file +## Example + +``` +buttons: + - type: dropdown + icon: + + + items: + - label: English + url: https://teachbooks.github.io/files-and-folders/EN + - label: Nederlands + url: https://teachbooks.github.io/files-and-folders/NL +``` \ No newline at end of file From 0dc1b8231364cfd76b963adec2bb1354ae09ab1b Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Wed, 27 Nov 2024 12:07:45 +0100 Subject: [PATCH 06/26] final update --- book/features/custom-launch-button.md | 39 +++++++++++++++++++--- book/features/figures/language_button.PNG | Bin 0 -> 7266 bytes 2 files changed, 34 insertions(+), 5 deletions(-) create mode 100644 book/features/figures/language_button.PNG diff --git a/book/features/custom-launch-button.md b/book/features/custom-launch-button.md index 66e67e2..cf94a08 100644 --- a/book/features/custom-launch-button.md +++ b/book/features/custom-launch-button.md @@ -3,9 +3,9 @@ The custom launch button extension allows you to create a customizable button in the top right of your jupyter book. This may have many applications, one of them being that you can create different language versions of the book available for the user. -This section will explain how to create a "Languages" or +This section will explain how to create a "Languages" or " - button, like you might be used to seeing on just about any website. The use of the button, however, is completey customizable and may be used in many different ways. + " button, like you might be used to seeing on just about any website. The use of the button, however, is completey customizable and may be used in many different ways. ## Installation @@ -41,7 +41,24 @@ buttons: - type : dropdown label: Language - type : button - label : + icon : ... + +``` +4. Lastly you need to specifiy the items of your button. So assuming you want to have different language versions, each item will be one of the languages. + +``` +buttons: + - type : dropdown + label: Language + + - type : button + icon : ... + + items: + - label: English + url: url of branch + - label: Nederlands + url: url of branch ``` ## Setting up your repository @@ -50,7 +67,7 @@ For the implementation to your book, it is handy to create a branch for each lan You will then need to translate the content in the dutch branch to dutch which can take some time. From experience, [DeepL](https://www.deepl.com/en/translator) is a good tool for this but any AI chatbot might be helpful as well. Make sure to proofread the translation. - +Make sure to add the updated `_config.yml` and the new `_launch_buttons.yml` in all of your branches. ## Example @@ -65,4 +82,16 @@ buttons: url: https://teachbooks.github.io/files-and-folders/EN - label: Nederlands url: https://teachbooks.github.io/files-and-folders/NL -``` \ No newline at end of file +``` + +The code in the above cell is the `_launch_buttons.yml` file of a repository called "files-and-folders". The buttons created look like this: + +```{figure} figures/language_button.PNG +--- +width: 70% +name:language_button +--- +Custom Button +``` + +As you can see in the `items:` line, each dropdown option links to the branch of the repository in the respective language. \ No newline at end of file diff --git a/book/features/figures/language_button.PNG b/book/features/figures/language_button.PNG new file mode 100644 index 0000000000000000000000000000000000000000..93304229a2180a05c7837d5b44a712aecb7379da GIT binary patch literal 7266 zcmcI}RX~(m*FPoQ$S`!5%+Ph{Zjka25;8OlAl)FTI5bL!bP5iQl*EA2NQZ?bV=<28v;nU!wp`j6}t10QDp`oV%&!2EHfN!n& z`WL_tx~IOX0$TM5-4-ywvX|GEM?*s<5ZqWj0>*eR)l59m(8#?WKIlt!jDBcnv={11 z@`ipEdpU7|hEqBH7jAPddG<})(^T^=Q|9F#MLU#TguRuR!4Z6Q3M^zXU(_Vke5%;` zl8+wI%u%YdmV-1j$ArOI913z4v0TYmYG0TV#lXiZ!q+*0A)X!^BQ_ofLu@(f9eEp4 zQl6u?KZJy&maj8B_ZQjjg;j8ww+Nvsxaw{W0t#vYiU=}=@3f||q{&NTu*k&IXb@{; zkyt&LnXNq^1xzLSZ%j4#n&!f}Jb$%OE7mA=5J*Wx@+n4VE{E_zqGM`0n(Ck?j+!r7 zNqh10p9mgtrC^f30>om=FmKIbu)GRaey&G5pbL48B7my=%x~EHQ|Z>Wm6<1YF+Idn z(}KRo*|c=K60UqV!y_T_RDIlQe8Si2KA-g3OZ*P5<))Y2~`l=5s1WHfe8+Bf;)BYtsH#r>&_Z+VEaPc49_~goY zTUlz+cxAhlsWFnh*S9#aIR8{joPJ*_xKBUm+$>>N6C7l>d4FD}y{!OWxLl~a?Y6?@u}Aiy-9=j*}cq$Y^Yz)=;zi5&R4ZyhM+0$^=-yQuf2qj+SZQM z)P>NnpEwKw^`)gVV5STQ?OC|5bTd|IC7slnRw+uyH)qOiVvz~AoIgxQGs9_*^QopX zhF5U#U0B=i)Fi03MvwoWnDYQ2Xz|1?LP~3 zHVkY)eZgsHMed-yYs@-={I_bK`2}4BlMs<`t_E@qt7_+M)^+P$?>b}=3ZMYaFYIrz zhh5AspX*z}Zu_19y#2cLlhA6~Tc!lzHYwj<>Uf0|6Y#$|l?Vf|rmR`i63RR=+rKIMCh;lA#MVl$Y1+MK^nCqP*JWpX%#PuFa-ZantC6}>u zbDbL@IA(ZE(lm>4QL&DhrydnkvfiV|SIy~)tQpC!i=}Q*_r{`hbDIzWYXrC`B9hc+ zTPi^u;Vl{iH+=W!A|gEl{*!V26;_ThC1Q*g;I{L7t??7Tw(6nK-y&i!P9i#0Ojg8g zUpmYNL96!sI3;A4F1Atz-!g`H*p6o|ry8|IMB~gVar)$=*xS2bu29@U`dvvwYn6c+t&}C_0&UVGPCw%A*sosFyUJ{V}wK0dWTXmb|18ax4&*H^ENiQc1Estm$+V2YJ zE`2Tg3~-UpaKJ^37d@`|_C2BRh?GA1%bprOyUm5u0)+MkK63Rq88-I!?YG>oE(q4y zvhwmzt;8_cDM-0xyCGWRVcq@j}Zi3(0T*rb{G zJy_`b8MI^VyX$dd9s-8|gyATHowMqU3jPnv9{<>>=?;bLE(V;$_4Ds)OPkTOxUsj# zIoq-Wjq<D5sXLCvf=e1l&# ziL@OsVeYtZrDtGF$27)1_J_^|lQKSvI~ubipSRxUzKk}$-@#+D72 zBxE5?Zn7d>bMejaTm31AEssXVK1rdJVq?v!{jL*IF$Lc3>WJzoi_$*E_7U5yYdiYN zQM_8k6RJt|f^^Fp1K94PZ(Tj4q-Goo*4AQozkE)bQklNPe3y1I1D#9Yv2h>IulT=~ zLSvSebkXoo}3V9)$bH|muadtZ%3(2tuX)~v}4{u*}o z=2MAC0C8Ue*xe^~0U0<1zh04p zbKI?|;)~ELE;ODfW@CQpNtN9VvQ;eJ6+Kd_&x=tXP}=p)`lxC6qyDRm(-jsGNx>5> zF+y8HYFX}M3bo8sKGU)1;aospl8~|psE!z)SwCaCeu8=en5fNDe zwF5F#Xmm=p8PC@5CflBf*ldSKua#U?lbNTKwC;&5{#nhVlZ`efQvtl%!}1L%YZh&; z?S1~}Gj;~0Cxp^h40?pcPu4i5AlL!dyjADzC6-e~L@043;&_6GEV{WVHh01hmN5PP z5_#Eu|8B*7qW`#5UUb-IK&%Qt3oB=fe*~UW-gKZhMoSgBs z#dBk-W-9dbh&?d#;sGaQJ5TQ9m|mF=!2HIRLs#vaegytVa8r>VDRh0j>|aya+S(6h z0+G`%DDh6%yvD0TC71DkcpX=`#aJ^g?Ih$n1Ts)i4a~P$qw0^>jKcG(27Ed#zZ|o) z8-^wXf!r8XLuYDq#k^of;RgKL9uN*IHX#~u&6X|6lu_1;h5Q_74{cLfCS0ZX?uh+uMTKu8>A#ZQWX!am+AK4Y zyMv4^r?HdJxBB_CbsK71LI2l0FXfi{4Jf5KBhfF}kgPTsbkDVtZ9ia?-g z03=b$1}Sz&M@Ksd2vTw(l$R!IJh+r2BhwdQPbB2H3Cm(;S5{txhRQ-!l8F_f9GG7? zNtEc9La~eDNiq9D6NBoJRW&sUAXaspe1-aY)Tx(NxEdnq<^MFXFnVTk~#v?IUvdjZh$QTvb8?3X{{%4G{dq}y<=OSIY?u#x8X(iU>my$q8{4*dfp)MPD*9>WDWaIJ9_+4!Z(8N2sA!#2 zzPATX{PFFJAXOa!R5b2^IJbkq##?s`XzJC&s6JiV0qF=pe!LndBIcFKHOb#;zlTUH z1P6!CQV$63ozq#(y(v*nZhb*DO^xj$ev{3wAfP&pJ-BsCe~QRcdJDr(h2~c%7^^uE z?PANN(?P{{A^MzlG9FZgPCy&9<20X$Bhq|K(AX<+;$pnZZfTP5to=+|(c0W)s;;Gs zZ{EuczfVPyCvDXPpWum8_{^jaoY(kW9_71uX+%y9^ks_>fv6!)P5+cps-Mt|Sf%s; zY)R0~!7a|seax%Uhw~(pUhhGZ2^jK3pgZj98Lw}2X`^bR z`u7K8m!M!8==q?v5xgE)>H$}RlQy^yuWo48So2cBS4F+>sJYUkT+&)OPML@PSy$n% zF}%5hkZ;s{N(K&(wrYFimI9|HoUHP;hx}kT_fQl356#lXjSPtBoEh9q00hAhFk6BIBLh*7ZYe zKOPlH#jcaZ{lNsupg|w1T`4~EwJ})TqX$5F1pV7=#ofMnzzO3!bvP&s`mi2= zi_o6(J=ZizYnR~Weh1_nP$xgECfM%FO3FEKp-H5dFUVd98+C3QBoG?U%gJk4w7hL; z34z0lDys{`Rd34=FD=|$0-cLc7^;<;Z6+t-A{i|f2l0g*-cPK&eMDTo5)c;<*PB+A zqWp-)ss$7rQ~aS2RF8RF@wWHpW6$a7`sn)>59%&Is=sn8+S}t&eV@1)$f7zz<^&Y; z9|H6nOrGq^ZZ?S$d2RXLPZ{gDL;0rtpISoOc-T>+-YCFn@sQ6g< zBX&`^?*|WKqaIO;cyrAnTVCje{LSm61tJi>_V_{FvUE%j&PUE4glW`@ZZi|&_`f{~ zIx}Be!fTo>-}9eyox%4f>OlG3Ms)<6mZ-SLEK4sNROG^f^>oWS`mDGUeUnU9YO0jw zgKc9tg_=mE*AD7`Yr{WJ8%}|r>g{uTJl)eeWF&d;U?@n^(ttGELGAf7Mj2~C0at;s zBVMeehC8{O4Kyxv2Q@2u;(hoT5ocGgrSv z#Y@AZbBhLBskLq~lK2YkC={$A%O{J&GVIFUT}{0ZUO{HIG;nlahT}B-QzSCC+mEX2 zz()J&ctfH1A4bZ6(!d$od(M*Z)x+||p@;O84npi5IY;HAn#&&B3An$_osTqu`}vxv z_>4!3Hn4-wwhu?NAMM9diVQf=6f)T$yRM$4ufbi#L>0i>r+a#|eM0d(>SV40Jm&BD zxAcQc)!vZ>_$cV-YF8BC-3wh7zmDzC99OB?%4u}%I{i2{Biv(@WcLuTj>vT6?srg~ zBo$`i9_^y>QTd#1Ix4n&`cHa^Xvo=s6W3o)Y>=@{@GB_MCa^YToH39)OnhN6vmSVF?zjo4)R_<~`TlcT*pD7ih_!oh> z0QZz^MvfUvMF)G@R}EJ2Xiz|Z6GU7%Z6Y?`P7fRBL_wyXKPPqRu!9LA;zX~_R%g~H zHKrR;1)T)e<+QE>R?U?@luI*z{`^Cfg$N=lI**bcOTL*R~H?9i{ zT4j3vKcwj)(L(;q(JR9^t3r?0as`7E6s*nn&W{_G!d;kc%bwetD=%#a?0zgi-x$8Q z($M137_*ujIw{Lsi6f@8_0LTw#@~T2{}Po(rKXu7-V$UFq5Ar;&#U{jJa0mhjwz$6 z1w#)JBV&>-T!W)WW$k?i&5M5_*As-$AMi*TQZjme=sm4w)UzIr>f%{;$Y@dCPu>e0 z9q3@PryZ15?i()fcnY8O7Km8oHD4P^H`+AauaWw2kexmW>ncrLF!>!lHS+a<%i5HX zkZx|(7st)U(|(BWNtwfLx5Ct^j^y_3zH5nfW}&n24J{gsLJlY_2HWdn4+R0u8E~3mX!@y7in8E*D}s(JkJxAo~*Ng&qMUTb7h z5}7Shj_GB=+T{2&g}#PbHU23wnj$vr2`OQqtokn&vL=~3+{`l=TGpJs#EbRPD^8>p<`e1l>edXciS z3kHd@SUBm$j1B=O^GyDKa8afoT1!dtvOK^*fAoTsHWG(S;eoscl#@(Inhf*FYv2v@ z&-!$K2@o#U)%A5?KtO!nrX1;!d%&iUsAwxum^_@6K?zr0->8=*Ek*9Pu7bK6E)EED z048Um^|U`xDk$>&?9AKOH&4=ce|N6VGW7P0I)Yb$MR!h4jg%4#8!7Kc%8d0*ifqjz zdA19QdiNDFApjK&N@a=v(9}f5_|Y!WP;fAbD^gC)(3F(6t{bM+`zkUyk+czl%_d*6 zl}=7ABQ(s?>UUJ&kugmzXN)(l1|jrE2Pg~h5axf!$20`TXiI?%SSB9m)(yTJ5q?q= zsm4TTs8iqhN*~M#BvrsxY^r1|h;6}Qp|}AaW^!E2_Z07`>pIaWRdy*7P_N#mk!N^N zAD5b!c$et;vnyecDHJPT5^#lvsYRjVu`sWSe*z~8Q{UJnF3XrFfIi`W->!|s#@)(BEWZI A>Hq)$ literal 0 HcmV?d00001 From 81e8b8d66c1cd8b5e9f5636f816fbf80eae0d1cf Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Wed, 27 Nov 2024 12:16:42 +0100 Subject: [PATCH 07/26] tweaks --- book/features/custom-launch-button.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/book/features/custom-launch-button.md b/book/features/custom-launch-button.md index cf94a08..9d13dc8 100644 --- a/book/features/custom-launch-button.md +++ b/book/features/custom-launch-button.md @@ -9,7 +9,7 @@ This section will explain how to create a "Languages" or " Jupyter book package. However, this page includes also best-practices. +These pages will provide a list of some common, basic book features which are all available in the original Jupyter book package. Additionally, this page includes also best-practices. diff --git a/book/features/easy-editing.md b/book/features/easy-editing.md new file mode 100644 index 0000000..e69de29 diff --git a/book/features/overview.md b/book/features/overview.md index a9a4bc4..bfdc043 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -1,12 +1,15 @@ -# TeachBooks Authoring Features +# Easy editing process As TeachBooks, we collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is essential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching! -This chapter provides a list of commonly used book features together with sub-pages that provide additional information on: -- the purpose -- how to install them -- how to use them -- where to find the source code +Since the list of TeachBook features is getting quite long, we have grouped them in categories: +- Easy Editing Process +- Additional Book Functionalities +- Book Visuals + +Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features. + +Finally, the purpose, installation process and usage of each features is elaborated on in the respective sub-sections. To see examples for these features, go to the [Examples chapter](../examples/overview.md). diff --git a/book/visuals.md b/book/visuals.md new file mode 100644 index 0000000..ac3e6da --- /dev/null +++ b/book/visuals.md @@ -0,0 +1 @@ +# hi \ No newline at end of file From cf45708f9599dd255fa3447ea8a3ac8007a090d3 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Thu, 28 Nov 2024 22:58:16 +0100 Subject: [PATCH 14/26] tags --- book/external/JupyterBook-Patches | 2 +- book/external/Sphinx-Grasple-public | 2 +- book/external/Sphinx-Image-Inverter | 2 +- book/external/Sphinx-TUDelft-theme | 2 +- book/external/teachbooks-sphinx-tippy | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/book/external/JupyterBook-Patches b/book/external/JupyterBook-Patches index 8d97cb2..2eabe4a 160000 --- a/book/external/JupyterBook-Patches +++ b/book/external/JupyterBook-Patches @@ -1 +1 @@ -Subproject commit 8d97cb21d7d5f67cc19d35768c5e257d36cc0e69 +Subproject commit 2eabe4ab901626d164dbaad36e2f348a59993ad5 diff --git a/book/external/Sphinx-Grasple-public b/book/external/Sphinx-Grasple-public index b809233..be60255 160000 --- a/book/external/Sphinx-Grasple-public +++ b/book/external/Sphinx-Grasple-public @@ -1 +1 @@ -Subproject commit b8092330480b6b4694e91f100af4824becd77db2 +Subproject commit be602551986dfb6d0764be7908f8306709c00845 diff --git a/book/external/Sphinx-Image-Inverter b/book/external/Sphinx-Image-Inverter index 95fccf0..8693992 160000 --- a/book/external/Sphinx-Image-Inverter +++ b/book/external/Sphinx-Image-Inverter @@ -1 +1 @@ -Subproject commit 95fccf09f2c9d42ae473b3ed6033ebcb948792b1 +Subproject commit 8693992718956fea78e96af81eb27a2815a737bc diff --git a/book/external/Sphinx-TUDelft-theme b/book/external/Sphinx-TUDelft-theme index 9356dac..bb57b6e 160000 --- a/book/external/Sphinx-TUDelft-theme +++ b/book/external/Sphinx-TUDelft-theme @@ -1 +1 @@ -Subproject commit 9356dac16e04935cfa92924856f652d5653e8793 +Subproject commit bb57b6ebefa51e2705f75d72e5c93c2dfa9364c7 diff --git a/book/external/teachbooks-sphinx-tippy b/book/external/teachbooks-sphinx-tippy index 304a1dc..2a06428 160000 --- a/book/external/teachbooks-sphinx-tippy +++ b/book/external/teachbooks-sphinx-tippy @@ -1 +1 @@ -Subproject commit 304a1dcd6bdf6ce3501eb46d55fcc9216db0d334 +Subproject commit 2a06428e894f41fd29f6c2184c504aa90d20ff03 From 4e7f9957e1e130a7ddc5d8f0a0ca8f634786cc51 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Thu, 28 Nov 2024 23:14:32 +0100 Subject: [PATCH 15/26] updates --- book/_toc.yml | 1 + book/basic-features/external-features.md | 2 +- book/basic-features/overview.md | 2 +- book/features/custom-launch-button.md | 3 ++- book/features/easy-editing.md | 1 + book/features/overview.md | 2 +- 6 files changed, 7 insertions(+), 4 deletions(-) diff --git a/book/_toc.yml b/book/_toc.yml index 7af7fd9..fdacd59 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -42,6 +42,7 @@ parts: - file: basic-features/hypothesis.md - file: basic-features/utterances.md - file: features/overview.md + - file: features/easy-editing.md sections: - file: external/TeachBooks/README.md - file: external/deploy-book-workflow/README.md diff --git a/book/basic-features/external-features.md b/book/basic-features/external-features.md index f3e5fc2..39d9505 100644 --- a/book/basic-features/external-features.md +++ b/book/basic-features/external-features.md @@ -1 +1 @@ -# Externally developed features \ No newline at end of file +# Externally Developed Features \ No newline at end of file diff --git a/book/basic-features/overview.md b/book/basic-features/overview.md index f412e2a..1b55b30 100644 --- a/book/basic-features/overview.md +++ b/book/basic-features/overview.md @@ -1,4 +1,4 @@ -# Jupyter Book/Sphinx Features +# Original Jupyter Book (Sphinx) Features ```{admonition} User types :class: tip diff --git a/book/features/custom-launch-button.md b/book/features/custom-launch-button.md index dcee6ce..4acbf99 100644 --- a/book/features/custom-launch-button.md +++ b/book/features/custom-launch-button.md @@ -1,9 +1,10 @@ -# Sphinx extension: Custom Launch Button +# Custom Launch Button ```{admonition} User types :class: tip This page is useful for user type 4 and 5. ``` +{bdg-primary}`Sphinx Extension` The custom launch button extension allows you to create a customizable button in the top right of your jupyter book. This may have many applications, one of them being that you can create different language versions of the book available for the user. diff --git a/book/features/easy-editing.md b/book/features/easy-editing.md index e69de29..bb07d7d 100644 --- a/book/features/easy-editing.md +++ b/book/features/easy-editing.md @@ -0,0 +1 @@ +# Easy Editing Process \ No newline at end of file diff --git a/book/features/overview.md b/book/features/overview.md index bfdc043..170ef6f 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -1,4 +1,4 @@ -# Easy editing process +# TeachBooks As TeachBooks, we collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is essential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching! From fb0c2c6278db84e6cb65dcbeae611aa664f139d3 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Thu, 28 Nov 2024 23:17:18 +0100 Subject: [PATCH 16/26] check --- book/external/TeachBooks | 2 +- book/external/annotater | 2 +- book/external/deploy-book-workflow | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/book/external/TeachBooks b/book/external/TeachBooks index 1beb447..209dc7c 160000 --- a/book/external/TeachBooks +++ b/book/external/TeachBooks @@ -1 +1 @@ -Subproject commit 1beb4478a5f7df378d99f19e651f41d85fd7961c +Subproject commit 209dc7ceae034edd8ab43c0377e77466fdf15f1c diff --git a/book/external/annotater b/book/external/annotater index 22d2efa..df36ccf 160000 --- a/book/external/annotater +++ b/book/external/annotater @@ -1 +1 @@ -Subproject commit 22d2efac5bf175f8173b9accae21e7270c977b03 +Subproject commit df36ccffd4a980d97e90f667c5d5e6bdd941fdbd diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index 7f60d58..f7e24bb 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit 7f60d58a63b69192e998781d0dee43d1ccb0b2fe +Subproject commit f7e24bb274a0ba7046505ddffc3733ad1e28b6b6 From af207d4ead7b2ad044f13b0aebb0b2de30f9b4f3 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Thu, 28 Nov 2024 23:25:17 +0100 Subject: [PATCH 17/26] change1 --- book/external/Nested-Books | 2 +- book/external/deploy-book-workflow | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/book/external/Nested-Books b/book/external/Nested-Books index 15f59b1..ced5cde 160000 --- a/book/external/Nested-Books +++ b/book/external/Nested-Books @@ -1 +1 @@ -Subproject commit 15f59b176f793e457df3f44842f3d2b1631c3a9e +Subproject commit ced5cdefa1b1b6c4fdba3fc42a94e812db4892f0 diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index f7e24bb..b6476a0 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit f7e24bb274a0ba7046505ddffc3733ad1e28b6b6 +Subproject commit b6476a0997331d16b000715881f0044e6c68e297 From 7c0cde0fff5d7c53367de8217629fc4acc388f10 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 10:25:32 +0100 Subject: [PATCH 18/26] Added more badges --- book/basic-features/hypothesis.md | 2 ++ book/basic-features/utterances.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/book/basic-features/hypothesis.md b/book/basic-features/hypothesis.md index a22302c..3ab0050 100644 --- a/book/basic-features/hypothesis.md +++ b/book/basic-features/hypothesis.md @@ -1,5 +1,7 @@ # Making comments on the website: Hypothesis +{bdg-success}`Javascript overlay` {bdg-success}`Chrome Extension` + Hypothesis is a third-party application that allows anyone to make publicly visible comments on a website (once you create a free account). This section explains how to use and install the extension. As this tool requires an account with a third-party, we advise to use our [local-annotator](../external/annotater/README.md) with similar capabilities but which store annotations locally. By default Hypothesis stores annotations publicly, which might confuse other students. ```{admonition} Be careful of changing website URL's! diff --git a/book/basic-features/utterances.md b/book/basic-features/utterances.md index 6ce641b..7f0f7f5 100644 --- a/book/basic-features/utterances.md +++ b/book/basic-features/utterances.md @@ -1,5 +1,7 @@ # Discussions in your book: Utterances +{bdg-success}`Javascript script` + [Utterances 🔮](https://utteranc.es/) is a lightweight open-source widget which allows you, your colleages and your students to discuss stuff in a blog post in your book. It is build on GitHub issues, so requires a GitHub repository, although the book can be hosted anywhere (so also on GitLab). The [utterances website](https://utteranc.es/) clearly explains the required steps. One thing to take care of is how you want to do the issue-mapping with respect to multiple deployed versions (draft version, student version, archived versions): From 6e29254c48604c12b9eba9674ec7e5032364f029 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 10:25:55 +0100 Subject: [PATCH 19/26] clarified --- book/basic-features/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/basic-features/overview.md b/book/basic-features/overview.md index 1b55b30..df68f69 100644 --- a/book/basic-features/overview.md +++ b/book/basic-features/overview.md @@ -1,4 +1,4 @@ -# Original Jupyter Book (Sphinx) Features +# Original Jupyter Book and Sphinx Features ```{admonition} User types :class: tip From 5d095953f066467bf5f30207ba90db0c954a436d Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 10:26:48 +0100 Subject: [PATCH 20/26] Overview tool page --- book/_toc.yml | 2 +- book/features/overview.md | 5 +---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/book/_toc.yml b/book/_toc.yml index fdacd59..257e1e3 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -26,6 +26,7 @@ parts: - file: installation-and-setup/creating_content.md - caption: Features chapters: + - file: features/overview.md - file: basic-features/overview.md sections: - file: basic-features/jupyterbook.md @@ -41,7 +42,6 @@ parts: sections: - file: basic-features/hypothesis.md - file: basic-features/utterances.md - - file: features/overview.md - file: features/easy-editing.md sections: - file: external/TeachBooks/README.md diff --git a/book/features/overview.md b/book/features/overview.md index 170ef6f..bde9e86 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -1,11 +1,8 @@ -# TeachBooks +# Overview As TeachBooks, we collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is essential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching! Since the list of TeachBook features is getting quite long, we have grouped them in categories: -- Easy Editing Process -- Additional Book Functionalities -- Book Visuals Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features. From 055663cb4e4d48aa2e9a0bbc95b367037d135e85 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 10:46:04 +0100 Subject: [PATCH 21/26] extended badges --- book/basic-features/hypothesis.md | 2 +- book/basic-features/utterances.md | 2 +- book/external/TeachBooks | 2 +- book/features/HTML_javascript.md | 2 ++ book/features/adding_HTML_elements.md | 2 ++ book/features/h5p.md | 2 ++ book/features/live_code.ipynb | 2 ++ book/features/overview.md | 13 ++++++++++--- 8 files changed, 21 insertions(+), 6 deletions(-) diff --git a/book/basic-features/hypothesis.md b/book/basic-features/hypothesis.md index 3ab0050..1d490ce 100644 --- a/book/basic-features/hypothesis.md +++ b/book/basic-features/hypothesis.md @@ -1,6 +1,6 @@ # Making comments on the website: Hypothesis -{bdg-success}`Javascript overlay` {bdg-success}`Chrome Extension` +{bdg-warning}`Javascript overlay` {bdg-success}`Chrome Extension` Hypothesis is a third-party application that allows anyone to make publicly visible comments on a website (once you create a free account). This section explains how to use and install the extension. As this tool requires an account with a third-party, we advise to use our [local-annotator](../external/annotater/README.md) with similar capabilities but which store annotations locally. By default Hypothesis stores annotations publicly, which might confuse other students. diff --git a/book/basic-features/utterances.md b/book/basic-features/utterances.md index 7f0f7f5..9ec87f1 100644 --- a/book/basic-features/utterances.md +++ b/book/basic-features/utterances.md @@ -1,6 +1,6 @@ # Discussions in your book: Utterances -{bdg-success}`Javascript script` +{bdg-muted}`Javascript script` [Utterances 🔮](https://utteranc.es/) is a lightweight open-source widget which allows you, your colleages and your students to discuss stuff in a blog post in your book. It is build on GitHub issues, so requires a GitHub repository, although the book can be hosted anywhere (so also on GitLab). diff --git a/book/external/TeachBooks b/book/external/TeachBooks index 209dc7c..4a2e754 160000 --- a/book/external/TeachBooks +++ b/book/external/TeachBooks @@ -1 +1 @@ -Subproject commit 209dc7ceae034edd8ab43c0377e77466fdf15f1c +Subproject commit 4a2e75494b213c9a03615087bab2788f6188da2f diff --git a/book/features/HTML_javascript.md b/book/features/HTML_javascript.md index 491ce51..4192375 100644 --- a/book/features/HTML_javascript.md +++ b/book/features/HTML_javascript.md @@ -5,6 +5,8 @@ This section is useful for user type 5. ``` +{bdg-info}`iframe` + In this section, we will discuss how to [create](creating_basic_HTML_elements.md) and [embed](adding_HTML_elements.md) interactive HTML/Javascript elements created in HTML/JavaScript in a TeachBook. These HTML/Javascript element work very fluently and don't require a python kernel running in the background. This could be for example interactive 3d figures: diff --git a/book/features/adding_HTML_elements.md b/book/features/adding_HTML_elements.md index 41f3a9c..deab9f0 100644 --- a/book/features/adding_HTML_elements.md +++ b/book/features/adding_HTML_elements.md @@ -1,5 +1,7 @@ # Adding interactive HTML/JavaScript elements +{bdg-info}`iframe` + In this section, we will discuss how to embed interactive elements created in HTML/JavaScript in a TeachBook. If you are interested in learning how to create these elements yourself, we will discuss an example in the [next article](creating_basic_HTML_elements.md). As an example, let us discuss how to embed an interactive 3D model of a subsurface environment I created: diff --git a/book/features/h5p.md b/book/features/h5p.md index 853b822..015b2ad 100644 --- a/book/features/h5p.md +++ b/book/features/h5p.md @@ -5,6 +5,8 @@ This section is useful for user type 3-5. ``` +{bdg-info}`iframe` + ## Instruction H5p elements are interactive HTML-blocks which can be embedded in a Jupyter Book using an iframe. An H5p element can be created in the [TU Delft portal on the H5p website](https://tudelft.h5p.com/content) (sign in via Brightspace to H5p required first). The iframe code can be copied at Edit - Publish - Public - Embed code. This html code can be directly added to your markdown file: diff --git a/book/features/live_code.ipynb b/book/features/live_code.ipynb index d553b43..a923219 100644 --- a/book/features/live_code.ipynb +++ b/book/features/live_code.ipynb @@ -11,6 +11,8 @@ "This section is useful for user type 5.\n", "```\n", "\n", + "{bdg-primary}`Sphinx Extension`\n", + "\n", "Our book has been enable to run Python code live in the browser (thanks Max!). This extension makes code cells in your `.ipynb` book pages editable and executable by the reader! Opposed to the original sphinx-thebe extensions, our extension runs python in the reader's browser and doesn't rely on an external webserver for the python kernel. We highly recommend this extension as it allows you to use the strength of combining text/figures and code of a jupyter book with interactivity!\n", "\n", "This page contains some installation instructions and the other sections show how to use this functionality to create interactive figures and feedback on code\n", diff --git a/book/features/overview.md b/book/features/overview.md index bde9e86..de7ea78 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -4,9 +4,16 @@ As TeachBooks, we collect a suite of existing open-source software and keep our Since the list of TeachBook features is getting quite long, we have grouped them in categories: -Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features. +Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features: +- {bdg-warning}`Javascript overlay` +- {bdg-success}`Chrome Extension` +- {bdg-muted}`GitHub App and Javascript script` +- {bdg-secondary}`Python Package` +- {bdg-light}`GitHub Reusable Action` +- {bdg-dark}`Git Workflow` +- {bdg-primary}`Sphinx Extension` +- {bdg-info}`iframe` Finally, the purpose, installation process and usage of each features is elaborated on in the respective sub-sections. -To see examples for these features, go to the [Examples chapter](../examples/overview.md). - +To see examples for these features, go to the [Examples chapter](../examples/overview.md). \ No newline at end of file From edb7789d153c932ff437e2a871061da6415dae97 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 10:57:43 +0100 Subject: [PATCH 22/26] Added user types everywhere --- book/basic-features/external-features.md | 9 ++++++++- book/features/easy-editing.md | 9 ++++++++- book/features/interactive_element.ipynb | 2 +- book/features/sphinx_extensions.md | 5 +++++ book/features/students.md | 7 ++++++- 5 files changed, 28 insertions(+), 4 deletions(-) diff --git a/book/basic-features/external-features.md b/book/basic-features/external-features.md index 39d9505..d574b30 100644 --- a/book/basic-features/external-features.md +++ b/book/basic-features/external-features.md @@ -1 +1,8 @@ -# Externally Developed Features \ No newline at end of file +# Externally Developed Features + +```{admonition} User types +:class: tip +This section is useful for user type 1-5. +``` + +This chapter includes features useful for books in the educational context, developed by various parties. \ No newline at end of file diff --git a/book/features/easy-editing.md b/book/features/easy-editing.md index bb07d7d..418f55b 100644 --- a/book/features/easy-editing.md +++ b/book/features/easy-editing.md @@ -1 +1,8 @@ -# Easy Editing Process \ No newline at end of file +# Easy Editing Process + +```{admonition} User types +:class: tip +This section is useful for user type 3-5. +``` + +The following tools are created by TeachBooks to ease the process of making books. We acknowledge that making books is a difficult process; it requires advanced knowledge on CLI, python packages, html-files, data-storage and website hosting. The tools in this chapter are intended for those users who lack knowledge on these topics (which includes most of the TeachBooks' community members itself). \ No newline at end of file diff --git a/book/features/interactive_element.ipynb b/book/features/interactive_element.ipynb index 75bd000..f5fecce 100644 --- a/book/features/interactive_element.ipynb +++ b/book/features/interactive_element.ipynb @@ -9,7 +9,7 @@ "source": [ "# Interactive content: Elements not including Python\n", "\n", - "To add interactivity to the book, you can make use of interactive elements which are embedded in the book. You've four options:\n", + "To add interactivity to the book, you can make use of interactive elements which are embedded in the book. You've a few options:\n", "\n", " - Admonition: question provided in normal markdown language with answers in a drowdown menu. There's no feedback delivered to the student, only the correct answer no matter what the student's thinking/work.\n", " - JupyterQuiz: code-based implementation of multiple-choiche questions and numerical answer questions. This is a basic open course tool which requires you to write your quiz questions in Python language as a `dict` or to a `.json` file.\n", diff --git a/book/features/sphinx_extensions.md b/book/features/sphinx_extensions.md index 59eae0d..b30128a 100644 --- a/book/features/sphinx_extensions.md +++ b/book/features/sphinx_extensions.md @@ -1,5 +1,10 @@ # Sphinx Extensions +```{admonition} User types +:class: tip +This section is useful for user type 4-5. +``` + Sphinx extensions are plugins developed for the Sphinx documentation ecosystem (which Jupyter Book is built upon). They extend or modify Sphinx’s capabilities and can be added to Jupyter Book for extra functionality. Since Sphinx extensions are not an integral part of jupyter-book, as opposed to original jupyter-book features, they must be installed and configured explicitly, for example in the `_config.yml` file. At TeachBooks, we have many TA's working on developing cool and handy extensions to use in our books. Here's an overview: diff --git a/book/features/students.md b/book/features/students.md index a9a1abf..46a6993 100644 --- a/book/features/students.md +++ b/book/features/students.md @@ -1,3 +1,8 @@ # TeachBooks Student-view Features -This chapter includes some TeachBooks features which aim to improve the way students can use TeachBooks. These tools are fully student-side, they don't influence the book website and the author doesn't have to setup anything. Nevertheless, the author could point the students to the availability of these tools and use it as part of the didactical approach. +```{admonition} User types +:class: tip +This section is useful for user type 1-5. +``` + +This chapter includes some TeachBooks features which aim to improve the way students can use TeachBooks. These tools are fully student-side, they don't influence the book website and the author doesn't have to setup anything. Nevertheless, the author could point the students to the availability of these tools and use it as part of the didactical approach. These tools could also be useful for other users. From 1f0b0f47eef31727a038ed346634de185069e73b Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 11:15:59 +0100 Subject: [PATCH 23/26] Various updates --- book/external/JupyterBook-Patches | 2 +- book/external/Sphinx-Grasple-public | 2 +- book/external/Sphinx-Image-Inverter | 2 +- book/external/Sphinx-TUDelft-theme | 2 +- book/external/TeachBooks | 2 +- book/external/annotater | 2 +- book/external/deploy-book-workflow | 2 +- book/external/teachbooks-sphinx-tippy | 2 +- book/features/sphinx_extensions.md | 18 ++---------------- book/features/visuals.md | 8 ++++++++ book/visuals.md | 1 - 11 files changed, 18 insertions(+), 25 deletions(-) create mode 100644 book/features/visuals.md delete mode 100644 book/visuals.md diff --git a/book/external/JupyterBook-Patches b/book/external/JupyterBook-Patches index 2eabe4a..5c129f2 160000 --- a/book/external/JupyterBook-Patches +++ b/book/external/JupyterBook-Patches @@ -1 +1 @@ -Subproject commit 2eabe4ab901626d164dbaad36e2f348a59993ad5 +Subproject commit 5c129f2447bb4b30100c136d94b5bee9e51e2921 diff --git a/book/external/Sphinx-Grasple-public b/book/external/Sphinx-Grasple-public index be60255..c29b4a0 160000 --- a/book/external/Sphinx-Grasple-public +++ b/book/external/Sphinx-Grasple-public @@ -1 +1 @@ -Subproject commit be602551986dfb6d0764be7908f8306709c00845 +Subproject commit c29b4a03351c88fa5cdd09475f99a1b486a0e247 diff --git a/book/external/Sphinx-Image-Inverter b/book/external/Sphinx-Image-Inverter index 8693992..c9c9d2f 160000 --- a/book/external/Sphinx-Image-Inverter +++ b/book/external/Sphinx-Image-Inverter @@ -1 +1 @@ -Subproject commit 8693992718956fea78e96af81eb27a2815a737bc +Subproject commit c9c9d2f6953b5a57ff4763976840ec3bb281dbcf diff --git a/book/external/Sphinx-TUDelft-theme b/book/external/Sphinx-TUDelft-theme index bb57b6e..0f47585 160000 --- a/book/external/Sphinx-TUDelft-theme +++ b/book/external/Sphinx-TUDelft-theme @@ -1 +1 @@ -Subproject commit bb57b6ebefa51e2705f75d72e5c93c2dfa9364c7 +Subproject commit 0f4758586bebb1db4da0738b66d02d883ff7b54d diff --git a/book/external/TeachBooks b/book/external/TeachBooks index 4a2e754..eb5f90c 160000 --- a/book/external/TeachBooks +++ b/book/external/TeachBooks @@ -1 +1 @@ -Subproject commit 4a2e75494b213c9a03615087bab2788f6188da2f +Subproject commit eb5f90c86e6f9dd368c513b2d958f77fb941cae0 diff --git a/book/external/annotater b/book/external/annotater index df36ccf..7cd38db 160000 --- a/book/external/annotater +++ b/book/external/annotater @@ -1 +1 @@ -Subproject commit df36ccffd4a980d97e90f667c5d5e6bdd941fdbd +Subproject commit 7cd38dbba9ab50eebc5dbba6c61b9cb4f46d3cf0 diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index b6476a0..71dd5f2 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit b6476a0997331d16b000715881f0044e6c68e297 +Subproject commit 71dd5f2f56c8540fa45ce713adf44cab9d85c36e diff --git a/book/external/teachbooks-sphinx-tippy b/book/external/teachbooks-sphinx-tippy index 2a06428..546f58f 160000 --- a/book/external/teachbooks-sphinx-tippy +++ b/book/external/teachbooks-sphinx-tippy @@ -1 +1 @@ -Subproject commit 2a06428e894f41fd29f6c2184c504aa90d20ff03 +Subproject commit 546f58fe01a556130f06cdc95524efd922362f83 diff --git a/book/features/sphinx_extensions.md b/book/features/sphinx_extensions.md index b30128a..fa53945 100644 --- a/book/features/sphinx_extensions.md +++ b/book/features/sphinx_extensions.md @@ -1,22 +1,8 @@ -# Sphinx Extensions +# Additional functionality ```{admonition} User types :class: tip This section is useful for user type 4-5. ``` -Sphinx extensions are plugins developed for the Sphinx documentation ecosystem (which Jupyter Book is built upon). They extend or modify Sphinx’s capabilities and can be added to Jupyter Book for extra functionality. Since Sphinx extensions are not an integral part of jupyter-book, as opposed to original jupyter-book features, they must be installed and configured explicitly, for example in the `_config.yml` file. - -At TeachBooks, we have many TA's working on developing cool and handy extensions to use in our books. Here's an overview: - -- Download link replacer: Controls the download options of the chapters in your book. - -- Image Inverter: Makes it possible to distinguish figures and graphs that shouldn't automatically be converted by the dark/light mode. - -- Custom Launch Button: Allows you to add buttons to your book which you can use as quick access or settings options. - -- JupyterBook Patches: Fixes an issue where drop down menus would still take up space after being minimized. - -- TU Delft theme: Provides a simple solution to have a uniform theme across all the books created at Delft University of Technology that matches the TU Delft identity. - -- Rich hover over tips: This TeachBooks Tippy extension utilizes Sphinx-tippy and makes it plug-and-play within a JupyterBook. \ No newline at end of file +This sections includes the features developed by TeachBooks which add functionality to the book. Most of them are implemented as sphinx extensions, which are plugins developed for the Sphinx documentation ecosystem (which Jupyter Book is built upon). They extend or modify Sphinx’s capabilities. Since Sphinx extensions are not an integral part of jupyter-book, as opposed to original jupyter-book features, they must be installed and configured explicitly, for example in the `_config.yml` file. \ No newline at end of file diff --git a/book/features/visuals.md b/book/features/visuals.md new file mode 100644 index 0000000..3ae37b8 --- /dev/null +++ b/book/features/visuals.md @@ -0,0 +1,8 @@ +# Book styling + +```{admonition} User types +:class: tip +This section is useful for user type 1-5. +``` + +TeachBooks developed a few improvements of the book which improve the visual book styling. \ No newline at end of file diff --git a/book/visuals.md b/book/visuals.md deleted file mode 100644 index ac3e6da..0000000 --- a/book/visuals.md +++ /dev/null @@ -1 +0,0 @@ -# hi \ No newline at end of file From f33cb3f75f96dc305098b043445e63bc8ff05026 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 11:18:13 +0100 Subject: [PATCH 24/26] updated badges --- book/basic-features/utterances.md | 2 +- book/features/HTML_javascript.md | 2 +- book/features/adding_HTML_elements.md | 2 +- book/features/overview.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/book/basic-features/utterances.md b/book/basic-features/utterances.md index 9ec87f1..5bd350b 100644 --- a/book/basic-features/utterances.md +++ b/book/basic-features/utterances.md @@ -1,6 +1,6 @@ # Discussions in your book: Utterances -{bdg-muted}`Javascript script` +{bdg-white}`GitHub app and Javascript script` [Utterances 🔮](https://utteranc.es/) is a lightweight open-source widget which allows you, your colleages and your students to discuss stuff in a blog post in your book. It is build on GitHub issues, so requires a GitHub repository, although the book can be hosted anywhere (so also on GitLab). diff --git a/book/features/HTML_javascript.md b/book/features/HTML_javascript.md index 4192375..f103638 100644 --- a/book/features/HTML_javascript.md +++ b/book/features/HTML_javascript.md @@ -5,7 +5,7 @@ This section is useful for user type 5. ``` -{bdg-info}`iframe` +{bdg-danger}`iframe` In this section, we will discuss how to [create](creating_basic_HTML_elements.md) and [embed](adding_HTML_elements.md) interactive HTML/Javascript elements created in HTML/JavaScript in a TeachBook. These HTML/Javascript element work very fluently and don't require a python kernel running in the background. diff --git a/book/features/adding_HTML_elements.md b/book/features/adding_HTML_elements.md index deab9f0..b241964 100644 --- a/book/features/adding_HTML_elements.md +++ b/book/features/adding_HTML_elements.md @@ -1,6 +1,6 @@ # Adding interactive HTML/JavaScript elements -{bdg-info}`iframe` +{bdg-danger}`iframe` In this section, we will discuss how to embed interactive elements created in HTML/JavaScript in a TeachBook. If you are interested in learning how to create these elements yourself, we will discuss an example in the [next article](creating_basic_HTML_elements.md). As an example, let us discuss how to embed an interactive 3D model of a subsurface environment I created: diff --git a/book/features/overview.md b/book/features/overview.md index de7ea78..30d40b8 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -7,12 +7,12 @@ Since the list of TeachBook features is getting quite long, we have grouped them Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features: - {bdg-warning}`Javascript overlay` - {bdg-success}`Chrome Extension` -- {bdg-muted}`GitHub App and Javascript script` +- {bdg-white}`GitHub App and Javascript script` - {bdg-secondary}`Python Package` - {bdg-light}`GitHub Reusable Action` - {bdg-dark}`Git Workflow` - {bdg-primary}`Sphinx Extension` -- {bdg-info}`iframe` +- {bdg-danger}`iframe` Finally, the purpose, installation process and usage of each features is elaborated on in the respective sub-sections. From d2341353f9ec881eb424522e8b0ebb2c0dcc7ae7 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 11:30:34 +0100 Subject: [PATCH 25/26] typo --- book/features/h5p.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/features/h5p.md b/book/features/h5p.md index 015b2ad..cdb10c7 100644 --- a/book/features/h5p.md +++ b/book/features/h5p.md @@ -5,7 +5,7 @@ This section is useful for user type 3-5. ``` -{bdg-info}`iframe` +{bdg-danger}`iframe` ## Instruction H5p elements are interactive HTML-blocks which can be embedded in a Jupyter Book using an iframe. An H5p element can be created in the [TU Delft portal on the H5p website](https://tudelft.h5p.com/content) (sign in via Brightspace to H5p required first). The iframe code can be copied at Edit - Publish - Public - Embed code. This html code can be directly added to your markdown file: From 1aed476ce485acdcb0346476cf38f16da18fb467 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 29 Nov 2024 11:36:03 +0100 Subject: [PATCH 26/26] make custom launch button specific --- book/features/custom-launch-button.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/features/custom-launch-button.md b/book/features/custom-launch-button.md index 4acbf99..8df830b 100644 --- a/book/features/custom-launch-button.md +++ b/book/features/custom-launch-button.md @@ -1,4 +1,4 @@ -# Custom Launch Button +# Multilingual book ```{admonition} User types :class: tip