Merge remote-tracking branch 'origin/main-variants' into develop

subugoe · Oct 30, 2024 · 39ed6e6 · 39ed6e6
2 parents d0ff499 + 9d4b9e3
commit 39ed6e6
Show file tree

Hide file tree

Showing 39 changed files with 2,855 additions and 555 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,9 +5,9 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ "develop" ]
+    branches: [ "develop", "main-variants" ]
   pull_request:
-    branches: [ "develop", "main" ]
+    branches: [ "develop", "main", "main-variants" ]
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -37,13 +37,16 @@ jobs:
         restore-keys: |
           cypress-${{ runner.os }}-cypress-node${{ matrix.node-version }}-
 
-    - name: Install dependencies
+    - name: Setup node
       uses: actions/setup-node@v4
       with:
        node-version: ${{ matrix.node-version }}
+    - name: Install dependencies
+      run: npm ci
+    - name: Run Linting
+      run: npm run lint
     - name: Run tests
       run: |
-        npm ci
         npm run start:mock-api &
         npm run test
       # - name: Save test video folder

diff --git a/README.md b/README.md
diff --git a/examples/ahiqar-arabic-karshuni-local.html b/examples/ahiqar-arabic-karshuni-local.html
@@ -32,7 +32,8 @@
       "manifest": "Manuscript"
     },
     "colors": {
-      "forceMode": "light"
+      "forceMode": "light",
+      "primary": "#1a3771"
     },
     "panels": [
       {
@@ -86,10 +87,7 @@
             "connector": {
               "id": 4,
               "options": {
-                "type": "transcription",
-                "default_font_size": 16,
-                "min_font_size": 14,
-                "max_font_size": 28 
+                "type": "transcription"
               }
             }
           },
@@ -100,8 +98,8 @@
               "id": 4,
               "options": {
                 "type": "transliteration"
+              }
             }
-           }
           }
         ]
       },
@@ -117,19 +115,19 @@
                 "types": [
                   {
                     "name": "Person",
-                    "icon": "biPersonFill"
+                    "icon": "person"
                   },
                   {
                     "name": "Place",
-                    "icon": "biGeoAltFill"
+                    "icon": "marker"
                   },
                   {
                     "name": "Editorial Comment",
-                    "icon": "biChatFill"
+                    "icon": "chat"
                   },
                   {
                     "name": "Reference",
-                    "icon": "biBoxArrowUpRight"
+                    "icon": "externalLink"
                   }
                 ]
               }
@@ -144,11 +142,18 @@
                 "types": [
                   {
                     "name": "Motif",
-                    "icon": "biPenFill"
+                    "icon": "pen"
                   }
                 ]
               }
             }
+          },
+          {
+            "id": "annotations3",
+            "label": "Variants",
+            "connector": {
+              "id": 6
+            }
           }
         ]
       }
@@ -161,10 +166,10 @@
         "next_manifest": "Next Manuscript",
         "previous_manifest": "Previous Manuscript",
         "item": "Sheet"
-      },
+      }
     }
   });
 });
 </script>
 </body>
-</html>
+</html>
diff --git a/examples/ahiqar-arabic-karshuni-with-variants-local.html b/examples/ahiqar-arabic-karshuni-with-variants-local.html
@@ -0,0 +1,174 @@
+<!DOCTYPE html>
+<html>
+<head><title>TIDO</title>
+  <meta charset="utf-8">
+  <meta name="description" content="">
+  <meta name="format-detection" content="telephone=no">
+  <meta name="msapplication-tap-highlight" content="no">
+  <meta name="viewport" content="initial-scale=1,maximum-scale=5,minimum-scale=1,width=device-width">
+  <link rel="icon" type="image/x-icon" href="favicon.ico">
+  <link rel="stylesheet" href="dist/tido.css">
+  <style>
+    html, body {
+      margin: 0;
+    }
+    #app {
+      height: 100vh;
+    }
+  </style>
+</head>
+<body>
+<noscript><strong>We're sorry but TIDO doesn't work properly without JavaScript enabled. Please enable it to
+  continue.</strong></noscript>
+
+<div id="app"></div>
+<script src="dist/tido.js"></script>
+<script>
+window.addEventListener('load', function () {
+  window.tido = new window.Tido({
+    "collection": "http://localhost:8181/ahiqar/textapi/ahiqar/arabic-karshuni/collection.json",
+    "labels": {
+      "item": "Sheet",
+      "manifest": "Manuscript"
+    },
+    "colors": {
+      "forceMode": "light"
+    },
+    "panels": [
+      {
+        "label": "contents_and_metadata",
+        "views": [
+          {
+            "id": "tree",
+            "label": "contents",
+            "connector": {
+              "id": 1
+            }
+          },
+          {
+            "id": "metadata",
+            "label": "metadata",
+            "connector": {
+              "id": 2,
+              "options": {
+                "collection": {
+                  "all": true
+                },
+                "manifest": {
+                  "all": true
+                },
+                "item": {
+                  "all": true
+                }
+              }
+            }
+          }
+        ]
+      },
+      {
+        "label": "image",
+        "views": [
+          {
+            "id": "image",
+            "label": "Image",
+            "connector": {
+              "id": 3
+            }
+          }]
+      },
+      {
+        "label": "text",
+        "views": [
+          {
+            "id": "text1",
+            "label": "Transcription",
+            "default": true,
+            "connector": {
+              "id": 4,
+              "options": {
+                "type": "transcription"
+              }
+            }
+          },
+          {
+            "id": "text2",
+            "label": "Transliteration",
+            "connector": {
+              "id": 4,
+              "options": {
+                "type": "transliteration"
+              }
+            }
+          }
+        ]
+      },
+      {
+          "label": "annotations",
+          "views": [
+            {
+              "id": "annotations1",
+              "label": "Editorial",
+              "connector": {
+                "id": 5,
+                "options": {
+                  "types": [
+                    {
+                      "name": "Person",
+                      "icon": "person"
+                    },
+                    {
+                      "name": "Place",
+                      "icon": "marker"
+                    },
+                    {
+                      "name": "Editorial Comment",
+                      "icon": "chat"
+                    },
+                    {
+                      "name": "Reference",
+                      "icon": "externalLink"
+                    }
+                  ]
+                }
+              }
+            },
+            {
+              "id": "annotations2",
+              "label": "Motif",
+              "connector": {
+                "id": 5,
+                "options": {
+                  "types": [
+                    {
+                      "name": "Motif",
+                      "icon": "pen"
+                    }
+                  ]
+                }
+              }
+            },
+            {
+              "id": "annotations3",
+              "label": "Variants",
+              "connector": {
+                "id": 6
+              }
+            }
+          ]
+        }
+    ],
+    "translations": {
+      "en": {
+        "contents_and_metadata": "Contents & Metadata",
+        "next_item": "Next Sheet",
+        "previous_item": "Previous Sheet",
+        "next_manifest": "Next Manuscript",
+        "previous_manifest": "Previous Manuscript",
+        "item": "Sheet"
+      }
+    }
+  });
+});
+</script>
+</body>
+</html>
diff --git a/examples/ahiqar-arabic-karshuni.html b/examples/ahiqar-arabic-karshuni.html
@@ -33,7 +33,7 @@ <h1>Coming soon.</h1>
 <script src="dist/tido.js"></script>
 <script>
 window.addEventListener('load', function () {
- 
+
   const select = document.getElementById('nav-select');
   const pathArr = window.location.pathname.split('/')
 
@@ -47,13 +47,14 @@ <h1>Coming soon.</h1>
 
   const tido = new Tido({
     "collection": "https://api.dev.ahiqar.sub.uni-goettingen.de/textapi/ahiqar/arabic-karshuni/collection.json",
-    colors: {
-      primary: "#1a3771"
-    },
     "labels": {
       "item": "Sheet",
       "manifest": "Manuscript"
     },
+    "colors": {
+      "forceMode": "light",
+      "primary": "#1a3771"
+    },
     "panels": [
       {
         "label": "contents_and_metadata",
@@ -134,19 +135,19 @@ <h1>Coming soon.</h1>
                 "types": [
                   {
                     "name": "Person",
-                    "icon": "biPersonFill"
+                    "icon": "person"
                   },
                   {
                     "name": "Place",
-                    "icon": "biGeoAltFill"
+                    "icon": "marker"
                   },
                   {
                     "name": "Editorial Comment",
-                    "icon": "biChatFill"
+                    "icon": "chat"
                   },
                   {
                     "name": "Reference",
-                    "icon": "biBoxArrowUpRight"
+                    "icon": "externalLink"
                   }
                 ]
               }
@@ -161,18 +162,30 @@ <h1>Coming soon.</h1>
                 "types": [
                   {
                     "name": "Motif",
-                    "icon": "biPenFill"
+                    "icon": "pen"
                   }
                 ]
               }
             }
+          },
+          {
+            "id": "annotations3",
+            "label": "Variants",
+            "connector": {
+              "id": 6
+            }
           }
         ]
       }
     ],
     "translations": {
       "en": {
-        "contents_and_metadata": "Contents & Metadata"
+        "contents_and_metadata": "Contents & Metadata",
+        "next_item": "Next Sheet",
+        "previous_item": "Previous Sheet",
+        "next_manifest": "Next Manuscript",
+        "previous_manifest": "Previous Manuscript",
+        "item": "Sheet"
       }
     }
   });