diff --git a/HISTORY.md b/HISTORY.md index 85a383c575..01762fcc2c 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,5 +1,33 @@ # Keyman Version History +## 18.0.118 alpha 2024-09-26 + +* chore(developer): add context/options (#11566) +* chore(deps-dev): bump rollup from 4.16.4 to 4.22.4 (#12462) +* fix(developer): ignore excess whitespace in `` attribute (#12468) +* refactor(common): move help into common prod/docs/help folders (#12424) +* fix(developer): publish developer-utils package during build (#12471) +* fix(linux): ignore additional C++ symbol in API check (#12474) + +## 18.0.117 alpha 2024-09-25 + +* docs(common): Document how to skip generating CDN on websites (#12446) +* fix(android): Remove toggle for "Always Show Banner" (#12430) +* fix(android): Hide suggestion banner on password fields (#12442) +* fix(developer): prevent invalid string ids (#12465) + +## 18.0.116 alpha 2024-09-20 + +* change(mac): remove verbose logging option (#12431) +* chore(common): Allow to build offline (#12439) + +## 18.0.115 alpha 2024-09-19 + +* chore(common): detect ssh remotes in git hooks (#12437) +* fix(common): add proper configure output for hextobin (#12440) +* fix(core): add missing dependency for core (#12438) +* chore(developer): remove .js output from LDML compiler (#12432) + ## 18.0.114 alpha 2024-09-17 * fix(developer): rewrite ldml visual keyboard compiler (#12402) diff --git a/VERSION.md b/VERSION.md index 641f895ef1..49dcd61578 100644 --- a/VERSION.md +++ b/VERSION.md @@ -1 +1 @@ -18.0.115 \ No newline at end of file +18.0.119 \ No newline at end of file diff --git a/android/KMAPro/build-play-store-notes.inc.sh b/android/KMAPro/build-play-store-notes.inc.sh index 04fa876417..56b9a92326 100755 --- a/android/KMAPro/build-play-store-notes.inc.sh +++ b/android/KMAPro/build-play-store-notes.inc.sh @@ -24,7 +24,7 @@ function generateReleaseNotes() { # Pad release notes if whatsnew.md doesn't have any line items # Play Store release notes have a limit of 500 characters local DEFAULT_RELEASE_NOTE="* Additional bug fixes and improvements" - local FILTERED_LINES=$( grep '^\s*\*.*$' "$KEYMAN_ROOT/android/help/about/whatsnew.md" || [[ $? == 1 ]] ) # Continue if grep has no matches + local FILTERED_LINES=$( grep '^\s*\*.*$' "$KEYMAN_ROOT/android/docs/help/about/whatsnew.md" || [[ $? == 1 ]] ) # Continue if grep has no matches if [ -z "$FILTERED_LINES" ]; then FILTERED_LINES="$DEFAULT_RELEASE_NOTE" builder_warn "Warning: whatsnew.md empty so using default release note: '$FILTERED_LINES'" @@ -32,7 +32,7 @@ function generateReleaseNotes() { # Change IFS to new line local old_IFS="${IFS}" - IFS=$'\n' + IFS=$'\n' for line in $FILTERED_LINES do local CHARS_IN_RELEASE_NOTES=$( wc -m < "$PLAY_RELEASE_NOTES" ) diff --git a/android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/KeymanSettingsActivity.java b/android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/KeymanSettingsActivity.java index 86494e929b..7e6dcbe5b1 100644 --- a/android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/KeymanSettingsActivity.java +++ b/android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/KeymanSettingsActivity.java @@ -10,7 +10,6 @@ import androidx.appcompat.widget.Toolbar; public class KeymanSettingsActivity extends BaseActivity { protected static final String installedLanguagesKey = "InstalledLanguages"; protected static final String installKeyboardOrDictionaryKey = "InstallKeyboardOrDictionary"; - protected static final String showBannerKey = "ShowBanner"; protected static final String sendCrashReport = "SendCrashReport"; public static final String spacebarTextKey = "SpacebarText"; public static final String hapticFeedbackKey = "HapticFeedback"; diff --git a/android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/KeymanSettingsFragment.java b/android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/KeymanSettingsFragment.java index 95bb7774b0..59ac59e2f8 100644 --- a/android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/KeymanSettingsFragment.java +++ b/android/KMAPro/kMAPro/src/main/java/com/tavultesoft/kmapro/KeymanSettingsFragment.java @@ -178,12 +178,6 @@ public class KeymanSettingsFragment extends PreferenceFragmentCompat { editor.putBoolean(KeymanSettingsActivity.showBannerKey, isChecked); as part of the default onClick() used by SwitchPreference. */ - SwitchPreference bannerPreference = new SwitchPreference(context); - bannerPreference.setKey(KeymanSettingsActivity.showBannerKey); - bannerPreference.setTitle(getString(R.string.show_banner)); - bannerPreference.setSummaryOn(getString(R.string.show_banner_on)); - bannerPreference.setSummaryOff(getString(R.string.show_banner_off)); - SwitchPreference getStartedPreference = new SwitchPreference(context); getStartedPreference.setKey(GetStartedActivity.showGetStartedKey); getStartedPreference.setTitle(String.format(getString(R.string.show_get_started), getString(R.string.get_started))); @@ -207,7 +201,6 @@ public class KeymanSettingsFragment extends PreferenceFragmentCompat { screen.addPreference(spacebarTextPreference); screen.addPreference(hapticFeedbackPreference); - screen.addPreference(bannerPreference); screen.addPreference(getStartedPreference); screen.addPreference(sendCrashReportPreference); diff --git a/android/KMAPro/kMAPro/src/main/res/values/strings.xml b/android/KMAPro/kMAPro/src/main/res/values/strings.xml index a1f9e7240d..01546f91ba 100644 --- a/android/KMAPro/kMAPro/src/main/res/values/strings.xml +++ b/android/KMAPro/kMAPro/src/main/res/values/strings.xml @@ -147,13 +147,13 @@ Vibrate when typing - + Always show banner - + To be implemented - + When off, only shown when predictive text is enabled diff --git a/android/help/about/history.md b/android/docs/help/about/history.md similarity index 100% rename from android/help/about/history.md rename to android/docs/help/about/history.md diff --git a/android/help/about/index.md b/android/docs/help/about/index.md similarity index 100% rename from android/help/about/index.md rename to android/docs/help/about/index.md diff --git a/android/help/about/privacy.md b/android/docs/help/about/privacy.md similarity index 100% rename from android/help/about/privacy.md rename to android/docs/help/about/privacy.md diff --git a/android/help/about/system-requirements.md b/android/docs/help/about/system-requirements.md similarity index 100% rename from android/help/about/system-requirements.md rename to android/docs/help/about/system-requirements.md diff --git a/android/help/about/welcome.md b/android/docs/help/about/welcome.md similarity index 100% rename from android/help/about/welcome.md rename to android/docs/help/about/welcome.md diff --git a/android/help/about/whatsnew.md b/android/docs/help/about/whatsnew.md similarity index 100% rename from android/help/about/whatsnew.md rename to android/docs/help/about/whatsnew.md diff --git a/android/help/android_images/adjust-height.png b/android/docs/help/android_images/adjust-height.png similarity index 100% rename from android/help/android_images/adjust-height.png rename to android/docs/help/android_images/adjust-height.png diff --git a/android/help/android_images/backspace-ap.png b/android/docs/help/android_images/backspace-ap.png similarity index 100% rename from android/help/android_images/backspace-ap.png rename to android/docs/help/android_images/backspace-ap.png diff --git a/android/help/android_images/backspace-at.png b/android/docs/help/android_images/backspace-at.png similarity index 100% rename from android/help/android_images/backspace-at.png rename to android/docs/help/android_images/backspace-at.png diff --git a/android/help/android_images/blank-osk.png b/android/docs/help/android_images/blank-osk.png similarity index 100% rename from android/help/android_images/blank-osk.png rename to android/docs/help/android_images/blank-osk.png diff --git a/android/help/android_images/browser-a.png b/android/docs/help/android_images/browser-a.png similarity index 100% rename from android/help/android_images/browser-a.png rename to android/docs/help/android_images/browser-a.png diff --git a/android/help/android_images/confirm-english-dictionary-delete-ap.png b/android/docs/help/android_images/confirm-english-dictionary-delete-ap.png similarity index 100% rename from android/help/android_images/confirm-english-dictionary-delete-ap.png rename to android/docs/help/android_images/confirm-english-dictionary-delete-ap.png diff --git a/android/help/android_images/confirm-khmer-delete-ap.png b/android/docs/help/android_images/confirm-khmer-delete-ap.png similarity index 100% rename from android/help/android_images/confirm-khmer-delete-ap.png rename to android/docs/help/android_images/confirm-khmer-delete-ap.png diff --git a/android/help/android_images/delete-a.png b/android/docs/help/android_images/delete-a.png similarity index 100% rename from android/help/android_images/delete-a.png rename to android/docs/help/android_images/delete-a.png diff --git a/android/help/android_images/dist-file-browser-ap.png b/android/docs/help/android_images/dist-file-browser-ap.png similarity index 100% rename from android/help/android_images/dist-file-browser-ap.png rename to android/docs/help/android_images/dist-file-browser-ap.png diff --git a/android/help/android_images/dist-file-browser-at.png b/android/docs/help/android_images/dist-file-browser-at.png similarity index 100% rename from android/help/android_images/dist-file-browser-at.png rename to android/docs/help/android_images/dist-file-browser-at.png diff --git a/android/help/android_images/dist-install1-ap.png b/android/docs/help/android_images/dist-install1-ap.png similarity index 100% rename from android/help/android_images/dist-install1-ap.png rename to android/docs/help/android_images/dist-install1-ap.png diff --git a/android/help/android_images/dist-install1-at.png b/android/docs/help/android_images/dist-install1-at.png similarity index 100% rename from android/help/android_images/dist-install1-at.png rename to android/docs/help/android_images/dist-install1-at.png diff --git a/android/help/android_images/dist-storage-permission-ap.png b/android/docs/help/android_images/dist-storage-permission-ap.png similarity index 100% rename from android/help/android_images/dist-storage-permission-ap.png rename to android/docs/help/android_images/dist-storage-permission-ap.png diff --git a/android/help/android_images/dist-storage-permission-at.png b/android/docs/help/android_images/dist-storage-permission-at.png similarity index 100% rename from android/help/android_images/dist-storage-permission-at.png rename to android/docs/help/android_images/dist-storage-permission-at.png diff --git a/android/help/android_images/dist-url-screen-ap.png b/android/docs/help/android_images/dist-url-screen-ap.png similarity index 100% rename from android/help/android_images/dist-url-screen-ap.png rename to android/docs/help/android_images/dist-url-screen-ap.png diff --git a/android/help/android_images/dist-url-screen-at.png b/android/docs/help/android_images/dist-url-screen-at.png similarity index 100% rename from android/help/android_images/dist-url-screen-at.png rename to android/docs/help/android_images/dist-url-screen-at.png diff --git a/android/help/android_images/dl-success-ap.png b/android/docs/help/android_images/dl-success-ap.png similarity index 100% rename from android/help/android_images/dl-success-ap.png rename to android/docs/help/android_images/dl-success-ap.png diff --git a/android/help/android_images/english-dictionaries-ap.png b/android/docs/help/android_images/english-dictionaries-ap.png similarity index 100% rename from android/help/android_images/english-dictionaries-ap.png rename to android/docs/help/android_images/english-dictionaries-ap.png diff --git a/android/help/android_images/english-dictionary-info-ap.png b/android/docs/help/android_images/english-dictionary-info-ap.png similarity index 100% rename from android/help/android_images/english-dictionary-info-ap.png rename to android/docs/help/android_images/english-dictionary-info-ap.png diff --git a/android/help/android_images/english-settings-ap.png b/android/docs/help/android_images/english-settings-ap.png similarity index 100% rename from android/help/android_images/english-settings-ap.png rename to android/docs/help/android_images/english-settings-ap.png diff --git a/android/help/android_images/font-size-a.png b/android/docs/help/android_images/font-size-a.png similarity index 100% rename from android/help/android_images/font-size-a.png rename to android/docs/help/android_images/font-size-a.png diff --git a/android/help/android_images/get-started-a.png b/android/docs/help/android_images/get-started-a.png similarity index 100% rename from android/help/android_images/get-started-a.png rename to android/docs/help/android_images/get-started-a.png diff --git a/android/help/android_images/globe-ap.png b/android/docs/help/android_images/globe-ap.png similarity index 100% rename from android/help/android_images/globe-ap.png rename to android/docs/help/android_images/globe-ap.png diff --git a/android/help/android_images/globe-at.png b/android/docs/help/android_images/globe-at.png similarity index 100% rename from android/help/android_images/globe-at.png rename to android/docs/help/android_images/globe-at.png diff --git a/android/help/android_images/hide-keyboard-ap.png b/android/docs/help/android_images/hide-keyboard-ap.png similarity index 100% rename from android/help/android_images/hide-keyboard-ap.png rename to android/docs/help/android_images/hide-keyboard-ap.png diff --git a/android/help/android_images/hide-keyboard-at.png b/android/docs/help/android_images/hide-keyboard-at.png similarity index 100% rename from android/help/android_images/hide-keyboard-at.png rename to android/docs/help/android_images/hide-keyboard-at.png diff --git a/android/help/android_images/ic_cloud_download.png b/android/docs/help/android_images/ic_cloud_download.png similarity index 100% rename from android/help/android_images/ic_cloud_download.png rename to android/docs/help/android_images/ic_cloud_download.png diff --git a/android/help/android_images/ic_content_add.png b/android/docs/help/android_images/ic_content_add.png similarity index 100% rename from android/help/android_images/ic_content_add.png rename to android/docs/help/android_images/ic_content_add.png diff --git a/android/help/android_images/ic_timelapse.png b/android/docs/help/android_images/ic_timelapse.png similarity index 100% rename from android/help/android_images/ic_timelapse.png rename to android/docs/help/android_images/ic_timelapse.png diff --git a/android/help/android_images/ic_translate_a.png b/android/docs/help/android_images/ic_translate_a.png similarity index 100% rename from android/help/android_images/ic_translate_a.png rename to android/docs/help/android_images/ic_translate_a.png diff --git a/android/help/android_images/info-a-gray.png b/android/docs/help/android_images/info-a-gray.png similarity index 100% rename from android/help/android_images/info-a-gray.png rename to android/docs/help/android_images/info-a-gray.png diff --git a/android/help/android_images/info-a.png b/android/docs/help/android_images/info-a.png similarity index 100% rename from android/help/android_images/info-a.png rename to android/docs/help/android_images/info-a.png diff --git a/android/help/android_images/keyman-storage-permission-34b.png b/android/docs/help/android_images/keyman-storage-permission-34b.png similarity index 100% rename from android/help/android_images/keyman-storage-permission-34b.png rename to android/docs/help/android_images/keyman-storage-permission-34b.png diff --git a/android/help/android_images/keyman-storage-permission-ap.png b/android/docs/help/android_images/keyman-storage-permission-ap.png similarity index 100% rename from android/help/android_images/keyman-storage-permission-ap.png rename to android/docs/help/android_images/keyman-storage-permission-ap.png diff --git a/android/help/android_images/keyman-storage-permission-at.png b/android/docs/help/android_images/keyman-storage-permission-at.png similarity index 100% rename from android/help/android_images/keyman-storage-permission-at.png rename to android/docs/help/android_images/keyman-storage-permission-at.png diff --git a/android/help/android_images/khmer-downloading-a.png b/android/docs/help/android_images/khmer-downloading-a.png similarity index 100% rename from android/help/android_images/khmer-downloading-a.png rename to android/docs/help/android_images/khmer-downloading-a.png diff --git a/android/help/android_images/khmer-install-a.png b/android/docs/help/android_images/khmer-install-a.png similarity index 100% rename from android/help/android_images/khmer-install-a.png rename to android/docs/help/android_images/khmer-install-a.png diff --git a/android/help/android_images/khmer-readme-a.png b/android/docs/help/android_images/khmer-readme-a.png similarity index 100% rename from android/help/android_images/khmer-readme-a.png rename to android/docs/help/android_images/khmer-readme-a.png diff --git a/android/help/android_images/khmer-search-a.png b/android/docs/help/android_images/khmer-search-a.png similarity index 100% rename from android/help/android_images/khmer-search-a.png rename to android/docs/help/android_images/khmer-search-a.png diff --git a/android/help/android_images/khmer-settings-ap.png b/android/docs/help/android_images/khmer-settings-ap.png similarity index 100% rename from android/help/android_images/khmer-settings-ap.png rename to android/docs/help/android_images/khmer-settings-ap.png diff --git a/android/help/android_images/khmer-welcome-a.png b/android/docs/help/android_images/khmer-welcome-a.png similarity index 100% rename from android/help/android_images/khmer-welcome-a.png rename to android/docs/help/android_images/khmer-welcome-a.png diff --git a/android/help/android_images/longpress-slider.png b/android/docs/help/android_images/longpress-slider.png similarity index 100% rename from android/help/android_images/longpress-slider.png rename to android/docs/help/android_images/longpress-slider.png diff --git a/android/help/android_images/menu-icon-a.png b/android/docs/help/android_images/menu-icon-a.png similarity index 100% rename from android/help/android_images/menu-icon-a.png rename to android/docs/help/android_images/menu-icon-a.png diff --git a/android/help/android_images/other-input-methods.png b/android/docs/help/android_images/other-input-methods.png similarity index 100% rename from android/help/android_images/other-input-methods.png rename to android/docs/help/android_images/other-input-methods.png diff --git a/android/help/android_images/plus-a.png b/android/docs/help/android_images/plus-a.png similarity index 100% rename from android/help/android_images/plus-a.png rename to android/docs/help/android_images/plus-a.png diff --git a/android/help/android_images/reset-to-default.png b/android/docs/help/android_images/reset-to-default.png similarity index 100% rename from android/help/android_images/reset-to-default.png rename to android/docs/help/android_images/reset-to-default.png diff --git a/android/help/android_images/return-ap.png b/android/docs/help/android_images/return-ap.png similarity index 100% rename from android/help/android_images/return-ap.png rename to android/docs/help/android_images/return-ap.png diff --git a/android/help/android_images/return-at.png b/android/docs/help/android_images/return-at.png similarity index 100% rename from android/help/android_images/return-at.png rename to android/docs/help/android_images/return-at.png diff --git a/android/help/android_images/return.png b/android/docs/help/android_images/return.png similarity index 100% rename from android/help/android_images/return.png rename to android/docs/help/android_images/return.png diff --git a/android/help/android_images/select_language.png b/android/docs/help/android_images/select_language.png similarity index 100% rename from android/help/android_images/select_language.png rename to android/docs/help/android_images/select_language.png diff --git a/android/help/android_images/settings-2-installed-languages-ap.png b/android/docs/help/android_images/settings-2-installed-languages-ap.png similarity index 100% rename from android/help/android_images/settings-2-installed-languages-ap.png rename to android/docs/help/android_images/settings-2-installed-languages-ap.png diff --git a/android/help/android_images/settings-a.png b/android/docs/help/android_images/settings-a.png similarity index 100% rename from android/help/android_images/settings-a.png rename to android/docs/help/android_images/settings-a.png diff --git a/android/help/android_images/settings-download-dictionary-background-ap.png b/android/docs/help/android_images/settings-download-dictionary-background-ap.png similarity index 100% rename from android/help/android_images/settings-download-dictionary-background-ap.png rename to android/docs/help/android_images/settings-download-dictionary-background-ap.png diff --git a/android/help/android_images/settings-download-str-dictionary-ap.png b/android/docs/help/android_images/settings-download-str-dictionary-ap.png similarity index 100% rename from android/help/android_images/settings-download-str-dictionary-ap.png rename to android/docs/help/android_images/settings-download-str-dictionary-ap.png diff --git a/android/help/android_images/settings-khmer-info-ap.png b/android/docs/help/android_images/settings-khmer-info-ap.png similarity index 100% rename from android/help/android_images/settings-khmer-info-ap.png rename to android/docs/help/android_images/settings-khmer-info-ap.png diff --git a/android/help/android_images/settings-language-ap.png b/android/docs/help/android_images/settings-language-ap.png similarity index 100% rename from android/help/android_images/settings-language-ap.png rename to android/docs/help/android_images/settings-language-ap.png diff --git a/android/help/android_images/settings-languages-ap.png b/android/docs/help/android_images/settings-languages-ap.png similarity index 100% rename from android/help/android_images/settings-languages-ap.png rename to android/docs/help/android_images/settings-languages-ap.png diff --git a/android/docs/help/android_images/settings-screen-ap.png b/android/docs/help/android_images/settings-screen-ap.png new file mode 100644 index 0000000000..f83da38040 Binary files /dev/null and b/android/docs/help/android_images/settings-screen-ap.png differ diff --git a/android/help/android_images/settings-screen-install-keyboard-dictionary.png b/android/docs/help/android_images/settings-screen-install-keyboard-dictionary.png similarity index 100% rename from android/help/android_images/settings-screen-install-keyboard-dictionary.png rename to android/docs/help/android_images/settings-screen-install-keyboard-dictionary.png diff --git a/android/help/android_images/settings-str-dictionary-ap.png b/android/docs/help/android_images/settings-str-dictionary-ap.png similarity index 100% rename from android/help/android_images/settings-str-dictionary-ap.png rename to android/docs/help/android_images/settings-str-dictionary-ap.png diff --git a/android/help/android_images/settings-str-settings-ap.png b/android/docs/help/android_images/settings-str-settings-ap.png similarity index 100% rename from android/help/android_images/settings-str-settings-ap.png rename to android/docs/help/android_images/settings-str-settings-ap.png diff --git a/android/help/android_images/settings-suggestions-ap.png b/android/docs/help/android_images/settings-suggestions-ap.png similarity index 100% rename from android/help/android_images/settings-suggestions-ap.png rename to android/docs/help/android_images/settings-suggestions-ap.png diff --git a/android/help/android_images/settings-two-installed-languages-ap.png b/android/docs/help/android_images/settings-two-installed-languages-ap.png similarity index 100% rename from android/help/android_images/settings-two-installed-languages-ap.png rename to android/docs/help/android_images/settings-two-installed-languages-ap.png diff --git a/android/help/android_images/settings1-ap.png b/android/docs/help/android_images/settings1-ap.png similarity index 100% rename from android/help/android_images/settings1-ap.png rename to android/docs/help/android_images/settings1-ap.png diff --git a/android/help/android_images/settings1-at.png b/android/docs/help/android_images/settings1-at.png similarity index 100% rename from android/help/android_images/settings1-at.png rename to android/docs/help/android_images/settings1-at.png diff --git a/android/help/android_images/settings2-ap.png b/android/docs/help/android_images/settings2-ap.png similarity index 100% rename from android/help/android_images/settings2-ap.png rename to android/docs/help/android_images/settings2-ap.png diff --git a/android/help/android_images/settings2-at.png b/android/docs/help/android_images/settings2-at.png similarity index 100% rename from android/help/android_images/settings2-at.png rename to android/docs/help/android_images/settings2-at.png diff --git a/android/help/android_images/settings3-ap.png b/android/docs/help/android_images/settings3-ap.png similarity index 100% rename from android/help/android_images/settings3-ap.png rename to android/docs/help/android_images/settings3-ap.png diff --git a/android/help/android_images/settings3-at.png b/android/docs/help/android_images/settings3-at.png similarity index 100% rename from android/help/android_images/settings3-at.png rename to android/docs/help/android_images/settings3-at.png diff --git a/android/help/android_images/settings4-ap.png b/android/docs/help/android_images/settings4-ap.png similarity index 100% rename from android/help/android_images/settings4-ap.png rename to android/docs/help/android_images/settings4-ap.png diff --git a/android/help/android_images/settings4-at.png b/android/docs/help/android_images/settings4-at.png similarity index 100% rename from android/help/android_images/settings4-at.png rename to android/docs/help/android_images/settings4-at.png diff --git a/android/help/android_images/settings5-ap.png b/android/docs/help/android_images/settings5-ap.png similarity index 100% rename from android/help/android_images/settings5-ap.png rename to android/docs/help/android_images/settings5-ap.png diff --git a/android/help/android_images/settings5-at.png b/android/docs/help/android_images/settings5-at.png similarity index 100% rename from android/help/android_images/settings5-at.png rename to android/docs/help/android_images/settings5-at.png diff --git a/android/help/android_images/settings6-ap.png b/android/docs/help/android_images/settings6-ap.png similarity index 100% rename from android/help/android_images/settings6-ap.png rename to android/docs/help/android_images/settings6-ap.png diff --git a/android/help/android_images/settings6-at.png b/android/docs/help/android_images/settings6-at.png similarity index 100% rename from android/help/android_images/settings6-at.png rename to android/docs/help/android_images/settings6-at.png diff --git a/android/help/android_images/settings7-ap.png b/android/docs/help/android_images/settings7-ap.png similarity index 100% rename from android/help/android_images/settings7-ap.png rename to android/docs/help/android_images/settings7-ap.png diff --git a/android/help/android_images/settings7-at.png b/android/docs/help/android_images/settings7-at.png similarity index 100% rename from android/help/android_images/settings7-at.png rename to android/docs/help/android_images/settings7-at.png diff --git a/android/help/android_images/share-a.png b/android/docs/help/android_images/share-a.png similarity index 100% rename from android/help/android_images/share-a.png rename to android/docs/help/android_images/share-a.png diff --git a/android/help/android_images/shift-ap.png b/android/docs/help/android_images/shift-ap.png similarity index 100% rename from android/help/android_images/shift-ap.png rename to android/docs/help/android_images/shift-ap.png diff --git a/android/help/android_images/shift-at.png b/android/docs/help/android_images/shift-at.png similarity index 100% rename from android/help/android_images/shift-at.png rename to android/docs/help/android_images/shift-at.png diff --git a/android/help/android_images/spacebar-caption-ap.png b/android/docs/help/android_images/spacebar-caption-ap.png similarity index 100% rename from android/help/android_images/spacebar-caption-ap.png rename to android/docs/help/android_images/spacebar-caption-ap.png diff --git a/android/help/android_images/themed-banner.png b/android/docs/help/android_images/themed-banner.png similarity index 100% rename from android/help/android_images/themed-banner.png rename to android/docs/help/android_images/themed-banner.png diff --git a/android/help/android_images/touch-hold-ap.png b/android/docs/help/android_images/touch-hold-ap.png similarity index 100% rename from android/help/android_images/touch-hold-ap.png rename to android/docs/help/android_images/touch-hold-ap.png diff --git a/android/help/android_images/touch-hold-at.png b/android/docs/help/android_images/touch-hold-at.png similarity index 100% rename from android/help/android_images/touch-hold-at.png rename to android/docs/help/android_images/touch-hold-at.png diff --git a/android/help/android_images/uninstall-dictionary-notification-ap.png b/android/docs/help/android_images/uninstall-dictionary-notification-ap.png similarity index 100% rename from android/help/android_images/uninstall-dictionary-notification-ap.png rename to android/docs/help/android_images/uninstall-dictionary-notification-ap.png diff --git a/android/help/android_images/uninstall-notification-ap.png b/android/docs/help/android_images/uninstall-notification-ap.png similarity index 100% rename from android/help/android_images/uninstall-notification-ap.png rename to android/docs/help/android_images/uninstall-notification-ap.png diff --git a/android/help/android_images/uninstall-notification-at.png b/android/docs/help/android_images/uninstall-notification-at.png similarity index 100% rename from android/help/android_images/uninstall-notification-at.png rename to android/docs/help/android_images/uninstall-notification-at.png diff --git a/android/help/android_images/video.png b/android/docs/help/android_images/video.png similarity index 100% rename from android/help/android_images/video.png rename to android/docs/help/android_images/video.png diff --git a/android/help/basic/config/adjust-keyboard-height.md b/android/docs/help/basic/config/adjust-keyboard-height.md similarity index 100% rename from android/help/basic/config/adjust-keyboard-height.md rename to android/docs/help/basic/config/adjust-keyboard-height.md diff --git a/android/help/basic/config/adjust-longpress-delay.md b/android/docs/help/basic/config/adjust-longpress-delay.md similarity index 100% rename from android/help/basic/config/adjust-longpress-delay.md rename to android/docs/help/basic/config/adjust-longpress-delay.md diff --git a/android/help/basic/config/index.md b/android/docs/help/basic/config/index.md similarity index 91% rename from android/help/basic/config/index.md rename to android/docs/help/basic/config/index.md index 4d55e98839..96a3fb5e35 100644 --- a/android/help/basic/config/index.md +++ b/android/docs/help/basic/config/index.md @@ -55,11 +55,6 @@ Click on this to [change the displayed keyboard name](spacebar-caption) on the s ## Vibrate When Typing When enabled, the Keyman keyboard will provide haptic feedback (vibrate) when the user presses a key and generates output. The default preference is off. -## Always show banner -This toggle is reserved for future features. When off, the text suggestion banner is only displayed when -the dictionary is enabled. The language associated with the keyboard must match the language associated with -the dictionary. - ## Show "Get Started" on startup When enabled, the Keyman app will display the 'Get Started' screen on app startup. diff --git a/android/help/basic/config/install-keyboard-or-dictionary.md b/android/docs/help/basic/config/install-keyboard-or-dictionary.md similarity index 100% rename from android/help/basic/config/install-keyboard-or-dictionary.md rename to android/docs/help/basic/config/install-keyboard-or-dictionary.md diff --git a/android/help/basic/config/spacebar-caption.md b/android/docs/help/basic/config/spacebar-caption.md similarity index 100% rename from android/help/basic/config/spacebar-caption.md rename to android/docs/help/basic/config/spacebar-caption.md diff --git a/android/help/basic/index.md b/android/docs/help/basic/index.md similarity index 100% rename from android/help/basic/index.md rename to android/docs/help/basic/index.md diff --git a/android/help/basic/installing-custom-packages.md b/android/docs/help/basic/installing-custom-packages.md similarity index 100% rename from android/help/basic/installing-custom-packages.md rename to android/docs/help/basic/installing-custom-packages.md diff --git a/android/help/basic/installing-dictionaries.md b/android/docs/help/basic/installing-dictionaries.md similarity index 100% rename from android/help/basic/installing-dictionaries.md rename to android/docs/help/basic/installing-dictionaries.md diff --git a/android/help/basic/switching-between-keyboards.md b/android/docs/help/basic/switching-between-keyboards.md similarity index 100% rename from android/help/basic/switching-between-keyboards.md rename to android/docs/help/basic/switching-between-keyboards.md diff --git a/android/help/basic/uninstalling-dictionaries.md b/android/docs/help/basic/uninstalling-dictionaries.md similarity index 100% rename from android/help/basic/uninstalling-dictionaries.md rename to android/docs/help/basic/uninstalling-dictionaries.md diff --git a/android/help/basic/uninstalling-keyboards.md b/android/docs/help/basic/uninstalling-keyboards.md similarity index 100% rename from android/help/basic/uninstalling-keyboards.md rename to android/docs/help/basic/uninstalling-keyboards.md diff --git a/android/help/basic/using-the-banner.md b/android/docs/help/basic/using-the-banner.md similarity index 100% rename from android/help/basic/using-the-banner.md rename to android/docs/help/basic/using-the-banner.md diff --git a/android/help/context/gestures.md b/android/docs/help/context/gestures.md similarity index 100% rename from android/help/context/gestures.md rename to android/docs/help/context/gestures.md diff --git a/android/help/context/index.md b/android/docs/help/context/index.md similarity index 100% rename from android/help/context/index.md rename to android/docs/help/context/index.md diff --git a/android/help/context/menu-phone.md b/android/docs/help/context/menu-phone.md similarity index 100% rename from android/help/context/menu-phone.md rename to android/docs/help/context/menu-phone.md diff --git a/android/help/context/menu-tablet.md b/android/docs/help/context/menu-tablet.md similarity index 100% rename from android/help/context/menu-tablet.md rename to android/docs/help/context/menu-tablet.md diff --git a/android/help/index.md b/android/docs/help/index.md similarity index 100% rename from android/help/index.md rename to android/docs/help/index.md diff --git a/android/help/start/enabling-system-keyboard.md b/android/docs/help/start/enabling-system-keyboard.md similarity index 100% rename from android/help/start/enabling-system-keyboard.md rename to android/docs/help/start/enabling-system-keyboard.md diff --git a/android/help/start/index.md b/android/docs/help/start/index.md similarity index 100% rename from android/help/start/index.md rename to android/docs/help/start/index.md diff --git a/android/help/start/installing-keyboards.md b/android/docs/help/start/installing-keyboards.md similarity index 100% rename from android/help/start/installing-keyboards.md rename to android/docs/help/start/installing-keyboards.md diff --git a/android/help/troubleshooting/grant-storage-permission.md b/android/docs/help/troubleshooting/grant-storage-permission.md similarity index 100% rename from android/help/troubleshooting/grant-storage-permission.md rename to android/docs/help/troubleshooting/grant-storage-permission.md diff --git a/android/help/troubleshooting/index.md b/android/docs/help/troubleshooting/index.md similarity index 100% rename from android/help/troubleshooting/index.md rename to android/docs/help/troubleshooting/index.md diff --git a/android/help/troubleshooting/integrating.md b/android/docs/help/troubleshooting/integrating.md similarity index 100% rename from android/help/troubleshooting/integrating.md rename to android/docs/help/troubleshooting/integrating.md diff --git a/android/help/troubleshooting/keyboard-help.md b/android/docs/help/troubleshooting/keyboard-help.md similarity index 100% rename from android/help/troubleshooting/keyboard-help.md rename to android/docs/help/troubleshooting/keyboard-help.md diff --git a/android/help/android_images/settings-screen-ap.png b/android/help/android_images/settings-screen-ap.png deleted file mode 100644 index f316fefd73..0000000000 Binary files a/android/help/android_images/settings-screen-ap.png and /dev/null differ diff --git a/common/tools/hextobin/build.sh b/common/tools/hextobin/build.sh index c1e2338e9d..9e73f8c410 100755 --- a/common/tools/hextobin/build.sh +++ b/common/tools/hextobin/build.sh @@ -11,7 +11,7 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")" builder_describe "Build hextobin" clean configure build builder_describe_outputs \ - configure /node_modules \ + configure /common/tools/hextobin/node_modules/commander \ build /common/tools/hextobin/build/index.js builder_parse "$@" diff --git a/developer/src/build.sh b/developer/src/build.sh index c85851f1f6..cde9b7fc23 100755 --- a/developer/src/build.sh +++ b/developer/src/build.sh @@ -149,6 +149,7 @@ function do_publish() { DRY_RUN=--dry-run fi + ./common/web/utils/build.sh publish $DRY_RUN $NPM_PUBLISH ../../common/web/keyman-version/build.sh publish $DRY_RUN $NPM_PUBLISH ../../common/web/types/build.sh publish $DRY_RUN $NPM_PUBLISH ../../core/include/ldml/build.sh publish $DRY_RUN $NPM_PUBLISH diff --git a/developer/src/kmc-ldml/src/compiler/compiler.ts b/developer/src/kmc-ldml/src/compiler/compiler.ts index cbaf2cad37..388a64de69 100644 --- a/developer/src/kmc-ldml/src/compiler/compiler.ts +++ b/developer/src/kmc-ldml/src/compiler/compiler.ts @@ -30,7 +30,6 @@ import { KmnCompiler } from '@keymanapp/kmc-kmn'; import { KMXPlusMetadataCompiler } from './metadata-compiler.js'; import { LdmlKeyboardVisualKeyboardCompiler } from './visual-keyboard-compiler.js'; import { LinterKeycaps } from './linter-keycaps.js'; -//KMW17.0: import { LdmlKeyboardKeymanWebCompiler } from './keymanweb-compiler.js'; export const SECTION_COMPILERS = [ // These are in dependency order. @@ -73,11 +72,6 @@ export interface LdmlKeyboardCompilerArtifacts extends KeymanCompilerArtifacts { * desktop projects alongside .kmx */ kvk?: KeymanCompilerArtifactOptional; - /** - * Javascript keyboard filedata and filename - installable into KeymanWeb, - * Keyman mobile products - */ - js?: KeymanCompilerArtifactOptional; }; export interface LdmlKeyboardCompilerResult extends KeymanCompilerResult { @@ -90,7 +84,7 @@ export interface LdmlKeyboardCompilerResult extends KeymanCompilerResult { /** * @public - * Compiles a LDML keyboard .xml file to a .kmx (KMXPlus), .kvk, and/or .js. The + * Compiles a LDML keyboard .xml file to a .kmx (KMXPlus), .kvk. The * compiler does not read or write from filesystem or network directly, but * relies on callbacks for all external IO. */ @@ -116,7 +110,7 @@ export class LdmlKeyboardCompiler implements KeymanCompiler { } /** - * Compiles a LDML keyboard .xml file to .kmx, .kvk, and/or .js files. Returns + * Compiles a LDML keyboard .xml file to .kmx, .kvk files. Returns * an object containing binary artifacts on success. The files are passed in * by name, and the compiler will use callbacks as passed to the * {@link LdmlKeyboardCompiler.init} function to read any input files by disk. @@ -186,7 +180,6 @@ export class LdmlKeyboardCompiler implements KeymanCompiler { artifacts: { kmx: { data: kmxBinary, filename: outputFilename }, kvk: kvkBinary ? { data: kvkBinary, filename: outputFilename.replace(/\.kmx$/, '.kvk') } : null, - //KMW17.0: js: { data: kmw_binary, filename: outputFilename.replace(/\.kmx$/, '.js') }, } }; } @@ -197,7 +190,6 @@ export class LdmlKeyboardCompiler implements KeymanCompiler { * * - .kmx file - binary keyboard used by Keyman on desktop platforms * - .kvk file - binary on screen keyboard used by Keyman on desktop platforms - * - .js file - Javascript keyboard for web and touch platforms * * @param artifacts - object containing artifact binary data to write out * @returns true on success @@ -211,10 +203,6 @@ export class LdmlKeyboardCompiler implements KeymanCompiler { this.callbacks.fs.writeFileSync(artifacts.kvk.filename, artifacts.kvk.data); } - if (artifacts.js) { - this.callbacks.fs.writeFileSync(artifacts.js.filename, artifacts.js.data); - } - return true; } diff --git a/developer/src/kmc-ldml/src/compiler/layr.ts b/developer/src/kmc-ldml/src/compiler/layr.ts index 62f8b3360d..6c945a1864 100644 --- a/developer/src/kmc-ldml/src/compiler/layr.ts +++ b/developer/src/kmc-ldml/src/compiler/layr.ts @@ -63,7 +63,7 @@ export class LayrCompiler extends SectionCompiler { for (const layer of layers.layer) { const rows = layer.row.map((row) => { const erow: LayrRow = { - keys: row.keys.split(' ').map((id) => sections.strs.allocString(id)), + keys: row.keys.trim().split(/[ \t]+/).map((id) => sections.strs.allocString(id)), }; return erow; }); diff --git a/developer/src/kmc-ldml/src/compiler/ldml-compiler-messages.ts b/developer/src/kmc-ldml/src/compiler/ldml-compiler-messages.ts index 1b6752bdee..901f4b0022 100644 --- a/developer/src/kmc-ldml/src/compiler/ldml-compiler-messages.ts +++ b/developer/src/kmc-ldml/src/compiler/ldml-compiler-messages.ts @@ -187,7 +187,13 @@ export class LdmlCompilerMessages { static Error_UnparseableReorderSet = (o: { from: string, set: string }) => m(this.ERROR_UnparseableReorderSet, `Illegal UnicodeSet "${def(o.set)}" in reorder "${def(o.from)}`); - // Available: 0x029 + static ERROR_InvalidVariableIdentifer = SevError | 0x0029; + static Error_InvalidVariableIdentifer = (o: { id: string }) => m( + this.ERROR_InvalidVariableIdentifer, + `Invalid variable identifier "\\u${def(o.id)}". Identifiers must be between 1 and 32 characters, and can use A-Z, a-z, 0-9, and _.`, + ); + + // Available: 0x02A-0x2F static ERROR_InvalidQuadEscape = SevError | 0x0030; static Error_InvalidQuadEscape = (o: { cp: number }) => @@ -202,9 +208,12 @@ export class LdmlCompilerMessages { m(this.ERROR_UnparseableTransformFrom, `Invalid transform from="${def(o.from)}": "${def(o.message)}"`); static ERROR_IllegalTransformDollarsign = SevErrorTransform | 0x01; - static Error_IllegalTransformDollarsign = (o: { from: string }) => - m(this.ERROR_IllegalTransformDollarsign, `Invalid transform from="${def(o.from)}": Unescaped dollar-sign ($) is not valid transform syntax.`, - '**Hint**: Use `\\$` to match a literal dollar-sign.'); + static Error_IllegalTransformDollarsign = (o: { from: string }) => m( + this.ERROR_IllegalTransformDollarsign, + `Invalid transform from="${def(o.from)}": Unescaped dollar-sign ($) is not valid transform syntax.`, + `**Hint**: Use \`\\$\` to match a literal dollar-sign. If this precedes a variable name, `+ + `the variable name may not be valid (A-Z, a-z, 0-9, _, 32 character maximum).` + ); static ERROR_TransformFromMatchesNothing = SevErrorTransform | 0x02; static Error_TransformFromMatchesNothing = (o: { from: string }) => diff --git a/developer/src/kmc-ldml/src/compiler/vars.ts b/developer/src/kmc-ldml/src/compiler/vars.ts index 39bc9304af..3fc39f0d01 100644 --- a/developer/src/kmc-ldml/src/compiler/vars.ts +++ b/developer/src/kmc-ldml/src/compiler/vars.ts @@ -40,6 +40,14 @@ export class VarsCompiler extends SectionCompiler { return valid; } + private validateIdentifier(id: string) { + if(!id.match(VariableParser.ID)) { // From DTD + this.callbacks.reportMessage(LdmlCompilerMessages.Error_InvalidVariableIdentifer({id})); + return false; + } + return true; + } + private validateVars(st: Substitutions): boolean { let valid = true; const variables = this.keyboard3?.variables; @@ -67,6 +75,10 @@ export class VarsCompiler extends SectionCompiler { if (variables) { // Strings for (const { id, value } of variables.string) { + if(!this.validateIdentifier(id)) { + valid = false; + continue; + } addId(id); const stringrefs = VariableParser.allStringReferences(value); for(const ref of stringrefs) { @@ -81,6 +93,10 @@ export class VarsCompiler extends SectionCompiler { } // Sets for (const { id, value } of variables.set) { + if(!this.validateIdentifier(id)) { + valid = false; + continue; + } addId(id); allSets.add(id); // check for illegal references, here. @@ -103,6 +119,10 @@ export class VarsCompiler extends SectionCompiler { } // UnicodeSets for (const { id, value } of variables.uset) { + if(!this.validateIdentifier(id)) { + valid = false; + continue; + } addId(id); allUnicodeSets.add(id); const stringrefs = VariableParser.allStringReferences(value); diff --git a/developer/src/kmc-ldml/test/fixtures/sections/layr/row-keys-whitespace.xml b/developer/src/kmc-ldml/test/fixtures/sections/layr/row-keys-whitespace.xml new file mode 100644 index 0000000000..f8d1a629d5 --- /dev/null +++ b/developer/src/kmc-ldml/test/fixtures/sections/layr/row-keys-whitespace.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/developer/src/kmc-ldml/test/fixtures/sections/vars/fail-invalid-identifiers.xml b/developer/src/kmc-ldml/test/fixtures/sections/vars/fail-invalid-identifiers.xml new file mode 100644 index 0000000000..880864fd4e --- /dev/null +++ b/developer/src/kmc-ldml/test/fixtures/sections/vars/fail-invalid-identifiers.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/developer/src/kmc-ldml/test/test-layr.ts b/developer/src/kmc-ldml/test/test-layr.ts index 3cf0701986..8aeb604171 100644 --- a/developer/src/kmc-ldml/test/test-layr.ts +++ b/developer/src/kmc-ldml/test/test-layr.ts @@ -135,5 +135,30 @@ describe('layr', function () { LdmlCompilerMessages.Error_InvalidModifier({ layer: '', modifiers: 'caps bogus'}), ] }, + { + subpath: 'sections/layr/row-keys-whitespace.xml', + callback(sect) { + const layr = sect; + assert.ok(layr); + assert.equal(compilerTestCallbacks.messages.length, 0); + + assert.equal(layr.lists?.length, 1); + const list0 = layr.lists[0]; + assert.ok(list0); + assert.equal(list0.layers.length, 1); + assert.equal(list0.hardware.value, 'us'); + const layer0 = list0.layers[0]; + assert.ok(layer0); + assert.equal(layer0.rows.length, 2); + assert.equal(layer0.id.value, 'base'); + assert.equal(layer0.mod, constants.keys_mod_none); + for(const row of layer0.rows) { + assert.ok(row); + assert.equal(row.keys.length, 2); + assert.equal(row.keys[0]?.value, 'grave'); + assert.equal(row.keys[1]?.value, 'mistake'); + } + }, + }, ]); }); diff --git a/developer/src/kmc-ldml/test/test-vars.ts b/developer/src/kmc-ldml/test/test-vars.ts index d513574ee8..8eef17af25 100644 --- a/developer/src/kmc-ldml/test/test-vars.ts +++ b/developer/src/kmc-ldml/test/test-vars.ts @@ -121,6 +121,16 @@ describe('vars', function () { LdmlCompilerMessages.Error_DuplicateVariable({ids: 'upper, y'}) ], }, + { + subpath: 'sections/vars/fail-invalid-identifiers.xml', + errors: [ + LdmlCompilerMessages.Error_InvalidVariableIdentifer({id: 'invalid-string'}), + LdmlCompilerMessages.Error_InvalidVariableIdentifer({id: 'invalid-set'}), + LdmlCompilerMessages.Error_InvalidVariableIdentifer({id: 'invalid-uset'}), + LdmlCompilerMessages.Error_InvalidVariableIdentifer({id: 'a_marker_name_more_than_32_chars_long'}), + LdmlCompilerMessages.Error_InvalidVariableIdentifer({id: '😡'}), + ], + }, { subpath: 'sections/vars/fail-uset-props1.xml', errors: [ diff --git a/developer/src/kmc/build.sh b/developer/src/kmc/build.sh index a3bf11774a..a39808a546 100755 --- a/developer/src/kmc/build.sh +++ b/developer/src/kmc/build.sh @@ -16,6 +16,7 @@ builder_describe "Build Keyman Keyboard Compiler kmc" \ "@/common/include" \ "@/common/web/keyman-version" \ "@/common/web/types" \ + "@/core/include/ldml" \ "@/developer/src/common/web/utils" \ "@/developer/src/kmc-analyze" \ "@/developer/src/kmc-keyboard-info" \ diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index 2298b5676e..66140f0ae9 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -920,7 +920,151 @@ - +
+ +

The Options dialog display several tabs such as General, Editor, Debugger, Character Map and Server. + You can configure the environment of Keyman Developer here.

+
+ + +

Instead of opening a keyboard file in the Details tab, open directly into the Layout tab, Source pane.

+
+ + +

You can open any Keyman source file shown in the project in an external text editor by right-clicking + on the file and selecting "Open in External Editor". The files available for editing externally + are .kmn, .kps, and .kvks. This field configures which editor you wish to use to edit the files. + Note: if you need to pass command line parameters to the editor, you will need to wrap the command + in a batch file and reference the batch file here.

+
+ + +

You can open any Keyman source file shown in the project in an external text editor by right-clicking + on the file and selecting "Open in External Editor". The files available for editing externally + are .kmn, .kps, and .kvks. This field configures which editor you wish to use to edit the files. + Note: if you need to pass command line parameters to the editor, you will need to wrap the command + in a batch file and reference the batch file here.

+
+ + +

You can check the location of your default project folder, where projects like keyboards or + lexical models will be saved automatically. If needed, you can change the folder location + to a more convenient spot.

+
+ + +

Reset all tabs to their original locations.

+
+ + +

Configure your SMTP server settings for email functionality within Keyman Developer, + such as emailing debug URLs for the touch layout debugger.

+
+ + +

Configure the HTTP proxy settings for online functionality within Keyman Developer, + such as uploading files to Tavultesoft.

+
+ + +

Click Cancel to close the dialog without saving changes.

+
+ + +

Click OK to save changes and close the dialog.

+
+ + +

Sets whether to use the Tab character or spaces for indents.

+
+ + +

The indent size, measured in number of spaces.

+
+ + +

If checked, the quoted font size will be the same as the default font size.

+
+ + +

Sets the font for ordinary text in the editor.

+
+ + +

Sets the font for displaying comments text and strings in Keyman source files in + single or double quotes.

+
+ + +

Sets the display theme and syntax highlighting options for the editor. A custom + theme can be defined in a JSON file.

+
+ + +

Enables the Keyman 5-style Test window instead of the debugger.

+
+ + +

Breakpoints will fire when a rule has finished being processed also.

+
+ + +

Activates single-step mode after a breakpoint fires.

+
+ + +

Displays numeric indices of characters in stores

+
+ + +

When the debugger starts, rebuild a keyboard without prompting if the keyboard + has no debug symbols included.

+
+ + +

If you are debugging a keyboard, make a change to the keyboard, and recompile it, + then the debugger needs to be reset in order to get access to the new keyboard. + Keyman Developer will normally prompt you to do this, but if you set + this option, then it will reset the debugger automatically instead.

+
+ + +

The character beneath the cursor in the edit window will be highlighted in the + Character Map. This will intelligently parse the character data under the cursor so that + a character code (e.g. U+1234) will be highlighted correctly.

+
+ + +

Rebuilds the Unicode character database from source unicodedata.txt and blocks.txt. + These files can be downloaded from the Unicode website at http://www.unicode.org/ucd/. + This lets you update the character map with a newer version of Unicode. + Keyman Developer 17.0 was released with Unicode version 15.1 data.

+
+ + +

Rebuilds the Unicode character database from source unicodedata.txt and blocks.txt. + These files can be downloaded from the Unicode website at http://www.unicode.org/ucd/. + This lets you update the character map with a newer version of Unicode. + Keyman Developer 17.0 was released with Unicode version 15.1 data.

+
+ + +

You can customize the Keyman Developer server for testing the usability of your keyboard. + Features of the Keyman Developer server include: +

    +
  • Seamless integration with the IDE (Start, Stop, Live reload, Recompile...)
  • +
  • Port configuration
  • +
  • Allow testing cross devices
  • +
  • Support for ngrok to allow simple sharing of debug sessions across the Internet
  • +
+

+
+ + +

Below Configure Server, untick the box, and it will quit displaying any local URLs for keyboard testing.

+
+
+

The name of the developer of the keyboard. This is either your full name or diff --git a/docs/minimum-versions.md b/docs/minimum-versions.md index cce0405050..c0b034dde0 100644 --- a/docs/minimum-versions.md +++ b/docs/minimum-versions.md @@ -10,23 +10,23 @@ Target Operating System and Platform Versions ### Keyman for Windows -Helpfile: [os.md](../../windows/src/desktop/help/common/os.md) +Helpfile: [os.md](../../windows/docs/help/common/os.md) ### Keyman for macOS -Helpfile: [requirements.md](../../mac/help/about/requirements.md) +Helpfile: [requirements.md](../../mac/docs/help/about/requirements.md) ### Keyman for Linux -Helpfile: [common/index.md](../../linux/help/common/index.md#q-what-linux-distros-will-keyman-work-with) +Helpfile: [common/index.md](../../linux/docs/help/common/index.md#q-what-linux-distros-will-keyman-work-with) ### Keyman iPhone and iPad -Helpfile: [system-requirements.md](../../ios/help/about/system-requirements.md) +Helpfile: [system-requirements.md](../../ios/docs/help/about/system-requirements.md) ### Keyman for Android -Helpfile: [system-requirements.md](../../android/help/about/system-requirements.md) +Helpfile: [system-requirements.md](../../android/docs/help/about/system-requirements.md) ---- diff --git a/docs/minimum-versions.md.in b/docs/minimum-versions.md.in index 42d04b5987..35fa2adde3 100644 --- a/docs/minimum-versions.md.in +++ b/docs/minimum-versions.md.in @@ -10,23 +10,23 @@ Target Operating System and Platform Versions ### Keyman for Windows -Helpfile: [os.md](../../windows/src/desktop/help/common/os.md) +Helpfile: [os.md](../../windows/docs/help/common/os.md) ### Keyman for macOS -Helpfile: [requirements.md](../../mac/help/about/requirements.md) +Helpfile: [requirements.md](../../mac/docs/help/about/requirements.md) ### Keyman for Linux -Helpfile: [common/index.md](../../linux/help/common/index.md#q-what-linux-distros-will-keyman-work-with) +Helpfile: [common/index.md](../../linux/docs/help/common/index.md#q-what-linux-distros-will-keyman-work-with) ### Keyman iPhone and iPad -Helpfile: [system-requirements.md](../../ios/help/about/system-requirements.md) +Helpfile: [system-requirements.md](../../ios/docs/help/about/system-requirements.md) ### Keyman for Android -Helpfile: [system-requirements.md](../../android/help/about/system-requirements.md) +Helpfile: [system-requirements.md](../../android/docs/help/about/system-requirements.md) ---- diff --git a/docs/websites/README.md b/docs/websites/README.md index 5fc84ffa59..62fc3f7388 100644 --- a/docs/websites/README.md +++ b/docs/websites/README.md @@ -53,6 +53,8 @@ This maps the local directory to the the Docker image. For sites that use Composer dependencies, this step also creates a link in the Docker image from /var/www/vendor/ to /var/www/html/vendor. The link file also appears locally. +Some sites have assets in `/cdn/dev/` used to generate CDN in `/dev/deploy/`. To avoid confusion during development, you can skip generating CDN with `./build.sh start --debug`. + ##### Port lookup table After this, you can access the website at the following ports: diff --git a/ios/help/about/history.md b/ios/docs/help/about/history.md similarity index 100% rename from ios/help/about/history.md rename to ios/docs/help/about/history.md diff --git a/ios/help/about/index.md b/ios/docs/help/about/index.md similarity index 100% rename from ios/help/about/index.md rename to ios/docs/help/about/index.md diff --git a/ios/help/about/system-requirements.md b/ios/docs/help/about/system-requirements.md similarity index 100% rename from ios/help/about/system-requirements.md rename to ios/docs/help/about/system-requirements.md diff --git a/ios/help/about/welcome.md b/ios/docs/help/about/welcome.md similarity index 100% rename from ios/help/about/welcome.md rename to ios/docs/help/about/welcome.md diff --git a/ios/help/about/whatsnew.md b/ios/docs/help/about/whatsnew.md similarity index 100% rename from ios/help/about/whatsnew.md rename to ios/docs/help/about/whatsnew.md diff --git a/ios/help/basic/config/index.md b/ios/docs/help/basic/config/index.md similarity index 100% rename from ios/help/basic/config/index.md rename to ios/docs/help/basic/config/index.md diff --git a/ios/help/basic/config/spacebar-caption.md b/ios/docs/help/basic/config/spacebar-caption.md similarity index 100% rename from ios/help/basic/config/spacebar-caption.md rename to ios/docs/help/basic/config/spacebar-caption.md diff --git a/ios/help/basic/index.md b/ios/docs/help/basic/index.md similarity index 100% rename from ios/help/basic/index.md rename to ios/docs/help/basic/index.md diff --git a/ios/help/basic/installing-custom-keyboards-dictionaries.md b/ios/docs/help/basic/installing-custom-keyboards-dictionaries.md similarity index 100% rename from ios/help/basic/installing-custom-keyboards-dictionaries.md rename to ios/docs/help/basic/installing-custom-keyboards-dictionaries.md diff --git a/ios/help/basic/keyboard-usage.md b/ios/docs/help/basic/keyboard-usage.md similarity index 100% rename from ios/help/basic/keyboard-usage.md rename to ios/docs/help/basic/keyboard-usage.md diff --git a/ios/help/basic/language-settings.md b/ios/docs/help/basic/language-settings.md similarity index 100% rename from ios/help/basic/language-settings.md rename to ios/docs/help/basic/language-settings.md diff --git a/ios/help/basic/sharing-keyboards.md b/ios/docs/help/basic/sharing-keyboards.md similarity index 100% rename from ios/help/basic/sharing-keyboards.md rename to ios/docs/help/basic/sharing-keyboards.md diff --git a/ios/help/basic/switching-between-keyboards.md b/ios/docs/help/basic/switching-between-keyboards.md similarity index 100% rename from ios/help/basic/switching-between-keyboards.md rename to ios/docs/help/basic/switching-between-keyboards.md diff --git a/ios/help/basic/uninstalling-keyboards.md b/ios/docs/help/basic/uninstalling-keyboards.md similarity index 100% rename from ios/help/basic/uninstalling-keyboards.md rename to ios/docs/help/basic/uninstalling-keyboards.md diff --git a/ios/help/basic/using-keyman-browser.md b/ios/docs/help/basic/using-keyman-browser.md similarity index 100% rename from ios/help/basic/using-keyman-browser.md rename to ios/docs/help/basic/using-keyman-browser.md diff --git a/ios/help/basic/using-the-banner.md b/ios/docs/help/basic/using-the-banner.md similarity index 100% rename from ios/help/basic/using-the-banner.md rename to ios/docs/help/basic/using-the-banner.md diff --git a/ios/help/context/index.md b/ios/docs/help/context/index.md similarity index 100% rename from ios/help/context/index.md rename to ios/docs/help/context/index.md diff --git a/ios/help/index.md b/ios/docs/help/index.md similarity index 100% rename from ios/help/index.md rename to ios/docs/help/index.md diff --git a/ios/help/ios_images/add-keyboard-file-i.png b/ios/docs/help/ios_images/add-keyboard-file-i.png similarity index 100% rename from ios/help/ios_images/add-keyboard-file-i.png rename to ios/docs/help/ios_images/add-keyboard-file-i.png diff --git a/ios/help/ios_images/add-keyboard-i.png b/ios/docs/help/ios_images/add-keyboard-i.png similarity index 100% rename from ios/help/ios_images/add-keyboard-i.png rename to ios/docs/help/ios_images/add-keyboard-i.png diff --git a/ios/help/ios_images/add-keyboard-i2.png b/ios/docs/help/ios_images/add-keyboard-i2.png similarity index 100% rename from ios/help/ios_images/add-keyboard-i2.png rename to ios/docs/help/ios_images/add-keyboard-i2.png diff --git a/ios/help/ios_images/add-keyboard-i3.png b/ios/docs/help/ios_images/add-keyboard-i3.png similarity index 100% rename from ios/help/ios_images/add-keyboard-i3.png rename to ios/docs/help/ios_images/add-keyboard-i3.png diff --git a/ios/help/ios_images/backspace.png b/ios/docs/help/ios_images/backspace.png similarity index 100% rename from ios/help/ios_images/backspace.png rename to ios/docs/help/ios_images/backspace.png diff --git a/ios/help/ios_images/browser-icon.png b/ios/docs/help/ios_images/browser-icon.png similarity index 100% rename from ios/help/ios_images/browser-icon.png rename to ios/docs/help/ios_images/browser-icon.png diff --git a/ios/help/ios_images/confirm-dl.png b/ios/docs/help/ios_images/confirm-dl.png similarity index 100% rename from ios/help/ios_images/confirm-dl.png rename to ios/docs/help/ios_images/confirm-dl.png diff --git a/ios/help/ios_images/delete-keyboard-i.png b/ios/docs/help/ios_images/delete-keyboard-i.png similarity index 100% rename from ios/help/ios_images/delete-keyboard-i.png rename to ios/docs/help/ios_images/delete-keyboard-i.png diff --git a/ios/help/ios_images/delete-keyboard-i2.png b/ios/docs/help/ios_images/delete-keyboard-i2.png similarity index 100% rename from ios/help/ios_images/delete-keyboard-i2.png rename to ios/docs/help/ios_images/delete-keyboard-i2.png diff --git a/ios/help/ios_images/delete.png b/ios/docs/help/ios_images/delete.png similarity index 100% rename from ios/help/ios_images/delete.png rename to ios/docs/help/ios_images/delete.png diff --git a/ios/help/ios_images/dictionary-list.png b/ios/docs/help/ios_images/dictionary-list.png similarity index 100% rename from ios/help/ios_images/dictionary-list.png rename to ios/docs/help/ios_images/dictionary-list.png diff --git a/ios/help/ios_images/dictionary-select.png b/ios/docs/help/ios_images/dictionary-select.png similarity index 100% rename from ios/help/ios_images/dictionary-select.png rename to ios/docs/help/ios_images/dictionary-select.png diff --git a/ios/help/ios_images/dist-install1-i.png b/ios/docs/help/ios_images/dist-install1-i.png similarity index 100% rename from ios/help/ios_images/dist-install1-i.png rename to ios/docs/help/ios_images/dist-install1-i.png diff --git a/ios/help/ios_images/dist-kmp-open-i.png b/ios/docs/help/ios_images/dist-kmp-open-i.png similarity index 100% rename from ios/help/ios_images/dist-kmp-open-i.png rename to ios/docs/help/ios_images/dist-kmp-open-i.png diff --git a/ios/help/ios_images/dist-kmp-success-i.png b/ios/docs/help/ios_images/dist-kmp-success-i.png similarity index 100% rename from ios/help/ios_images/dist-kmp-success-i.png rename to ios/docs/help/ios_images/dist-kmp-success-i.png diff --git a/ios/help/ios_images/dist-url-screen-i.png b/ios/docs/help/ios_images/dist-url-screen-i.png similarity index 100% rename from ios/help/ios_images/dist-url-screen-i.png rename to ios/docs/help/ios_images/dist-url-screen-i.png diff --git a/ios/help/ios_images/dist-welcome-i.png b/ios/docs/help/ios_images/dist-welcome-i.png similarity index 100% rename from ios/help/ios_images/dist-welcome-i.png rename to ios/docs/help/ios_images/dist-welcome-i.png diff --git a/ios/help/ios_images/dl-success.png b/ios/docs/help/ios_images/dl-success.png similarity index 100% rename from ios/help/ios_images/dl-success.png rename to ios/docs/help/ios_images/dl-success.png diff --git a/ios/help/ios_images/down-flick-i.gif b/ios/docs/help/ios_images/down-flick-i.gif similarity index 100% rename from ios/help/ios_images/down-flick-i.gif rename to ios/docs/help/ios_images/down-flick-i.gif diff --git a/ios/help/ios_images/file-share-1i.png b/ios/docs/help/ios_images/file-share-1i.png similarity index 100% rename from ios/help/ios_images/file-share-1i.png rename to ios/docs/help/ios_images/file-share-1i.png diff --git a/ios/help/ios_images/file-share-2i.png b/ios/docs/help/ios_images/file-share-2i.png similarity index 100% rename from ios/help/ios_images/file-share-2i.png rename to ios/docs/help/ios_images/file-share-2i.png diff --git a/ios/help/ios_images/find-new.png b/ios/docs/help/ios_images/find-new.png similarity index 100% rename from ios/help/ios_images/find-new.png rename to ios/docs/help/ios_images/find-new.png diff --git a/ios/help/ios_images/font-dl1.png b/ios/docs/help/ios_images/font-dl1.png similarity index 100% rename from ios/help/ios_images/font-dl1.png rename to ios/docs/help/ios_images/font-dl1.png diff --git a/ios/help/ios_images/font-dl2.png b/ios/docs/help/ios_images/font-dl2.png similarity index 100% rename from ios/help/ios_images/font-dl2.png rename to ios/docs/help/ios_images/font-dl2.png diff --git a/ios/help/ios_images/font-dl3.png b/ios/docs/help/ios_images/font-dl3.png similarity index 100% rename from ios/help/ios_images/font-dl3.png rename to ios/docs/help/ios_images/font-dl3.png diff --git a/ios/help/ios_images/font-dl4.png b/ios/docs/help/ios_images/font-dl4.png similarity index 100% rename from ios/help/ios_images/font-dl4.png rename to ios/docs/help/ios_images/font-dl4.png diff --git a/ios/help/ios_images/font-dl5.png b/ios/docs/help/ios_images/font-dl5.png similarity index 100% rename from ios/help/ios_images/font-dl5.png rename to ios/docs/help/ios_images/font-dl5.png diff --git a/ios/help/ios_images/font-size.png b/ios/docs/help/ios_images/font-size.png similarity index 100% rename from ios/help/ios_images/font-size.png rename to ios/docs/help/ios_images/font-size.png diff --git a/ios/help/ios_images/get-started.png b/ios/docs/help/ios_images/get-started.png similarity index 100% rename from ios/help/ios_images/get-started.png rename to ios/docs/help/ios_images/get-started.png diff --git a/ios/help/ios_images/globe.png b/ios/docs/help/ios_images/globe.png similarity index 100% rename from ios/help/ios_images/globe.png rename to ios/docs/help/ios_images/globe.png diff --git a/ios/help/ios_images/hide-keyboard.png b/ios/docs/help/ios_images/hide-keyboard.png similarity index 100% rename from ios/help/ios_images/hide-keyboard.png rename to ios/docs/help/ios_images/hide-keyboard.png diff --git a/ios/help/ios_images/in-app-picker-i.png b/ios/docs/help/ios_images/in-app-picker-i.png similarity index 100% rename from ios/help/ios_images/in-app-picker-i.png rename to ios/docs/help/ios_images/in-app-picker-i.png diff --git a/ios/help/ios_images/info.png b/ios/docs/help/ios_images/info.png similarity index 100% rename from ios/help/ios_images/info.png rename to ios/docs/help/ios_images/info.png diff --git a/ios/help/ios_images/key-submenu.png b/ios/docs/help/ios_images/key-submenu.png similarity index 100% rename from ios/help/ios_images/key-submenu.png rename to ios/docs/help/ios_images/key-submenu.png diff --git a/ios/help/ios_images/keyboard-search-1.png b/ios/docs/help/ios_images/keyboard-search-1.png similarity index 100% rename from ios/help/ios_images/keyboard-search-1.png rename to ios/docs/help/ios_images/keyboard-search-1.png diff --git a/ios/help/ios_images/keyboard-search-2.png b/ios/docs/help/ios_images/keyboard-search-2.png similarity index 100% rename from ios/help/ios_images/keyboard-search-2.png rename to ios/docs/help/ios_images/keyboard-search-2.png diff --git a/ios/help/ios_images/keyboard-search-3.png b/ios/docs/help/ios_images/keyboard-search-3.png similarity index 100% rename from ios/help/ios_images/keyboard-search-3.png rename to ios/docs/help/ios_images/keyboard-search-3.png diff --git a/ios/help/ios_images/keyboard-search-4.png b/ios/docs/help/ios_images/keyboard-search-4.png similarity index 100% rename from ios/help/ios_images/keyboard-search-4.png rename to ios/docs/help/ios_images/keyboard-search-4.png diff --git a/ios/help/ios_images/keyboard-search-5.png b/ios/docs/help/ios_images/keyboard-search-5.png similarity index 100% rename from ios/help/ios_images/keyboard-search-5.png rename to ios/docs/help/ios_images/keyboard-search-5.png diff --git a/ios/help/ios_images/keyman-settings.png b/ios/docs/help/ios_images/keyman-settings.png similarity index 100% rename from ios/help/ios_images/keyman-settings.png rename to ios/docs/help/ios_images/keyman-settings.png diff --git a/ios/help/ios_images/keyman-settings2.png b/ios/docs/help/ios_images/keyman-settings2.png similarity index 100% rename from ios/help/ios_images/keyman-settings2.png rename to ios/docs/help/ios_images/keyman-settings2.png diff --git a/ios/help/ios_images/keyman-settings3.png b/ios/docs/help/ios_images/keyman-settings3.png similarity index 100% rename from ios/help/ios_images/keyman-settings3.png rename to ios/docs/help/ios_images/keyman-settings3.png diff --git a/ios/help/ios_images/keyman-settings4.png b/ios/docs/help/ios_images/keyman-settings4.png similarity index 100% rename from ios/help/ios_images/keyman-settings4.png rename to ios/docs/help/ios_images/keyman-settings4.png diff --git a/ios/help/ios_images/keyman-settings5.png b/ios/docs/help/ios_images/keyman-settings5.png similarity index 100% rename from ios/help/ios_images/keyman-settings5.png rename to ios/docs/help/ios_images/keyman-settings5.png diff --git a/ios/help/ios_images/keyman-settings6.png b/ios/docs/help/ios_images/keyman-settings6.png similarity index 100% rename from ios/help/ios_images/keyman-settings6.png rename to ios/docs/help/ios_images/keyman-settings6.png diff --git a/ios/help/ios_images/language-settings.png b/ios/docs/help/ios_images/language-settings.png similarity index 100% rename from ios/help/ios_images/language-settings.png rename to ios/docs/help/ios_images/language-settings.png diff --git a/ios/help/ios_images/menu-icon.png b/ios/docs/help/ios_images/menu-icon.png similarity index 100% rename from ios/help/ios_images/menu-icon.png rename to ios/docs/help/ios_images/menu-icon.png diff --git a/ios/help/ios_images/package-install-1.png b/ios/docs/help/ios_images/package-install-1.png similarity index 100% rename from ios/help/ios_images/package-install-1.png rename to ios/docs/help/ios_images/package-install-1.png diff --git a/ios/help/ios_images/package-install-2.png b/ios/docs/help/ios_images/package-install-2.png similarity index 100% rename from ios/help/ios_images/package-install-2.png rename to ios/docs/help/ios_images/package-install-2.png diff --git a/ios/help/ios_images/package-install-3.png b/ios/docs/help/ios_images/package-install-3.png similarity index 100% rename from ios/help/ios_images/package-install-3.png rename to ios/docs/help/ios_images/package-install-3.png diff --git a/ios/help/ios_images/package-install-4.png b/ios/docs/help/ios_images/package-install-4.png similarity index 100% rename from ios/help/ios_images/package-install-4.png rename to ios/docs/help/ios_images/package-install-4.png diff --git a/ios/help/ios_images/package-install-5.png b/ios/docs/help/ios_images/package-install-5.png similarity index 100% rename from ios/help/ios_images/package-install-5.png rename to ios/docs/help/ios_images/package-install-5.png diff --git a/ios/help/ios_images/qr-code-share-1i.png b/ios/docs/help/ios_images/qr-code-share-1i.png similarity index 100% rename from ios/help/ios_images/qr-code-share-1i.png rename to ios/docs/help/ios_images/qr-code-share-1i.png diff --git a/ios/help/ios_images/qr-code-share-2i.png b/ios/docs/help/ios_images/qr-code-share-2i.png similarity index 100% rename from ios/help/ios_images/qr-code-share-2i.png rename to ios/docs/help/ios_images/qr-code-share-2i.png diff --git a/ios/help/ios_images/qr-code-share-3i.png b/ios/docs/help/ios_images/qr-code-share-3i.png similarity index 100% rename from ios/help/ios_images/qr-code-share-3i.png rename to ios/docs/help/ios_images/qr-code-share-3i.png diff --git a/ios/help/ios_images/qr-code-share-4i.png b/ios/docs/help/ios_images/qr-code-share-4i.png similarity index 100% rename from ios/help/ios_images/qr-code-share-4i.png rename to ios/docs/help/ios_images/qr-code-share-4i.png diff --git a/ios/help/ios_images/return.png b/ios/docs/help/ios_images/return.png similarity index 100% rename from ios/help/ios_images/return.png rename to ios/docs/help/ios_images/return.png diff --git a/ios/help/ios_images/settings-screen.png b/ios/docs/help/ios_images/settings-screen.png similarity index 100% rename from ios/help/ios_images/settings-screen.png rename to ios/docs/help/ios_images/settings-screen.png diff --git a/ios/help/ios_images/settings-suggestions-i.png b/ios/docs/help/ios_images/settings-suggestions-i.png similarity index 100% rename from ios/help/ios_images/settings-suggestions-i.png rename to ios/docs/help/ios_images/settings-suggestions-i.png diff --git a/ios/help/ios_images/share.png b/ios/docs/help/ios_images/share.png similarity index 100% rename from ios/help/ios_images/share.png rename to ios/docs/help/ios_images/share.png diff --git a/ios/help/ios_images/shift.png b/ios/docs/help/ios_images/shift.png similarity index 100% rename from ios/help/ios_images/shift.png rename to ios/docs/help/ios_images/shift.png diff --git a/ios/help/ios_images/spacebar-caption.png b/ios/docs/help/ios_images/spacebar-caption.png similarity index 100% rename from ios/help/ios_images/spacebar-caption.png rename to ios/docs/help/ios_images/spacebar-caption.png diff --git a/ios/help/ios_images/system-keyboard-cal.png b/ios/docs/help/ios_images/system-keyboard-cal.png similarity index 100% rename from ios/help/ios_images/system-keyboard-cal.png rename to ios/docs/help/ios_images/system-keyboard-cal.png diff --git a/ios/help/ios_images/system-picker-i.png b/ios/docs/help/ios_images/system-picker-i.png similarity index 100% rename from ios/help/ios_images/system-picker-i.png rename to ios/docs/help/ios_images/system-picker-i.png diff --git a/ios/help/ios_images/system-wide-setting.png b/ios/docs/help/ios_images/system-wide-setting.png similarity index 100% rename from ios/help/ios_images/system-wide-setting.png rename to ios/docs/help/ios_images/system-wide-setting.png diff --git a/ios/help/ios_images/themed-banner.png b/ios/docs/help/ios_images/themed-banner.png similarity index 100% rename from ios/help/ios_images/themed-banner.png rename to ios/docs/help/ios_images/themed-banner.png diff --git a/ios/help/ios_images/touch-hold.png b/ios/docs/help/ios_images/touch-hold.png similarity index 100% rename from ios/help/ios_images/touch-hold.png rename to ios/docs/help/ios_images/touch-hold.png diff --git a/ios/help/ios_images/uninstall-delete-i.png b/ios/docs/help/ios_images/uninstall-delete-i.png similarity index 100% rename from ios/help/ios_images/uninstall-delete-i.png rename to ios/docs/help/ios_images/uninstall-delete-i.png diff --git a/ios/help/ios_images/uninstall-list-i.png b/ios/docs/help/ios_images/uninstall-list-i.png similarity index 100% rename from ios/help/ios_images/uninstall-list-i.png rename to ios/docs/help/ios_images/uninstall-list-i.png diff --git a/ios/help/ios_images/video.png b/ios/docs/help/ios_images/video.png similarity index 100% rename from ios/help/ios_images/video.png rename to ios/docs/help/ios_images/video.png diff --git a/ios/help/start/index.md b/ios/docs/help/start/index.md similarity index 100% rename from ios/help/start/index.md rename to ios/docs/help/start/index.md diff --git a/ios/help/start/installing-packages.md b/ios/docs/help/start/installing-packages.md similarity index 100% rename from ios/help/start/installing-packages.md rename to ios/docs/help/start/installing-packages.md diff --git a/ios/help/start/installing-system-keyboard.md b/ios/docs/help/start/installing-system-keyboard.md similarity index 100% rename from ios/help/start/installing-system-keyboard.md rename to ios/docs/help/start/installing-system-keyboard.md diff --git a/ios/help/start/searching-for-keyboards.md b/ios/docs/help/start/searching-for-keyboards.md similarity index 100% rename from ios/help/start/searching-for-keyboards.md rename to ios/docs/help/start/searching-for-keyboards.md diff --git a/ios/help/troubleshooting/index.md b/ios/docs/help/troubleshooting/index.md similarity index 100% rename from ios/help/troubleshooting/index.md rename to ios/docs/help/troubleshooting/index.md diff --git a/ios/help/troubleshooting/installing-fonts.md b/ios/docs/help/troubleshooting/installing-fonts.md similarity index 100% rename from ios/help/troubleshooting/installing-fonts.md rename to ios/docs/help/troubleshooting/installing-fonts.md diff --git a/ios/help/troubleshooting/integrating.md b/ios/docs/help/troubleshooting/integrating.md similarity index 100% rename from ios/help/troubleshooting/integrating.md rename to ios/docs/help/troubleshooting/integrating.md diff --git a/linux/debian/libkeymancore2.symbols b/linux/debian/libkeymancore2.symbols index 593e7aa7fc..83aa5a5125 100644 --- a/linux/debian/libkeymancore2.symbols +++ b/linux/debian/libkeymancore2.symbols @@ -2,6 +2,7 @@ libkeymancore.so.2 libkeymancore2 #MINVER# * Build-Depends-Package: libkeymancore-dev (c++|optional)"typeinfo name for std::codecvt_utf8_utf16@Base" 17.0.244 + (c++|optional)std::piecewise_construct@Base 18.0.118 km_core_context_clear@Base 17.0.195 km_core_context_get@Base 17.0.195 km_core_context_item_list_size@Base 17.0.195 diff --git a/linux/help/about/history.md b/linux/docs/help/about/history.md similarity index 100% rename from linux/help/about/history.md rename to linux/docs/help/about/history.md diff --git a/linux/help/about/index.md b/linux/docs/help/about/index.md similarity index 100% rename from linux/help/about/index.md rename to linux/docs/help/about/index.md diff --git a/linux/help/about/welcome.md b/linux/docs/help/about/welcome.md similarity index 100% rename from linux/help/about/welcome.md rename to linux/docs/help/about/welcome.md diff --git a/linux/help/about/whatsnew.md b/linux/docs/help/about/whatsnew.md similarity index 100% rename from linux/help/about/whatsnew.md rename to linux/docs/help/about/whatsnew.md diff --git a/linux/help/common/index.md b/linux/docs/help/common/index.md similarity index 100% rename from linux/help/common/index.md rename to linux/docs/help/common/index.md diff --git a/linux/help/index.md b/linux/docs/help/index.md similarity index 100% rename from linux/help/index.md rename to linux/docs/help/index.md diff --git a/linux/help/linux_images/add-input-source-khmer-angkor.png b/linux/docs/help/linux_images/add-input-source-khmer-angkor.png similarity index 100% rename from linux/help/linux_images/add-input-source-khmer-angkor.png rename to linux/docs/help/linux_images/add-input-source-khmer-angkor.png diff --git a/linux/help/linux_images/add-input-source-khmer.png b/linux/docs/help/linux_images/add-input-source-khmer.png similarity index 100% rename from linux/help/linux_images/add-input-source-khmer.png rename to linux/docs/help/linux_images/add-input-source-khmer.png diff --git a/linux/help/linux_images/add-input-source.png b/linux/docs/help/linux_images/add-input-source.png similarity index 100% rename from linux/help/linux_images/add-input-source.png rename to linux/docs/help/linux_images/add-input-source.png diff --git a/linux/help/linux_images/download-khmer-angkor.png b/linux/docs/help/linux_images/download-khmer-angkor.png similarity index 100% rename from linux/help/linux_images/download-khmer-angkor.png rename to linux/docs/help/linux_images/download-khmer-angkor.png diff --git a/linux/help/linux_images/km-config-khmer-angkor.png b/linux/docs/help/linux_images/km-config-khmer-angkor.png similarity index 100% rename from linux/help/linux_images/km-config-khmer-angkor.png rename to linux/docs/help/linux_images/km-config-khmer-angkor.png diff --git a/linux/help/linux_images/km-config.png b/linux/docs/help/linux_images/km-config.png similarity index 100% rename from linux/help/linux_images/km-config.png rename to linux/docs/help/linux_images/km-config.png diff --git a/linux/help/linux_images/mobile viewport.png b/linux/docs/help/linux_images/mobile viewport.png similarity index 100% rename from linux/help/linux_images/mobile viewport.png rename to linux/docs/help/linux_images/mobile viewport.png diff --git a/linux/help/linux_images/onboard.png b/linux/docs/help/linux_images/onboard.png similarity index 100% rename from linux/help/linux_images/onboard.png rename to linux/docs/help/linux_images/onboard.png diff --git a/linux/help/linux_images/package-khmer-angkor-welcome.png b/linux/docs/help/linux_images/package-khmer-angkor-welcome.png similarity index 100% rename from linux/help/linux_images/package-khmer-angkor-welcome.png rename to linux/docs/help/linux_images/package-khmer-angkor-welcome.png diff --git a/linux/help/linux_images/region-and-language.png b/linux/docs/help/linux_images/region-and-language.png similarity index 100% rename from linux/help/linux_images/region-and-language.png rename to linux/docs/help/linux_images/region-and-language.png diff --git a/linux/help/linux_images/region-language-khmer-angkor.png b/linux/docs/help/linux_images/region-language-khmer-angkor.png similarity index 100% rename from linux/help/linux_images/region-language-khmer-angkor.png rename to linux/docs/help/linux_images/region-language-khmer-angkor.png diff --git a/linux/help/linux_images/search-khmer-angkor.png b/linux/docs/help/linux_images/search-khmer-angkor.png similarity index 100% rename from linux/help/linux_images/search-khmer-angkor.png rename to linux/docs/help/linux_images/search-khmer-angkor.png diff --git a/linux/help/linux_images/video.png b/linux/docs/help/linux_images/video.png similarity index 100% rename from linux/help/linux_images/video.png rename to linux/docs/help/linux_images/video.png diff --git a/linux/help/reference/index.md b/linux/docs/help/reference/index.md similarity index 100% rename from linux/help/reference/index.md rename to linux/docs/help/reference/index.md diff --git a/linux/help/start/index.md b/linux/docs/help/start/index.md similarity index 100% rename from linux/help/start/index.md rename to linux/docs/help/start/index.md diff --git a/linux/help/start/installing-keyboard.md b/linux/docs/help/start/installing-keyboard.md similarity index 100% rename from linux/help/start/installing-keyboard.md rename to linux/docs/help/start/installing-keyboard.md diff --git a/linux/keyman-config/build-help.sh b/linux/keyman-config/build-help.sh index e05b8d284e..3bc959cc6c 100755 --- a/linux/keyman-config/build-help.sh +++ b/linux/keyman-config/build-help.sh @@ -72,11 +72,11 @@ fi if [ -n "$generate_help" ]; then echo "Generating markdown help pages..." - mkdir -p ../help/reference - buildtools/help2md ./km-package-get -o ../help/reference/km-package-get.md -n "Download a Keyman keyboard package" -I maninc/km-package-get.inc - buildtools/help2md ./km-package-install -o ../help/reference/km-package-install.md -n "Install a Keyman keyboard package" -I maninc/km-package-install.inc - buildtools/help2md ./km-config -o ../help/reference/km-config.md -n "Launches Keyman Configuration for installing and showing information about Keyman keyboards" -I maninc/km-config.inc - buildtools/help2md ./km-kvk2ldml -o ../help/reference/km-kvk2ldml.md -n "Convert a Keyman on-screen keyboard file to LDML" -I maninc/km-kvk2ldml.inc - buildtools/help2md ./km-package-list-installed -o ../help/reference/km-package-list-installed.md -n "List installed Keyman keyboard packages" -I maninc/km-package-list-installed.inc - buildtools/help2md ./km-package-uninstall -o ../help/reference/km-package-uninstall.md -n "Uninstall a Keyman keyboard package" -I maninc/km-package-uninstall.inc + mkdir -p ../docs/help/reference + buildtools/help2md ./km-package-get -o ../docs/help/reference/km-package-get.md -n "Download a Keyman keyboard package" -I maninc/km-package-get.inc + buildtools/help2md ./km-package-install -o ../docs/help/reference/km-package-install.md -n "Install a Keyman keyboard package" -I maninc/km-package-install.inc + buildtools/help2md ./km-config -o ../docs/help/reference/km-config.md -n "Launches Keyman Configuration for installing and showing information about Keyman keyboards" -I maninc/km-config.inc + buildtools/help2md ./km-kvk2ldml -o ../docs/help/reference/km-kvk2ldml.md -n "Convert a Keyman on-screen keyboard file to LDML" -I maninc/km-kvk2ldml.inc + buildtools/help2md ./km-package-list-installed -o ../docs/help/reference/km-package-list-installed.md -n "List installed Keyman keyboard packages" -I maninc/km-package-list-installed.inc + buildtools/help2md ./km-package-uninstall -o ../docs/help/reference/km-package-uninstall.md -n "Uninstall a Keyman keyboard package" -I maninc/km-package-uninstall.inc fi diff --git a/linux/keyman-config/build.sh b/linux/keyman-config/build.sh index 3346a7defa..9296f80d05 100755 --- a/linux/keyman-config/build.sh +++ b/linux/keyman-config/build.sh @@ -28,7 +28,7 @@ builder_describe_outputs \ clean_action() { rm -rf dist make_deb build ./*.egg-info keyman_config/version.py find . \( -name __pycache__ -o -name keyman-config.mo \) -exec rm -rf {} + - rm -rf ../help/reference/km-*.md + rm -rf ../docs/help/reference/km-*.md # Don't delete this file during a package build because they are # part of the source package. We can't generate it during a package diff --git a/linux/scripts/dist.sh b/linux/scripts/dist.sh index 6ef0be7d8b..1c730f8f4b 100755 --- a/linux/scripts/dist.sh +++ b/linux/scripts/dist.sh @@ -57,7 +57,7 @@ dpkg-source --tar-ignore=*~ \ --tar-ignore=linux/keyman-config/keyman_config/version.py \ --tar-ignore=linux/keyman-config/buildtools/build-langtags.py \ --tar-ignore=__pycache__ \ - --tar-ignore=linux/help \ + --tar-ignore=linux/docs/help \ --tar-ignore=mac \ --tar-ignore=node_modules \ --tar-ignore=oem \ diff --git a/mac/Keyman4Mac/Keyman4Mac/AppDelegate.m b/mac/Keyman4Mac/Keyman4Mac/AppDelegate.m index 44f7cfda58..f6bf6c81fe 100644 --- a/mac/Keyman4Mac/Keyman4Mac/AppDelegate.m +++ b/mac/Keyman4Mac/Keyman4Mac/AppDelegate.m @@ -9,8 +9,6 @@ #import "AppDelegate.h" #import -static BOOL debugMode = YES; - BOOL isKeyMapEnabled; const unsigned short keyMapSize = 0x80; @@ -47,8 +45,6 @@ NSString *const kKMXFileKey = @"KMXFile"; NSArray *kvkFiles = [self KVKFiles]; for (NSString *path in kvkFiles){ KVKFile *kvkFile = [[KVKFile alloc] initWithFilePath:path]; - if (debugMode) - NSLog(@"%@", kvkFile); }*/ } @@ -116,7 +112,7 @@ CGEventRef eventTapFunction(CGEventTapProxy proxy, CGEventType type, CGEventRef NSLog(@"AppDelegate eventTapFunction key down event: %@", event); // Key down event NSEvent *mEvent = [NSEvent eventWithCGEvent:event]; - KMEngine *kme = [[KMEngine alloc] initWithKMX:kmx context:contextBuffer verboseLogging:debugMode]; + KMEngine *kme = [[KMEngine alloc] initWithKMX:kmx context:contextBuffer]; CoreKeyOutput *coreKeyOutput = [kme processEvent:mEvent]; if (coreKeyOutput) { if (coreKeyOutput.hasTextToInsert) { @@ -227,18 +223,6 @@ CGEventRef eventTapFunction(CGEventTapProxy proxy, CGEventType type, CGEventRef NSLog(@"%d: %@", index, kmStore); index++; } - - for (NSObject *gp in kmx.group) { - if (debugMode) { - NSLog(@"Group %@", gp); - //NSLog(@"match = %@", gp.match); - //NSLog(@"nomatch = %@", gp.noMatch); - /* - for (KMCompKey *kmKey in gp.keys) { - NSLog(@"\nKey: %@", kmKey); - }*/ - } - } } } @@ -259,9 +243,6 @@ CGEventRef eventTapFunction(CGEventTapProxy proxy, CGEventType type, CGEventRef if (!infoDict) continue; - //if (debugMode) - // NSLog(@"%@", infoDict); - //NSString *str = [NSString stringWithFormat:@"%@ (%@)", [infoDict objectForKey:kKMKeyboardNameKey], [infoDict objectForKey:kKMKeyboardVersionKey]]; NSString *str = [infoDict objectForKey:kKMKeyboardNameKey]; [kmxDesc addObject:str]; } diff --git a/mac/Keyman4MacIM/Keyman4MacIM/KMConfiguration/Base.lproj/preferences.xib b/mac/Keyman4MacIM/Keyman4MacIM/KMConfiguration/Base.lproj/preferences.xib index d5afcd00d5..e6cc0173aa 100644 --- a/mac/Keyman4MacIM/Keyman4MacIM/KMConfiguration/Base.lproj/preferences.xib +++ b/mac/Keyman4MacIM/Keyman4MacIM/KMConfiguration/Base.lproj/preferences.xib @@ -2,8 +2,8 @@ - - + + @@ -13,8 +13,6 @@ - - @@ -209,29 +207,6 @@ - - - - diff --git a/mac/Keyman4MacIM/Keyman4MacIM/KMConfiguration/KMConfigurationWindowController.m b/mac/Keyman4MacIM/Keyman4MacIM/KMConfiguration/KMConfigurationWindowController.m index f3a0c3501e..202be65ef5 100644 --- a/mac/Keyman4MacIM/Keyman4MacIM/KMConfiguration/KMConfigurationWindowController.m +++ b/mac/Keyman4MacIM/Keyman4MacIM/KMConfiguration/KMConfigurationWindowController.m @@ -14,8 +14,6 @@ @interface KMConfigurationWindowController () @property (nonatomic, weak) IBOutlet NSTableView *tableView; @property (nonatomic, weak) IBOutlet WebView *webView; -@property (nonatomic, weak) IBOutlet NSButton *useVerboseLoggingCheckBox; -@property (nonatomic, weak) IBOutlet NSTextField *verboseLoggingInfo; @property (nonatomic, weak) IBOutlet NSButton *supportBack; @property (nonatomic, weak) IBOutlet NSButton *supportForward; @property (nonatomic, weak) IBOutlet NSButton *supportHome; @@ -68,8 +66,6 @@ NSURL *homeUrl = [[NSBundle mainBundle] URLForResource:@"index" withExtension:@"html" subdirectory:@"Help"]; [self.webView.mainFrame loadRequest:[NSURLRequest requestWithURL:homeUrl]]; - - [self.useVerboseLoggingCheckBox setState:(self.AppDelegate.useVerboseLogging ? NSOnState : NSOffState)]; } - (void)webView:(WebView *)sender decidePolicyForNewWindowAction:(NSDictionary *)actionInformation request:(NSURLRequest *)request newFrameName:(NSString *)frameName decisionListener:(id)listener { @@ -437,13 +433,6 @@ [self.AppDelegate.downloadKBWindow.window makeKeyAndOrderFront:nil]; } -- (IBAction)useVerboseLoggingCheckBoxAction:(id)sender { - NSButton *checkBox = (NSButton *)sender; - BOOL verboseLoggingOn = checkBox.state == NSOnState; - [self.AppDelegate setUseVerboseLogging:verboseLoggingOn]; - [self.verboseLoggingInfo setHidden:!verboseLoggingOn]; -} - - (void)handleRequestToInstallPackage:(KMPackage *) package { os_log_debug([KMLogs dataLog], "handleRequestToInstallPackage"); NSString *keyboardInfoString = NSLocalizedString(@"info-install-keyboard-filename", nil); diff --git a/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.h b/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.h index 7f6b2f3655..667e630f3c 100644 --- a/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.h +++ b/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.h @@ -89,9 +89,7 @@ static const int KEYMAN_FIRST_KEYBOARD_MENUITEM_INDEX = 0; @property (nonatomic, strong) NSString *downloadFilename; @property (nonatomic, strong) NSMutableData *receivedData; @property (nonatomic, assign) NSUInteger expectedBytes; -@property (nonatomic, assign) BOOL useVerboseLogging; @property (nonatomic, assign) BOOL useNullChar; -@property (nonatomic, assign) BOOL debugMode; - (NSMenu *)menu; - (void)saveActiveKeyboards; diff --git a/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.m b/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.m index 7392c3dc2f..199721f8be 100644 --- a/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.m +++ b/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.m @@ -64,16 +64,7 @@ id _lastServerWithOSKShowing = nil; - (id)init { self = [super init]; - if (self) { -#ifdef DEBUG - // If debugging, we'll turn it on by default, regardless of setting. If developer - // really wants it off, they can either change this line of code temporarily or - // go to the config screen and turn it off explicitly. - _debugMode = YES; -#else - _debugMode = self.useVerboseLogging; -#endif - + if (self) { // first notify user and request access to Accessibility/PostEvent permissions // pass block as completion handler to complete init with initCompletion [PrivacyConsent.shared requestPrivacyAccess:^void (void){ @@ -384,7 +375,7 @@ CGEventRef eventTapFunction(CGEventTapProxy proxy, CGEventType type, CGEventRef - (KMEngine *)kme { if (_kme == nil) { - _kme = [[KMEngine alloc] initWithKMX:nil context:self.contextBuffer verboseLogging:self.debugMode]; + _kme = [[KMEngine alloc] initWithKMX:nil context:self.contextBuffer]; } return _kme; @@ -441,19 +432,6 @@ CGEventRef eventTapFunction(CGEventTapProxy proxy, CGEventType type, CGEventRef return [NSString stringWithFormat:@"%@ - Keyman", _keyboardName]; } -- (void)setUseVerboseLogging:(BOOL)useVerboseLogging { - os_log_debug([KMLogs configLog], "Turning verbose logging %{public}@", useVerboseLogging ? @"on." : @"off."); - _debugMode = useVerboseLogging; - if (_kme != nil) - [_kme setUseVerboseLogging:useVerboseLogging]; - - [[KMSettingsRepository shared] writeUseVerboseLogging:useVerboseLogging]; -} - -- (BOOL)useVerboseLogging { - return [[KMSettingsRepository shared] readUseVerboseLogging]; -} - #pragma mark - Keyman Data /** @@ -769,9 +747,7 @@ CGEventRef eventTapFunction(CGEventTapProxy proxy, CGEventType type, CGEventRef NSString *keyboardMenuName = @""; int menuItemIndex = KEYMAN_FIRST_KEYBOARD_MENUITEM_INDEX; - if (self.debugMode) { - os_log_info([KMLogs configLog], "*** populateKeyboardMenuItems, number of active keyboards=%lu", self.activeKeyboards.count); - } + os_log_debug([KMLogs configLog], "*** populateKeyboardMenuItems, number of active keyboards=%lu", self.activeKeyboards.count); // loop through the active keyboards list and add them to the menu for (NSString *path in self.activeKeyboards) { diff --git a/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodEventHandler.m b/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodEventHandler.m index d102e69ca3..c5b6f172b6 100644 --- a/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodEventHandler.m +++ b/mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodEventHandler.m @@ -45,11 +45,14 @@ NSString* const kEasterEggKmxName = @"EnglishSpanish.kmx"; _lowLevelBackspaceCount = 0; _queuedText = nil; - // In Xcode, if Keyman is the active IM and is in "debugMode" and "English plus Spanish" is - // the current keyboard and you type "Sentry force now", it will force a simulated crash to + BOOL forceSentryCrash = [KMSettingsRepository.shared readForceSentryError]; + + // In Xcode, if Keyman is the active IM and the settings include the + // forceSentryCrash flag and "English plus Spanish" is the current keyboard + // and you type "Sentry force now", it will force a simulated crash to // test reporting to sentry.keyman.com - if ([self.appDelegate debugMode] && [clientAppId isEqual: @"com.apple.dt.Xcode"]) { - os_log_debug([KMLogs testLog], "Sentry - Preparing to detect Easter egg."); + if (forceSentryCrash && [clientAppId isEqual: @"com.apple.dt.Xcode"]) { + os_log_debug([KMLogs testLog], "initWithClient, preparing to force Sentry crash."); _easterEggForSentry = [[NSMutableString alloc] init]; } else @@ -66,9 +69,7 @@ NSString* const kEasterEggKmxName = @"EnglishSpanish.kmx"; if (_generatedBackspaceCount > 0 || (_queuedText != nil && _queuedText.length > 0) || _keyCodeOfOriginalEvent != 0 || _sourceFromOriginalEvent != nil) { - if ([self.appDelegate debugMode]) { - os_log_error([KMLogs lifecycleLog], "ERROR: new app activated before previous app finished processing pending events! _generatedBackspaceCount: %lu, _queuedText: '%{public}@' _keyCodeOfOriginalEvent: %hu", _generatedBackspaceCount, _queuedText == nil ? @"(NIL)" : (NSString*)[self queuedText], _keyCodeOfOriginalEvent); - } + os_log_error([KMLogs lifecycleLog], "ERROR: new app activated before previous app finished processing pending events! _generatedBackspaceCount: %lu, _queuedText: '%{public}@' _keyCodeOfOriginalEvent: %hu", _generatedBackspaceCount, _queuedText == nil ? @"(NIL)" : (NSString*)[self queuedText], _keyCodeOfOriginalEvent); _keyCodeOfOriginalEvent = 0; _generatedBackspaceCount = 0; _queuedText = nil; diff --git a/mac/Keyman4MacIM/Keyman4MacIM/KMSettingsRepository.h b/mac/Keyman4MacIM/Keyman4MacIM/KMSettingsRepository.h index 7fdf3de034..846b9e11c6 100644 --- a/mac/Keyman4MacIM/Keyman4MacIM/KMSettingsRepository.h +++ b/mac/Keyman4MacIM/Keyman4MacIM/KMSettingsRepository.h @@ -26,8 +26,7 @@ NS_ASSUME_NONNULL_BEGIN - (void)writeOptionForSelectedKeyboard:(NSString *)key withValue:(NSString*)value; - (BOOL)readShowOskOnActivate; - (void)writeShowOskOnActivate:(BOOL)show; -- (BOOL)readUseVerboseLogging; -- (void)writeUseVerboseLogging:(BOOL)verboseLogging; +- (BOOL)readForceSentryError; @end NS_ASSUME_NONNULL_END diff --git a/mac/Keyman4MacIM/Keyman4MacIM/KMSettingsRepository.m b/mac/Keyman4MacIM/Keyman4MacIM/KMSettingsRepository.m index db59929eae..120c26e2c4 100644 --- a/mac/Keyman4MacIM/Keyman4MacIM/KMSettingsRepository.m +++ b/mac/Keyman4MacIM/Keyman4MacIM/KMSettingsRepository.m @@ -15,7 +15,7 @@ NSString *const kActiveKeyboardsKey = @"KMActiveKeyboardsKey"; NSString *const kSelectedKeyboardKey = @"KMSelectedKeyboardKey"; NSString *const kPersistedOptionsKey = @"KMPersistedOptionsKey"; NSString *const kShowOskOnActivate = @"KMShowOskOnActivate"; -NSString *const kUseVerboseLogging = @"KMUseVerboseLogging"; +NSString *const kForceSentryError = @"KMForceSentryError"; /** * The following constant "KMSavedStoresKey" is left here for documentation @@ -30,6 +30,11 @@ NSString *const kKMDeprecatedPersistedOptionsKey = @"KMSavedStoresKey"; * but the related UI has been removed according to issue #12342 */ NSString *const kAlwaysShowOSKKey = @"KMAlwaysShowOSKKey"; +/** + * The following constant "KMUseVerboseLogging" is left here for documentation + * but it is obsolete and removed issue #11525 + */ +NSString *const kUseVerboseLogging = @"KMUseVerboseLogging"; NSString *const kObsoletePathComponent = @"/Documents/Keyman-Keyboards"; NSString *const kNewPathComponent = @"/Library/Application Support/keyman.inputmethod.Keyman/"; @@ -321,14 +326,9 @@ NSInteger const kCurrentDataModelVersionNumber = kVersionStoreDataInLibraryDirec [userData setBool:show forKey:kShowOskOnActivate]; } -- (BOOL)readUseVerboseLogging { +- (BOOL)readForceSentryError { NSUserDefaults *userData = [NSUserDefaults standardUserDefaults]; - return [userData boolForKey:kUseVerboseLogging]; -} - -- (void)writeUseVerboseLogging:(BOOL)verboseLogging { - NSUserDefaults *userData = [NSUserDefaults standardUserDefaults]; - [userData setBool:verboseLogging forKey:kUseVerboseLogging]; + return [userData boolForKey:kForceSentryError]; } @end diff --git a/mac/Keyman4MacIM/KeymanTests/TestAppDelegate.h b/mac/Keyman4MacIM/KeymanTests/TestAppDelegate.h index fafd6f1905..8cb043d410 100644 --- a/mac/Keyman4MacIM/KeymanTests/TestAppDelegate.h +++ b/mac/Keyman4MacIM/KeymanTests/TestAppDelegate.h @@ -22,7 +22,6 @@ typedef void(^PostEventCallback)(CGEventRef eventToPost); @property (nonatomic, assign) CFMachPortRef lowLevelEventTap; // Always nil for tests @property (nonatomic, assign) BOOL contextChangingEventDetected; @property (nonatomic, assign) BOOL useNullChar; -@property (nonatomic, assign) BOOL debugMode; @property (nonatomic, assign) CGKeyCode virtualKeyPosted; // Helper method diff --git a/mac/Keyman4MacIM/KeymanTests/TestAppDelegate.m b/mac/Keyman4MacIM/KeymanTests/TestAppDelegate.m index 4b247056af..b2d1f859a2 100644 --- a/mac/Keyman4MacIM/KeymanTests/TestAppDelegate.m +++ b/mac/Keyman4MacIM/KeymanTests/TestAppDelegate.m @@ -16,7 +16,7 @@ - (KMEngine *)kme { if (_kme == nil) { - _kme = [[KMEngine alloc] initWithKMX:nil context:self.contextBuffer verboseLogging:self.debugMode]; + _kme = [[KMEngine alloc] initWithKMX:nil context:self.contextBuffer]; } return _kme; @@ -42,10 +42,6 @@ [self.kme setCoreContextIfNeeded:self.contextBuffer]; } -- (BOOL)debugMode { - return YES; -} - -(NSEvent *)keyStrokeEventForCharacter:(NSString *)character keyCode:(unsigned short) keyCode { return [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSZeroPoint modifierFlags:0 timestamp:NSTimeIntervalSince1970 windowNumber:0 context:nil characters:character charactersIgnoringModifiers:character isARepeat:NO keyCode:keyCode]; } diff --git a/mac/KeymanEngine4Mac/KeymanEngine4Mac/CoreWrapper/CoreHelper.h b/mac/KeymanEngine4Mac/KeymanEngine4Mac/CoreWrapper/CoreHelper.h index 0345ea6f31..ba3e5031f3 100644 --- a/mac/KeymanEngine4Mac/KeymanEngine4Mac/CoreWrapper/CoreHelper.h +++ b/mac/KeymanEngine4Mac/KeymanEngine4Mac/CoreWrapper/CoreHelper.h @@ -16,13 +16,10 @@ extern UInt32 VirtualKeyMap[0x80]; @interface CoreHelper : NSObject -@property (assign, nonatomic) BOOL debugMode; - -(unichar const *) createUnicharStringFromNSString:(NSString *)string; -(NSString *) createNSStringFromUnicharString:(unichar const *)string; -(unsigned long long) unicharStringLength:(unichar const *)string; --(instancetype)initWithDebugMode:(BOOL)debugMode; -(unsigned short) macVirtualKeyToWindowsVirtualKey:(unsigned short) keyCode; -(UTF32Char)macToKeymanModifier:(NSEventModifierFlags)modifiers; -(NSString*)utf32ValueToString:(UTF32Char)scalarValue; diff --git a/mac/KeymanEngine4Mac/KeymanEngine4Mac/CoreWrapper/CoreHelper.m b/mac/KeymanEngine4Mac/KeymanEngine4Mac/CoreWrapper/CoreHelper.m index 46ddbdeeb1..c7858e7b0d 100644 --- a/mac/KeymanEngine4Mac/KeymanEngine4Mac/CoreWrapper/CoreHelper.m +++ b/mac/KeymanEngine4Mac/KeymanEngine4Mac/CoreWrapper/CoreHelper.m @@ -69,10 +69,9 @@ UInt32 VirtualKeyMap[VIRTUAL_KEY_ARRAY_SIZE]; return length; } --(instancetype)initWithDebugMode:(BOOL)debugMode { +-(instancetype)init { self = [super init]; if (self) { - _debugMode = debugMode; [self initVirtualKeyMapping]; } return self; diff --git a/mac/KeymanEngine4Mac/KeymanEngine4Mac/KME/KMEngine.h b/mac/KeymanEngine4Mac/KeymanEngine4Mac/KME/KMEngine.h index c79b02ba32..523415fd26 100644 --- a/mac/KeymanEngine4Mac/KeymanEngine4Mac/KME/KMEngine.h +++ b/mac/KeymanEngine4Mac/KeymanEngine4Mac/KME/KMEngine.h @@ -18,16 +18,14 @@ @interface KMEngine : NSObject @property (weak, nonatomic) KMXFile *kmx; -@property (assign, nonatomic) BOOL debugMode; -- (id)initWithKMX:(KMXFile *)kmx context:(NSString *)ctxBuf verboseLogging:(BOOL)enableDebugLogging; +- (id)initWithKMX:(KMXFile *)kmx context:(NSString *)ctxBuf; - (NSString *)getCoreContextDebug; - (void)clearCoreContext; - (void)setCoreContextIfNeeded:(NSString *)context; - (void)setCoreOptions:(NSString *)key withValue:(NSString *)value; - (CoreKeyOutput *)processEvent:(NSEvent *)event; -- (void)setUseVerboseLogging:(BOOL)useVerboseLogging; @end diff --git a/mac/KeymanEngine4Mac/KeymanEngine4Mac/KME/KMEngine.m b/mac/KeymanEngine4Mac/KeymanEngine4Mac/KME/KMEngine.m index dd2b3247ed..4578472b6c 100644 --- a/mac/KeymanEngine4Mac/KeymanEngine4Mac/KME/KMEngine.m +++ b/mac/KeymanEngine4Mac/KeymanEngine4Mac/KME/KMEngine.m @@ -25,16 +25,11 @@ @implementation KMEngine -NSMutableString* _easterEggForSentry = nil; -const NSString* kEasterEggText = @"Sentrycrash#KME"; -const NSString* kEasterEggKmxName = @"EnglishSpanish.kmx"; - -- (id)initWithKMX:(KMXFile *)kmx context:(NSString *)contextString verboseLogging:(BOOL)enableDebugLogging { +- (id)initWithKMX:(KMXFile *)kmx context:(NSString *)contextString { self = [super init]; if (self) { - self.debugMode = enableDebugLogging; _kmx = kmx; - _coreHelper = [[CoreHelper alloc] initWithDebugMode:enableDebugLogging]; + _coreHelper = [[CoreHelper alloc] init]; if (kmx) { [self loadCoreWrapperFromKmxFile:self.kmx.filePath]; @@ -63,31 +58,6 @@ const NSString* kEasterEggKmxName = @"EnglishSpanish.kmx"; } } -- (void)setUseVerboseLogging:(BOOL)useVerboseLogging { - self.debugMode = useVerboseLogging; - - if (self.coreHelper) { - self.coreHelper.debugMode = useVerboseLogging; - } - - if (useVerboseLogging) { - os_log_debug([KMELogs testLog], "KMEngine - Turning verbose logging on"); - // In Keyman Engine if "debugMode" is turned on (explicitly) with "English plus Spanish" as the current keyboard and you type "Sentrycrash#KME", - // it will force a simulated crash to test reporting to sentry.keyman.com. - NSString * kmxName = [[_kmx filePath] lastPathComponent]; - os_log_debug([KMELogs testLog], "Sentry - KME: _kmx name = %{public}@", kmxName); - if ([kEasterEggKmxName isEqualToString:kmxName]) { - os_log_debug([KMELogs testLog], "Sentry - KME: Preparing to detect Easter egg."); - _easterEggForSentry = [[NSMutableString alloc] init]; - } - else - _easterEggForSentry = nil; - } - else { - os_log_debug([KMELogs testLog], "KMEngine - Turning verbose logging off"); - } -} - - (NSString *)getCoreContextDebug { return self.coreWrapper.contextDebug; } @@ -115,43 +85,6 @@ const NSString* kEasterEggKmxName = @"EnglishSpanish.kmx"; return [self.coreWrapper processEvent:event]; } -- (void) processPossibleEasterEggCharacterFrom:(NSString *)characters { - NSUInteger len = [_easterEggForSentry length]; - os_log_debug([KMELogs keyLog], "Sentry - KME: Processing character(s): %{public}@", characters); - if ([characters length] == 1 && [characters characterAtIndex:0] == [kEasterEggText characterAtIndex:len]) { - NSString *characterToAdd = [kEasterEggText substringWithRange:NSMakeRange(len, 1)]; - os_log_debug([KMELogs keyLog], "Sentry - KME: Adding character to Easter Egg code string: %{public}@", characterToAdd); - [_easterEggForSentry appendString:characterToAdd]; - if ([kEasterEggText isEqualToString:_easterEggForSentry]) { - os_log_debug([KMELogs keyLog], "Sentry - KME: Forcing crash now!"); - // Both of the following approaches do throw an exception that causes control to exit this method, - // but at least in my debug builds locally, neither one seems to get picked up by Sentry in a - // way that results in a new report on sentry.keyman.com - -#ifndef USE_ALERT_SHOW_HELP_TO_FORCE_EASTER_EGG_CRASH_FROM_ENGINE - //#1 - @throw ([NSException exceptionWithName:@"SentryForce" reason:@"Easter egg hit" userInfo:nil]); - - //#2 - // NSDecimalNumber *i = [NSDecimalNumber decimalNumberWithDecimal:[@(1) decimalValue]]; - // NSDecimalNumber *o = [NSDecimalNumber decimalNumberWithDecimal:[@(0) decimalValue]]; - // // Divide by 0 to throw an exception - // NSDecimalNumber *x = [i decimalNumberByDividingBy:o]; - -#else - //#3 The following DOES work, but it's really lame because the crash actually gets forced in the IM - // via this bogus call to a protocol method implemented in the IM's App Delegate just for the - // purpose of enabling the engine to force a crash. - [(NSObject *)[NSApp delegate] alertShowHelp:[NSAlert alertWithMessageText:@"Forcing an error" defaultButton:nil alternateButton:nil otherButton:nil informativeTextWithFormat:@"Forcing an Easter egg error from KME!"]]; -#endif - } - } - else if (len > 0) { - os_log_debug([KMELogs keyLog], "Sentry - KME: Clearing Easter Egg code string."); - [_easterEggForSentry setString:@""]; - } -} - - (NSString *)getCharsFromKeyCode:(UInt16)keyCode { TISInputSourceRef currentKeyboard = TISCopyCurrentKeyboardLayoutInputSource(); CFDataRef uchr = (CFDataRef)TISGetInputSourceProperty(currentKeyboard, kTISPropertyUnicodeKeyLayoutData); diff --git a/mac/KeymanEngine4Mac/KeymanEngine4MacTests/CoreTestStaticHelperMethods.m b/mac/KeymanEngine4Mac/KeymanEngine4MacTests/CoreTestStaticHelperMethods.m index 0f0aaf8a83..9954f4e01d 100644 --- a/mac/KeymanEngine4Mac/KeymanEngine4MacTests/CoreTestStaticHelperMethods.m +++ b/mac/KeymanEngine4Mac/KeymanEngine4MacTests/CoreTestStaticHelperMethods.m @@ -16,7 +16,7 @@ + (CoreHelper *)helper { static CoreHelper *coreHelper = nil; if (coreHelper == nil) { - coreHelper = [[CoreHelper alloc] initWithDebugMode:YES]; + coreHelper = [[CoreHelper alloc] init]; } return coreHelper; } diff --git a/mac/KeymanEngine4Mac/KeymanEngine4MacTests/KMEngineTests.m b/mac/KeymanEngine4Mac/KeymanEngine4MacTests/KMEngineTests.m index 290f30f302..2ebe487f8c 100644 --- a/mac/KeymanEngine4Mac/KeymanEngine4MacTests/KMEngineTests.m +++ b/mac/KeymanEngine4Mac/KeymanEngine4MacTests/KMEngineTests.m @@ -32,7 +32,7 @@ NSString * names[nCombinations]; } - (void)testinitWithKMX_NilKmx_ProcessEventReturnsNil { - KMEngine *engine = [[KMEngine alloc] initWithKMX:nil context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:nil context:@""]; NSEvent *event = [[NSEvent alloc] init]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(output == nil, @"Expected processEvent to return nil for nil kmx"); @@ -40,7 +40,7 @@ NSString * names[nCombinations]; - (void)testinitWithKMX_ValidKmxEmptyContext_InitializedWithEmptyContext { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; XCTAssert(engine != nil, @"Expected non-nil engine"); // Note: relying on km_core_state_context_debug output format is just barely // acceptable for a unit test @@ -49,7 +49,7 @@ NSString * names[nCombinations]; - (void)testinitWithKMX_ValidKmxNonEmptyContext_InitializedWithContext { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"abc" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"abc"]; XCTAssert(engine != nil, @"Expected non-nil engine"); // Note: relying on km_core_state_context_debug output format is just barely // acceptable for a unit test @@ -58,7 +58,7 @@ NSString * names[nCombinations]; - (void)testsetCoreContextIfNeeded_NonEmptyContext_InitialContextUpdated { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"a" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"a"]; [engine setCoreContextIfNeeded:@"xyz"]; // Note: relying on km_core_state_context_debug output format is just barely // acceptable for a unit test @@ -69,7 +69,7 @@ NSString * names[nCombinations]; /* - (void)testsetCoreContextIfNeeded_EmptyContext_InitialContextUpdated { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; [engine setCoreContextIfNeeded:@"xyz"]; // Note: relying on km_core_state_context_debug output format is just barely // acceptable for a unit test @@ -79,7 +79,7 @@ NSString * names[nCombinations]; - (void)testprocessEvent_eventForCommandKey_ReturnsNilOutput { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:NSEventModifierFlagCommand timestamp:0 windowNumber:0 context:nil characters:@"a" charactersIgnoringModifiers:@"a" isARepeat:NO keyCode:kVK_ANSI_A]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(output == nil, @"expected nil output from core"); @@ -87,7 +87,7 @@ NSString * names[nCombinations]; - (void)testprocessEvent_eventWithoutKeycode_ReturnsNilOutput { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; NSEvent *event = [NSEvent mouseEventWithType:NSEventTypeMouseMoved location:NSMakePoint(29, 21) modifierFlags:NSEventModifierFlagShift timestamp:0 windowNumber:0 context:nil eventNumber:23 clickCount:0 pressure:0]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(output == nil, @"nil CoreKeyOutput"); @@ -96,7 +96,7 @@ NSString * names[nCombinations]; // TODO: shouldn't this return emitKeystroke = YES? - (void)testprocessEvent_eventForUnmappedKey_ReturnsNoActions { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"z" charactersIgnoringModifiers:@"z" isARepeat:NO keyCode:kVK_ANSI_Z]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(output == nil, @"Expected nil array of actions"); @@ -104,7 +104,7 @@ NSString * names[nCombinations]; - (void)testprocessEvent_eventForLowercaseA_ReturnsCharacterActionWithExpectedCharacterBasedOnKmx { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"a" charactersIgnoringModifiers:@"a" isARepeat:NO keyCode:kVK_ANSI_A]; CoreKeyOutput *output = [engine processEvent:event]; os_log_debug([KMELogs testLog], "output = %{public}@", output); @@ -116,7 +116,7 @@ NSString * names[nCombinations]; /* -(void)testprocessEvent_eventForCtrlShiftNumeralWithCipherMusicKmx_ReturnsQstrActionForCorrectUnicodeSurrogatePair { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForCipherMusicTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile contextBuffer:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile contextBuffer:@""]; for (int i = 1; i <= 6; i++) { unsigned short ansiCode = kVK_ANSI_1 + i - 1; @@ -152,7 +152,7 @@ NSString * names[nCombinations]; - (void)testprocessEvent_eventsForOpenCurlyBraceWithCipherMusicKmx_ReturnsCharacterForStartSlide { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForCipherMusicTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; UTF32Char expectedUtf32Char = 0x1D177; NSString * expectedStartSlideSurrogatePair = [[NSString alloc] initWithBytes:&expectedUtf32Char length:4 encoding:NSUTF32LittleEndianStringEncoding]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:NSEventModifierFlagShift timestamp:0 windowNumber:0 context:nil characters:@"{" charactersIgnoringModifiers:@"[" isARepeat:NO keyCode:kVK_ANSI_LeftBracket]; @@ -165,7 +165,7 @@ NSString * names[nCombinations]; // TODO: fails with core, investigate - (void)testprocessEvent_eventForUnshiftedNumeralWithCipherMusicKmx_ReturnsCharacterActionToInsertNumeral { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForCipherMusicTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile contextBuffer:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile contextBuffer:@""]; for (int i = 1; i <= 9; i++) { unsigned short ansiCode = kVK_ANSI_1 + i - 1; @@ -185,7 +185,7 @@ NSString * names[nCombinations]; // TODO: fails with core, returns CharacterAction - (void)testprocessEvent_eventForShiftNumeralsWithoutRulesInCipherMusicKmx_ReturnsNoAction { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForCipherMusicTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; for (int i = 0; i <= 9; i++) { if (i == 6) @@ -228,7 +228,7 @@ NSString * names[nCombinations]; // TODO: fails with core, returns CharacterAction - (void)testprocessEvent_eventForPeriodWithCipherMusicKmx_ReturnsNoAction { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForCipherMusicTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"." charactersIgnoringModifiers:@"." isARepeat:NO keyCode:kVK_ANSI_Period]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(!output.hasTextToInsert, @"expected no text to insert"); @@ -236,7 +236,7 @@ NSString * names[nCombinations]; - (void)testprocessEvent_eventForCtrl8WithCipherMusicKmx_ReturnsEmit { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForCipherMusicTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:NSEventModifierFlagControl timestamp:0 windowNumber:0 context:nil characters:@"8" charactersIgnoringModifiers:@"8" isARepeat:NO keyCode:kVK_ANSI_8]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(output.emitKeystroke, @"emitKeystroke == YES"); @@ -279,7 +279,7 @@ NSString * names[nCombinations]; [KMEngineTests fillInNamesAndModifiersForAllChiralCombinations]; KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; for (i = 0; i < nCombinations; i++) { [engine clearCoreContext]; @@ -346,7 +346,7 @@ NSString * names[nCombinations]; [KMEngineTests fillInNamesAndModifiersForAllChiralCombinations]; KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileTestMacEngine]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; for (i = 0; i < nCombinations; i++) { [engine clearCoreContext]; @@ -419,7 +419,7 @@ NSString * names[nCombinations]; - (NSString *)checkPlatform_getOutputForKeystroke: (NSString*) character modifierFlags: (NSEventModifierFlags) flag keyCode:(unsigned short)code { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForPlatformTest]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; NSString *lcChar = [character lowercaseString]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:flag timestamp:0 windowNumber:0 context:nil characters:character charactersIgnoringModifiers:lcChar isARepeat:NO keyCode:code]; CoreKeyOutput *output = [engine processEvent:event]; @@ -516,7 +516,7 @@ NSString * names[nCombinations]; - (void)testEngine_ipaKeyboardAction_DoesNotCrash_Issue1892 { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForIndexOffsetTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"z" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"z"]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"a" charactersIgnoringModifiers:@"a" isARepeat:NO keyCode:kVK_ANSI_A]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(output.hasCodePointsToDelete, @"output hasCodePointsToDelete == YES"); @@ -525,7 +525,7 @@ NSString * names[nCombinations]; - (void)testCoreProcessEvent_eventForFWithElNuerKmx_ReturnsCorrectCharacter { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForElNuerTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"f" charactersIgnoringModifiers:@"f" isARepeat:NO keyCode:kVK_ANSI_F]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert([output.textToInsert isEqualToString:@"ɣ"], @"Expected output to be 'ɣ'."); @@ -535,7 +535,7 @@ NSString * names[nCombinations]; - (void)testArmenianMnemonic_triggerPersistOptions_ReturnsOptions { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForArmenianMnemonicTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"√" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"√"]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"w" charactersIgnoringModifiers:@"w" isARepeat:NO keyCode:kVK_ANSI_W]; CoreKeyOutput *output = [engine processEvent:event]; NSString *key = @"option_ligature_ew"; @@ -546,7 +546,7 @@ NSString * names[nCombinations]; - (void)testCoreProcessEvent_backspaceElNuerEmptyContext_PassesThrough { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForElNuerTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@""]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"\b" charactersIgnoringModifiers:@"\b" isARepeat:NO keyCode:kVK_Delete]; CoreKeyOutput *output = [engine processEvent:event]; os_log_debug([KMELogs testLog], "output = %{public}@", output); @@ -557,7 +557,7 @@ NSString * names[nCombinations]; - (void)testCoreProcessEvent_backspaceElNuerWithContext_EmptiesContextReturnsDelete { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForElNuerTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"ɣ" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"ɣ"]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"\b" charactersIgnoringModifiers:@"\b" isARepeat:NO keyCode:kVK_Delete]; CoreKeyOutput *output = [engine processEvent:event]; os_log_debug([KMELogs testLog], "output = %{public}@", output); @@ -571,7 +571,7 @@ NSString * names[nCombinations]; - (void)testCoreProcessEvent_eventReturnWithElNuerKmx_EmitWithContextEmpty { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForElNuerTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"ɣ" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"ɣ"]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"\n" charactersIgnoringModifiers:@"\n" isARepeat:NO keyCode:kVK_Return]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(output.emitKeystroke, @"Expected emitKeystroke==YES"); @@ -583,7 +583,7 @@ NSString * names[nCombinations]; - (void)testCoreProcessEvent_eventTabWithElNuerKmx_EmitWithContextEmpty { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForElNuerTests]; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"ɣ" verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:@"ɣ"]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"\t" charactersIgnoringModifiers:@"\t" isARepeat:NO keyCode:kVK_Tab]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(output.emitKeystroke, @"Expected emitKeystroke==YES"); @@ -596,7 +596,7 @@ NSString * names[nCombinations]; - (void)testCoreProcessEvent_eventSingleQuoteWithElNuerKmx_ReturnsDiacritic { KMXFile *kmxFile = [KeymanEngineTestsStaticHelperMethods getKmxFileForElNuerTests]; NSString *context = @"ɛ"; - KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:context verboseLogging:YES]; + KMEngine *engine = [[KMEngine alloc] initWithKMX:kmxFile context:context]; NSEvent *event = [NSEvent keyEventWithType:NSEventTypeKeyDown location:NSMakePoint(0, 0) modifierFlags:0 timestamp:0 windowNumber:0 context:nil characters:@"'" charactersIgnoringModifiers:@"'" isARepeat:NO keyCode:kVK_ANSI_Quote]; CoreKeyOutput *output = [engine processEvent:event]; XCTAssert(output.hasTextToInsert, @"returns text to insert"); diff --git a/mac/help/about/history.md b/mac/docs/help/about/history.md similarity index 100% rename from mac/help/about/history.md rename to mac/docs/help/about/history.md diff --git a/mac/help/about/index.md b/mac/docs/help/about/index.md similarity index 100% rename from mac/help/about/index.md rename to mac/docs/help/about/index.md diff --git a/mac/help/about/requirements.md b/mac/docs/help/about/requirements.md similarity index 100% rename from mac/help/about/requirements.md rename to mac/docs/help/about/requirements.md diff --git a/mac/help/about/welcome.md b/mac/docs/help/about/welcome.md similarity index 100% rename from mac/help/about/welcome.md rename to mac/docs/help/about/welcome.md diff --git a/mac/help/about/whatsnew.md b/mac/docs/help/about/whatsnew.md similarity index 100% rename from mac/help/about/whatsnew.md rename to mac/docs/help/about/whatsnew.md diff --git a/mac/help/basic/config/index.md b/mac/docs/help/basic/config/index.md similarity index 100% rename from mac/help/basic/config/index.md rename to mac/docs/help/basic/config/index.md diff --git a/mac/help/basic/config/keyboards.md b/mac/docs/help/basic/config/keyboards.md similarity index 100% rename from mac/help/basic/config/keyboards.md rename to mac/docs/help/basic/config/keyboards.md diff --git a/mac/help/basic/config/options.md b/mac/docs/help/basic/config/options.md similarity index 100% rename from mac/help/basic/config/options.md rename to mac/docs/help/basic/config/options.md diff --git a/mac/help/basic/config/support.md b/mac/docs/help/basic/config/support.md similarity index 100% rename from mac/help/basic/config/support.md rename to mac/docs/help/basic/config/support.md diff --git a/mac/help/basic/index.md b/mac/docs/help/basic/index.md similarity index 100% rename from mac/help/basic/index.md rename to mac/docs/help/basic/index.md diff --git a/mac/help/common/adware.md b/mac/docs/help/common/adware.md similarity index 100% rename from mac/help/common/adware.md rename to mac/docs/help/common/adware.md diff --git a/mac/help/common/bug.md b/mac/docs/help/common/bug.md similarity index 100% rename from mac/help/common/bug.md rename to mac/docs/help/common/bug.md diff --git a/mac/help/common/free.md b/mac/docs/help/common/free.md similarity index 100% rename from mac/help/common/free.md rename to mac/docs/help/common/free.md diff --git a/mac/help/common/index.md b/mac/docs/help/common/index.md similarity index 100% rename from mac/help/common/index.md rename to mac/docs/help/common/index.md diff --git a/mac/help/common/keyboards.md b/mac/docs/help/common/keyboards.md similarity index 100% rename from mac/help/common/keyboards.md rename to mac/docs/help/common/keyboards.md diff --git a/mac/help/common/os.md b/mac/docs/help/common/os.md similarity index 100% rename from mac/help/common/os.md rename to mac/docs/help/common/os.md diff --git a/mac/help/common/osk.md b/mac/docs/help/common/osk.md similarity index 100% rename from mac/help/common/osk.md rename to mac/docs/help/common/osk.md diff --git a/mac/help/common/requirements.md b/mac/docs/help/common/requirements.md similarity index 100% rename from mac/help/common/requirements.md rename to mac/docs/help/common/requirements.md diff --git a/mac/help/common/support.md b/mac/docs/help/common/support.md similarity index 100% rename from mac/help/common/support.md rename to mac/docs/help/common/support.md diff --git a/mac/help/index.md b/mac/docs/help/index.md similarity index 100% rename from mac/help/index.md rename to mac/docs/help/index.md diff --git a/mac/help/mac_images/add.png b/mac/docs/help/mac_images/add.png similarity index 100% rename from mac/help/mac_images/add.png rename to mac/docs/help/mac_images/add.png diff --git a/mac/help/mac_images/add_keyman.png b/mac/docs/help/mac_images/add_keyman.png similarity index 100% rename from mac/help/mac_images/add_keyman.png rename to mac/docs/help/mac_images/add_keyman.png diff --git a/mac/help/mac_images/apple_menu.png b/mac/docs/help/mac_images/apple_menu.png similarity index 100% rename from mac/help/mac_images/apple_menu.png rename to mac/docs/help/mac_images/apple_menu.png diff --git a/mac/help/mac_images/go_to_folder.png b/mac/docs/help/mac_images/go_to_folder.png similarity index 100% rename from mac/help/mac_images/go_to_folder.png rename to mac/docs/help/mac_images/go_to_folder.png diff --git a/mac/help/mac_images/help_button.png b/mac/docs/help/mac_images/help_button.png similarity index 100% rename from mac/help/mac_images/help_button.png rename to mac/docs/help/mac_images/help_button.png diff --git a/mac/help/mac_images/icon-fonts.png b/mac/docs/help/mac_images/icon-fonts.png similarity index 100% rename from mac/help/mac_images/icon-fonts.png rename to mac/docs/help/mac_images/icon-fonts.png diff --git a/mac/help/mac_images/icon-help.png b/mac/docs/help/mac_images/icon-help.png similarity index 100% rename from mac/help/mac_images/icon-help.png rename to mac/docs/help/mac_images/icon-help.png diff --git a/mac/help/mac_images/icon-intro.png b/mac/docs/help/mac_images/icon-intro.png similarity index 100% rename from mac/help/mac_images/icon-intro.png rename to mac/docs/help/mac_images/icon-intro.png diff --git a/mac/help/mac_images/icon-keyman.png b/mac/docs/help/mac_images/icon-keyman.png similarity index 100% rename from mac/help/mac_images/icon-keyman.png rename to mac/docs/help/mac_images/icon-keyman.png diff --git a/mac/help/mac_images/icon-osk.png b/mac/docs/help/mac_images/icon-osk.png similarity index 100% rename from mac/help/mac_images/icon-osk.png rename to mac/docs/help/mac_images/icon-osk.png diff --git a/mac/help/mac_images/icon-unicode.png b/mac/docs/help/mac_images/icon-unicode.png similarity index 100% rename from mac/help/mac_images/icon-unicode.png rename to mac/docs/help/mac_images/icon-unicode.png diff --git a/mac/help/mac_images/information_button.png b/mac/docs/help/mac_images/information_button.png similarity index 100% rename from mac/help/mac_images/information_button.png rename to mac/docs/help/mac_images/information_button.png diff --git a/mac/help/mac_images/input_menu.png b/mac/docs/help/mac_images/input_menu.png similarity index 100% rename from mac/help/mac_images/input_menu.png rename to mac/docs/help/mac_images/input_menu.png diff --git a/mac/help/mac_images/keyboards_menu.png b/mac/docs/help/mac_images/keyboards_menu.png similarity index 100% rename from mac/help/mac_images/keyboards_menu.png rename to mac/docs/help/mac_images/keyboards_menu.png diff --git a/mac/help/mac_images/keyman_config.png b/mac/docs/help/mac_images/keyman_config.png similarity index 100% rename from mac/help/mac_images/keyman_config.png rename to mac/docs/help/mac_images/keyman_config.png diff --git a/mac/help/mac_images/keyman_install.png b/mac/docs/help/mac_images/keyman_install.png similarity index 100% rename from mac/help/mac_images/keyman_install.png rename to mac/docs/help/mac_images/keyman_install.png diff --git a/mac/help/mac_images/keyman_menu_config.png b/mac/docs/help/mac_images/keyman_menu_config.png similarity index 100% rename from mac/help/mac_images/keyman_menu_config.png rename to mac/docs/help/mac_images/keyman_menu_config.png diff --git a/mac/help/mac_images/menu_bar.png b/mac/docs/help/mac_images/menu_bar.png similarity index 100% rename from mac/help/mac_images/menu_bar.png rename to mac/docs/help/mac_images/menu_bar.png diff --git a/mac/help/mac_images/menu_bar_keyman.png b/mac/docs/help/mac_images/menu_bar_keyman.png similarity index 100% rename from mac/help/mac_images/menu_bar_keyman.png rename to mac/docs/help/mac_images/menu_bar_keyman.png diff --git a/mac/help/mac_images/osk_amharic.png b/mac/docs/help/mac_images/osk_amharic.png similarity index 100% rename from mac/help/mac_images/osk_amharic.png rename to mac/docs/help/mac_images/osk_amharic.png diff --git a/mac/help/mac_images/privacy_accessibility.png b/mac/docs/help/mac_images/privacy_accessibility.png similarity index 100% rename from mac/help/mac_images/privacy_accessibility.png rename to mac/docs/help/mac_images/privacy_accessibility.png diff --git a/mac/help/mac_images/privacy_files_and_folders.png b/mac/docs/help/mac_images/privacy_files_and_folders.png similarity index 100% rename from mac/help/mac_images/privacy_files_and_folders.png rename to mac/docs/help/mac_images/privacy_files_and_folders.png diff --git a/mac/help/mac_images/privacy_input_monitoring.png b/mac/docs/help/mac_images/privacy_input_monitoring.png similarity index 100% rename from mac/help/mac_images/privacy_input_monitoring.png rename to mac/docs/help/mac_images/privacy_input_monitoring.png diff --git a/mac/help/mac_images/privacy_input_monitoring_locked.png b/mac/docs/help/mac_images/privacy_input_monitoring_locked.png similarity index 100% rename from mac/help/mac_images/privacy_input_monitoring_locked.png rename to mac/docs/help/mac_images/privacy_input_monitoring_locked.png diff --git a/mac/help/mac_images/remove.png b/mac/docs/help/mac_images/remove.png similarity index 100% rename from mac/help/mac_images/remove.png rename to mac/docs/help/mac_images/remove.png diff --git a/mac/help/mac_images/remove_button.png b/mac/docs/help/mac_images/remove_button.png similarity index 100% rename from mac/help/mac_images/remove_button.png rename to mac/docs/help/mac_images/remove_button.png diff --git a/mac/help/mac_images/remove_keyman.png b/mac/docs/help/mac_images/remove_keyman.png similarity index 100% rename from mac/help/mac_images/remove_keyman.png rename to mac/docs/help/mac_images/remove_keyman.png diff --git a/mac/help/mac_images/system_preferences.png b/mac/docs/help/mac_images/system_preferences.png similarity index 100% rename from mac/help/mac_images/system_preferences.png rename to mac/docs/help/mac_images/system_preferences.png diff --git a/mac/help/mac_images/video.png b/mac/docs/help/mac_images/video.png similarity index 100% rename from mac/help/mac_images/video.png rename to mac/docs/help/mac_images/video.png diff --git a/mac/help/start/index.md b/mac/docs/help/start/index.md similarity index 100% rename from mac/help/start/index.md rename to mac/docs/help/start/index.md diff --git a/mac/help/start/install-keyboard.md b/mac/docs/help/start/install-keyboard.md similarity index 100% rename from mac/help/start/install-keyboard.md rename to mac/docs/help/start/install-keyboard.md diff --git a/mac/help/start/install-keyman.md b/mac/docs/help/start/install-keyman.md similarity index 100% rename from mac/help/start/install-keyman.md rename to mac/docs/help/start/install-keyman.md diff --git a/mac/help/start/tutorial.md b/mac/docs/help/start/tutorial.md similarity index 100% rename from mac/help/start/tutorial.md rename to mac/docs/help/start/tutorial.md diff --git a/mac/help/troubleshooting/configure-security.md b/mac/docs/help/troubleshooting/configure-security.md similarity index 100% rename from mac/help/troubleshooting/configure-security.md rename to mac/docs/help/troubleshooting/configure-security.md diff --git a/mac/help/troubleshooting/index.md b/mac/docs/help/troubleshooting/index.md similarity index 100% rename from mac/help/troubleshooting/index.md rename to mac/docs/help/troubleshooting/index.md diff --git a/mac/help/troubleshooting/uninstall-keyman.md b/mac/docs/help/troubleshooting/uninstall-keyman.md similarity index 100% rename from mac/help/troubleshooting/uninstall-keyman.md rename to mac/docs/help/troubleshooting/uninstall-keyman.md diff --git a/package-lock.json b/package-lock.json index 912bb6727f..7cbb8d2da2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3639,9 +3639,9 @@ } }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.16.4.tgz", - "integrity": "sha512-GkhjAaQ8oUTOKE4g4gsZ0u8K/IHU1+2WQSgS1TwTcYvL+sjbaQjNHFXbOJ6kgqGHIO1DfUhI/Sphi9GkRT9K+Q==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.22.4.tgz", + "integrity": "sha512-Fxamp4aEZnfPOcGA8KSNEohV8hX7zVHOemC8jVBoBUHu5zpJK/Eu3uJwt6BMgy9fkvzxDaurgj96F/NiLukF2w==", "cpu": [ "arm" ], @@ -3652,9 +3652,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.16.4.tgz", - "integrity": "sha512-Bvm6D+NPbGMQOcxvS1zUl8H7DWlywSXsphAeOnVeiZLQ+0J6Is8T7SrjGTH29KtYkiY9vld8ZnpV3G2EPbom+w==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.22.4.tgz", + "integrity": "sha512-VXoK5UMrgECLYaMuGuVTOx5kcuap1Jm8g/M83RnCHBKOqvPPmROFJGQaZhGccnsFtfXQ3XYa4/jMCJvZnbJBdA==", "cpu": [ "arm64" ], @@ -3665,9 +3665,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.16.4.tgz", - "integrity": "sha512-i5d64MlnYBO9EkCOGe5vPR/EeDwjnKOGGdd7zKFhU5y8haKhQZTN2DgVtpODDMxUr4t2K90wTUJg7ilgND6bXw==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.22.4.tgz", + "integrity": "sha512-xMM9ORBqu81jyMKCDP+SZDhnX2QEVQzTcC6G18KlTQEzWK8r/oNZtKuZaCcHhnsa6fEeOBionoyl5JsAbE/36Q==", "cpu": [ "arm64" ], @@ -3678,9 +3678,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.16.4.tgz", - "integrity": "sha512-WZupV1+CdUYehaZqjaFTClJI72fjJEgTXdf4NbW69I9XyvdmztUExBtcI2yIIU6hJtYvtwS6pkTkHJz+k08mAQ==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.22.4.tgz", + "integrity": "sha512-aJJyYKQwbHuhTUrjWjxEvGnNNBCnmpHDvrb8JFDbeSH3m2XdHcxDd3jthAzvmoI8w/kSjd2y0udT+4okADsZIw==", "cpu": [ "x64" ], @@ -3691,9 +3691,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.16.4.tgz", - "integrity": "sha512-ADm/xt86JUnmAfA9mBqFcRp//RVRt1ohGOYF6yL+IFCYqOBNwy5lbEK05xTsEoJq+/tJzg8ICUtS82WinJRuIw==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.22.4.tgz", + "integrity": "sha512-j63YtCIRAzbO+gC2L9dWXRh5BFetsv0j0va0Wi9epXDgU/XUi5dJKo4USTttVyK7fGw2nPWK0PbAvyliz50SCQ==", "cpu": [ "arm" ], @@ -3704,9 +3704,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.16.4.tgz", - "integrity": "sha512-tJfJaXPiFAG+Jn3cutp7mCs1ePltuAgRqdDZrzb1aeE3TktWWJ+g7xK9SNlaSUFw6IU4QgOxAY4rA+wZUT5Wfg==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.22.4.tgz", + "integrity": "sha512-dJnWUgwWBX1YBRsuKKMOlXCzh2Wu1mlHzv20TpqEsfdZLb3WoJW2kIEsGwLkroYf24IrPAvOT/ZQ2OYMV6vlrg==", "cpu": [ "arm" ], @@ -3717,9 +3717,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.16.4.tgz", - "integrity": "sha512-7dy1BzQkgYlUTapDTvK997cgi0Orh5Iu7JlZVBy1MBURk7/HSbHkzRnXZa19ozy+wwD8/SlpJnOOckuNZtJR9w==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.22.4.tgz", + "integrity": "sha512-AdPRoNi3NKVLolCN/Sp4F4N1d98c4SBnHMKoLuiG6RXgoZ4sllseuGioszumnPGmPM2O7qaAX/IJdeDU8f26Aw==", "cpu": [ "arm64" ], @@ -3730,9 +3730,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.16.4.tgz", - "integrity": "sha512-zsFwdUw5XLD1gQe0aoU2HVceI6NEW7q7m05wA46eUAyrkeNYExObfRFQcvA6zw8lfRc5BHtan3tBpo+kqEOxmg==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.22.4.tgz", + "integrity": "sha512-Gl0AxBtDg8uoAn5CCqQDMqAx22Wx22pjDOjBdmG0VIWX3qUBHzYmOKh8KXHL4UpogfJ14G4wk16EQogF+v8hmA==", "cpu": [ "arm64" ], @@ -3743,9 +3743,9 @@ ] }, "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.16.4.tgz", - "integrity": "sha512-p8C3NnxXooRdNrdv6dBmRTddEapfESEUflpICDNKXpHvTjRRq1J82CbU5G3XfebIZyI3B0s074JHMWD36qOW6w==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.22.4.tgz", + "integrity": "sha512-3aVCK9xfWW1oGQpTsYJJPF6bfpWfhbRnhdlyhak2ZiyFLDaayz0EP5j9V1RVLAAxlmWKTDfS9wyRyY3hvhPoOg==", "cpu": [ "ppc64" ], @@ -3756,9 +3756,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.16.4.tgz", - "integrity": "sha512-Lh/8ckoar4s4Id2foY7jNgitTOUQczwMWNYi+Mjt0eQ9LKhr6sK477REqQkmy8YHY3Ca3A2JJVdXnfb3Rrwkng==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.22.4.tgz", + "integrity": "sha512-ePYIir6VYnhgv2C5Xe9u+ico4t8sZWXschR6fMgoPUK31yQu7hTEJb7bCqivHECwIClJfKgE7zYsh1qTP3WHUA==", "cpu": [ "riscv64" ], @@ -3769,9 +3769,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.16.4.tgz", - "integrity": "sha512-1xwwn9ZCQYuqGmulGsTZoKrrn0z2fAur2ujE60QgyDpHmBbXbxLaQiEvzJWDrscRq43c8DnuHx3QorhMTZgisQ==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.22.4.tgz", + "integrity": "sha512-GqFJ9wLlbB9daxhVlrTe61vJtEY99/xB3C8e4ULVsVfflcpmR6c8UZXjtkMA6FhNONhj2eA5Tk9uAVw5orEs4Q==", "cpu": [ "s390x" ], @@ -3782,9 +3782,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.16.4.tgz", - "integrity": "sha512-LuOGGKAJ7dfRtxVnO1i3qWc6N9sh0Em/8aZ3CezixSTM+E9Oq3OvTsvC4sm6wWjzpsIlOCnZjdluINKESflJLA==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.22.4.tgz", + "integrity": "sha512-87v0ol2sH9GE3cLQLNEy0K/R0pz1nvg76o8M5nhMR0+Q+BBGLnb35P0fVz4CQxHYXaAOhE8HhlkaZfsdUOlHwg==", "cpu": [ "x64" ], @@ -3795,9 +3795,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.16.4.tgz", - "integrity": "sha512-ch86i7KkJKkLybDP2AtySFTRi5fM3KXp0PnHocHuJMdZwu7BuyIKi35BE9guMlmTpwwBTB3ljHj9IQXnTCD0vA==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.22.4.tgz", + "integrity": "sha512-UV6FZMUgePDZrFjrNGIWzDo/vABebuXBhJEqrHxrGiU6HikPy0Z3LfdtciIttEUQfuDdCn8fqh7wiFJjCNwO+g==", "cpu": [ "x64" ], @@ -3808,9 +3808,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.16.4.tgz", - "integrity": "sha512-Ma4PwyLfOWZWayfEsNQzTDBVW8PZ6TUUN1uFTBQbF2Chv/+sjenE86lpiEwj2FiviSmSZ4Ap4MaAfl1ciF4aSA==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.22.4.tgz", + "integrity": "sha512-BjI+NVVEGAXjGWYHz/vv0pBqfGoUH0IGZ0cICTn7kB9PyjrATSkX+8WkguNjWoj2qSr1im/+tTGRaY+4/PdcQw==", "cpu": [ "arm64" ], @@ -3821,9 +3821,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.16.4.tgz", - "integrity": "sha512-9m/ZDrQsdo/c06uOlP3W9G2ENRVzgzbSXmXHT4hwVaDQhYcRpi9bgBT0FTG9OhESxwK0WjQxYOSfv40cU+T69w==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.22.4.tgz", + "integrity": "sha512-SiWG/1TuUdPvYmzmYnmd3IEifzR61Tragkbx9D3+R8mzQqDBz8v+BvZNDlkiTtI9T15KYZhP0ehn3Dld4n9J5g==", "cpu": [ "ia32" ], @@ -3834,9 +3834,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.16.4.tgz", - "integrity": "sha512-YunpoOAyGLDseanENHmbFvQSfVL5BxW3k7hhy0eN4rb3gS/ct75dVD0EXOWIqFT/nE8XYW6LP6vz6ctKRi0k9A==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.22.4.tgz", + "integrity": "sha512-j8pPKp53/lq9lMXN57S8cFz0MynJk8OWNuUnXct/9KCpKU7DgU3bYMJhwWmcqC0UU29p8Lr0/7KEVcaM6bf47Q==", "cpu": [ "x64" ], @@ -12742,9 +12742,9 @@ } }, "node_modules/rollup": { - "version": "4.16.4", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.16.4.tgz", - "integrity": "sha512-kuaTJSUbz+Wsb2ATGvEknkI12XV40vIiHmLuFlejoo7HtDok/O5eDDD0UpCVY5bBX5U5RYo8wWP83H7ZsqVEnA==", + "version": "4.22.4", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.22.4.tgz", + "integrity": "sha512-vD8HJ5raRcWOyymsR6Z3o6+RzfEPCnVLMFJ6vRslO1jt4LO6dUo5Qnpg7y4RkZFM2DMe3WUirkI5c16onjrc6A==", "dev": true, "dependencies": { "@types/estree": "1.0.5" @@ -12757,22 +12757,22 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.16.4", - "@rollup/rollup-android-arm64": "4.16.4", - "@rollup/rollup-darwin-arm64": "4.16.4", - "@rollup/rollup-darwin-x64": "4.16.4", - "@rollup/rollup-linux-arm-gnueabihf": "4.16.4", - "@rollup/rollup-linux-arm-musleabihf": "4.16.4", - "@rollup/rollup-linux-arm64-gnu": "4.16.4", - "@rollup/rollup-linux-arm64-musl": "4.16.4", - "@rollup/rollup-linux-powerpc64le-gnu": "4.16.4", - "@rollup/rollup-linux-riscv64-gnu": "4.16.4", - "@rollup/rollup-linux-s390x-gnu": "4.16.4", - "@rollup/rollup-linux-x64-gnu": "4.16.4", - "@rollup/rollup-linux-x64-musl": "4.16.4", - "@rollup/rollup-win32-arm64-msvc": "4.16.4", - "@rollup/rollup-win32-ia32-msvc": "4.16.4", - "@rollup/rollup-win32-x64-msvc": "4.16.4", + "@rollup/rollup-android-arm-eabi": "4.22.4", + "@rollup/rollup-android-arm64": "4.22.4", + "@rollup/rollup-darwin-arm64": "4.22.4", + "@rollup/rollup-darwin-x64": "4.22.4", + "@rollup/rollup-linux-arm-gnueabihf": "4.22.4", + "@rollup/rollup-linux-arm-musleabihf": "4.22.4", + "@rollup/rollup-linux-arm64-gnu": "4.22.4", + "@rollup/rollup-linux-arm64-musl": "4.22.4", + "@rollup/rollup-linux-powerpc64le-gnu": "4.22.4", + "@rollup/rollup-linux-riscv64-gnu": "4.22.4", + "@rollup/rollup-linux-s390x-gnu": "4.22.4", + "@rollup/rollup-linux-x64-gnu": "4.22.4", + "@rollup/rollup-linux-x64-musl": "4.22.4", + "@rollup/rollup-win32-arm64-msvc": "4.22.4", + "@rollup/rollup-win32-ia32-msvc": "4.22.4", + "@rollup/rollup-win32-x64-msvc": "4.22.4", "fsevents": "~2.3.2" } }, diff --git a/resources/build/build-help.inc.sh b/resources/build/build-help.inc.sh index f5770fe885..364f3f1bcd 100644 --- a/resources/build/build-help.inc.sh +++ b/resources/build/build-help.inc.sh @@ -36,7 +36,7 @@ function _build_help_build() { local CSS="$KEYMAN_ROOT/resources/build/offline-help-style-spec.txt" local PLATFORM="$1" - cd "$KEYMAN_ROOT/$PLATFORM/help" + cd "$KEYMAN_ROOT/$PLATFORM/docs/help" local MD=`find . -name "*.md"` local DESTHTM="$KEYMAN_ROOT/$PLATFORM/$2" @@ -53,9 +53,9 @@ function _build_help_build() { # # Copy Images # - cd "$KEYMAN_ROOT/$PLATFORM/help/" + cd "$KEYMAN_ROOT/$PLATFORM/docs/help/" mkdir -p "$DESTHTM/${PLATFORM}_images" - cp $KEYMAN_ROOT/$PLATFORM/help/${PLATFORM}_images/* "$DESTHTM/${PLATFORM}_images/" + cp $KEYMAN_ROOT/$PLATFORM/docs/help/${PLATFORM}_images/* "$DESTHTM/${PLATFORM}_images/" } # @@ -74,7 +74,7 @@ function _build_help_build() { # # ### Description # -# Expects to find .md source under $KEYMAN_ROOT/$platform/help/, and +# Expects to find .md source under $KEYMAN_ROOT/$platform/docs/help/, and # will write the output .html to $KEYMAN_ROOT/$platform/$output_path. # function build_help_html() { diff --git a/resources/build/builder.md b/resources/build/builder.md index 0e3ef901f7..dd52318810 100644 --- a/resources/build/builder.md +++ b/resources/build/builder.md @@ -327,6 +327,8 @@ The following parameters are pre-defined and should not be overridden: * `--no-color`: forces off ANSI color output for the script * `--verbose`, `-v`: verbose mode, sets the [`$builder_verbose`] variable * `--debug`, `-d`: debug build; see [`builder_is_debug_build`] for more detail +* `--offline`: allow to build while offline. This might fail if not all + dependencies are cached. -------------------------------------------------------------------------------- diff --git a/resources/build/help-keyman-com.sh b/resources/build/help-keyman-com.sh index 6160816443..98723f0667 100755 --- a/resources/build/help-keyman-com.sh +++ b/resources/build/help-keyman-com.sh @@ -74,19 +74,19 @@ function upload { function upload_keyman_help { case $platform in android) - upload android/help products/android/$VERSION_RELEASE + upload android/docs/help products/android/$VERSION_RELEASE ;; ios) - upload ios/help products/iphone-and-ipad/$VERSION_RELEASE + upload ios/docs/help products/iphone-and-ipad/$VERSION_RELEASE ;; linux) pushd "$KEYMAN_ROOT/linux/keyman-config" > /dev/null ./build.sh build popd > /dev/null - upload linux/help products/linux/$VERSION_RELEASE + upload linux/docs/help products/linux/$VERSION_RELEASE ;; mac) - upload mac/help products/mac/$VERSION_RELEASE + upload mac/docs/help products/mac/$VERSION_RELEASE ;; windows) # Note: `/windows/src/desktop/help/build.sh web` must be run first diff --git a/resources/builder.inc.sh b/resources/builder.inc.sh index b233614029..c4cf586f42 100755 --- a/resources/builder.inc.sh +++ b/resources/builder.inc.sh @@ -40,6 +40,12 @@ function _builder_init() { else builder_use_color false fi + + # Set shared Meson package cache (works with Meson >= 1.3) + if [[ -z ${MESON_PACKAGE_CACHE_DIR:-} ]]; then + export MESON_PACKAGE_CACHE_DIR="${XDG_CACHE_HOME:-${HOME}/.cache}/keyman/builder" + mkdir -p "${MESON_PACKAGE_CACHE_DIR}" + fi } function _builder_findRepoRoot() { @@ -416,6 +422,7 @@ _builder_execute_child() { ${child_options[@]} \ $builder_verbose \ $builder_debug \ + $_builder_offline \ && ( if $_builder_debug_internal; then builder_echo success "## $action$target completed successfully" @@ -1267,6 +1274,7 @@ _builder_parse_expanded_parameters() { _builder_chosen_options=() _builder_current_action= _builder_is_child=1 + _builder_offline= local n=0 @@ -1399,6 +1407,9 @@ _builder_parse_expanded_parameters() { # internal reporting function, ignores all other parameters _builder_report_dependencies ;; + --offline) + _builder_offline=--offline + ;; *) # script does not recognize anything of action or target form at this point. if [[ $key =~ ^: ]]; then @@ -1565,6 +1576,7 @@ builder_display_usage() { _builder_pad $width " --debug, -d" "Debug build" _builder_pad $width " --color" "Force colorized output" _builder_pad $width " --no-color" "Never use colorized output" + _builder_pad $width " --offline" "Try to build while being offline" if builder_has_dependencies; then _builder_pad $width " --deps" "Build dependencies if required (default)" _builder_pad $width " --no-deps" "Skip build of dependencies" @@ -1731,6 +1743,7 @@ _builder_do_build_deps() { "$REPO_ROOT/$dep/build.sh" "configure$dep_target" "build$dep_target" \ $builder_verbose \ $builder_debug \ + $_builder_offline \ $_builder_build_deps \ --builder-dep-parent "$THIS_SCRIPT_IDENTIFIER" && ( if $_builder_debug_internal; then @@ -1761,6 +1774,18 @@ builder_is_child_build() { return $_builder_is_child } +# +# return `1` for a regular build, `0` to try to build while being offline. +# The offline build might fail if not all dependencies are cached. +# +builder_try_offline() { + if [[ "${_builder_offline}" == "--offline" ]]; then + return 0 + else + return 1 + fi +} + # # returns `0` if we should attempt to do quick builds in a dependency build, for # example skipping `tsc -b` where a parent may also do it; corresponds to the diff --git a/resources/git-hooks/commit-msg b/resources/git-hooks/commit-msg index 427ad96b58..fcb4f26a04 100755 --- a/resources/git-hooks/commit-msg +++ b/resources/git-hooks/commit-msg @@ -51,7 +51,7 @@ fi GIT_ORIGIN="$(git remote get-url origin)" -if [[ ! "$GIT_ORIGIN" =~ github\.com/keymanapp ]]; then +if [[ ! "$GIT_ORIGIN" =~ github\.com(/|:)keymanapp ]]; then # Not a Keyman repository. We have no opinion. # echo "DEBUG: Not a Keyman repository. We don't care" exit 0 @@ -107,14 +107,18 @@ function print_error() { echo -e "----------------------------------------------------------${t_end}" echo -e "Valid types: ${t_grn}${types[@]}${t_end}" echo -e "Valid scopes: ${t_grn}${scopes[@]}${t_end}" - echo -e "Max length (first line): ${t_grn}$max_length${t_end}" + echo -e "" echo -e "Min length (first line): ${t_grn}$min_length${t_end}" + echo -e "Max length (first line): ${t_grn}$max_length${t_end}" + echo -e "" echo -e "If possible, append git trailers:" echo -e " * ${t_grn}Fixes: #1234${t_end}" echo -e " * ${t_grn}Fixes: KEYMAN-MODULE-XYZ${t_end}" echo -e " * ${t_grn}Cherry-pick-of: #2468${t_end}" echo -e " * ${t_grn}Co-authored-by: Firstname Lastname ${t_end}" + echo -e "" echo -e "${t_cyn}Example:${t_end} fix(windows): Re-attach the widget plug which had fallen out" + echo -e "" echo -e "${t_cyn}Reference${t_end}: https://github.com/keymanapp/keyman/wiki/Pull-Request-and-Commit-workflow-notes" echo -e "" echo -e "Tips: " @@ -136,4 +140,4 @@ if [[ ! $msg =~ $regexp ]]; then print_error fi exit 1 -fi \ No newline at end of file +fi diff --git a/resources/git-hooks/pre-commit b/resources/git-hooks/pre-commit index db7ba3cf30..df165feaec 100755 --- a/resources/git-hooks/pre-commit +++ b/resources/git-hooks/pre-commit @@ -6,7 +6,7 @@ GIT_ORIGIN="$(git remote get-url origin)" -if [[ ! "$GIT_ORIGIN" =~ github\.com/keymanapp ]]; then +if [[ ! "$GIT_ORIGIN" =~ github\.com(/|:)keymanapp ]]; then # Not a Keyman repository. We have no opinion. echo "DEBUG: Not a Keyman repository. We don't care" exit 0 diff --git a/resources/shellHelperFunctions.sh b/resources/shellHelperFunctions.sh index 7ded208d44..a3f419382e 100755 --- a/resources/shellHelperFunctions.sh +++ b/resources/shellHelperFunctions.sh @@ -267,7 +267,12 @@ verify_npm_setup() { pushd "$KEYMAN_ROOT" > /dev/null - try_multiple_times npm ci + offline_param= + if builder_try_offline; then + builder_echo "Trying offline build" + offline_param=--prefer-offline + fi + try_multiple_times npm ${offline_param} ci popd > /dev/null } diff --git a/windows/src/desktop/help/Kmhelp.css b/windows/docs/help/Kmhelp.css similarity index 100% rename from windows/src/desktop/help/Kmhelp.css rename to windows/docs/help/Kmhelp.css diff --git a/windows/src/desktop/help/about/credits.md b/windows/docs/help/about/credits.md similarity index 100% rename from windows/src/desktop/help/about/credits.md rename to windows/docs/help/about/credits.md diff --git a/windows/src/desktop/help/about/history.md b/windows/docs/help/about/history.md similarity index 100% rename from windows/src/desktop/help/about/history.md rename to windows/docs/help/about/history.md diff --git a/windows/src/desktop/help/about/index.md b/windows/docs/help/about/index.md similarity index 100% rename from windows/src/desktop/help/about/index.md rename to windows/docs/help/about/index.md diff --git a/windows/src/desktop/help/about/license.md b/windows/docs/help/about/license.md similarity index 100% rename from windows/src/desktop/help/about/license.md rename to windows/docs/help/about/license.md diff --git a/windows/src/desktop/help/about/requirements.md b/windows/docs/help/about/requirements.md similarity index 100% rename from windows/src/desktop/help/about/requirements.md rename to windows/docs/help/about/requirements.md diff --git a/windows/src/desktop/help/about/welcome.md b/windows/docs/help/about/welcome.md similarity index 100% rename from windows/src/desktop/help/about/welcome.md rename to windows/docs/help/about/welcome.md diff --git a/windows/src/desktop/help/about/whatsnew.md b/windows/docs/help/about/whatsnew.md similarity index 100% rename from windows/src/desktop/help/about/whatsnew.md rename to windows/docs/help/about/whatsnew.md diff --git a/windows/src/desktop/help/advanced/index.md b/windows/docs/help/advanced/index.md similarity index 100% rename from windows/src/desktop/help/advanced/index.md rename to windows/docs/help/advanced/index.md diff --git a/windows/src/desktop/help/advanced/locale_edit.md b/windows/docs/help/advanced/locale_edit.md similarity index 100% rename from windows/src/desktop/help/advanced/locale_edit.md rename to windows/docs/help/advanced/locale_edit.md diff --git a/windows/src/desktop/help/advanced/proxy_config.md b/windows/docs/help/advanced/proxy_config.md similarity index 100% rename from windows/src/desktop/help/advanced/proxy_config.md rename to windows/docs/help/advanced/proxy_config.md diff --git a/windows/src/desktop/help/basic/config/hotkeys.md b/windows/docs/help/basic/config/hotkeys.md similarity index 100% rename from windows/src/desktop/help/basic/config/hotkeys.md rename to windows/docs/help/basic/config/hotkeys.md diff --git a/windows/src/desktop/help/basic/config/index.md b/windows/docs/help/basic/config/index.md similarity index 100% rename from windows/src/desktop/help/basic/config/index.md rename to windows/docs/help/basic/config/index.md diff --git a/windows/src/desktop/help/basic/config/keep-in-touch.md b/windows/docs/help/basic/config/keep-in-touch.md similarity index 100% rename from windows/src/desktop/help/basic/config/keep-in-touch.md rename to windows/docs/help/basic/config/keep-in-touch.md diff --git a/windows/src/desktop/help/basic/config/keyboards.md b/windows/docs/help/basic/config/keyboards.md similarity index 100% rename from windows/src/desktop/help/basic/config/keyboards.md rename to windows/docs/help/basic/config/keyboards.md diff --git a/windows/src/desktop/help/basic/config/options.md b/windows/docs/help/basic/config/options.md similarity index 100% rename from windows/src/desktop/help/basic/config/options.md rename to windows/docs/help/basic/config/options.md diff --git a/windows/src/desktop/help/basic/config/support.md b/windows/docs/help/basic/config/support.md similarity index 100% rename from windows/src/desktop/help/basic/config/support.md rename to windows/docs/help/basic/config/support.md diff --git a/windows/src/desktop/help/basic/enable-or-disable-keyboard.md b/windows/docs/help/basic/enable-or-disable-keyboard.md similarity index 100% rename from windows/src/desktop/help/basic/enable-or-disable-keyboard.md rename to windows/docs/help/basic/enable-or-disable-keyboard.md diff --git a/windows/src/desktop/help/basic/help.md b/windows/docs/help/basic/help.md similarity index 100% rename from windows/src/desktop/help/basic/help.md rename to windows/docs/help/basic/help.md diff --git a/windows/src/desktop/help/basic/index.md b/windows/docs/help/basic/index.md similarity index 100% rename from windows/src/desktop/help/basic/index.md rename to windows/docs/help/basic/index.md diff --git a/windows/src/desktop/help/basic/language-switcher.md b/windows/docs/help/basic/language-switcher.md similarity index 100% rename from windows/src/desktop/help/basic/language-switcher.md rename to windows/docs/help/basic/language-switcher.md diff --git a/windows/src/desktop/help/basic/make-taskbar-icon-visible.md b/windows/docs/help/basic/make-taskbar-icon-visible.md similarity index 100% rename from windows/src/desktop/help/basic/make-taskbar-icon-visible.md rename to windows/docs/help/basic/make-taskbar-icon-visible.md diff --git a/windows/src/desktop/help/basic/new-ways-to-use-keyman.md b/windows/docs/help/basic/new-ways-to-use-keyman.md similarity index 100% rename from windows/src/desktop/help/basic/new-ways-to-use-keyman.md rename to windows/docs/help/basic/new-ways-to-use-keyman.md diff --git a/windows/src/desktop/help/basic/select-keyboard.md b/windows/docs/help/basic/select-keyboard.md similarity index 100% rename from windows/src/desktop/help/basic/select-keyboard.md rename to windows/docs/help/basic/select-keyboard.md diff --git a/windows/src/desktop/help/basic/text-editor.md b/windows/docs/help/basic/text-editor.md similarity index 100% rename from windows/src/desktop/help/basic/text-editor.md rename to windows/docs/help/basic/text-editor.md diff --git a/windows/src/desktop/help/basic/toolbox/character-map.md b/windows/docs/help/basic/toolbox/character-map.md similarity index 100% rename from windows/src/desktop/help/basic/toolbox/character-map.md rename to windows/docs/help/basic/toolbox/character-map.md diff --git a/windows/src/desktop/help/basic/toolbox/font-helper.md b/windows/docs/help/basic/toolbox/font-helper.md similarity index 100% rename from windows/src/desktop/help/basic/toolbox/font-helper.md rename to windows/docs/help/basic/toolbox/font-helper.md diff --git a/windows/src/desktop/help/basic/toolbox/index.md b/windows/docs/help/basic/toolbox/index.md similarity index 100% rename from windows/src/desktop/help/basic/toolbox/index.md rename to windows/docs/help/basic/toolbox/index.md diff --git a/windows/src/desktop/help/basic/toolbox/osk.md b/windows/docs/help/basic/toolbox/osk.md similarity index 100% rename from windows/src/desktop/help/basic/toolbox/osk.md rename to windows/docs/help/basic/toolbox/osk.md diff --git a/windows/src/desktop/help/basic/tray-menu.md b/windows/docs/help/basic/tray-menu.md similarity index 100% rename from windows/src/desktop/help/basic/tray-menu.md rename to windows/docs/help/basic/tray-menu.md diff --git a/windows/src/desktop/help/basic/uninstall-keyboard.md b/windows/docs/help/basic/uninstall-keyboard.md similarity index 100% rename from windows/src/desktop/help/basic/uninstall-keyboard.md rename to windows/docs/help/basic/uninstall-keyboard.md diff --git a/windows/src/desktop/help/basic/uninstall.md b/windows/docs/help/basic/uninstall.md similarity index 100% rename from windows/src/desktop/help/basic/uninstall.md rename to windows/docs/help/basic/uninstall.md diff --git a/windows/src/desktop/help/basic/update.md b/windows/docs/help/basic/update.md similarity index 100% rename from windows/src/desktop/help/basic/update.md rename to windows/docs/help/basic/update.md diff --git a/windows/src/desktop/help/common/adware.md b/windows/docs/help/common/adware.md similarity index 100% rename from windows/src/desktop/help/common/adware.md rename to windows/docs/help/common/adware.md diff --git a/windows/src/desktop/help/common/bug.md b/windows/docs/help/common/bug.md similarity index 100% rename from windows/src/desktop/help/common/bug.md rename to windows/docs/help/common/bug.md diff --git a/windows/src/desktop/help/common/compatibility.md b/windows/docs/help/common/compatibility.md similarity index 100% rename from windows/src/desktop/help/common/compatibility.md rename to windows/docs/help/common/compatibility.md diff --git a/windows/src/desktop/help/common/free.md b/windows/docs/help/common/free.md similarity index 100% rename from windows/src/desktop/help/common/free.md rename to windows/docs/help/common/free.md diff --git a/windows/src/desktop/help/common/index.md b/windows/docs/help/common/index.md similarity index 100% rename from windows/src/desktop/help/common/index.md rename to windows/docs/help/common/index.md diff --git a/windows/src/desktop/help/common/linux.md b/windows/docs/help/common/linux.md similarity index 100% rename from windows/src/desktop/help/common/linux.md rename to windows/docs/help/common/linux.md diff --git a/windows/src/desktop/help/common/mac.md b/windows/docs/help/common/mac.md similarity index 100% rename from windows/src/desktop/help/common/mac.md rename to windows/docs/help/common/mac.md diff --git a/windows/src/desktop/help/common/old_version.md b/windows/docs/help/common/old_version.md similarity index 100% rename from windows/src/desktop/help/common/old_version.md rename to windows/docs/help/common/old_version.md diff --git a/windows/src/desktop/help/common/os.md b/windows/docs/help/common/os.md similarity index 100% rename from windows/src/desktop/help/common/os.md rename to windows/docs/help/common/os.md diff --git a/windows/src/desktop/help/common/osk.md b/windows/docs/help/common/osk.md similarity index 100% rename from windows/src/desktop/help/common/osk.md rename to windows/docs/help/common/osk.md diff --git a/windows/src/desktop/help/common/requirements.md b/windows/docs/help/common/requirements.md similarity index 100% rename from windows/src/desktop/help/common/requirements.md rename to windows/docs/help/common/requirements.md diff --git a/windows/src/desktop/help/common/support.md b/windows/docs/help/common/support.md similarity index 100% rename from windows/src/desktop/help/common/support.md rename to windows/docs/help/common/support.md diff --git a/windows/src/desktop/help/common/unicode.md b/windows/docs/help/common/unicode.md similarity index 100% rename from windows/src/desktop/help/common/unicode.md rename to windows/docs/help/common/unicode.md diff --git a/windows/src/desktop/help/context/base-keyboard.md b/windows/docs/help/context/base-keyboard.md similarity index 100% rename from windows/src/desktop/help/context/base-keyboard.md rename to windows/docs/help/context/base-keyboard.md diff --git a/windows/src/desktop/help/context/change-hotkey.md b/windows/docs/help/context/change-hotkey.md similarity index 100% rename from windows/src/desktop/help/context/change-hotkey.md rename to windows/docs/help/context/change-hotkey.md diff --git a/windows/src/desktop/help/context/configuration-hotkeys.md b/windows/docs/help/context/configuration-hotkeys.md similarity index 100% rename from windows/src/desktop/help/context/configuration-hotkeys.md rename to windows/docs/help/context/configuration-hotkeys.md diff --git a/windows/src/desktop/help/context/configuration-keepintouch.md b/windows/docs/help/context/configuration-keepintouch.md similarity index 100% rename from windows/src/desktop/help/context/configuration-keepintouch.md rename to windows/docs/help/context/configuration-keepintouch.md diff --git a/windows/src/desktop/help/context/configuration-keyboards.md b/windows/docs/help/context/configuration-keyboards.md similarity index 100% rename from windows/src/desktop/help/context/configuration-keyboards.md rename to windows/docs/help/context/configuration-keyboards.md diff --git a/windows/src/desktop/help/context/configuration-options.md b/windows/docs/help/context/configuration-options.md similarity index 100% rename from windows/src/desktop/help/context/configuration-options.md rename to windows/docs/help/context/configuration-options.md diff --git a/windows/src/desktop/help/context/configuration-support.md b/windows/docs/help/context/configuration-support.md similarity index 100% rename from windows/src/desktop/help/context/configuration-support.md rename to windows/docs/help/context/configuration-support.md diff --git a/windows/src/desktop/help/context/download-keyboard.md b/windows/docs/help/context/download-keyboard.md similarity index 100% rename from windows/src/desktop/help/context/download-keyboard.md rename to windows/docs/help/context/download-keyboard.md diff --git a/windows/src/desktop/help/context/index.md b/windows/docs/help/context/index.md similarity index 100% rename from windows/src/desktop/help/context/index.md rename to windows/docs/help/context/index.md diff --git a/windows/src/desktop/help/context/install-keyboard-language.md b/windows/docs/help/context/install-keyboard-language.md similarity index 100% rename from windows/src/desktop/help/context/install-keyboard-language.md rename to windows/docs/help/context/install-keyboard-language.md diff --git a/windows/src/desktop/help/context/install-keyboard.md b/windows/docs/help/context/install-keyboard.md similarity index 100% rename from windows/src/desktop/help/context/install-keyboard.md rename to windows/docs/help/context/install-keyboard.md diff --git a/windows/src/desktop/help/context/keyman.md b/windows/docs/help/context/keyman.md similarity index 100% rename from windows/src/desktop/help/context/keyman.md rename to windows/docs/help/context/keyman.md diff --git a/windows/src/desktop/help/context/online-update.md b/windows/docs/help/context/online-update.md similarity index 100% rename from windows/src/desktop/help/context/online-update.md rename to windows/docs/help/context/online-update.md diff --git a/windows/src/desktop/help/context/proxy-configuration.md b/windows/docs/help/context/proxy-configuration.md similarity index 100% rename from windows/src/desktop/help/context/proxy-configuration.md rename to windows/docs/help/context/proxy-configuration.md diff --git a/windows/src/desktop/help/context/splash.md b/windows/docs/help/context/splash.md similarity index 100% rename from windows/src/desktop/help/context/splash.md rename to windows/docs/help/context/splash.md diff --git a/windows/src/desktop/help/context/text-editor.md b/windows/docs/help/context/text-editor.md similarity index 100% rename from windows/src/desktop/help/context/text-editor.md rename to windows/docs/help/context/text-editor.md diff --git a/windows/src/desktop/help/context/toolbox-charactermap.md b/windows/docs/help/context/toolbox-charactermap.md similarity index 100% rename from windows/src/desktop/help/context/toolbox-charactermap.md rename to windows/docs/help/context/toolbox-charactermap.md diff --git a/windows/src/desktop/help/context/toolbox-fonthelper.md b/windows/docs/help/context/toolbox-fonthelper.md similarity index 100% rename from windows/src/desktop/help/context/toolbox-fonthelper.md rename to windows/docs/help/context/toolbox-fonthelper.md diff --git a/windows/src/desktop/help/context/toolbox-onscreenkeyboard.md b/windows/docs/help/context/toolbox-onscreenkeyboard.md similarity index 100% rename from windows/src/desktop/help/context/toolbox-onscreenkeyboard.md rename to windows/docs/help/context/toolbox-onscreenkeyboard.md diff --git a/windows/src/desktop/help/context/tray-menu.md b/windows/docs/help/context/tray-menu.md similarity index 100% rename from windows/src/desktop/help/context/tray-menu.md rename to windows/docs/help/context/tray-menu.md diff --git a/windows/src/desktop/help/desktop_images/7-taskbar.png b/windows/docs/help/desktop_images/7-taskbar.png similarity index 100% rename from windows/src/desktop/help/desktop_images/7-taskbar.png rename to windows/docs/help/desktop_images/7-taskbar.png diff --git a/windows/src/desktop/help/desktop_images/charmap-big.png b/windows/docs/help/desktop_images/charmap-big.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap-big.png rename to windows/docs/help/desktop_images/charmap-big.png diff --git a/windows/src/desktop/help/desktop_images/charmap-button.png b/windows/docs/help/desktop_images/charmap-button.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap-button.png rename to windows/docs/help/desktop_images/charmap-button.png diff --git a/windows/src/desktop/help/desktop_images/charmap-filter.png b/windows/docs/help/desktop_images/charmap-filter.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap-filter.png rename to windows/docs/help/desktop_images/charmap-filter.png diff --git a/windows/src/desktop/help/desktop_images/charmap-filterdialog.png b/windows/docs/help/desktop_images/charmap-filterdialog.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap-filterdialog.png rename to windows/docs/help/desktop_images/charmap-filterdialog.png diff --git a/windows/src/desktop/help/desktop_images/charmap-font.png b/windows/docs/help/desktop_images/charmap-font.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap-font.png rename to windows/docs/help/desktop_images/charmap-font.png diff --git a/windows/src/desktop/help/desktop_images/charmap-goto.png b/windows/docs/help/desktop_images/charmap-goto.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap-goto.png rename to windows/docs/help/desktop_images/charmap-goto.png diff --git a/windows/src/desktop/help/desktop_images/charmap-insert.png b/windows/docs/help/desktop_images/charmap-insert.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap-insert.png rename to windows/docs/help/desktop_images/charmap-insert.png diff --git a/windows/src/desktop/help/desktop_images/charmap-options.png b/windows/docs/help/desktop_images/charmap-options.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap-options.png rename to windows/docs/help/desktop_images/charmap-options.png diff --git a/windows/src/desktop/help/desktop_images/charmap-quality.png b/windows/docs/help/desktop_images/charmap-quality.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap-quality.png rename to windows/docs/help/desktop_images/charmap-quality.png diff --git a/windows/src/desktop/help/desktop_images/charmap.png b/windows/docs/help/desktop_images/charmap.png similarity index 100% rename from windows/src/desktop/help/desktop_images/charmap.png rename to windows/docs/help/desktop_images/charmap.png diff --git a/windows/src/desktop/help/desktop_images/config-locale.png b/windows/docs/help/desktop_images/config-locale.png similarity index 100% rename from windows/src/desktop/help/desktop_images/config-locale.png rename to windows/docs/help/desktop_images/config-locale.png diff --git a/windows/src/desktop/help/desktop_images/download-keyboard-step0.png b/windows/docs/help/desktop_images/download-keyboard-step0.png similarity index 100% rename from windows/src/desktop/help/desktop_images/download-keyboard-step0.png rename to windows/docs/help/desktop_images/download-keyboard-step0.png diff --git a/windows/src/desktop/help/desktop_images/download-keyboard-step1.png b/windows/docs/help/desktop_images/download-keyboard-step1.png similarity index 100% rename from windows/src/desktop/help/desktop_images/download-keyboard-step1.png rename to windows/docs/help/desktop_images/download-keyboard-step1.png diff --git a/windows/src/desktop/help/desktop_images/download-keyboard-step2.png b/windows/docs/help/desktop_images/download-keyboard-step2.png similarity index 100% rename from windows/src/desktop/help/desktop_images/download-keyboard-step2.png rename to windows/docs/help/desktop_images/download-keyboard-step2.png diff --git a/windows/src/desktop/help/desktop_images/download-keyboard-step3.png b/windows/docs/help/desktop_images/download-keyboard-step3.png similarity index 100% rename from windows/src/desktop/help/desktop_images/download-keyboard-step3.png rename to windows/docs/help/desktop_images/download-keyboard-step3.png diff --git a/windows/src/desktop/help/desktop_images/download-keyboard-step4.png b/windows/docs/help/desktop_images/download-keyboard-step4.png similarity index 100% rename from windows/src/desktop/help/desktop_images/download-keyboard-step4.png rename to windows/docs/help/desktop_images/download-keyboard-step4.png diff --git a/windows/src/desktop/help/desktop_images/download-keyboard-step5.png b/windows/docs/help/desktop_images/download-keyboard-step5.png similarity index 100% rename from windows/src/desktop/help/desktop_images/download-keyboard-step5.png rename to windows/docs/help/desktop_images/download-keyboard-step5.png diff --git a/windows/src/desktop/help/desktop_images/download-keyboard-step6.png b/windows/docs/help/desktop_images/download-keyboard-step6.png similarity index 100% rename from windows/src/desktop/help/desktop_images/download-keyboard-step6.png rename to windows/docs/help/desktop_images/download-keyboard-step6.png diff --git a/windows/src/desktop/help/desktop_images/fonthelper.png b/windows/docs/help/desktop_images/fonthelper.png similarity index 100% rename from windows/src/desktop/help/desktop_images/fonthelper.png rename to windows/docs/help/desktop_images/fonthelper.png diff --git a/windows/src/desktop/help/desktop_images/help-dialog.png b/windows/docs/help/desktop_images/help-dialog.png similarity index 100% rename from windows/src/desktop/help/desktop_images/help-dialog.png rename to windows/docs/help/desktop_images/help-dialog.png diff --git a/windows/src/desktop/help/desktop_images/hotkeys-change.png b/windows/docs/help/desktop_images/hotkeys-change.png similarity index 100% rename from windows/src/desktop/help/desktop_images/hotkeys-change.png rename to windows/docs/help/desktop_images/hotkeys-change.png diff --git a/windows/src/desktop/help/desktop_images/icon-fonts.png b/windows/docs/help/desktop_images/icon-fonts.png similarity index 100% rename from windows/src/desktop/help/desktop_images/icon-fonts.png rename to windows/docs/help/desktop_images/icon-fonts.png diff --git a/windows/src/desktop/help/desktop_images/icon-help.png b/windows/docs/help/desktop_images/icon-help.png similarity index 100% rename from windows/src/desktop/help/desktop_images/icon-help.png rename to windows/docs/help/desktop_images/icon-help.png diff --git a/windows/src/desktop/help/desktop_images/icon-intro.png b/windows/docs/help/desktop_images/icon-intro.png similarity index 100% rename from windows/src/desktop/help/desktop_images/icon-intro.png rename to windows/docs/help/desktop_images/icon-intro.png diff --git a/windows/src/desktop/help/desktop_images/icon-introductory-help.png b/windows/docs/help/desktop_images/icon-introductory-help.png similarity index 100% rename from windows/src/desktop/help/desktop_images/icon-introductory-help.png rename to windows/docs/help/desktop_images/icon-introductory-help.png diff --git a/windows/src/desktop/help/desktop_images/icon-keyman.png b/windows/docs/help/desktop_images/icon-keyman.png similarity index 100% rename from windows/src/desktop/help/desktop_images/icon-keyman.png rename to windows/docs/help/desktop_images/icon-keyman.png diff --git a/windows/src/desktop/help/desktop_images/icon-osk.png b/windows/docs/help/desktop_images/icon-osk.png similarity index 100% rename from windows/src/desktop/help/desktop_images/icon-osk.png rename to windows/docs/help/desktop_images/icon-osk.png diff --git a/windows/src/desktop/help/desktop_images/icon-unicode.png b/windows/docs/help/desktop_images/icon-unicode.png similarity index 100% rename from windows/src/desktop/help/desktop_images/icon-unicode.png rename to windows/docs/help/desktop_images/icon-unicode.png diff --git a/windows/src/desktop/help/desktop_images/icon-uninstall.png b/windows/docs/help/desktop_images/icon-uninstall.png similarity index 100% rename from windows/src/desktop/help/desktop_images/icon-uninstall.png rename to windows/docs/help/desktop_images/icon-uninstall.png diff --git a/windows/src/desktop/help/desktop_images/keyboard-share.png b/windows/docs/help/desktop_images/keyboard-share.png similarity index 100% rename from windows/src/desktop/help/desktop_images/keyboard-share.png rename to windows/docs/help/desktop_images/keyboard-share.png diff --git a/windows/src/desktop/help/desktop_images/keyboards-downarrow.png b/windows/docs/help/desktop_images/keyboards-downarrow.png similarity index 100% rename from windows/src/desktop/help/desktop_images/keyboards-downarrow.png rename to windows/docs/help/desktop_images/keyboards-downarrow.png diff --git a/windows/src/desktop/help/desktop_images/km_install_anywhere_1.png b/windows/docs/help/desktop_images/km_install_anywhere_1.png similarity index 100% rename from windows/src/desktop/help/desktop_images/km_install_anywhere_1.png rename to windows/docs/help/desktop_images/km_install_anywhere_1.png diff --git a/windows/src/desktop/help/desktop_images/km_install_anywhere_2.png b/windows/docs/help/desktop_images/km_install_anywhere_2.png similarity index 100% rename from windows/src/desktop/help/desktop_images/km_install_anywhere_2.png rename to windows/docs/help/desktop_images/km_install_anywhere_2.png diff --git a/windows/src/desktop/help/desktop_images/km_install_anywhere_3.png b/windows/docs/help/desktop_images/km_install_anywhere_3.png similarity index 100% rename from windows/src/desktop/help/desktop_images/km_install_anywhere_3.png rename to windows/docs/help/desktop_images/km_install_anywhere_3.png diff --git a/windows/src/desktop/help/desktop_images/km_non_app_store_1.png b/windows/docs/help/desktop_images/km_non_app_store_1.png similarity index 100% rename from windows/src/desktop/help/desktop_images/km_non_app_store_1.png rename to windows/docs/help/desktop_images/km_non_app_store_1.png diff --git a/windows/src/desktop/help/desktop_images/km_non_app_store_2.png b/windows/docs/help/desktop_images/km_non_app_store_2.png similarity index 100% rename from windows/src/desktop/help/desktop_images/km_non_app_store_2.png rename to windows/docs/help/desktop_images/km_non_app_store_2.png diff --git a/windows/src/desktop/help/desktop_images/lang-assoc-multi.png b/windows/docs/help/desktop_images/lang-assoc-multi.png similarity index 100% rename from windows/src/desktop/help/desktop_images/lang-assoc-multi.png rename to windows/docs/help/desktop_images/lang-assoc-multi.png diff --git a/windows/src/desktop/help/desktop_images/language-association.png b/windows/docs/help/desktop_images/language-association.png similarity index 100% rename from windows/src/desktop/help/desktop_images/language-association.png rename to windows/docs/help/desktop_images/language-association.png diff --git a/windows/src/desktop/help/desktop_images/language-bar.png b/windows/docs/help/desktop_images/language-bar.png similarity index 100% rename from windows/src/desktop/help/desktop_images/language-bar.png rename to windows/docs/help/desktop_images/language-bar.png diff --git a/windows/src/desktop/help/desktop_images/languageswitcher-small.png b/windows/docs/help/desktop_images/languageswitcher-small.png similarity index 100% rename from windows/src/desktop/help/desktop_images/languageswitcher-small.png rename to windows/docs/help/desktop_images/languageswitcher-small.png diff --git a/windows/src/desktop/help/desktop_images/languageswitcher.png b/windows/docs/help/desktop_images/languageswitcher.png similarity index 100% rename from windows/src/desktop/help/desktop_images/languageswitcher.png rename to windows/docs/help/desktop_images/languageswitcher.png diff --git a/windows/src/desktop/help/desktop_images/menu.png b/windows/docs/help/desktop_images/menu.png similarity index 100% rename from windows/src/desktop/help/desktop_images/menu.png rename to windows/docs/help/desktop_images/menu.png diff --git a/windows/src/desktop/help/desktop_images/menuicon-charmap.png b/windows/docs/help/desktop_images/menuicon-charmap.png similarity index 100% rename from windows/src/desktop/help/desktop_images/menuicon-charmap.png rename to windows/docs/help/desktop_images/menuicon-charmap.png diff --git a/windows/src/desktop/help/desktop_images/menuicon-config.png b/windows/docs/help/desktop_images/menuicon-config.png similarity index 100% rename from windows/src/desktop/help/desktop_images/menuicon-config.png rename to windows/docs/help/desktop_images/menuicon-config.png diff --git a/windows/src/desktop/help/desktop_images/menuicon-exit.png b/windows/docs/help/desktop_images/menuicon-exit.png similarity index 100% rename from windows/src/desktop/help/desktop_images/menuicon-exit.png rename to windows/docs/help/desktop_images/menuicon-exit.png diff --git a/windows/src/desktop/help/desktop_images/menuicon-fonthelper.png b/windows/docs/help/desktop_images/menuicon-fonthelper.png similarity index 100% rename from windows/src/desktop/help/desktop_images/menuicon-fonthelper.png rename to windows/docs/help/desktop_images/menuicon-fonthelper.png diff --git a/windows/src/desktop/help/desktop_images/menuicon-help.png b/windows/docs/help/desktop_images/menuicon-help.png similarity index 100% rename from windows/src/desktop/help/desktop_images/menuicon-help.png rename to windows/docs/help/desktop_images/menuicon-help.png diff --git a/windows/src/desktop/help/desktop_images/menuicon-osk.png b/windows/docs/help/desktop_images/menuicon-osk.png similarity index 100% rename from windows/src/desktop/help/desktop_images/menuicon-osk.png rename to windows/docs/help/desktop_images/menuicon-osk.png diff --git a/windows/src/desktop/help/desktop_images/menuicon-texteditor.png b/windows/docs/help/desktop_images/menuicon-texteditor.png similarity index 100% rename from windows/src/desktop/help/desktop_images/menuicon-texteditor.png rename to windows/docs/help/desktop_images/menuicon-texteditor.png diff --git a/windows/src/desktop/help/desktop_images/menuicon-usage.png b/windows/docs/help/desktop_images/menuicon-usage.png similarity index 100% rename from windows/src/desktop/help/desktop_images/menuicon-usage.png rename to windows/docs/help/desktop_images/menuicon-usage.png diff --git a/windows/src/desktop/help/desktop_images/options-advanced.png b/windows/docs/help/desktop_images/options-advanced.png similarity index 100% rename from windows/src/desktop/help/desktop_images/options-advanced.png rename to windows/docs/help/desktop_images/options-advanced.png diff --git a/windows/src/desktop/help/desktop_images/options-general.png b/windows/docs/help/desktop_images/options-general.png similarity index 100% rename from windows/src/desktop/help/desktop_images/options-general.png rename to windows/docs/help/desktop_images/options-general.png diff --git a/windows/src/desktop/help/desktop_images/options-hint.png b/windows/docs/help/desktop_images/options-hint.png similarity index 100% rename from windows/src/desktop/help/desktop_images/options-hint.png rename to windows/docs/help/desktop_images/options-hint.png diff --git a/windows/src/desktop/help/desktop_images/options-osk.png b/windows/docs/help/desktop_images/options-osk.png similarity index 100% rename from windows/src/desktop/help/desktop_images/options-osk.png rename to windows/docs/help/desktop_images/options-osk.png diff --git a/windows/src/desktop/help/desktop_images/options-startup.png b/windows/docs/help/desktop_images/options-startup.png similarity index 100% rename from windows/src/desktop/help/desktop_images/options-startup.png rename to windows/docs/help/desktop_images/options-startup.png diff --git a/windows/src/desktop/help/desktop_images/osk-tibetan.png b/windows/docs/help/desktop_images/osk-tibetan.png similarity index 100% rename from windows/src/desktop/help/desktop_images/osk-tibetan.png rename to windows/docs/help/desktop_images/osk-tibetan.png diff --git a/windows/src/desktop/help/desktop_images/osk_keyboard.png b/windows/docs/help/desktop_images/osk_keyboard.png similarity index 100% rename from windows/src/desktop/help/desktop_images/osk_keyboard.png rename to windows/docs/help/desktop_images/osk_keyboard.png diff --git a/windows/src/desktop/help/desktop_images/proxy-config.png b/windows/docs/help/desktop_images/proxy-config.png similarity index 100% rename from windows/src/desktop/help/desktop_images/proxy-config.png rename to windows/docs/help/desktop_images/proxy-config.png diff --git a/windows/src/desktop/help/desktop_images/setup-click1.png b/windows/docs/help/desktop_images/setup-click1.png similarity index 100% rename from windows/src/desktop/help/desktop_images/setup-click1.png rename to windows/docs/help/desktop_images/setup-click1.png diff --git a/windows/src/desktop/help/desktop_images/setup-click2.png b/windows/docs/help/desktop_images/setup-click2.png similarity index 100% rename from windows/src/desktop/help/desktop_images/setup-click2.png rename to windows/docs/help/desktop_images/setup-click2.png diff --git a/windows/src/desktop/help/desktop_images/setup-click3.png b/windows/docs/help/desktop_images/setup-click3.png similarity index 100% rename from windows/src/desktop/help/desktop_images/setup-click3.png rename to windows/docs/help/desktop_images/setup-click3.png diff --git a/windows/src/desktop/help/desktop_images/start_tray.png b/windows/docs/help/desktop_images/start_tray.png similarity index 100% rename from windows/src/desktop/help/desktop_images/start_tray.png rename to windows/docs/help/desktop_images/start_tray.png diff --git a/windows/src/desktop/help/desktop_images/tab-add-lang.png b/windows/docs/help/desktop_images/tab-add-lang.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-add-lang.png rename to windows/docs/help/desktop_images/tab-add-lang.png diff --git a/windows/src/desktop/help/desktop_images/tab-add-popup.png b/windows/docs/help/desktop_images/tab-add-popup.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-add-popup.png rename to windows/docs/help/desktop_images/tab-add-popup.png diff --git a/windows/src/desktop/help/desktop_images/tab-hotkeys.png b/windows/docs/help/desktop_images/tab-hotkeys.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-hotkeys.png rename to windows/docs/help/desktop_images/tab-hotkeys.png diff --git a/windows/src/desktop/help/desktop_images/tab-keyboards.png b/windows/docs/help/desktop_images/tab-keyboards.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-keyboards.png rename to windows/docs/help/desktop_images/tab-keyboards.png diff --git a/windows/src/desktop/help/desktop_images/tab-layout-detail1.png b/windows/docs/help/desktop_images/tab-layout-detail1.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-layout-detail1.png rename to windows/docs/help/desktop_images/tab-layout-detail1.png diff --git a/windows/src/desktop/help/desktop_images/tab-layout-detail2.png b/windows/docs/help/desktop_images/tab-layout-detail2.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-layout-detail2.png rename to windows/docs/help/desktop_images/tab-layout-detail2.png diff --git a/windows/src/desktop/help/desktop_images/tab-layout-disable.png b/windows/docs/help/desktop_images/tab-layout-disable.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-layout-disable.png rename to windows/docs/help/desktop_images/tab-layout-disable.png diff --git a/windows/src/desktop/help/desktop_images/tab-layout-enable.png b/windows/docs/help/desktop_images/tab-layout-enable.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-layout-enable.png rename to windows/docs/help/desktop_images/tab-layout-enable.png diff --git a/windows/src/desktop/help/desktop_images/tab-layout-help.png b/windows/docs/help/desktop_images/tab-layout-help.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-layout-help.png rename to windows/docs/help/desktop_images/tab-layout-help.png diff --git a/windows/src/desktop/help/desktop_images/tab-layout-share.png b/windows/docs/help/desktop_images/tab-layout-share.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-layout-share.png rename to windows/docs/help/desktop_images/tab-layout-share.png diff --git a/windows/src/desktop/help/desktop_images/tab-layout.png b/windows/docs/help/desktop_images/tab-layout.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-layout.png rename to windows/docs/help/desktop_images/tab-layout.png diff --git a/windows/src/desktop/help/desktop_images/tab-options.png b/windows/docs/help/desktop_images/tab-options.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-options.png rename to windows/docs/help/desktop_images/tab-options.png diff --git a/windows/src/desktop/help/desktop_images/tab-options2.png b/windows/docs/help/desktop_images/tab-options2.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-options2.png rename to windows/docs/help/desktop_images/tab-options2.png diff --git a/windows/src/desktop/help/desktop_images/tab-support.png b/windows/docs/help/desktop_images/tab-support.png similarity index 100% rename from windows/src/desktop/help/desktop_images/tab-support.png rename to windows/docs/help/desktop_images/tab-support.png diff --git a/windows/src/desktop/help/desktop_images/texteditor.png b/windows/docs/help/desktop_images/texteditor.png similarity index 100% rename from windows/src/desktop/help/desktop_images/texteditor.png rename to windows/docs/help/desktop_images/texteditor.png diff --git a/windows/src/desktop/help/desktop_images/toolbox-options.png b/windows/docs/help/desktop_images/toolbox-options.png similarity index 100% rename from windows/src/desktop/help/desktop_images/toolbox-options.png rename to windows/docs/help/desktop_images/toolbox-options.png diff --git a/windows/src/desktop/help/desktop_images/toolbox-toolbar.png b/windows/docs/help/desktop_images/toolbox-toolbar.png similarity index 100% rename from windows/src/desktop/help/desktop_images/toolbox-toolbar.png rename to windows/docs/help/desktop_images/toolbox-toolbar.png diff --git a/windows/src/desktop/help/desktop_images/toolboxicon-charmap.png b/windows/docs/help/desktop_images/toolboxicon-charmap.png similarity index 100% rename from windows/src/desktop/help/desktop_images/toolboxicon-charmap.png rename to windows/docs/help/desktop_images/toolboxicon-charmap.png diff --git a/windows/src/desktop/help/desktop_images/toolboxicon-close.png b/windows/docs/help/desktop_images/toolboxicon-close.png similarity index 100% rename from windows/src/desktop/help/desktop_images/toolboxicon-close.png rename to windows/docs/help/desktop_images/toolboxicon-close.png diff --git a/windows/src/desktop/help/desktop_images/toolboxicon-config.png b/windows/docs/help/desktop_images/toolboxicon-config.png similarity index 100% rename from windows/src/desktop/help/desktop_images/toolboxicon-config.png rename to windows/docs/help/desktop_images/toolboxicon-config.png diff --git a/windows/src/desktop/help/desktop_images/toolboxicon-fonthelper.png b/windows/docs/help/desktop_images/toolboxicon-fonthelper.png similarity index 100% rename from windows/src/desktop/help/desktop_images/toolboxicon-fonthelper.png rename to windows/docs/help/desktop_images/toolboxicon-fonthelper.png diff --git a/windows/src/desktop/help/desktop_images/toolboxicon-help.png b/windows/docs/help/desktop_images/toolboxicon-help.png similarity index 100% rename from windows/src/desktop/help/desktop_images/toolboxicon-help.png rename to windows/docs/help/desktop_images/toolboxicon-help.png diff --git a/windows/src/desktop/help/desktop_images/toolboxicon-osk.png b/windows/docs/help/desktop_images/toolboxicon-osk.png similarity index 100% rename from windows/src/desktop/help/desktop_images/toolboxicon-osk.png rename to windows/docs/help/desktop_images/toolboxicon-osk.png diff --git a/windows/src/desktop/help/desktop_images/toolboxicon-usage.png b/windows/docs/help/desktop_images/toolboxicon-usage.png similarity index 100% rename from windows/src/desktop/help/desktop_images/toolboxicon-usage.png rename to windows/docs/help/desktop_images/toolboxicon-usage.png diff --git a/windows/src/desktop/help/desktop_images/video.png b/windows/docs/help/desktop_images/video.png similarity index 100% rename from windows/src/desktop/help/desktop_images/video.png rename to windows/docs/help/desktop_images/video.png diff --git a/windows/src/desktop/help/desktop_images/win10-taskbar1.png b/windows/docs/help/desktop_images/win10-taskbar1.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win10-taskbar1.png rename to windows/docs/help/desktop_images/win10-taskbar1.png diff --git a/windows/src/desktop/help/desktop_images/win10-taskbar2.png b/windows/docs/help/desktop_images/win10-taskbar2.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win10-taskbar2.png rename to windows/docs/help/desktop_images/win10-taskbar2.png diff --git a/windows/src/desktop/help/desktop_images/win10-taskbar3.png b/windows/docs/help/desktop_images/win10-taskbar3.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win10-taskbar3.png rename to windows/docs/help/desktop_images/win10-taskbar3.png diff --git a/windows/src/desktop/help/desktop_images/win11-taskbar1.png b/windows/docs/help/desktop_images/win11-taskbar1.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win11-taskbar1.png rename to windows/docs/help/desktop_images/win11-taskbar1.png diff --git a/windows/src/desktop/help/desktop_images/win11-taskbar2.png b/windows/docs/help/desktop_images/win11-taskbar2.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win11-taskbar2.png rename to windows/docs/help/desktop_images/win11-taskbar2.png diff --git a/windows/src/desktop/help/desktop_images/win11-uninstall.png b/windows/docs/help/desktop_images/win11-uninstall.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win11-uninstall.png rename to windows/docs/help/desktop_images/win11-uninstall.png diff --git a/windows/src/desktop/help/desktop_images/win11_km_install_anywhere_1.png b/windows/docs/help/desktop_images/win11_km_install_anywhere_1.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win11_km_install_anywhere_1.png rename to windows/docs/help/desktop_images/win11_km_install_anywhere_1.png diff --git a/windows/src/desktop/help/desktop_images/win8-taskbar1.png b/windows/docs/help/desktop_images/win8-taskbar1.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win8-taskbar1.png rename to windows/docs/help/desktop_images/win8-taskbar1.png diff --git a/windows/src/desktop/help/desktop_images/win8-taskbar2.png b/windows/docs/help/desktop_images/win8-taskbar2.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win8-taskbar2.png rename to windows/docs/help/desktop_images/win8-taskbar2.png diff --git a/windows/src/desktop/help/desktop_images/win8-taskbar3.png b/windows/docs/help/desktop_images/win8-taskbar3.png similarity index 100% rename from windows/src/desktop/help/desktop_images/win8-taskbar3.png rename to windows/docs/help/desktop_images/win8-taskbar3.png diff --git a/windows/src/desktop/help/index.md b/windows/docs/help/index.md similarity index 100% rename from windows/src/desktop/help/index.md rename to windows/docs/help/index.md diff --git a/windows/src/desktop/help/keymandesktop.hhp b/windows/docs/help/keymandesktop.hhp similarity index 100% rename from windows/src/desktop/help/keymandesktop.hhp rename to windows/docs/help/keymandesktop.hhp diff --git a/windows/src/desktop/help/start/configure-computer.md b/windows/docs/help/start/configure-computer.md similarity index 100% rename from windows/src/desktop/help/start/configure-computer.md rename to windows/docs/help/start/configure-computer.md diff --git a/windows/src/desktop/help/start/configure_office.md b/windows/docs/help/start/configure_office.md similarity index 100% rename from windows/src/desktop/help/start/configure_office.md rename to windows/docs/help/start/configure_office.md diff --git a/windows/src/desktop/help/start/download-and-install-keyboard.md b/windows/docs/help/start/download-and-install-keyboard.md similarity index 100% rename from windows/src/desktop/help/start/download-and-install-keyboard.md rename to windows/docs/help/start/download-and-install-keyboard.md diff --git a/windows/src/desktop/help/start/download-and-install-keyman.md b/windows/docs/help/start/download-and-install-keyman.md similarity index 100% rename from windows/src/desktop/help/start/download-and-install-keyman.md rename to windows/docs/help/start/download-and-install-keyman.md diff --git a/windows/src/desktop/help/start/font.md b/windows/docs/help/start/font.md similarity index 100% rename from windows/src/desktop/help/start/font.md rename to windows/docs/help/start/font.md diff --git a/windows/src/desktop/help/start/hotkey_set.md b/windows/docs/help/start/hotkey_set.md similarity index 100% rename from windows/src/desktop/help/start/hotkey_set.md rename to windows/docs/help/start/hotkey_set.md diff --git a/windows/src/desktop/help/start/index.md b/windows/docs/help/start/index.md similarity index 100% rename from windows/src/desktop/help/start/index.md rename to windows/docs/help/start/index.md diff --git a/windows/src/desktop/help/start/locale.md b/windows/docs/help/start/locale.md similarity index 100% rename from windows/src/desktop/help/start/locale.md rename to windows/docs/help/start/locale.md diff --git a/windows/src/desktop/help/start/rtl.md b/windows/docs/help/start/rtl.md similarity index 100% rename from windows/src/desktop/help/start/rtl.md rename to windows/docs/help/start/rtl.md diff --git a/windows/src/desktop/help/start/tutorial.md b/windows/docs/help/start/tutorial.md similarity index 100% rename from windows/src/desktop/help/start/tutorial.md rename to windows/docs/help/start/tutorial.md diff --git a/windows/src/desktop/help/troubleshooting/bootstrapper.md b/windows/docs/help/troubleshooting/bootstrapper.md similarity index 100% rename from windows/src/desktop/help/troubleshooting/bootstrapper.md rename to windows/docs/help/troubleshooting/bootstrapper.md diff --git a/windows/src/desktop/help/troubleshooting/excel.md b/windows/docs/help/troubleshooting/excel.md similarity index 100% rename from windows/src/desktop/help/troubleshooting/excel.md rename to windows/docs/help/troubleshooting/excel.md diff --git a/windows/src/desktop/help/troubleshooting/font.md b/windows/docs/help/troubleshooting/font.md similarity index 100% rename from windows/src/desktop/help/troubleshooting/font.md rename to windows/docs/help/troubleshooting/font.md diff --git a/windows/src/desktop/help/troubleshooting/index.md b/windows/docs/help/troubleshooting/index.md similarity index 100% rename from windows/src/desktop/help/troubleshooting/index.md rename to windows/docs/help/troubleshooting/index.md diff --git a/windows/src/desktop/help/troubleshooting/install-app-from-anywhere.md b/windows/docs/help/troubleshooting/install-app-from-anywhere.md similarity index 100% rename from windows/src/desktop/help/troubleshooting/install-app-from-anywhere.md rename to windows/docs/help/troubleshooting/install-app-from-anywhere.md diff --git a/windows/src/desktop/help/troubleshooting/securitysoftware.md b/windows/docs/help/troubleshooting/securitysoftware.md similarity index 100% rename from windows/src/desktop/help/troubleshooting/securitysoftware.md rename to windows/docs/help/troubleshooting/securitysoftware.md diff --git a/windows/src/desktop/help/troubleshooting/sigma.md b/windows/docs/help/troubleshooting/sigma.md similarity index 100% rename from windows/src/desktop/help/troubleshooting/sigma.md rename to windows/docs/help/troubleshooting/sigma.md diff --git a/windows/src/desktop/help/build.sh b/windows/src/desktop/help/build.sh index d8331b345e..807f7047ab 100755 --- a/windows/src/desktop/help/build.sh +++ b/windows/src/desktop/help/build.sh @@ -25,6 +25,11 @@ builder_describe_outputs \ #------------------------------------------------------------------------------------------------------------------- +# All content is stored in windows/docs/help + +HELP_SOURCE_PATH="$KEYMAN_ROOT/windows/docs/help" +cd "$HELP_SOURCE_PATH" + MD=`find -name "*.md"` DESTCHM="$KEYMAN_ROOT/windows/bin/help/desktop" DESTWEB="$KEYMAN_ROOT/windows/bin/help/md/desktop" @@ -121,7 +126,7 @@ function do_build_chm() { # mkdir -p "$DESTCHM/desktop_images" - cp "$THIS_SCRIPT_PATH/desktop_images"/* "$DESTCHM/desktop_images/" + cp "$HELP_SOURCE_PATH/desktop_images"/* "$DESTCHM/desktop_images/" # # Prepare TOC and HHP files @@ -129,7 +134,7 @@ function do_build_chm() { pushd "$DESTCHM" > /dev/null - cp "$THIS_SCRIPT_PATH/keymandesktop.hhp" "$DESTCHM/keymandesktop.hhp" + cp "$HELP_SOURCE_PATH/keymandesktop.hhp" "$DESTCHM/keymandesktop.hhp" find -name '*.htm' >> "$DESTCHM/keymandesktop.hhp" build_hhc_header @@ -163,7 +168,7 @@ function do_build_web() { done mkdir -p "$DESTWEB/desktop_images" - cp "$THIS_SCRIPT_PATH/desktop_images"/* "$DESTWEB/desktop_images/" + cp "$HELP_SOURCE_PATH/desktop_images"/* "$DESTWEB/desktop_images/" } builder_run_action clean:chm do_clean_chm diff --git a/windows/src/desktop/help/help.sln b/windows/src/desktop/help/help.sln deleted file mode 100644 index c5e8fa36be..0000000000 --- a/windows/src/desktop/help/help.sln +++ /dev/null @@ -1,62 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 9.00 -# Visual Studio 2005 -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{61F7EA69-424D-41F9-B734-1EF0661A564C}" - ProjectSection(SolutionItems) = preProject - chm.xsl = chm.xsl - home.xml = home.xml - index.xml = index.xml - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "context", "context", "{803201BB-4DA1-4A4C-9D6D-BA6BC19BF9EA}" - ProjectSection(SolutionItems) = preProject - context\activate.xml = context\activate.xml - context\charactermap.xml = context\charactermap.xml - context\configuration_addins.xml = context\configuration_addins.xml - context\configuration_hotkeys.xml = context\configuration_hotkeys.xml - context\configuration_keyboards.xml = context\configuration_keyboards.xml - context\configuration_languages.xml = context\configuration_languages.xml - context\configuration_options.xml = context\configuration_options.xml - context\configuration_support.xml = context\configuration_support.xml - context\keyman.xml = context\keyman.xml - context\manualactivate.xml = context\manualactivate.xml - context\onscreenkeyboard.xml = context\onscreenkeyboard.xml - context\selectlanguage.xml = context\selectlanguage.xml - context\splash.xml = context\splash.xml - context\traymenu.xml = context\traymenu.xml - context\welcome.xml = context\welcome.xml - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "guide", "guide", "{773446EB-3B8A-4D7A-848E-A6A643A0F78A}" - ProjectSection(SolutionItems) = preProject - guide\changehotkey.xml = guide\changehotkey.xml - guide\install.xml = guide\install.xml - guide\install_keyboard.xml = guide\install_keyboard.xml - guide\keyboard_uninstall.xml = guide\keyboard_uninstall.xml - guide\keyboard_unload.xml = guide\keyboard_unload.xml - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "main", "main", "{2C8697CC-0686-48E5-AFB5-E836E96D4FAD}" - ProjectSection(SolutionItems) = preProject - main\license.xml = main\license.xml - main\purchase.xml = main\purchase.xml - main\welcome.xml = main\welcome.xml - main\whatsnew.xml = main\whatsnew.xml - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ref", "ref", "{D17860DB-EFA1-444B-BE05-5889A338F552}" - ProjectSection(SolutionItems) = preProject - ref\systemshadowkeyboards.xml = ref\systemshadowkeyboards.xml - EndProjectSection -EndProject -Global - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(NestedProjects) = preSolution - {803201BB-4DA1-4A4C-9D6D-BA6BC19BF9EA} = {61F7EA69-424D-41F9-B734-1EF0661A564C} - {773446EB-3B8A-4D7A-848E-A6A643A0F78A} = {61F7EA69-424D-41F9-B734-1EF0661A564C} - {2C8697CC-0686-48E5-AFB5-E836E96D4FAD} = {61F7EA69-424D-41F9-B734-1EF0661A564C} - {D17860DB-EFA1-444B-BE05-5889A338F552} = {61F7EA69-424D-41F9-B734-1EF0661A564C} - EndGlobalSection -EndGlobal