You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: book/Styleguide.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# styleguide (overall)
1
+
# Styleguide (overall)
2
2
3
3
The overall structure of each experiment is BASIC:
4
4
- Background
@@ -54,7 +54,7 @@ Per section we have an:
54
54
55
55
56
56
57
-
# styleguide (per experiment)
57
+
# Styleguide (per experiment)
58
58
59
59
## Layout:
60
60
- accessibility code
@@ -67,7 +67,7 @@ Per section we have an:
67
67
- images
68
68
- fonts
69
69
70
-
## accessibility code
70
+
## Accessibility code
71
71
For accessibility each will start with a piece of code for the accessibility of the notebook (.ipynb file). You can adjust the width of the text with the function provided below.
72
72
- You can toggle the auto-numbering of the sections in the outline toolbox (sidebar or topbar).
73
73
- You can toggle the code line numbers in the dropdown menu of the "view" button in the topbar.
@@ -86,7 +86,7 @@ set_width(50)
86
86
87
87
```
88
88
89
-
## title, goal, structure
89
+
## Title, Goal, Structure
90
90
91
91
The title starts with a single hashtag plus space. Later sub sections go with ##, ###, etc.
92
92
@@ -106,7 +106,7 @@ In each assignment the estimated time you will spend per part is given. If you s
106
106
107
107
108
108
109
-
### subsections format
109
+
### Subsections format
110
110
- subsections start with ##
111
111
- per subsection give an estimated time, indented in grey. Example: > <fontcolor='grey'>⏳ Estimated time: 10 min</font>
112
112
- we want as little cookbook recipe following as possible.
Inserting an online image, in our case on an open gitlab repository is done with html code. Have a look at the code of this block, and you see:
128
128
- '<img': start of image
@@ -136,7 +136,7 @@ Inserting an online image, in our case on an open gitlab repository is done with
136
136
137
137
<!-- #endregion -->
138
138
139
-
### fonts
139
+
### Fonts
140
140
you can make different color or size fonts:
141
141
- first define the font color
142
142
- then write the text, or even copy paste an icon
@@ -153,7 +153,7 @@ Example:
153
153
154
154
155
155
156
-
### Inserting student's images
156
+
### Inserting own images
157
157
In some cases an answer can be best illustrated with a picutre, either drawn or a photo taken from the setup, or oscilloscope screen, or screendump of the laptop. Then the following code is most udesfull, which need to be in two consecutive cells:
Copy file name to clipboardExpand all lines: book/intro.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,12 @@
1
+
```python
2
+
3
+
```
4
+
1
5
<!-- #region -->
2
6
(intro)=
3
-
# Welcome to the Template Book
7
+
# Welcome to the Online Manuals of the NB2214 practicum
4
8
5
-
This Teachbook is meant to be able to open all NB2214 Practicum manuals without having to open the jupyter notebook on your laptop. If you want to, you can still download this notebook and work offline.
9
+
This Teachbook is meant to be able to open all NB2214 Practicum manuals without having to open the jupyter notebook on your laptop. If you want to, you can still download this notebook and work offline, which is mainly needed when connecting to equipment such as the ALPACA, or NIDAQ.
0 commit comments