Merge pull request #2539 from keymanapp/auto/A19S30-merge-master-into-staging

auto: A19S30 merge master into staging

Author: keyman-status

_includes/includes/index-content.php

@@ -7,6 +7,7 @@
  * be appended to the bottom of the list.
  */
 function get_file_titles_by_index($base, $unsorted_items) {
+  $items = [];
   $order = str_replace("\r\n", "\n", @file_get_contents($base.'__index.txt'));
   $order = explode("\n", $order);
   foreach($order as $item) {

_includes/includes/page-version.php

@@ -6,6 +6,8 @@
   $PageVersion = new PageVersion();
 
   class PageVersion {
+    // TODO: - avoid public fields and use getters/setters instead
+
     public $active;
     public $versions, $basePath, $versionedPath, $subPath, $path;
     public $currentVersion;
@@ -71,29 +73,39 @@ static function WriteBanner() {
       global $PageVersion;
       if(!$PageVersion->active) return;
 
-      if($PageVersion->isCurrentPageCurrent() || !$PageVersion->currentFileExists) {
+      if($PageVersion->isCurrentPageCurrent()) {
         // Don't show the banner if we are on the current version
         return;
       }
 
-      if($PageVersion->isCurrentPageOlder()) {
-        $message = 'You are viewing an old version of this documentation';
-      } else {
-        $message = 'You are viewing an incomplete pre-release version of this documentation';
-      }
-
       $alertIcon =
         '<svg class="octicon octicon-alert mr-2" viewBox="0 0 16 16" version="1.1" width="22" height="22" '.
         'style="vertical-align: bottom; padding-right: 4px" aria-hidden="true">'.
         '<path fill="orange" d="M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 '.
         '1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 '.
         '0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 '.
         '0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg>';
-      $target = PageVersion::GetVersionedFilePath($PageVersion->basePath, $PageVersion->file, $PageVersion->currentVersion, $PageVersion->currentVersion);
+        
+      if(!$PageVersion->currentFileExists) {
+        $message = "You are viewing documentation of version {$PageVersion->versionedPath}, which is not included in the latest version";
+      } else if($PageVersion->isCurrentPageOlder()) {
+        $message = 'You are viewing an old version of this documentation';
+      } else {
+        $message = 'You are viewing an incomplete pre-release version of this documentation';
+      }
+
+      if(!$PageVersion->currentFileExists) {
+        # redirect to the base folder for the current version, as we don't have a mapping for this page
+        $target = "{$PageVersion->basePath}/current-version/";
+        $actionText = "to open the index page for version {$PageVersion->currentVersion}.";
+      } else {
+        $target = PageVersion::GetVersionedFilePath($PageVersion->basePath, $PageVersion->file, $PageVersion->currentVersion, $PageVersion->currentVersion);
+        $actionText = "to open the current version, {$PageVersion->currentVersion}.";
+      }
       $html =
         "<div id='version-banner'>$alertIcon $message. ".
-        "<a href='{$target}'>Click here</a>".
-        " to open the current version, {$PageVersion->currentVersion}.</div>";
+        "<a href='{$target}'>Click here</a> $actionText".
+        "</div>";
       echo $html;
     }
 

composer.json

@@ -7,5 +7,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.2"
+    },
+    "config": {
+        "allow-plugins": false
     }
 }

composer.lock

@@ -2,6 +2,17 @@
 title: Changes - Keyman Core API
 ---
 
+## Changes between 18.0 and 19.0
+
+* Removed deprecated `km_core_keyboard_attrs.folder_path`
+
+## Changes between 17.0 and 18.0
+
+* Replaced `km_core_keyboard_load` with `km_core_keyboard_load_from_blob`.
+  Keyboard loading is now done in the engine, and the content of the
+  keyboard passed to Core as a blob.
+* Deprecated `km_core_keyboard_attrs.folder_path`
+
 ## Changes between 16.0 and 17.0
 
 * The namespace identifier has changed from `km_kbp_` to `km_core_`.
@@ -61,4 +72,4 @@ title: Changes - Keyman Core API
 [km_core_event_flags]: processor#km_core_event_flags "km_core_event_flags enum"
 [km_core_process_event]: processor#km_core_process_event "km_core_process_event function"
 [km_core_event]: processor#km_core_event "km_core_event function"
-[km_core_event_code]: processor#km_core_event_code "km_core_event_code enum"
+[km_core_event_code]: processor#km_core_event_code "km_core_event_code enum"

developer/core/19.0/changes.md

@@ -20,7 +20,6 @@ Provides read-only information about a keyboard.
 typedef struct {
   km_core_cp const * version_string;
   km_core_cp const * id;
-  km_core_path_name  folder_path;
   km_core_option_item const * default_options;
 } km_core_keyboard_attrs;
 
@@ -33,9 +32,6 @@ typedef struct {
 `id`
 : Keyman keyboard ID string.
 
-`folder_path`
-: Path to the unpacked folder containing the keyboard and associated resources.
-
 `default_options`
 : Set of default values for any options included in the keyboard.
 
@@ -662,4 +658,4 @@ km_core_state_to_json(km_core_state const *state,
 [km_core_event_flags]: processor#km_core_event_flags "km_core_event_flags enum"
 [km_core_process_event]: processor#km_core_process_event "km_core_process_event function"
 [km_core_event]: processor#km_core_event "km_core_event function"
-[km_core_event_code]: processor#km_core_event_code "km_core_event_code enum"
+[km_core_event_code]: processor#km_core_event_code "km_core_event_code enum"

developer/core/19.0/keyboards.md

@@ -26,7 +26,9 @@ keyman.addKeyboards(spec[, spec...])
 fulfilled upon adding keyboards.
 
 The promise is an array containing a combination of the following:
-* successfully registered keyboard objects which define some or all of these [properties](../keyboard_properties)
+
+* successfully registered keyboard objects which define some or all of these
+  [properties](../keyboard_properties)
 * [ErrorStub](../keyboard_registration_errors) objects for keyboards that failed to register
 
 ## Description
@@ -35,7 +37,8 @@ The keyboard spec can be a string or an object. Multiple keyboard specs can be
 specified in a single call, which can reduce the round-trip cost of multiple
 calls to Keyman Cloud servers (when using Keyman Cloud).
 
-For general information and example uses of this method, please see the [Adding Keyboards](../../guide/adding-keyboards) page from the guide section.
+For general information and example uses of this method, please see the
+[Adding Keyboards](../../guide/adding-keyboards) page from the guide section.
 
 ### Using a `string`
 
@@ -48,7 +51,7 @@ The string format is one of the following:
 * `'keyboardID@languageID'`: Loads a specific keyboard + language combination
 
 The keyboard catalogue is online at
-[http://keyman.com/developer/keymanweb/keyboards](http://keyman.com/developer/keymanweb/keyboards).
+[https://keyman.com/developer/keymanweb/keyboards](https://keyman.com/developer/keymanweb/keyboards).
 
 ### Using an `object`
 
@@ -59,7 +62,6 @@ known as KeymanWeb Server Data API):
 
 The `spec` object contains the following members:
 
-
 `name`
 
 : `string`
@@ -143,7 +145,7 @@ The `spec.languages` object contains the following members:
 
 : `array|object` <span class="optional">optional</span>
 
-  An array of Font objects (see definition below) or single object describing
+  An array of Font objects (see `font` definition below) or single object describing
   fonts for input fields and the OSK (if `oskFont` is not present.)
 
 `oskFont`

developer/engine/web/19.0/reference/core/addKeyboards.md

@@ -18,25 +18,31 @@ keyman.addKeyboardsForLanguage(spec[, spec...])
 
 : Type: `string`
 
-  Language name string. Appending `$` to the language name will cause all available keyboards for that language to be loaded rather than the default keyboard.
+  Language name string. Appending `$` to the language name will cause all available keyboards for
+  that language to be loaded rather than only the default keyboard.
 
 ### Return Value
 
 `Promise`: A [JavaScript Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
 fulfilled upon adding keyboards.
 
 The promise is an array containing the following:
-* successfully registered keyboard objects which define some or all of these [properties](../keyboard_properties)
+
+* successfully registered keyboard objects which define some or all of these
+  [properties](../keyboard_properties)
 
 ## Description
 
 The language spec is a string. Multiple language specs can also be
 specified in a single call, which can reduce the round-trip cost of multiple
 calls to Keyman Cloud servers (when using Keyman Cloud).
 
-The first call to `addKeyboardsForLanguage()` makes an additional call to the Keyman API to load the current list of keyboard/language associations. This determines the default keyboards that are added for the language.
+The first call to `addKeyboardsForLanguage()` makes an additional call to the Keyman API to load
+the current list of keyboard/language associations. This determines the default keyboards that
+are added for the language.
 
-For general information and example uses of this method, please see the [Adding Keyboards](../../guide/adding-keyboards) page from the guide section.
+For general information and example uses of this method, please see the
+[Adding Keyboards](../../guide/adding-keyboards) page from the guide section.
 
 ### Using a `string`
 

developer/engine/web/19.0/reference/core/addKeyboardsForLanguage.md

@@ -11,13 +11,13 @@ gap between desktop and web core functionality for `context(n)` matching on `not
 ## Syntax
 
 ```js
-  keyman.interface.contextExOutput(dn, outputTarget, contextLength, contextOffset);
+  keyman.interface.contextExOutput(dn, textStore, contextLength, contextOffset);
 ```
 
 or
 
 ```js
-  KeymanWeb.KCXO(dn, outputTarget, contextLength, contextOffset); // Shorthand
+  KeymanWeb.KCXO(dn, textStore, contextLength, contextOffset); // Shorthand
 ```
 
 ## Parameters
@@ -26,8 +26,8 @@ or
 : Type: `number`
 : number of characters to delete left of cursor
 
-`outputTarget`
-: Type: `OutputTarget`
+`textStore`
+: Type: `TextStore`
 : target to output to
 
 `contextLength`

developer/engine/web/19.0/reference/interface/contextExOutput.md

@@ -129,6 +129,42 @@ unnecessary [issue #14718](https://github.com/keymanapp/keyman/issues/14718).
 Using control characters in the context in a [`readonly`
 group](groups#readonly-clause) is safe; no special handling is required.
 
+# Non-breaking space (NBSP) in context
+
+Non-breaking space (NBSP, U+00A0) is used in the digital world to prevent automatic line
+breaks from being inserted between two words. Said another way, it prevents two words
+being separated on to two separate lines. In some applications NBSP are returned in the
+context to Keyman (for example, see issue with Firefox [#14945](https://github.com/keymanapp/keyman/issues/14945)).
+Therefore in this case NBSP should be considered in a rule that detects
+a blank space.
+
+A simple example: when <kbd>e</kbd> is pressed, output an `ἐ` after a space, and output `ε` otherwise:
+```
+store(spaceChrs)  U+0020 U+00A0 
+c The nbsp Unicode Character is U+00A0 and space is U+0020.
+any(spaceChrs) + [K_E] > context U+1f10 
++ [K_E] > U+03B5
+```
+
+A example taken from the [greek_tonzio keyboard](https://github.com/keymanapp/keyboards/tree/master/release/g/greek_tonizo). This keyboard uses stores; see  [`store()`](../reference/store):
+
+```
+c Characters usually found before words  These characters are Space, parenthesis, quotes etc and to this we add the nbsp 
+store(beforeWordChars)  U+0020 U+0028 U+002D U+0027 \
+                        U+0022 U+003A U+007B U+00AB \
+                        U+00B6 U+00A9 U+000A U+00A0 
+
+c These are the characters [ ἀ ἐ ἠ ἰ ὀ ὑ ὠ Ἀ Ἐ Ἠ Ἰ Ὀ Ὑ Ὠ]                        
+store(fwnWithBreathing) U+1F00 U+1F10 U+1F20 U+1F30 U+1F40 U+1F51 U+1F60 \
+                        U+1F08 U+1F18 U+1F28 U+1F38 U+1F48 U+1F59 U+1F68
+```
+
+Then we can have a rule that adds the breathing when the encountering a "before word" character:
+```
+c ------- GENERAL RULE: AUTOMATIC PSILI AT BEGINNING OF WORD STARTING WITH VOWEL ------
+any(beforeWordChars) + any(vowels) > context index(fwnWithBreathing,2)
+```
+
 # References
 
 * [Issue #14148](https://github.com/keymanapp/keyman/issues/14148#issuecomment-3269582559)