-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathchapter-template.qmd
123 lines (85 loc) · 2.95 KB
/
chapter-template.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
---
title: Chapter Page Template
author: Your Name Here
bibliography: assets/references/chapter-template.bib
---
Introduction goes here.
## Section
First section.
One sentence _per line_.
Emphasis should be with italics via underscores
New paragraph through a _line break_ above.
Lists can be rendered with hyphens as bullets, and 4 spaces for sub-bullets:
- Bullet 1
- Bullet 2
- **Sub-bullet** 1
- **Sub-bullet** 2
- Bullet 3
Bold can be used to indicate first words of a list as above, or as a word that could be included in a **glossary**.
### Sub section
Here is an example of a code block. The line before must end in a full stop.
```bash
echo "Hello world!"
```
The code block above has `bash` as the code identifier. Inline text should only be used for single commands, file extensions, or paths, i.e., not whole commands.
For code blocks that execute - by default only R - should be set to `eval=FALSE`.
Pre-made output should be copy pasted and placed in a collapsible block.
For example the following.
```{.r eval=FALSE}
print('SPAAM Rules!')
```
::: {.callout-note collapse="true"}
## Expand see output
```{.r eval=FALSE}
[1] "SPAAM Rules!"
```
:::
Can be written as.
`````verbatim
```{.r eval=FALSE}
print('SPAAM Rules!')
```
`````
::: {.callout-note collapse="true"}
## Expand see output
`````verbatim
```{.r eval=FALSE}
[1] "SPAAM Rules!"
```
`````
:::
Other code blocks will not execute by default, and can be simply set without setting no execution.
`````verbatim
```bash
echo "SPAAM Rules!"
```
`````
## Second section
Here is an example of a figure. It must have a caption, and a label for referencing in text.
![The figure caption goes here](assets/images/cover.png){#fig-chaptertempalte-figuretemplate}
The label must be prefixed with `fig-<chaptername>-<figureidentifier>` and should be in lowercase.
## Third section
Tables should also have a caption and a label for referencing in text.
| Default | Left | Right | Center |
|---------|:-----|------:|:------:|
| 12 | 12 | 12 | 12 |
| 123 | 123 | 123 | 123 |
| 1 | 1 | 1 | 1 |
: Demonstration of pipe table syntax {#tbl-chaptertemplate-tabletemplate}
### Third sub section
::: {.callout-warning}
This is a call out block with a warning style.
Note that we reserve some callout formatting styles for specific objects!
:::
For example the end of every _section_ should have a task or question with a hidden answer.
::: {.callout-tip title="Question" appearance="simple"}
Your question(s) goes here.
:::
::: {.callout-note collapse="true" title="Answer"}
The answer(s) goes here, in a by-default 'hidden' block the reader can open to view.
:::
## Summary
Please refer to [Chapter Writing Guidelines](chapter-writing-guidelines.qmd) for the full list of guidelines.
Citations come from the associated `.bib` file, and are referenced in the text like this [@Fellows-Yates2024-tg].
References are automatically rendered for you at the end of the chapter.
## References