Skip to content

Commit 4e4d683

Browse files
authored
Update README.md
1 parent 3efd27c commit 4e4d683

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

+19-11
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ You can obtain all of these from the Azure portal.
2929

3030
|Command | |
3131
|----------------------------|-----------------------------------------|
32-
|'doctr config --set storage <Storage Connection String> | Required |
33-
|'doctr config --set key <Subscription key of the Translator resource> | Required |
34-
|'doctr config --set name <Name of the Azure Translator resource> | Required |
35-
|'doctr config --set category <Custom Translator category ID> | Optional |
32+
|'doctr config --set storage &<Storage Connection String&> | Required |
33+
|'doctr config --set key &<Subscription key of the Translator resource&> | Required |
34+
|'doctr config --set name &<Name of the Azure Translator resource&> | Required |
35+
|'doctr config --set category &<Custom Translator category ID&> | Optional |
3636

3737
The configuration settings are stored in the file appsettings.json, in the user's roaming app settings folder, typically
3838
C:\Users\<Username>\AppData\Roaming\Document Translation
@@ -43,21 +43,29 @@ You can inspect the settings using the following commands:
4343
'doctr config test' | Validate the credentials and report which one is failing.
4444

4545
### List capabilities
46-
+-------------------+---------------------+
46+
47+
|Command | |
48+
|-------------------|---------------------|
4749
|'doctr languages' | List the available languages. Can be listed before credentials are set. |
4850
|'doctr formats' | List the file formats available for translation. Requires credentials key, name and storage to be set. |
4951
|'doctr glossary' | List the glossary formats available for use as glossary. Requires credentials key, name and storage to be set. |
5052

53+
5154
### Translate
52-
+----+-----+
53-
'doctr translate <source folder OR document> [<target folder>] --to <language code>' | Translate a document or the content of a folder to another language.
55+
|Command | |
56+
|----|-----|
57+
|'doctr translate <source folder OR document> [<target folder>] --to <language code>' | Translate a document or the content of a folder to another language.|
58+
5459
If provided, the target folder must be a folder, even if the source document is an individual document. If not provided, the translated document will be placed in a folder
5560
that has the same name as the source folder, plus '.<language code>'.
5661
Optional parameters to the translate command are
57-
--from <language code> | The language to translate from. If omitted, the system performs automatic language detection.
58-
--key <key to the Translator resource> | This key will override the settin in the appsettings.json file. Use this if you want to avoid storing the key in a settings file.
59-
--category <category ID> | The custom Translator category ID.
60-
--glossary <file or folder> | The glossaries to use for this run. The glossary contains phrases with a defined translation in a table format.
62+
63+
| Options | |
64+
| --|---|
65+
|--from <language code> | The language to translate from. If omitted, the system performs automatic language detection.|
66+
|--key <key to the Translator resource> | This key will override the settin in the appsettings.json file. Use this if you want to avoid storing the key in a settings file. |
67+
|--category <category ID> | The custom Translator category ID.|
68+
|--glossary <file or folder> | The glossaries to use for this run. The glossary contains phrases with a defined translation in a table format.|
6169

6270
### Clear
6371
If a translation run gets interrupted or fails, it may also fail to clean up after itself and leave behind documents in the storage account.

0 commit comments

Comments
 (0)