You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -53,7 +53,7 @@ By using this template, there is no need to use the cobra-cli to scaffold your a
53
53
54
54
### 📝 Checklist of required changes
55
55
56
-
The following is list of actions that must be performed before using this template. Most of the changes concern changing the name `Arcadia` to the name of the new application. As the template is instantiated from github, the new name will automatically replace the top level directory name, that being ___arcadia___. However, there are 2 situations at hand:
56
+
The following is list of actions that must be performed before using this template. Most of the changes concern changing the name `Goo` to the name of the new application. As the template is instantiated from github, the new name will automatically replace the top level directory name, that being ___goo___. However, there are 2 situations at hand:
57
57
58
58
1) target repo is owned by the snivilised organisation: the changes required will be made automatically after the repo has been created from the template WITHOUT user intervention
➕ The following descriptions use owner name ___pandora___ and repo name ___maestro___ as an example. That is to say the client has instantiated ___arcadia___ template into github at url _github.com/pandora/maestro_
76
+
➕ The following descriptions use owner name ___pandora___ and repo name ___maestro___ as an example. That is to say the client has instantiated ___goo___ template into github at url _github.com/pandora/maestro_
77
77
78
78
#### 🤖 Automated changes
79
79
@@ -121,7 +121,7 @@ Of course, its up to the user what settings they use in their repo, these are ju
121
121
122
122
### 🌐 l10n Translations
123
123
124
-
This template has been setup to support localisation. The default language is `en-GB` with support for `en-US`. There is a translation file for `en-US` defined as __locale/i18n/deploy/arcadia.active.en-US.json__. This is the initial translation for `en-US` that should be deployed with the app.
124
+
This template has been setup to support localisation. The default language is `en-GB` with support for `en-US`. There is a translation file for `en-US` defined as __locale/i18n/deploy/goo.active.en-US.json__. This is the initial translation for `en-US` that should be deployed with the app.
125
125
126
126
Make sure that the go-i18n package has been installed so that it can be invoked as cli, see [go-i18n](https://github.com/nicksnyder/go-i18n) for installation instructions.
Copy file name to clipboardExpand all lines: resources/doc/i18n-README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,18 +8,18 @@ The local directory structure is as follows:
8
8
9
9
-___default___: contains the translation file created by the __newt__ (new translation task). Actually, this task creates an __active__ file (`active.en-GB.json`) in the `i18n/out` folder, the result of which needs to be manually copied into the __active__ file in the `default` folder.
10
10
11
-
-___deploy___: contains all the translations files that are intended to be deployed with the application. There will be one per supported language and by default this template project includes a translation file for __en-US__ (`arcadia.active.en-US.json`)
11
+
-___deploy___: contains all the translations files that are intended to be deployed with the application. There will be one per supported language and by default this template project includes a translation file for __en-US__ (`goo.active.en-US.json`)
12
12
13
13
## ⚙️ Translation Workflow
14
14
15
15
### ✨ New Translations
16
16
17
-
__goi18n__ instructs the user to manually create an empty translation message file that they want to add (eg `translate.en-US.json`). This is taken care of by the __newt__ task. Then the requirement is to run the goi18n merge \<active\> command (goi18n merge `arcadia.active.en-US.json``arcadia.translate.en-US.json`). This has been wrapped up into the __merge__ task and the result is that the translation file `arcadia.translation.en-US.json` is populated with the messages to be translated. So the sequence goes:
17
+
__goi18n__ instructs the user to manually create an empty translation message file that they want to add (eg `translate.en-US.json`). This is taken care of by the __newt__ task. Then the requirement is to run the goi18n merge \<active\> command (goi18n merge `goo.active.en-US.json``goo.translate.en-US.json`). This has been wrapped up into the __merge__ task and the result is that the translation file `goo.translation.en-US.json` is populated with the messages to be translated. So the sequence goes:
18
18
19
-
- run __newt__ task: (generates default language file `./locale/i18n/out/active.en-GB.json` and empty `./locale/i18n/out/us-US/arcadia.translation.en-US.json` file). This task can be run from the root folder, __goi18n__ will recursively search the directory tree for files with translate-able content, ie files with template definitions (___i18n.Message___)
20
-
- run __merge__ task: derives a translation file for the requested language __en-US__ using 2 files as inputs: source active file (`./locale/i18n/out/active.en-GB.json`) and the empty __en-US__ translate file (`./locale/i18n/out/us-US/arcadia.translation.en-US.json`), both of which were generated in the previous step.
19
+
- run __newt__ task: (generates default language file `./locale/i18n/out/active.en-GB.json` and empty `./locale/i18n/out/us-US/goo.translation.en-US.json` file). This task can be run from the root folder, __goi18n__ will recursively search the directory tree for files with translate-able content, ie files with template definitions (___i18n.Message___)
20
+
- run __merge__ task: derives a translation file for the requested language __en-US__ using 2 files as inputs: source active file (`./locale/i18n/out/active.en-GB.json`) and the empty __en-US__ translate file (`./locale/i18n/out/us-US/goo.translation.en-US.json`), both of which were generated in the previous step.
21
21
- hand the translate file to your translator for them to translate
22
-
- rename the translate file to the active equivalent (`arcadia.translation.en-US.json`). Save this into the __deploy__ folder. This file will be deployed with the application.
22
+
- rename the translate file to the active equivalent (`goo.translation.en-US.json`). Save this into the __deploy__ folder. This file will be deployed with the application.
23
23
24
24
### 🧩 Update Existing Translations (⚠️ not finalised)
25
25
@@ -36,7 +36,7 @@ However, in this template, the user can execute the following steps:
36
36
37
37
- run task __update__: this will re-extract messages into `active.en-GB.json` and then runs merge to create an updated translate file.
38
38
- hand the translate file to your translator for them to translate
39
-
- as before, this translated file should be used to update the active file `arcadia.active.en-US.json` inside the __deploy__ folder.
39
+
- as before, this translated file should be used to update the active file `goo.active.en-US.json` inside the __deploy__ folder.
0 commit comments