-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathquickstart.qmd
164 lines (131 loc) · 6.87 KB
/
quickstart.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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# Quick Start Guide
## Get an account
Click the [login link](https://carnap.io/auth/login) located in the upper right hand
corner of most Carnap pages, and log in with a Google account (a Gmail
account works, but you can also make a Google account with a different
email).
Email Graham Leach-Krouse at
[[email protected]](mailto:[email protected]) using your institutional
email address to request instructor status.
## Make your first assignment
### Carnap's assignment format
An assignment in Carnap is a document which may include text (e.g.,
instructions for your students, where to find the relevant material in
your textbook, etc.) but mainly will include *Carnap code blocks*.
Each Carnap code block corresponds to one problem. They can be of any
of the types listed on [the main page](index.html). They are:
1. [Derivations](derivations.html)
2. [Truth Tables](truth-tables.html)
3. [Translations](translation.html)
4. [Model Checking](modelchecker.html)
5. [Gentzen-Prawitz Natural Deduction](gentzen-ND.html)
6. [Sequent Calculus Deductions](sequent-calculus.html)
7. [Qualitative Problems](qualitative.html), e.g., multiple-choice
8. [Truth Trees (Semantic Tableaux)](truth-tree.html)
9. [Syntax Checking](syntax-check.html)
Each assignment document is a plain text file formatted in Markdown, a
simple markup language. (Typically, the extension of Markdown text
files is `.md`.) You can find a comprehensive introduction in the
[Markdown Guide](https://www.markdownguide.org/) including a list of editors
that support Markdown. For a quick reference, try [Learn Markdown in 60
seconds](https://commonmark.org/help/). Any plain text editor is fine, but
Markdown (and Carnap) are sticklers about spaces and newlines in Markdown
documents. So make sure your editor does not automatically wrap text.
### Downloading shared documents
You can start with an existing document another instructor has shared.
A list of shared documents can be found at
[carnap.io/shared](https://carnap.io/shared). Each shared document has a download icon
at the bottom (<span style="font-family:FontAwesome"></span>). If you
click on that, you can save the source Markdown document of the shared
page to your own computer. You can then edit it.
For instance, here is a [sample
assignment](https://carnap.io/shared/[email protected]/Problem%20Set%201.md)
which you can download by adding `/download` to the end of the URL in
your browser (or just [click
here](https://carnap.io/shared/[email protected]/Problem%20Set%201.md/download)).
### Converting existing problem sets
If you already have problem sets in another format, you can turn them
into Markdown for use on Carnap. If your problem sets are written in
Word, there is a Markdown export plugin:
[Writeage](https://www.writage.com/). Or, select Save As (Plain Text)
and then recreate the formatting in the resulting text file. If your
sheets are in LaTeX you can use [Pandoc](https://pandoc.org/). Here is
an [online converter](https://pandoc.org/try/) (select from LaTeX to
Markdown (pandoc)).
### Carnap code blocks
Next you turn each problem into a Carnap code block. For instance, a
translation exercise will be put into your Markdown document as:
~~~{.Translate .Prop}
3.1 P/\Q : People want to know what's going on and questions are unavoidable
~~~
`.Translate` tells Carnap that you want a translation exercise.
`.Prop` tells Carnap it should use its propositional equivalence
checker to test if the solution provided by the student is equivalent
to the solution you provide. The number 3.1 indicates the exercise
number. It is followed by a model solution. The colon separates the
solution from the text that will be presented for translation. The
result of the above is:
~~~{.Translate .Prop}
3.1 P/\Q : People want to know what's going on and questions are unavoidable
~~~
Each Carnap code block takes a number of options as well, which are
described in the linked pages above. The most important one is perhaps
the `system` attribute, which determines the syntax and symbols used
for sentences entered as solutions which Carnap will accept, and how
Carnap formats formulas it displays to the student.
For instance,
~~~{.SynChecker .Match system="LogicBookSD"}
1.1 (P /\ Q) -> R
~~~
~~~{.SynChecker .Match system="thomasBolducAndZachTFL2019"}
1.1 (P /\ Q) -> R
~~~
will generate:
~~~{.SynChecker .Match system="LogicBookSD"}
1.1 (P /\ Q) -> R
~~~
~~~{.SynChecker .Match system="thomasBolducAndZachTFL"}
1.1 (P /\ Q) -> R
~~~
The attributes `LogicBookSD` and `thomasBolducAndZachTFL`
correspond to the syntax and conventions of *The Logic Book*, and
*forall x: Calgary*, respectively. The available `system` attributes
are described on the [Systems](systems.html) page.
Options common to all exercise types, such as how many points a
problem is worth, are described on the [Carnap Pandoc](pandoc.html)
page. There you will also find a more in-depth description of the
format of Carnap's documents.
## Upload and test your document
On your [Instructor Page](https://carnap.io/instructor/) on Carnap,
there is a [Manage Uploaded
Documents](dashboard.md#manage-uploaded-documents) tab where you will
upload your finished assignment documents.
Once a document is uploaded, it will show up in your [Instructor
Page](https://carnap.io/instructor/) in the *Manage Uploaded
Documents* tab. If you click on the file name, Carnap will display
the document to you the same way that students will see it. You might
first have to go through a bit of proof-reading. If the page contains
an error message instead of the problem you expect, it's probably
because you misspelled an option or did not use the correct syntax for
your selected system.
## Set up a course and assign your problems
Once you are ready to give your problem sets to students, you have to
make a course for them to enrol in. You do this on your [Instructor
Page](https://carnap.io/instructor/) in the the *Manage Courses* card.
You will provide your students with an enrolment link which you can
find at the bottom of your class card. This
[video](https://youtu.be/lmkWcxqxEZk) describes what this process
looks like for a student. See the documentation of the [Carnap
Dashboard](dashboard.html) for more detail.
When you (and your students) are ready, you can assign any of your
uploaded documents to your students. Carnap will allow them to
complete and submit them. Once a problem is submitted, Carnap
records the point value you have given to the problems as a score for
the student. Students can see on their Student Home page which problems
the have submitted and how many points they earned. You can also (in
the course card for your course) see a list of enrolled students.
Below the student roster, there is a link to download grades (per
assignment, per problem). Your course card will look something like
this:
