mirror of
https://github.com/TeachBooks/template.git
synced 2026-11-12 22:25:52 +00:00
user type 4
This commit is contained in:
parent
1cb5bde1b0
commit
437bedb142
6 changed files with 26 additions and 19 deletions
|
|
@ -22,7 +22,7 @@ parts:
|
|||
sections:
|
||||
- file: exercises/007.md
|
||||
- file: exercises/008.md
|
||||
- file: exercises/type4.mb
|
||||
- file: exercises/type4.md
|
||||
sections:
|
||||
- file: exercises/009.md
|
||||
- file: exercises/010.md
|
||||
|
|
|
|||
|
|
@ -15,7 +15,6 @@ To help you illustrate your content, it can be sueful to add some type of visual
|
|||
|
||||
5. Copy this syntax and adjust the file name, width, alignment and caption.
|
||||
|
||||
|
||||
```{figure} figures/<new_figure>.PNG
|
||||
---
|
||||
width: 80%
|
||||
|
|
@ -42,7 +41,6 @@ Make sure the file extension of your figure is correct because markdown differen
|
|||
|
||||
To link and display an online figure, you can use the `{figure}` directive, which also allows captions and references.
|
||||
|
||||
|
||||
```{figure} https://town-n-country-living.com/wp-content/uploads/2023/06/craftsman-exterior.jpg
|
||||
---
|
||||
width: 80%
|
||||
|
|
@ -51,7 +49,6 @@ To link and display an online figure, you can use the `{figure}` directive, whic
|
|||
---
|
||||
<caption>
|
||||
```
|
||||
|
||||
````
|
||||
`````
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,14 @@
|
|||
# Exercise 9: Referencing using target headers
|
||||
|
||||
It can be really useful to refer to a specific section in your book while working in a different file. Referencing can be done using target headers. (<title>)=
|
||||
It can be really useful to refer to a specific section in your book while working in a different file. Referencing can be done using target headers such as:
|
||||
|
||||
```
|
||||
(<title>)=
|
||||
```
|
||||
|
||||
1. Navigate to the file you want to work in (for example `book/some_content/overview.md`) and make sure you're in the correct branch.
|
||||
|
||||
2. Identify the section you want to reference and name it ebtween bracketsfor example exercise_1.
|
||||
2. Identify the section you want to reference and name it between brackets for example `exercise_`1.
|
||||
|
||||
```
|
||||
(exercise_1)=
|
||||
|
|
@ -14,21 +18,21 @@ Let's start with the most basic edit: add some text to a file and see that the w
|
|||
|
||||
```
|
||||
|
||||
3. Referncing
|
||||
3. Referencing
|
||||
|
||||
There are three types of referencing
|
||||
There are three types of referencing:
|
||||
|
||||
If you want to refernce in line you can use:
|
||||
* If you want to refernce in line you can use:
|
||||
|
||||
My favourte exercise was {ref}`exercise_1`.
|
||||
My favourite exercise was {ref}`exercise_1`.
|
||||
|
||||
```
|
||||
My favourte exercise was {ref}`exercise_1`.
|
||||
```
|
||||
You can specify the text of the target:
|
||||
* You can also specify the in-line text of the target (aka what the link will say):
|
||||
|
||||
{ref}`MyST syntax lecture <exercise_1>`
|
||||
{ref}`Best exercise <exercise_1>`
|
||||
|
||||
Another alternative is to use Markdown syntax:
|
||||
* Another alternative is to use Markdown syntax:
|
||||
|
||||
[MyST syntax lecture](exercise_1)
|
||||
[Best exercose](exercise_1)
|
||||
|
|
@ -1,3 +1,6 @@
|
|||
# Exercise 10: ...
|
||||
|
||||
ghkvkhg
|
||||
```{attention}
|
||||
|
||||
Under Construction
|
||||
```
|
||||
|
|
@ -4,6 +4,5 @@ Now that you've made your own version of the book, it's time to add some content
|
|||
|
||||
Exercises for user type 3 relate to:
|
||||
|
||||
- File Structure (Markdown)
|
||||
- In-text referencing
|
||||
- Adding a figure
|
||||
- [File structure (Markdown)](007.md)
|
||||
- [Adding visual media](008.md)
|
||||
|
|
@ -1,3 +1,7 @@
|
|||
# User type 4
|
||||
|
||||
User 4 is a hybrid between type 3 and 5. Basically this user is making changes by editing the .md files locally using, for example, VS Code. Therefore, this user requires a little bit more knowledge on git (think of pulling and pushing changes) but their main focus remains to make adjustments to the content of the book by editing .md files whereas user type 5 has more knowledge to make changes to python files the book as well. This user can build the book online and therefore does not need to have special software installed besides a text editor (e.g., Python is not required). Using this skills, this user type can take the role as editor, managing more than just book content.
|
||||
User 4 is a hybrid between type 3 and 5. As user type 4 you will mainly be making changes by editing the `.md` files locally using, for example, VS Code.
|
||||
|
||||
Exercises for user type 4 relate to:
|
||||
|
||||
- [Referencing](009.md)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue