Merge pull request #1 from stweil/main

Fix some spelling and whitespace issues
OCR-D · Jun 28, 2022 · 1356248 · 1356248
2 parents f984ba3 + 6e52368
commit 1356248
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 43 deletions.
diff --git a/.github/workflows/keyboardGT.yml b/.github/workflows/keyboardGT.yml
@@ -9,21 +9,21 @@ jobs:
     name: keyboardGT
     runs-on: ubuntu-latest
     steps:
-    
+
     - name: Git checkout
       uses: actions/checkout@v2
 
-       
+
    # Installation and Directories
-      
+
     - name: Download and install saxon
       run: |
        wget https://sourceforge.net/projects/saxon/files/Saxon-HE/10/Java/SaxonHE10-5J.zip/download
        unzip download
-    
+
 
     - name: Make gh-pages_out, keyboards, doc folder
-      run: | 
+      run: |
         mkdir ghout
         mkdir ghout/keyboards
         mkdir ghout/keyboards/aletheia
@@ -33,64 +33,64 @@ jobs:
         mkdir ghout/keyboards/escriptorium
         mkdir ghout/doc
         mkdir keyboards
-    
+
    # Transformation and analysis
 
     - name: Transform MUFI snapshot to Aletheia keyboard
       run: |
         java -jar saxon-he-10.5.jar -xsl:scripts/keyboard.xsl output=keyboards \
-        -s:scripts/keyboard.xsl 
+        -s:scripts/keyboard.xsl
       shell: bash
 
     - name: Transform MUFI snapshot to Transkribus keyboard
       run: |
         java -jar saxon-he-10.5.jar -xsl:scripts/keyboard.xsl output=tkeyboards \
-        -s:scripts/keyboard.xsl 
+        -s:scripts/keyboard.xsl
       shell: bash
 
 
     - name: Transform MUFI snapshot to LAREX keyboard
       run: |
         java -jar saxon-he-10.5.jar -xsl:scripts/keyboard.xsl output=lkeyboards \
-        -s:scripts/keyboard.xsl 
+        -s:scripts/keyboard.xsl
       shell: bash
 
 
     - name: Transform MUFI snapshot to qurator-neat keyboard
       run: |
         java -jar saxon-he-10.5.jar -xsl:scripts/keyboard.xsl output=qkeyboards \
-        -s:scripts/keyboard.xsl 
-      shell: bash  
+        -s:scripts/keyboard.xsl
+      shell: bash
 
-    - name: Transform MUFI snapshot to escriptorium keyboard
+    - name: Transform MUFI snapshot to eScriptorium keyboard
       run: |
         java -jar saxon-he-10.5.jar -xsl:scripts/keyboard.xsl output=ekeyboards \
-        -s:scripts/keyboard.xsl 
-      shell: bash    
+        -s:scripts/keyboard.xsl
+      shell: bash
 
     - name: Make compressed table view
-      run: | 
+      run: |
         java -jar saxon-he-10.5.jar -xsl:scripts/keyboard.xsl output=keytable release=$GITHUB_RUN_NUMBER \
         -s:scripts/keyboard.xsl -o:ghout/overview.md
       shell: bash
 
-   # GH-style  
-                                                                                        
-    - name: Copy css styles, keybords, docs and yml files 
+   # GH-style
+
+    - name: Copy css styles, keyboards, docs and yml files
       run:  |
         cp scripts/table_hide.css ghout/
         cp scripts/_config.yml ghout/
         cp docu/* ghout/doc/
         cp -r ghout/keyboards/* keyboards/
-        
 
 
-    - name: Archive the keyboard files 
+
+    - name: Archive the keyboard files
       uses: thedoctor0/zip-release@master
       with:
          filename: site.zip
          path: 'keyboards'
-      
+
    # GitHub release
 
     - name: Create GitHub release
@@ -101,11 +101,11 @@ jobs:
       with:
           tag_name: v${{ github.run_number }}
           release_name: Release ${{ github.run_number }}
-          body_path: CHANGELOG.md 
+          body_path: CHANGELOG.md
           draft: false
           prerelease: false
-     
-    
+
+
     - name: Upload asset to GitHub release
       uses: actions/upload-release-asset@latest
       env:
@@ -115,13 +115,11 @@ jobs:
           asset_path: ./site.zip
           asset_name: keyboardGT-v${{ github.run_number }}.zip
           asset_content_type: application/zip
-          
-      
+
+
     - name: Deploy GT-Overview to GitHub Pages
       uses: JamesIves/[email protected]
       with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BRANCH: gh-pages # The branch the action should deploy to.
           FOLDER: ghout # The folder the action should deploy.
-
-
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # keyboardGT
 
-The Aletheia document image analysis system, Transkribus, LAREX, QURATOR-neat and escriptorium offer the possibility to install additional virtual keyboards or to customize them.
+The Aletheia document image analysis system, Transkribus, LAREX, QURATOR-neat and eScriptorium offer the possibility to install additional virtual keyboards or to customize them.
 This repository offers about 80 keyboards based on the [MUFI snapshot](https://mufi.info/m.php?p=mufiexport) for download on the [Github page](https://tboenig.github.io/keyboardGT/overview.html).
 
 ## Download your Keyboard
@@ -31,11 +31,11 @@ If you want to create the keyboard on your computer
 **For QURATOR-neat**
 `java -jar saxon-he.jar -xsl:scripts/keyboard.xsl output=qkeyboards -s:scripts/keyboard.xsl `
 
-**For escriptorium**
+**For eScriptorium**
 `java -jar saxon-he.jar -xsl:scripts/keyboard.xsl output=ekeyboards -s:scripts/keyboard.xsl `
 
 
-📝 Note: The keybords are stored in the folder `ghout/keyboards` on your system.
+📝 Note: The keyboards are stored in the folder `ghout/keyboards` on your system.
 
 ## See Also
 
@@ -44,5 +44,5 @@ If you want to create the keyboard on your computer
 - Transkribus https://readcoop.eu/transkribus/
 - LAREX https://github.com/OCR4all/LAREX
 - QURATOR-neat https://github.com/qurator-spk/neat
-- escriptorium https://gitlab.com/scripta/escriptorium
+- eScriptorium https://gitlab.com/scripta/escriptorium
 - Saxon https://www.saxonica.com/welcome/welcome.xml
diff --git a/scripts/keyboard.xsl b/scripts/keyboard.xsl
@@ -23,7 +23,7 @@
         The key of every entry is the name of the tab that is added to the GUI. 
         The value of the entry is a list of unicode characters OR a valid unicode range in 4-digit hex-format 
         (i.e. 0080-00FF for Latin-1 supplement) - Note that both, a list of characters and multiple ranges, can be combined 
-        into one keyboard by seperating the values with a whitespace!
+        into one keyboard by separating the values with a whitespace!
         The keyboards are sorted by their name in the GUI - add leading numbers to enforce a special order!
         The keyboard was created automatically. The basis was the snapshot of MUFI: The Medieval Unicode Font Initiative (https://mufi.info/m.php?p=mufiexport)
     </comment>
@@ -57,11 +57,11 @@
 
 <!-- 
 Keyboards
-    kb  = Keyborad Aletheia
-    tkb = Keyborad Transkribus
-    lkb = Keyborad Larex
+    kb  = Keyboard Aletheia
+    tkb = Keyboard Transkribus
+    lkb = Keyboard Larex
     qkb = Keyboard Qurator-neat
-    ekb = Keyboard escriptorium
+    ekb = Keyboard eScriptorium
 
 
 Names
@@ -275,19 +275,19 @@ Names
         <xsl:element name="h1">Code chart</xsl:element>
 
         <xsl:element name="p">
-            The Aletheia document image analysis system, Transkribus, LAREX, QURATOR-neat and escriptorium offer the possibility to install additional virtual keyboards or to customize them.
+            The Aletheia document image analysis system, Transkribus, LAREX, QURATOR-neat and eScriptorium offer the possibility to install additional virtual keyboards or to customize them.
             This repository offers about 80 keyboards based on the data snapshot of
             <a href="https://mufi.info/" target="_blank">MUFI: The Medieval Unicode Font Initiative</a> 
             <a href="https://mufi.info/m.php?p=mufiexport" target="_blank">(MUFI data as json)</a>.
         </xsl:element>
-        <xsl:element name="p">Would you like to use the keyboard in Aletheia or in Transkribus or in LAREX or in QURATOR-neat or in escriptorium. Then download and
+        <xsl:element name="p">Would you like to use the keyboard in Aletheia or in Transkribus or in LAREX or in QURATOR-neat or in eScriptorium. Then download and
             install the necessary virtual keyboard. You can find more information about using
             Virtual Keyboards in  
             <a href="https://www.primaresearch.org/www/assets/tools/Aletheia%20User%20Guide.pdf#page=91" target="_blank">Aletheia User Guide</a> or
             <a href="https://readcoop.eu/de/glossary/virtual-keyboard/" target="_blank">Transkribus Glossar,</a> or
             <a href="https://github.com/OCR4all/LAREX/issues/317" target="_blank">LAREX</a> or
             <a href="https://github.com/qurator-spk/neat" target="_blank">QURATOR-neat</a> or
-            <a href="https://gitlab.com/scripta/escriptorium" target="_blank">escriptorium</a>.
+            <a href="https://gitlab.com/scripta/escriptorium" target="_blank">eScriptorium</a>.
 
         </xsl:element>
 
@@ -297,7 +297,7 @@ Names
             <li>Transkribus <a href="https://readcoop.eu/transkribus/">https://readcoop.eu/transkribus/</a></li>
             <li>LAREX <a href="https://github.com/OCR4all/LAREX">https://github.com/OCR4all/LAREX</a></li>
             <li>QURATOR-neat <a href="https://github.com/qurator-spk/neat" target="_blank">https://github.com/qurator-spk/neat</a></li>
-            <li>escriptorium <a href="https://gitlab.com/scripta/escriptorium" target="_blank">https://gitlab.com/scripta/escriptorium</a></li>
+            <li>eScriptorium <a href="https://gitlab.com/scripta/escriptorium" target="_blank">https://gitlab.com/scripta/escriptorium</a></li>
         </ul>
 
         <h2>Recommendation</h2>
@@ -379,7 +379,7 @@ Names
         </xsl:element>
 
         <xsl:element name="details">
-            <xsl:element name="summary">For escriptorium</xsl:element>
+            <xsl:element name="summary">For eScriptorium</xsl:element>
             <xsl:element name="p">
                 Download the <strong>keyboard text files</strong> and copy or import the files to the appropriate directory.
             </xsl:element>
@@ -396,7 +396,7 @@ Names
                     <xsl:element name="th"><span class="big">&#x2328;</span> Virtual Keyboard Layouts<br/>for Transkribus</xsl:element>
                     <xsl:element name="th"><span class="big">&#x2328;</span> Virtual Keyboard Layouts<br/>for LAREX</xsl:element>
                     <xsl:element name="th"><span class="big">&#x2328;</span> Virtual Keyboard Layouts<br/>for QURATOR-neat</xsl:element>
-                    <xsl:element name="th"><span class="big">&#x2328;</span> Virtual Keyboard Layouts<br/>for escriptorium</xsl:element>
+                    <xsl:element name="th"><span class="big">&#x2328;</span> Virtual Keyboard Layouts<br/>for eScriptorium</xsl:element>
                     <xsl:element name="th"><span class="big">&#x1F481;</span> Browse by code chart<br/>(Link to MUFI)</xsl:element>
                 </xsl:element>
               </xsl:element>