Feature/stim grammar

.gitignore

@@ -9,3 +9,9 @@ upload-experiment.sh
 
 # Ignore the key used for testing purposes
 key.txt
+
+# node
+node_modules
+
+#vs code
+.vscode

README.md

@@ -45,58 +45,66 @@ conditions, you'd need to create four lists.
 
 ### Presenting multiple words as one group
 
-By defaut, the boilerplate experiment treats every word in the stimuli as a
-group of its own containing one word. Note, in some papers, the terminology for
-a group is a segment. Sometimes it is handy to group multiple words together,
-to shorten the time it takes to complete the experiment for example. This is
-possible, but must be enabled. The file `globals.js` contains another variable:
+Previously, when the spr was presenting multiple words as one group/simultaneous, you
+needed to separate them by inserting e.g. a `/`, as of now, you have to
+specifically create groups yourself and grouping of words is always on. On
+the. There are two kinds of groups `{{A group of words that is not recorded}}`
+`{{#A group of words that is NOT recorded.}}`. Recorded means that the
+RT of this group is logged. Of course it is fine to have just one `{{word}}`
+in a {{#group}}. the curly braces and # are stripped from the rendered
+output. You should not put word letters etc outside of a group.
+
+All the words of your spr need to be enclosed in **{{**double curly braces**}}**
+so the phrase "double curly braces" is presented together. If you want the to
+be presented individually, you'll need to make three groups such as
 
-```javascript
-const GROUPING_STRING = null;
+```
+{{double}} {{curly}} {{braces}}
 ```
 
-To enable grouping you must define a useful delimiter between groups.
-A little bit further in the file there's a commented version of this:
+#### White space issues
+
+In the example with three groups above, the " " are put outside of the group
+as that might be more readable than e.g.
 
-```javascript
-const GROUPING_STRING = "/";
+```
+{{double }}{{curly }}{{braces}}
 ```
 
-So in order to enable grouping, comment the first version and uncomment
-the latter. In theory you can fill out any string instead of the `"/"`
-(useful in case you need to use / in a stimulus).
-Notice the string is turned into a regular expression in order to split
-the stimulus into parts and to remove the `/` in the case described here.
+In this example the spaces are embedded inside the groups, both methods are
+fine, but the author finds the first method better readable. If you put
+none white space characters outside of a group it will be considered a syntax error.
+
+#### Presenting **bold** and *italic* words or ***both***
+
+Like HTML you can render words in bold or italic like this:
 
-```javascript
-re = RegExp(GROUPING_STRING,'gu');
+```
+{{a word in <b>bold</b> or some words <i>in italic</i>}}
 ```
 
-So make sure if you are going to be creative, that the expression is valid.
+or even both.
 
-### Warning the grouping string is going to be removed as it shouldn't be displayed
+```
+{{<b><i>Bold and italic</i></b>}}
+```
 
-In the stimulus file you should take care that the grouping string is removed
-from the stimulus. So you should take in mind how the stimulus would appear
-after the grouping string is removed.
+However, the syntax for this is more strict than HTML, forgetting to close a bold
+or italic tag will result in an error. The bold or you'll have to close the
+innermost group first and then the outermost group. So the following are errors:
 
-#### Example
+1.
 
-```javascript
-{
-    stimulus : "This is/my fantasic stimlus./Don't you think!"
-}
-```
+        {{<b><i>Oops close i first</b></i>}}
 
-The "/" will be removed, essentially gluing "is" and "my" together, just like
-"stimulus." and "Word".
+2.
 
-#### Example improved
+        {{<b>Oops forgot to close b}}
 
-```javascript
-{
-    stimulus : "This is/ my fantasic stimlus./ Don't you think"
-}
+If you want then to be partially overlapping you should open a new group
+
+```
+{{<b>Bold <i> and italic</i></b> <i>, only italic</i>
 ```
 
 ## Output

build.bash

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# "Compile" grammar.js, from grammar.ne
+npx nearleyc -o ./plugins/grammar.js ./plugins/grammar.ne -e spr_grammar
+
+# package it using esbuild
+node ./build.mjs

build.mjs

@@ -0,0 +1,13 @@
+import * as esbuild from 'esbuild'
+
+await esbuild.build({
+    entryPoints: [
+        './plugins/jspsych-spr-moving-window.js',
+    ],
+    bundle:true,
+    outdir: 'dist',
+    minify: false,
+    sourcemap: true,
+    format: "esm"
+})
+

globals.js

@@ -42,12 +42,3 @@ const FIX_CHOICES = [' '];
 // is on screen.
 const FINISH_TEXT_DUR = 3000;
 
-// If no grouping character is selected or if it is null as in this example
-// every word is a group of its own: sentences are split on whitespace.
-// each word will be a one word group
-const GROUPING_STRING = null;
-// Or create word groups based on a splitting string
-// Create groups using a "/". Note that every occurrence
-// of a "/" will lead to presentation as a word group and the a "/" itself
-// will not be displayed in the stimulus
-//const GROUPING_STRING = "/";

index.html

@@ -28,9 +28,8 @@
 
         <!--maybe one day this plugin will be put in the mainline jsPsych
              repository.-->
-        <script src="plugins/jspsych-spr-moving-window.js"></script>
 
-        <script src="main.js"></script>
+        <script type="module" src="main.js"></script>
         <style>
             .jspsych-survey-multi-choice-text {
                 text-align: left !important;
@@ -40,8 +39,4 @@
 
     </head>
     <body></body>
-    <script>
-        // see main.js for the main function and experiment timeline
-        window.addEventListener('load', main);
-    </script>
 </html>

main.js

@@ -1,10 +1,19 @@
+import {
+    sprMovingWindow,
+    checkStimuliSyntax
+} from './dist/jspsych-spr-moving-window.js'
+
 let jsPsych = initJsPsych({
     exclusions: {
         min_width : MIN_WIDTH,
         min_height : MIN_HEIGHT
     }
 });
 
+// export jsPsych globally because this is a module now...
+// or export jsPsych and import it from the other files.
+window.jsPsych = jsPsych
+
  // I liked RandomError too :-)
 class SprRandomizationError extends Error {
     constructor(message) {
@@ -38,7 +47,7 @@ let instruction_screen_practice = {
 
 let fixcross = {
     type : sprMovingWindow,
-    stimulus : '+',
+    stimulus : '{{+}}',
     choices : FIX_CHOICES,
     font_family : "Times New Roman",
     font_size : 36,
@@ -62,7 +71,6 @@ let present_text = {
     width : MIN_WIDTH,
     height : MIN_HEIGHT,
     post_trial_gap : ISI,
-    grouping_string : GROUPING_STRING,
     data : {
         id : jsPsych.timelineVariable('id'),
         item_type : jsPsych.timelineVariable('item_type'),
@@ -135,16 +143,16 @@ let end_experiment = {
 function randomizeStimuli(table) {
     let shuffled = uil.randomization.randomizeStimuli(
         table,
-        max_same_type=MAX_SUCCEEDING_ITEMS_OF_TYPE
+        MAX_SUCCEEDING_ITEMS_OF_TYPE
     );
 
     if (shuffled !== null)
         table = shuffled;
     else {
-            console.error('Unable to shuffle stimuli according constraints.');
-            let msg = "Unable to shuffle the stimuli, perhaps loosen the " +
-                      "constraints, or check the item_types on the stimuli.";
-            throw new SprRandomizationError(msg);
+        console.error('Unable to shuffle stimuli according constraints.');
+        let msg = "Unable to shuffle the stimuli, perhaps loosen the " +
+                  "constraints, or check the item_types on the stimuli.";
+        throw new SprRandomizationError(msg);
     }
 
     return table; // shuffled table if possible original otherwise
@@ -209,6 +217,8 @@ function main() {
 
     // Option 1: client side randomization:
     let stimuli = pickRandomList();
+    checkStimuliSyntax(PRACTICE_ITEMS);
+    checkStimuliSyntax(stimuli.table);
     kickOffExperiment(getTimeline(stimuli.table), stimuli.list_name);
 
     // Option 2: server side balancing:
@@ -280,3 +290,6 @@ function findList(name) {
     }
     return list;
 }
+
+// start the experiment
+window.addEventListener('load', main);

package.json

@@ -0,0 +1,20 @@
+{
+  "name": "jspsych-spr-mw",
+  "version": "1.0.0",
+  "description": "## A self paced reading with moving window experiment using jsPsych",
+  "main": "main.js",
+  "scripts": {
+    "test": "./build.bash && node ./dist/test.js",
+    "build": "./build.bash"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "moo": "^0.5.2",
+    "nearley": "^2.20.1"
+  },
+  "devDependencies": {
+    "esbuild": "0.24.0"
+  }
+}

plugins/.gitignore

@@ -0,0 +1,6 @@
+
+# ignore grammar.js as it is generated from grammar.ne using nearley
+grammar.js
+
+# a test script
+test.js