Index: docs/usage/xml-sync.md |
=================================================================== |
--- a/docs/usage/xml-sync.md |
+++ b/docs/usage/xml-sync.md |
@@ -8,10 +8,10 @@ |
and it has four main operational modes: |
-## 1. XTM Login |
+## 1. XTM Login |
-This mode prompts the user for the login credentials and prompts |
-the API for the authentication token. This token should then be saved as an |
+This mode prompts the user for the login credentials and prompts |
+the API for the authentication token. This token should then be saved as an |
environment variable to be used in the other modes. It can be run as follows: |
@@ -24,28 +24,28 @@ |
In this mode, one can create an XTM project. It can be run as follows: |
- python -m cms.bin.xtm_translations [-h] [-v] create [-h] --name NAME |
- --desc DESC --client-id CLIENT_ID --ref-id REF_ID |
- --workflow-id WORKFLOW_ID [--source-lang SOURCE_LANG] |
+ python -m cms.bin.xtm_translations [-h] [-v] create [-h] --name NAME |
+ --desc DESC --client-id CLIENT_ID --ref-id REF_ID |
+ --workflow-id WORKFLOW_ID [--source-lang SOURCE_LANG] |
[--save-id] [source_dir] |
where: |
* --name* = The name of the project will have once created. |
* *--desc** = The description you wish to add to the project. |
-* *--client-id** = The id of the **pre-configured** XTM client you want |
+* *--client-id** = The id of the **pre-configured** XTM client you want |
associated with the project. Has to be an integer! |
* *--ref-id** = The reference id you want associated with the XTM project. |
-* *--workflow-id** = The id of the **pre-configured** XTM workflow to be |
+* *--workflow-id** = The id of the **pre-configured** XTM workflow to be |
associated with the project. Has to be an integer! |
-* *--source-lang* = The language of the source files. If not provided, |
-the script will use `en_US` by default. |
-* *--save-id* = Whether to save the id of the newly created project into |
+* *--source-lang* = The language of the source files. If not provided, |
+the script will use `en_US` by default. |
+* *--save-id* = Whether to save the id of the newly created project into |
'settings.ini' or not. |
-* *source_dir* = The source directory of the website. If not specified, the |
+* *source_dir* = The source directory of the website. If not specified, the |
script would consider the current working directory as the source for the website. |
-It will be used to extract all the translation strings and create the files |
-to be uploaded on project creation. It will also be used to automatically |
+It will be used to extract all the translation strings and create the files |
+to be uploaded on project creation. It will also be used to automatically |
detect the target languages for this specific project. |
**Note:** All arguments marked with * are **mandatory** and the script will |
@@ -61,24 +61,24 @@ |
It can be run as follows: |
- python -m cms.bin.xtm_translations [-h] [-v] upload [-h] [--no-overwrite] |
+ python -m cms.bin.xtm_translations [-h] [-v] upload [-h] [--no-overwrite] |
[source_dir] |
where: |
-* *--no-overwrite* = If this flag is set, then the script would **create new |
+* *--no-overwrite* = If this flag is set, then the script would **create new |
files** in XTM, instead of overwriting the ones that were already there. |
* *source_dir* = The source directory of the website. See above for the full |
explanation. |
-If you wish to add a new target language to the project automatically, |
+If you wish to add a new target language to the project automatically, |
simply create a corresponding directory in the website's `locales` directory |
and the script will update the XTM project accordingly before uploading the |
new files and will create jobs for the new languages as well. |
In order for this mode to work, it requires two things to be present: |
1. The XTM authentication token saved in the `XTM_TOKEN` environment variable. |
-2. The XTM project number present in `settings.ini`, under the `project_id` |
+2. The XTM project number present in `settings.ini`, under the `project_id` |
option, in the `XTM` section. |
@@ -98,14 +98,14 @@ |
In order for this mode to work, three requirements need to be fulfilled: |
1. The XTM authentication token saved in the `XTM_TOKEN` environment variable. |
-2. The XTM project number present in `settings.ini`, under the `project_id` |
+2. The XTM project number present in `settings.ini`, under the `project_id` |
option, in the `XTM` section. |
3. (At least one) translation file(s) to be present in XTM. |
## Dependencies |
-On top of the Python standard library, this script requires the following |
+On top of the Python standard library, this script requires the following |
additional libraries to run correctly: |
1. [Markdown](https://pypi.org/project/Markdown/) |