Skip to content

Commit 35b5794

Browse files
author
Igor Afanasyev
committed
Add explanation on using configs with serge import
1 parent 010c0c6 commit 35b5794

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

doc/html/serge-import.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ <h1 id="DESCRIPTION">DESCRIPTION</h1>
3434

3535
<p>This is useful to initially import pre-existing translations before setting up an automated localization flow.</p>
3636

37+
<p>Note that for import to work, you don&#39;t need to create a separate Serge configuration file or a job: you need to setup Serge jobs for the primary workflow (localization), in each job specifying the path to output localized files using <code>output_file_path</code> parameter. Then make sure that the pre-existing localized files are located and named in accordance with that parameter, and <b>serge-import</b> will know where to find these files for importing.</p>
38+
3739
<h1 id="OPTIONS">OPTIONS</h1>
3840

3941
<dl>
@@ -53,7 +55,7 @@ <h1 id="OPTIONS">OPTIONS</h1>
5355
<dt><b>--disambiguate-keys</b></dt>
5456
<dd>
5557

56-
<p>If duplicate keys are found, don&#39;t exit but disambiguate them in the order of their presence. Use with care only when you are sure that the ordering and the number of ambigous keys in all files (both original and localized) is the same, otherwise you might end up importing wrong translations for wrong keys.</p>
58+
<p>If duplicate keys are found, don&#39;t exit but disambiguate them in the order of their presence. Use with care only when you are sure that the ordering and the number of ambiguous keys in all files (both original and localized) is the same, otherwise you might end up importing wrong translations for wrong keys.</p>
5759

5860
</dd>
5961
<dt><b>--no-report</b></dt>

doc/pod/serge-import.pod

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ and tries to import translations back into the database.
2020
This is useful to initially import pre-existing translations before setting up an
2121
automated localization flow.
2222

23+
Note that for import to work, you don't need to create a separate Serge
24+
configuration file or a job: you need to setup Serge jobs for the primary
25+
workflow (localization), in each job specifying the path to output localized
26+
files using C<< output_file_path >> parameter. Then make sure that the pre-existing
27+
localized files are located and named in accordance with that parameter,
28+
and B<serge-import> will know where to find these files for importing.
29+
2330
=head1 OPTIONS
2431

2532
=over 8
@@ -36,7 +43,7 @@ An optional comma-separated list of target languages
3643

3744
If duplicate keys are found, don't exit but disambiguate them in
3845
the order of their presence. Use with care only when you are sure that
39-
the ordering and the number of ambigous keys in all files (both original
46+
the ordering and the number of ambiguous keys in all files (both original
4047
and localized) is the same, otherwise you might end up importing
4148
wrong translations for wrong keys.
4249

0 commit comments

Comments
 (0)