Documentation for custom locales

Larissa Reis
1 parent da3b4c3f
Showing 1 changed file with 28 additions and 0 deletions Show diff stats
INSTALL.locales.md
@@ -0,0 +1,28 @@
+Using custom locales
+====================
+
+Personalized translations go into the `custom_locales/` directory. Custom
+locales can be identified by the rails environment, schema name in a
+multitenancy setup or domain name until the first dot (e.g env1.coop.br for the
+example below).
+
+Currently, the only filename prefix for the localization file which is
+processed is "environment". For instance, a POT file would be called
+"environment.pot".
+
+The structure of an environment named env1 with custom translations for both
+Portuguese and Spanish and an environment named env2 with custom Russian
+translation would be:
+  
+    custom_locales/
+      env1/
+        environment.pot
+        pt/
+          environment.po
+        es/
+          environment.po
+      env2/
+        environment.pot
+        ru/
+          environment.po
+
...	...	@@ -0,0 +1,28 @@
	1	+Using custom locales
	2	+====================
	3	+
	4	+Personalized translations go into the `custom_locales/` directory. Custom
	5	+locales can be identified by the rails environment, schema name in a
	6	+multitenancy setup or domain name until the first dot (e.g env1.coop.br for the
	7	+example below).
	8	+
	9	+Currently, the only filename prefix for the localization file which is
	10	+processed is "environment". For instance, a POT file would be called
	11	+"environment.pot".
	12	+
	13	+The structure of an environment named env1 with custom translations for both
	14	+Portuguese and Spanish and an environment named env2 with custom Russian
	15	+translation would be:
	16	+
	17	+ custom_locales/
	18	+ env1/
	19	+ environment.pot
	20	+ pt/
	21	+ environment.po
	22	+ es/
	23	+ environment.po
	24	+ env2/
	25	+ environment.pot
	26	+ ru/
	27	+ environment.po
	28	+
...	...