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

hide answers

Browse source
This commit is contained in:
Tom van Woudenberg 2025-03-27 08:59:58 +01:00
parent b2b5a1a20a
commit 026cd47dda
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
book/syntax_exercises/009.md
View file

@ -35,7 +35,7 @@ If you leave the text part empty, the title of the chapter you're referring to w
If the chapter you're referring to is in different directory than your chapter, you'll need to refer it using relative parts. If the to be referenced chapter is in a subdirectory of the directory of the chapter, go deeper with `subdirectory/` (e.g. `<subdirectory>/<chapter in subdirectory>.md`). If the to be referenced chapter is in another directory, move upwards with `../` (e.g. `../../<subdirectory>/<chapter which is located in a subdirectory two folders above the current page.md>` )
```
3. If we want to refer to a section within the same file, we can use local refencing by directly inputting the name of the required section. Use the example below to test this out. This code gives: [Jump to the next section](#referencing-an-equation)
3. If we want to refer to a section within the same file, we can use local refencing by directly inputting the name of the required section. Use the example below to test this out.
```md
[Jump to the next section](#referencing-an-equation)
@ -49,7 +49,7 @@ If the chapter you're referring to is in different directory than your chapter,
Let's start with the most basic edit: add some text to a file and see that the website is updated...
```
5. Now, let's explore three different ways to reference this section or chapter! For the first method, we use the standard title text by calling the identifier as follows. This will display: My favourite exercise was {ref}`exercise_1`.
5. Now, let's explore three different ways to reference this section or chapter! For the first method, we use the standard title text by calling the identifier as follows.
```md
My favourite exercise was {ref}`exercise_1`.
@ -57,14 +57,13 @@ My favourite exercise was {ref}`exercise_1`.
6. For the second method, we want to refer to the section using a custom title text. Try this out by placing the text that you want to be displayed within `` and calling the identifier within <>.
This will display: My favourite exercise was {ref}`the first one <exercise_1>`.
```md
My favourite exercise was {ref}`the first one <exercise_1>`.
```
7. The last method uses markdown syntax to also display a custom title text. Refer to the desired section once again, this time by putting the custom text within [] and calling the identifier within <> as shown below. This will display: My favourite exercise was [this one](exercise_1).
7. The last method uses markdown syntax to also display a custom title text. Refer to the desired section once again, this time by putting the custom text within [] and calling the identifier within <> as shown below.
```md
@ -85,12 +84,13 @@ $$ F = m \cdot a$$ (eq:Newton)
$$ F = m \cdot a$$ (eq:Newton)
9. Refer to this equation by using `{eq}` and calling the identifier within the `` to achieve: Refer to Equation {eq}`eq:Newton`. This will automatically insert the number of the equation. You can add text as you did in exercise 6. Alternatively, you can use the default `[<text to display>](<identifier>)`: [Newton Equation](eq:Newton).
9. Refer to this equation by using `{eq}` and calling the identifier within the ``. This will automatically insert the number of the equation. You can add text as you did in exercise 6.
```md
Refer to Equation {eq}`eq:Newton`
```
Alternatively, you can use the default `[<text to display>](<identifier>).
## Referencing a Table
@ -113,14 +113,14 @@ Refer to Equation {eq}`eq:Newton`
| A | B |
```
11. Refer to the table like {numref}`Table {number} <tab-example>` using `{numref}` and `{number}` as follows. You can add text as you did in exercise 6.
11. Refer to the table like with custom text 'Table' and the number using `{numref}` and `{number}` as follows. You can add text as you did in exercise 6.
```md
{numref}`Table {number} <tab-example>`
```
Or use the default `[<text to display>](<table name>)`: [Reference to Example Table](tab-example)
Or use the default `[<text to display>](<table name>)`.
## Referencing a Figure
@ -138,13 +138,13 @@ Example figure.
````
13. Refer to the figure in the format {numref}`Figure {number} <fig-example>` using `{numref}` as follows. You can add text as you did in exercise 6.
13. Refer to the figure in the with custom text 'Figure' and the number using `{numref}` as follows. You can add text as you did in exercise 6.
```md
{numref}`Figure {number} <fig-example>`
```
Alternatively use `{ref}` to use the figure name instead of number, or use the default `[<Eventually text to display, otherwise use title>](<figure name>)`.
Alternatively, you get an automatic text 'Fig.' and the number when using `` {numref}`<fig-example>` ``. Or use `{ref}` to use the figure name instead of number. Next to all of that you can use the default `[<Eventually text to display, otherwise use title>](<figure name>)`.
## Referencing a Link
@ -154,7 +154,7 @@ Alternatively use `{ref}` to use the figure name instead of number, or use the d
```md
[Text to display](url)
```
For example, you can use the code below to display: Here is the [link to the template](https://teachbooks.github.io/template/).
For example, you can use the code.
```md