Issue #6942 - Add XTM integration in CMS

docs/usage/xml-sync.md

Index: docs/usage/xml-sync.md
diff --git a/docs/usage/xml-sync.md b/docs/usage/xml-sync.md
new file mode 100644
index 0000000000000000000000000000000000000000..d3bce4fdf3a7ca0685b6bd64b8c81bec7cdf5009
--- /dev/null
+++ b/docs/usage/xml-sync.md
@@ -0,0 +1,113 @@
+# XTM Integration
+
+The integration with the XTM API can be run using the following command:
+
+    python -m cms.bin.xtm_translations [-h] [-v] {login,create,upload,download}
+
+
+and it has four main operational modes:
+
+
+## 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 
+environment variable to be used in the other modes. It can be run as follows:
+
+
+    python -m cms.bin.xtm_translations [-h] [-v] login [-h]
+
+
+
+## 2. Project Creation
+
+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] 
+                [--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 
+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 
+associated with the project. Has to be an integer!
+* *--source-lang* = The language of the source files. If not provided, 

[wspee, 2018/10/10 15:09:16]

This parameter is not mandatory

+the script will use `en_US` by default. 
+* *--save-id* = Whether to save the id of the newly created project into 

[wspee, 2018/10/10 15:09:16]

This parameter is not mandatory

+'settings.ini' or not.
+* *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 
+detect the target languages for this specific project.
+
+**Note:** All arguments marked with * are **mandatory** and the script will
+fail if not provided.
+
+In order for this mode to work, it requires the XTM authentication token
+to be saved in the `XTM_TOKEN` environment variable.
+
+
+## 3. File Uploading
+
+This mode can be used to upload new files for translation to an existing project.
+It can be run as follows:
+
+
+    python -m cms.bin.xtm_translations [-h] [-v] upload [-h] [--no-overwrite] 

[wspee, 2018/10/10 15:09:15]

Also it might make sense to document the settings.ini parameter?

[wspee, 2018/10/10 15:09:15]

For a per issue workflow (and also in general) it would be very nice to be able
to specify the project id via the command line.

+                [source_dir]
+
+
+where:
+* *--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, 
+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` 
+option, in the `XTM` section.
+
+
+## 4. Translation Files Downloading
+
+This mode downloads the translation files from the XTM project and saves them
+in the website's `locales` directory. It can be run as follows:
+
+    python -m cms.bin.xtm_translations [-h] [-v] download [-h] [source_dir]
+
+
+where `source_dir` is the source directory of the website. See above for full
+explanation.
+
+When run in this mode, the script will remove all the translation files that
+were previously saved locally and then save the new ones in their place.
+
+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` 
+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 
+additional libraries to run correctly:
+
+1. [Markdown](https://pypi.org/project/Markdown/)
+2. [Jinja2](https://pypi.org/project/Jinja2/)
+3. [Requests](https://pypi.org/project/requests/)