final update

This commit is contained in:
Julie Kirsch 2024-11-27 12:07:45 +01:00
parent b5fa74c734
commit 0dc1b82313
2 changed files with 34 additions and 5 deletions

View file

@ -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 <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-globe" viewBox="0 0 16 16">
This section will explain how to create a "Languages" or " <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-globe" viewBox="0 0 16 16">
<path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8m7.5-6.923c-.67.204-1.335.82-1.887 1.855A8 8 0 0 0 5.145 4H7.5zM4.09 4a9.3 9.3 0 0 1 .64-1.539 7 7 0 0 1 .597-.933A7.03 7.03 0 0 0 2.255 4zm-.582 3.5c.03-.877.138-1.718.312-2.5H1.674a7 7 0 0 0-.656 2.5zM4.847 5a12.5 12.5 0 0 0-.338 2.5H7.5V5zM8.5 5v2.5h2.99a12.5 12.5 0 0 0-.337-2.5zM4.51 8.5a12.5 12.5 0 0 0 .337 2.5H7.5V8.5zm3.99 0V11h2.653c.187-.765.306-1.608.338-2.5zM5.145 12q.208.58.468 1.068c.552 1.035 1.218 1.65 1.887 1.855V12zm.182 2.472a7 7 0 0 1-.597-.933A9.3 9.3 0 0 1 4.09 12H2.255a7 7 0 0 0 3.072 2.472M3.82 11a13.7 13.7 0 0 1-.312-2.5h-2.49c.062.89.291 1.733.656 2.5zm6.853 3.472A7 7 0 0 0 13.745 12H11.91a9.3 9.3 0 0 1-.64 1.539 7 7 0 0 1-.597.933M8.5 12v2.923c.67-.204 1.335-.82 1.887-1.855q.26-.487.468-1.068zm3.68-1h2.146c.365-.767.594-1.61.656-2.5h-2.49a13.7 13.7 0 0 1-.312 2.5m2.802-3.5a7 7 0 0 0-.656-2.5H12.18c.174.782.282 1.623.312 2.5zM11.27 2.461c.247.464.462.98.64 1.539h1.835a7 7 0 0 0-3.072-2.472c.218.284.418.598.597.933M10.855 4a8 8 0 0 0-.468-1.068C9.835 1.897 9.17 1.282 8.5 1.077V4z"/>
</svg> 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.
</svg> " 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 : <svg></svg>
icon : <svg> ...
</svg>
```
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 : <svg> ...
</svg>
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
```
```
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.1 KiB