Skip to content

Commit 130d482

Browse files
Update curriculum_spec.md
1 parent 1d0d992 commit 130d482

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

curriculum_spec.md

+18-12
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Code:
3535
int main() {
3636
int x, y, sum;
3737
38-
/// @ref:step1.1
38+
/// STEP 1
3939
/// Use scanf here to read in two numbers to x and y!
4040
4141
printf( "%d", sum );
@@ -49,33 +49,39 @@ Markdown:
4949
title: Step 1
5050
next: step_2.md
5151
prev: introduction.md
52-
jumpto: @ref:step1.1
52+
jumpto: @STEP 1
5353
---
5454
Given a variable declaration `int x` we can use `scanf("%d", x)` to a read an integer from
55-
the console and assign it to x. Use that [here](@ref:step1.1) to read in two integers, compute the sum,
55+
the console and assign it to x. Use that [here](@STEP 1) to read in two integers, compute the sum,
5656
and assign it to `sum`!
5757
```
5858

5959
#### Header Tags
6060
* ```title```: Title to display in sidebar
6161
* ```next```: A next button will be shown in the sidebar and will load the specified file when clicked.
6262
* ```prev```: ''
63-
* ```jumpto```: Line or reference to jump to when the markdown is loaded
63+
* ```jumpto```: Line or label to jump to when the markdown is loaded
6464

6565
#### Special Comments and Tags
6666

67-
* Code reference: Can be used to reference a specific line of code.
68-
* Code:
67+
* Instructional Block: Instructional blocks are multiline comments that whose lines start with any of the following:
68+
```
69+
///
70+
###
6971
```
70-
### @ref:label or
71-
/// @ref:label or
72-
/*** @ref:label */
72+
For example:
7373
```
74+
/// EXAMPLE
75+
/// This is an
76+
/// instructional block
7477
75-
* Code anchor links: Links to code anchor with corresponding label.
76-
* Markdown:
78+
* Code links: The first line of each instructional block acts as a label that can be used in sidebar instructions. For example in the instruction markdown we can put:
7779
```
78-
[link text](@ref:label)
80+
[link text](@EXAMPLE)
81+
```
82+
to create a link to the instructional block in the code itself. If there are multiple instructional blocks with the same label, we can distinguish between them by adding #<order of occurence>, e.g.
83+
```
84+
[link text](@EXAMPLE#2)
7985
```
8086
8187
### Project Task Specifications

0 commit comments

Comments
 (0)