Submodule i18n

.github/workflows/pr_ci.yaml

@@ -13,6 +13,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Set up Xcode
         run: sudo xcode-select -switch /Applications/Xcode.app

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Scribe/i18n"]
+	path = Scribe/i18n
+	url = https://github.com/scribe-org/Scribe-i18n.git

CONTRIBUTING.md

@@ -93,16 +93,19 @@ Scribe-iOS is developed using the [Swift](https://developer.apple.com/swift/) co
 >
 > To run git commands with SSH, remember then to substitute the HTTPS URL, `https://github.com/...`, with the SSH one, `git@github.com:...`.
 >
-> - e.g. Cloning now becomes `git clone git@github.com:<your-username>/Scribe-iOS.git`
+> - e.g. Cloning (with submodules) now becomes `git clone --recurse-submodules git@github.com:<your-username>/Scribe-iOS.git`
 >
 > GitHub also has their documentation on how to [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) 🔑
 >
 > </p>
 > </details>
 
+> [!NOTE]
+> Cloning this repository with `--recurse-submodules` also clones a copy of [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) where the texts for Scribe projects are localized. When pulling changes from `main`, you should also run the following command: `git submodule update --init --recursive` to get the copy of the localization files currently on main (you can also run [update_project_and_submodule.sh](./update_project_and_submodule.sh)). To get the most up to date version of Scribe-i18n, change to its directory in `Scribe/i18n` and run `git pull origin main`.
+
 ```bash
-# Clone your fork of the repo into the current directory.
-git clone https://github.com/<your-username>/Scribe-iOS.git
+# Clone your fork of the repo into the current directory (including submodules).
+git clone --recurse-submodules https://github.com/<your-username>/Scribe-iOS.git
 # Navigate to the newly cloned directory.
 cd Scribe-iOS
 # Assign the original repo to a remote called "upstream".

Keyboards/KeyboardsBase/InterfaceVariables.swift

@@ -155,16 +155,16 @@ let languagesAbbrDict = [
 ]
 
 let languagesStringDict = [
-  "English": NSLocalizedString("app._global.english", value: "English", comment: ""),
-  "French": NSLocalizedString("app._global.french", value: "French", comment: ""),
-  "German": NSLocalizedString("app._global.german", value: "German", comment: ""),
-  // "Indonesian": NSLocalizedString("app._global.indonesian", value: "Indonesian", comment: ""),
-  "Italian": NSLocalizedString("app._global.italian", value: "Italian", comment: ""),
-  // "Norwegian": NSLocalizedString("app._global.norwegian", value: "Norwegian", comment: ""),
-  "Portuguese": NSLocalizedString("app._global.portuguese", value: "Portuguese", comment: ""),
-  "Russian": NSLocalizedString("app._global.russian", value: "Russian", comment: ""),
-  "Spanish": NSLocalizedString("app._global.spanish", value: "Spanish", comment: ""),
-  "Swedish": NSLocalizedString("app._global.swedish", value: "Swedish", comment: "")
+  "English": NSLocalizedString("i18n.app._global.english", value: "English", comment: ""),
+  "French": NSLocalizedString("i18n.app._global.french", value: "French", comment: ""),
+  "German": NSLocalizedString("i18n.app._global.german", value: "German", comment: ""),
+  // "Indonesian": NSLocalizedString("i18n.app._global.indonesian", value: "Indonesian", comment: ""),
+  "Italian": NSLocalizedString("i18n.app._global.italian", value: "Italian", comment: ""),
+  // "Norwegian": NSLocalizedString("i18n.app._global.norwegian", value: "Norwegian", comment: ""),
+  "Portuguese": NSLocalizedString("i18n.app._global.portuguese", value: "Portuguese", comment: ""),
+  "Russian": NSLocalizedString("i18n.app._global.russian", value: "Russian", comment: ""),
+  "Spanish": NSLocalizedString("i18n.app._global.spanish", value: "Spanish", comment: ""),
+  "Swedish": NSLocalizedString("i18n.app._global.swedish", value: "Swedish", comment: "")
 ]
 
 func getKeyInDict(givenValue: String, dict: [String: String]) -> String {

Keyboards/KeyboardsBase/ToolTip/Model/InformationToolTipData.swift

@@ -9,7 +9,7 @@ import UIKit
 
 enum InformationToolTipData {
   static let wikiDataExplanation = NSMutableAttributedString(
-    string: NSLocalizedString("keyboard.not_in_wikidata.explanation_1",
+    string: NSLocalizedString("i18n.app.keyboard.not_in_wikidata.explanation_1",
                               value: "Wikidata is a collaboratively edited knowledge graph that's maintained by the Wikimedia Foundation. It serves as a source of open data for projects like Wikipedia and countless others.",
                               comment: ""),
     attributes: [
@@ -20,7 +20,7 @@ enum InformationToolTipData {
   )
 
   static let wikiDataContationOrigin = NSMutableAttributedString(
-    string: NSLocalizedString("keyboard.not_in_wikidata.explanation_2",
+    string: NSLocalizedString("i18n.app.keyboard.not_in_wikidata.explanation_2",
                               value: "Scribe uses Wikidata's language data for many of its core features. We get information like noun genders, verb conjugations and much more!",
                               comment: ""),
     attributes: [
@@ -31,7 +31,7 @@ enum InformationToolTipData {
   )
 
   static let howToContribute = NSMutableAttributedString(
-    string: NSLocalizedString("keyboard.not_in_wikidata.explanation_3",
+    string: NSLocalizedString("i18n.app.keyboard.not_in_wikidata.explanation_3",
                               value: "You can make an account at wikidata.org to join the community that's supporting Scribe and so many other projects. Help us bring free information to the world!",
                               comment: ""),
     attributes: [

README.md

@@ -143,16 +143,19 @@ Scribe-iOS is developed using the [Swift](https://developer.apple.com/swift/) co
 >
 > To run git commands with SSH, remember then to substitute the HTTPS URL, `https://github.com/...`, with the SSH one, `git@github.com:...`.
 >
-> - e.g. Cloning now becomes `git clone git@github.com:<your-username>/Scribe-iOS.git`
+> - e.g. Cloning (with submodules) now becomes `git clone --recurse-submodules git@github.com:<your-username>/Scribe-iOS.git`
 >
 > GitHub also has their documentation on how to [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) 🔑
 >
 > </p>
 > </details>
 
+> [!NOTE]
+> Cloning this repository with `--recurse-submodules` also clones a copy of [Scribe-i18n](https://github.com/scribe-org/Scribe-i18n) where the texts for Scribe projects are localized. When pulling changes from `main`, you should also run the following command: `git submodule update --init --recursive` to get the copy of the localization files currently on main (you can also run [update_project_and_submodule.sh](./update_project_and_submodule.sh)). To get the most up to date version of Scribe-i18n, change to its directory in `Scribe/i18n` and run `git pull origin main`.
+
 ```bash
-# Clone your fork of the repo into the current directory.
-git clone https://github.com/<your-username>/Scribe-iOS.git
+# Clone your fork of the repo into the current directory (including submodules).
+git clone --recurse-submodules https://github.com/<your-username>/Scribe-iOS.git
 # Navigate to the newly cloned directory.
 cd Scribe-iOS
 # Assign the original repo to a remote called "upstream".