edits to reference

This commit is contained in:
Freek Pols 2024-06-13 10:13:12 +02:00
parent 508fd7e8a1
commit 44972b3587
3 changed files with 38 additions and 2 deletions

View file

@ -2,6 +2,23 @@
To make references to figures, equations et cetera, use the following syntax:
- For figures, use: ``{numref}`<name of the figure>` ``
- For figures, use: ``{numref}`Figure {number} <name of the figure>` ``
- For equations, use: ``{eq}`<equation label>` ``
- For citations, use: ``{cite:p}`<bibtex_entry>` `` for a citation between parenthesis, or ``{cite:t}`<bibtex_entry>` `` for an inline citation.
**Examples**
As can be seen in ``{numref}`Figure {number} <fig-gitpush>` `` (result) {numref}`Figure {number} <fig-gitpush>`, not related to {eq}`<eq:Newton>`
```{figure} ../images/git-push.png
---
width: 50%
name: fig-gitpush
---
Some caption here
```
$$ F = m\cdot a $$(eq:Newton)

View file

@ -24,6 +24,12 @@ To number the equations and refer in text, you need to provide a label to the eq
F = m \cdot a
$$ (newtons_second_law)
Resulting in:
$$
F = m \cdot a
$$ (newtons_second_law)
> **Note**
>
> The Jupyter Book uses MathJax to display equations, which provides some LaTeX-like functionality, but not all! For example, the Euro symbol is missing, and packages like `siunitx` are not available (hint, use `\textrm{}` and `\textrm{}`). When something is not working, it's useful to search for MathJax-specific solutions (hint, include "mathjax" in your Google search).

View file

@ -86,7 +86,7 @@ et cetera...
```
## The structure of a chapter
The 'nested' structure in the TOC is one way to organize your book. Another way to do so is in the file itself. The structure is define by the number of `#`:
The 'nested' structure in the TOC is one way to organize your book. Another way to do so is in the file itself. The structure is defined by the number of `#`:
```
# Chapter 1 title
@ -99,3 +99,16 @@ The 'nested' structure in the TOC is one way to organize your book. Another way
### Subsection 1.2.1
```
The depth for numbered subsection can be set in the TOC file:
```
parts:
- caption: Part 1
numbered: 2
chapters:
- file: chapter_1
sections:
- file: section_1_1
- file: section_1_2
```