@dodona/papyros 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -13
- package/dist/Library.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
</p>
|
|
14
14
|
|
|
15
15
|
Papyros is a programming scratchpad in the browser. It allows running code
|
|
16
|
-
directly in your browser, no installation required. Right now, the focus
|
|
16
|
+
directly in your browser, no installation required. Right now, the focus is on providing a great experience for Python, while also supporting JavaScript.
|
|
17
17
|
By taking away obstacles between students and coding, the learning experience becomes
|
|
18
18
|
smoother and less error-prone.
|
|
19
19
|
|
|
@@ -38,22 +38,24 @@ as the user knows for what purpose Papyros is being used. For example, when used
|
|
|
38
38
|
scope of a Python exercise in Dodona, there is no need to support other programming languages.
|
|
39
39
|
The locale should also match that of the actual application.
|
|
40
40
|
|
|
41
|
-
The easiest way to initialize Papyros is by using the static method Papyros.fromElement
|
|
42
|
-
This method expects a parent element that wraps the scratchpad and a PapyrosConfig object.
|
|
41
|
+
The easiest way to initialize Papyros is by using the static method `Papyros.fromElement`.
|
|
42
|
+
This method expects a parent element that wraps the scratchpad and a `PapyrosConfig` object.
|
|
43
43
|
The following options are supported:
|
|
44
|
-
- standAlone: Whether to operate in stand-alone or embedded mode as described above.
|
|
45
|
-
- locale: The locale to use, currently English and Dutch translations are provided.
|
|
46
|
-
- programmingLanguage: The language to use in the CodeEditor and Backend
|
|
47
|
-
- inputMode: How the users can provide input, according to the [InputMode enum](/src/InputManager.ts)
|
|
48
44
|
|
|
49
|
-
|
|
45
|
+
- `standAlone`: Whether to operate in stand-alone or embedded mode as described above.
|
|
46
|
+
- `locale`: The locale to use, currently English and Dutch translations are provided.
|
|
47
|
+
- `programmingLanguage`: The language to use in the CodeEditor and Backend
|
|
48
|
+
- `inputMode`: How the users can provide input, according to the [InputMode enum](/src/InputManager.ts)
|
|
49
|
+
|
|
50
|
+
Furthermore, you can provide fine-grained configuration in embedded mode by providing `RenderOptions`
|
|
50
51
|
to each main component in the application. You minimally need to specify the ID of the parent element.
|
|
51
|
-
You can also specify attributes, such as style or data
|
|
52
|
+
You can also specify attributes, such as `style` or `data`, or `classNames` to be used.
|
|
52
53
|
The main components are the following:
|
|
53
|
-
|
|
54
|
-
-
|
|
55
|
-
-
|
|
56
|
-
-
|
|
54
|
+
|
|
55
|
+
- `code`: the CodeEditor.
|
|
56
|
+
- `panel`: the StatusPanel in the CodeEditor
|
|
57
|
+
- `input`: the field for the user input
|
|
58
|
+
- `output`: the panel for output of the code
|
|
57
59
|
|
|
58
60
|
### User input
|
|
59
61
|
|