FairCopy v1.2.0-beta.2

.vscode/launch.json

@@ -40,7 +40,7 @@
             "windows": {
                 "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron.cmd"
             },
-            "env": { "FAIRCOPY_DEBUG_MODE": "true", "FAIRCOPY_DEV_VERSION": "1.2.0" },
+            "env": { "FAIRCOPY_DEBUG_MODE": "true", "FAIRCOPY_DEV_VERSION": "1.2.0-dev.8" },
             "program": "${workspaceRoot}/public/electron.js",
             "protocol": "inspector",
         },

README.md

@@ -10,7 +10,7 @@ This README discusses how to set up a development environment on Mac or Windows
 Developer Environment
 -----------
 
-FairCopy can run in development mode on your local machine, which is useful for debugging the application and previewing functionality. This process has been tested on VSCode on both Mac and Windows. To run Faircopy in development mode, install the necessary dependencies using NPM. Next, set the following ENV variables at a minimum, using the .env file:
+FairCopy can run in development mode on your local machine, which is useful for debugging the application and previewing functionality. This process has been tested on VSCode on both Mac and Windows. To run Faircopy in development mode, install the necessary dependencies using NPM (`npm install`). Next, set the following ENV variables at a minimum, using the .env file:
 
 * BROWSER=none
 * PORT=4000 

forge.config.example.js

@@ -1,6 +1,7 @@
 module.exports = {
     packagerConfig: {
       asar: true,
+      icon: './public/icons/icon',
       osxSign: {
         optionsForFile: (filePath) => {
           return {
@@ -20,16 +21,26 @@ module.exports = {
       {
         name: '@electron-forge/maker-dmg',
         config: {
-          background: './public/icon.png',
-          icon: './public/icon.ico',
-          format: 'ULFO'
+          platform: 'darwin',
+          background: './public/img/DMG_background.png',
+          icon: './public/icons/icon.icns',
+          iconSize: 145,
+          format: 'ULFO',
+          contents: [
+              { "x": 480, "y": 220, "type": "link", "path": "/Applications" },
+              { "x": 140, "y": 220, "type": "file", "path": "<YOUR ABSOLUTE PATH TO PROJECT BASE DIR>/out/FairCopy-darwin-x64/FairCopy.app" }
+          ]
         }
       },
       {
         name: '@electron-forge/maker-squirrel',
         config: {
+          loadingGif: './public/img/install_spinner.gif',
+          iconURL: 'https://raw.githubusercontent.com/performant-software/faircopy/main/public/icons/icon.ico',
+          setupIcon: './public/icons/icon.ico',
           certificateFile: 'LOCATION OF APP SIGNING CERTIFICATE',
-          certificatePassword: 'CERTIFICATE PASSWORD'
+          certificatePassword: 'CERTIFICATE PASSWORD',
+          platform: 'win32'
         }
       }
     ],

package.json

@@ -1,6 +1,7 @@
 {
   "name": "faircopy",
-  "version": "1.2.0-beta.1",
+  "productName": "FairCopy",
+  "version": "1.2.0-beta.2",
   "description": "A word processor for the humanities scholar.",
   "main": "public/electron.js",
   "private": true,
@@ -71,7 +72,7 @@
     "react-scroll": "1.8.3",
     "react-split-pane": "^0.1.92",
     "react-spring": "9.5.5",
-    "semver": "^7.3.5",
+    "semver": "^7.6.0",
     "uuid": "^8.1.0",
     "w3c-xmlserializer": "^2.0.0",
     "xml-formatter": "^2.5.0"

public/css/ColorCodingDialog.css

@@ -0,0 +1,25 @@
+#ColorCodingDialog .element-field {
+    display: inline-block;
+}
+
+#ColorCodingDialog .keystroke-record-button {
+    margin-top: 20px;
+}
+
+#ColorCodingDialog .record-icon {
+    margin-right: 5px;
+    color: red;
+}
+
+#ColorCodingDialog .error-message {
+    margin: 5px;
+    color: red;
+}
+
+#ColorCodingDialog .color-block {
+    display: inline-block;
+    min-width: 20px;
+    min-height: 20px;
+    margin-right: 5px;
+    border: 1px solid black;
+}

public/css/ColorCodingTable.css

@@ -0,0 +1,23 @@
+#ColorCodingTable {
+    margin: 20px;
+}
+
+#ColorCodingTable .explanation {
+    margin-bottom: 50px;
+}
+
+#ColorCodingTable th {
+    font-weight: bold;
+}
+
+#ColorCodingTable .add-colorcode-button {
+    margin-top: 10px;
+}
+
+#ColorCodingTable .color-block {
+    display: inline-block;
+    width: 20px;
+    height: 20px;
+    margin-right: 5px;
+    border: 1px solid black;
+}

public/css/EditorSettings.css

@@ -0,0 +1,3 @@
+#EditorSettings {     
+    margin: 50px; 
+}

public/css/ReadOnlyToolbar.css

@@ -9,6 +9,10 @@
     display: inline-block;
 }
 
+#ReadOnlyToolbar .toolbar-button {
+    margin: 0 5px;
+}
+
 #ReadOnlyToolbar .rightgroup {
     display: inline-block;
 }

public/css/TEIElementStyles.css

@@ -13,10 +13,6 @@
     border-bottom: dotted red;
 }
 
-/* Phrase level markup styling is based on information layers */
-[phraselvl = "true"] {
-    border-bottom: dotted #0187a8;
-}
 
 [phraselvl = "false"] {
     margin: 0px;

public/css/index.css

@@ -62,4 +62,7 @@
 @import "KeyBindingsTable.css";
 @import "KeyBindingDialog.css";
 @import "PreviewWindow.css";
-@import "PreviewCSSEditor.css";
+@import "PreviewCSSEditor.css";
+@import "EditorSettings.css";
+@import "ColorCodingTable.css";
+@import "ColorCodingDialog.css";

public/main-process/RemoteProject.js

@@ -55,9 +55,10 @@ class RemoteProject {
                     const { config, configLastAction } = msg
                     const { fairCopyApplication, projectStore } = this.fairCopySession
                     const { baseConfig } = projectStore
+                    const { config: appConfig } = fairCopyApplication
                     const { generatedWith } = projectStore.manifestData
                     // make sure that the incoming config is migrated to the latest schema                    
-                    migrateConfig(generatedWith, baseConfig, config )
+                    migrateConfig(generatedWith, baseConfig, config, appConfig )
                     fairCopyApplication.sendToAllWindows('updateFairCopyConfig', {config, configLastAction} )
                 }
                 break

public/main-process/create-project-archive.js

@@ -23,6 +23,7 @@ const createProjectArchive = function createProjectArchive(projectInfo,baseDir,c
     const fairCopyConfigJSON = fs.readFileSync(`${baseDir}/config/faircopy-config.json`).toString('utf-8')
     const fairCopyConfig = JSON.parse(fairCopyConfigJSON)
     fairCopyConfig.projectCSS = defaultProjectCSS
+    fairCopyConfig.colorCodings = { '__default__': 'blue' }
 
     projectArchive.file(manifestEntryName, JSON.stringify(fairCopyManifest))
     projectArchive.file(configSettingsEntryName, JSON.stringify(fairCopyConfig))

public/main-process/data-migration.js

@@ -3,9 +3,7 @@ const log = require('electron-log')
 const { getBlankResourceMap } = require('./id-map-authority')
 
 function getProjectVersion(generatedWith) {
-    const ver = generatedWith ? generatedWith : '0.9.4'  // this field was added in 0.9.5
-    // ignore any pre-release fields (e.g "1.1.1-dev.8")
-    return `${semver.major(ver)}.${semver.minor(ver)}.${semver.patch(ver)}`
+    return generatedWith ? generatedWith : '0.9.4'  // this field was added in 0.9.5
 }
 
 // project files are backward compatible but not forward compatible
@@ -22,15 +20,9 @@ const migrateConfig = function migrateConfig( generatedWith, baseConfig, project
     migrationRemoveElements(projectConfig,baseConfig)
     migrationAddNewElements(baseConfig,projectConfig)
 
-    if( semver.lt(projectVersion,'1.1.6') ) {
-        migrationAddKeybindings(projectConfig)
-        log.info('applying migrations for v1.1.6')
-    }
-
-    if( semver.lt(projectVersion,'1.2.0') ) {
-        migrationAddProjectCSS(projectConfig,fairCopyAppConfig)
-        log.info('applying migrations for v1.2.0')
-    }
+    migrationAddKeybindings(projectConfig)
+    migrationAddProjectCSS(projectConfig,fairCopyAppConfig)
+    migrationAddColorCodings(projectConfig)
 
     if( semver.lt(projectVersion,'0.10.1') ) {
         migrationAddMenus(projectConfig,baseConfig)
@@ -75,13 +67,23 @@ exports.migrateManifestData = migrateManifestData
 
 //// MIGRATIONS /////////////////////////////////////////////////
 
+function migrationAddColorCodings(projectConfig) {
+    if( !projectConfig.colorCodings ) {
+        projectConfig.colorCodings = { '__default__': 'blue' }
+    }
+}
+
 function migrationAddKeybindings(projectConfig) {
-    projectConfig.keybindings = {}
+    if( !projectConfig.keybindings ) {
+        projectConfig.keybindings = {}
+    }
 }
 
 function migrationAddProjectCSS(projectConfig,fairCopyAppConfig) {
-    const { defaultProjectCSS } = fairCopyAppConfig
-    projectConfig.projectCSS = defaultProjectCSS
+    if( !projectConfig.projectCSS ) {
+        const { defaultProjectCSS } = fairCopyAppConfig
+        projectConfig.projectCSS = defaultProjectCSS    
+    }
 }
 
 function migrationAddNewElements(baseConfig,projectConfig) {