Using the Filesystem Connector
How it Works
Using the table below as a guide, create an Enterprise translation project with the Filesystem Connector command prompt.
Key Points
- Start by downloading the connector.
- Run ltk init on the directory you wish to manage (outlined below)
Unless you change the directory, all commands run during the session will be run on the directory initialized via ltk init.
- To get help: Type “ltk -h" in the command line.
- To cancel an action: Type "Ctrl+C" in the command line.
- For a full list of commands, /wiki/spaces/DDOC/pages/64323630.
To do this | Run this command | Tips, Examples | More information |
Download the Filesystem Connector | n/a | Download the Filesystem Connector to the drive where the files you want to translate are saved. | |
Open the command prompt | Go to your list of programs and search for “command prompt.” |
| |
Using the command prompt, open the directory you wish to translate | cd [file path] | cd Documents/marketing/campaigns/emails | |
Create a translation project | ltk init | ltk init Log into Enterprise and grant the Filesystem Connector permission to access TMS.
| This command initializes an Enterprise translation project for the current directory. |
Choose a community | [type number for Enterprise community] | If you only have one community, skip this step.
| Go back to the command prompt, and choose a community |
Choose a project | [y/n] | Create a new translation project or add files to an existing translation project.
| |
Designate a download folder | ltk config -d | Choose where completed translations will be downloaded. A new download folder can be designated for each project. ltk config -d Documents/Marketing/Emails | |
Add documents to the project | ltk add + [filepath for documents you want to translate] | When adding documents to a project, they must be children of the parent directory initialized at the beginning. Add documents…
| Upload the documents from the current directory to the TMS. Note: When adding a directory to a translation project, you’re adding all of its contents – including all of its files and sub-directories – to the translation project. |
Request translation (by target) | ltk request | Type ltk request (followed by target languages) to request translations. ltk request fr_FR ltk request -p . fr_FR ltk request -p . fr_FR de_DE es_ES pt_PT | First example: Request translations for all local documents in the project. Last two examples: Request translations for the current directory. |
Check document translation statuses | ltk status | Display status for all docs in currently selected directory or project. ltk status | See if translations are done. |
Publish completed translations for a specific directory/locale | ltk download | Example (single target language) ltk download de_DE Documents/Marketing/Emails (multiple target languages) When downloading multiple target languages, separate them with commas and no spaces: | Download completed translations to your file system. The locale is appended to the file name, and each translated document appears in the same directory as the original version of the document (default) or in a specified download folder. |
After running the basic commands outlined above, you may wish to run additional commands to further manage the project. Use the table below, or refer to the full list of commands here.
Request translations for updates (new files and updated files). | ltk watch | watch checks for updates in both Enterprise and the filesystem.
| This command also downloads completed translations. |
Add settings to a translation project | ltk config | Use ltk config to add targets or change the workflow on a translation project. (ltk config is often used in conjunction with ltk watch. For more information, type “ltk config --help” in the command prompt). | |
Send updated files to Enterprise | ltk push | ltk push Sends updated content to Enterprise for re-translation. | If files in the active directory have been updated, they will be sent to Enterprise for re-translation. |
Publish all completed translations | ltk pull | ltk pull Downloads all translations of local documents from the current Enterprise project to your filesystem. (This command overwrites all existing translations with new translations) | Publishes all translations for all directories. Note: Translations are downloaded even if they are not completed. If no translation has taken place, the original document will be downloaded with the locale extension. |
Delete files from a translation project | ltk rm | Removes files from the Enterprise project. Note: This command acts on files in the active directory. ltk rm . ltk rm “Documents/Marketing/Emails” | Use this command to remove any files you no longer wish to translate from a Enterprise project. |
Next: Commands