Skip to content

Commit 411d989

Browse files
committed
Mention the comment (ignorable) column function in translation csv
1 parent c8d799d commit 411d989

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

tutorials/assets_pipeline/importing_translations.rst

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -57,25 +57,26 @@ CSV files must be formatted as follows:
5757
+--------+----------+----------+----------+
5858

5959
The "lang" tags must represent a language, which must be one of the :ref:`valid
60-
locales <doc_locales>` supported by the engine. The "KEY" tags must be
61-
unique and represent a string universally (they are usually in
60+
locales <doc_locales>` supported by the engine, or they must start with an underscore (`_`),
61+
which means the related column is served as comment and won't be imported.
62+
The "KEY" tags must be unique and represent a string universally (they are usually in
6263
uppercase, to differentiate from other strings). These keys will be replaced at
6364
runtime by the matching translated string. Note that the case is important,
6465
"KEY1" and "Key1" will be different keys.
6566
The top-left cell is ignored and can be left empty or having any content.
6667
Here's an example:
6768

68-
+-------+-----------------------+------------------------+------------------------------+
69-
| keys | en | es | ja |
70-
+=======+=======================+========================+==============================+
71-
| GREET | Hello, friend! | Hola, amigo! | こんにちは |
72-
+-------+-----------------------+------------------------+------------------------------+
73-
| ASK | How are you? | Cómo está? | 元気ですか |
74-
+-------+-----------------------+------------------------+------------------------------+
75-
| BYE | Goodbye | Adiós | さようなら |
76-
+-------+-----------------------+------------------------+------------------------------+
77-
| QUOTE | "Hello" said the man. | "Hola" dijo el hombre. | 「こんにちは」男は言いました |
78-
+-------+-----------------------+------------------------+------------------------------+
69+
+-------+-----------------------+------------------------+------------------------------+------------------------------+
70+
| keys | en | es | ja | _character |
71+
+=======+=======================+========================+==============================+==============================+
72+
| GREET | Hello, friend! | Hola, amigo! | こんにちは | John |
73+
+-------+-----------------------+------------------------+------------------------------+------------------------------+
74+
| ASK | How are you? | Cómo está? | 元気ですか | Jade |
75+
+-------+-----------------------+------------------------+------------------------------+------------------------------+
76+
| BYE | Goodbye | Adiós | さようなら | Nancy |
77+
+-------+-----------------------+------------------------+------------------------------+------------------------------+
78+
| QUOTE | "Hello" said the man. | "Hola" dijo el hombre. | 「こんにちは」男は言いました | Tian |
79+
+-------+-----------------------+------------------------+------------------------------+------------------------------+
7980

8081
The same example is shown below as a comma-separated plain text file,
8182
which should be the result of editing the above in a spreadsheet.
@@ -89,11 +90,11 @@ comma in the import options.
8990

9091
.. code-block:: none
9192
92-
keys,en,es,ja
93-
GREET,"Hello, friend!","Hola, amigo!",こんにちは
94-
ASK,How are you?,Cómo está?,元気ですか
95-
BYE,Goodbye,Adiós,さようなら
96-
QUOTE,"""Hello"" said the man.","""Hola"" dijo el hombre.",「こんにちは」男は言いました
93+
keys,en,es,ja,_character
94+
GREET,"Hello, friend!","Hola, amigo!",こんにちは,John
95+
ASK,How are you?,Cómo está?,元気ですか,Jade
96+
BYE,Goodbye,Adiós,さようなら,Nancy
97+
QUOTE,"""Hello"" said the man.","""Hola"" dijo el hombre.",「こんにちは」男は言いました,Tian
9798
9899
CSV importer
99100
------------

0 commit comments

Comments
 (0)