Skip to content

v0.2.47..v0.2.48 changeset LanguageTranslation.asciidoc

Garret Voltz edited this page Sep 27, 2019 · 1 revision
diff --git a/docs/user/LanguageTranslation.asciidoc b/docs/user/LanguageTranslation.asciidoc
index 5515b82..5a59f18 100644
--- a/docs/user/LanguageTranslation.asciidoc
+++ b/docs/user/LanguageTranslation.asciidoc
@@ -2,13 +2,13 @@
 [[LanguageTranslation]]
 == Language Translation
 
-Hootenanny supports translating tag values to English.  At the time of this writing, translation is available only via the command line 
-(alternatively, you could write your own translation client), you must have the Hootenanny Web Services available, you must manually 
-install a language pack for each source language to be translated from, and you must be logged in to the Hootenanny Web Services.  
+Hootenanny supports translating tag values to English.  At the time of this writing, translation is available only via the command line
+(alternatively, you could write your own translation client), you must have the Hootenanny Web Services available, you must manually
+install a language pack for each source language to be translated from, and you must be logged in to the Hootenanny Web Services.
 
-For more information on logging into the web services, see the `login` command documentation.  All command line invocations making use of the 
-to English translation related services require the configuration options: `hoot.services.user.name`, `hoot.services.oauth.access.token`, and 
-`hoot.services.oauth.access.token.secret` be populated with your authentication information.  Those options are omitted from the following 
+For more information on logging into the web services, see the `login` command documentation.  All command line invocations making use of the
+to English translation related services require the configuration options: `hoot.services.user.name`, `hoot.services.oauth.access.token`, and
+`hoot.services.oauth.access.token.secret` be populated with your authentication information.  Those options are omitted from the following
 examples.
 
 First, log into the Hootenanny Web Services:
@@ -30,9 +30,9 @@ Also, there are several language translation configuration options available tha
 hoot info --config-options language.translation --option-details
 -------------------
 
-Optionally, since a translation service must be set up manually for each language being translated from and may consume significant 
+Optionally, since a translation service must be set up manually for each language being translated from and may consume significant
 resources, you may want to first scan your data for which non-English languages are most prevalent.  Language detection will not
-be completely accurate but should give you a good idea of the untranslated state of the data.  For example, to determine the 
+be completely accurate but should give you a good idea of the untranslated state of the data.  For example, to determine the
 most prevalent source languages for non-English POI names in a map:
 
 -----------------------
@@ -40,8 +40,8 @@ hoot convert -D language.parse.names=true -D language.hoot.services.detection.mi
 -----------------------
 
 Some language detectors support returning a confidence value with their detections, as indicated by the use of the configuration option,
-`language.hoot.services.detection.min.confidence.threshold`, above.  In the example above, only high confidence detections are being used.  
-To determine which server side language detectors support confidence, see the later section with an example showing how to list language 
+`language.hoot.services.detection.min.confidence.threshold`, above.  In the example above, only high confidence detections are being used.
+To determine which server side language detectors support confidence, see the later section with an example showing how to list language
 detectors.
 
 Next, determine what languages are available for translation.  This will list them:
@@ -55,7 +55,7 @@ to the Hootenanny team about the possibility of adding your language to the list
 see whether it is marked "available" or not.  If it is not marked "available", then you will need to have the language installed.  See
 the Hootenanny Installation Guide for details on installing a language pack.
 
-Once you've determined your language is available for translation, you can start translating with the default translation configuration.  
+Once you've determined your language is available for translation, you can start translating with the default translation configuration.
 The following will translate all "name" and "alt_name" tags for elements from German to English:
 
 -------------------
@@ -65,7 +65,7 @@ hoot convert -D convert.ops="hoot::ToEnglishTranslationVisitor" -D language.tran
 
 Note that the `language.translation.translator` configuration option is set explicitly to a particular fully functional translator client
 that accesses a translation service hosted by the Hootenanny Web Services.  The default translator (`hoot::ToEnglishDictionaryTranslator`) performs
-static lookups and therefore, isn't too useful and is used primarily for testing purposes.  Note also that source languages are specified 
+static lookups and therefore, isn't too useful and is used primarily for testing purposes.  Note also that source languages are specified
 by their ISO-6391-1 code.  When you listed the translatable languages earlier, the codes were printed along with the language names.
 
 The default translator has language detection built in.  So if you don't know the source language of your text, you can have the translator
@@ -86,7 +86,7 @@ hoot convert -D convert.ops="hoot::ToEnglishTranslationVisitor" -D language.tran
   -D language.translation.source.languages="de;es" -D language.tag.keys="name;alt_name" input.osm output.osm
 -------------------
 
-If you want to allow the translator to use a detected language for translation that isn't among one of your specified source languages, 
+If you want to allow the translator to use a detected language for translation that isn't among one of your specified source languages,
 you can do this:
 
 -------------------
@@ -123,8 +123,8 @@ hoot convert -D convert.ops="hoot::ToEnglishTranslationVisitor" -D language.tran
 -------------------
 
 All of the previous examples were done with the default service translator, HootLanguageTranslator.  At the time of this writing, the
-only other hoot services language translator available is JoshuaLanguageTranslator.  Since HootLanguageTranslator by default uses 
-JoshuaLanguageTranslator internally for its translation and adds detection on top of that, you won't gain to much by switching over to 
+only other hoot services language translator available is JoshuaLanguageTranslator.  Since HootLanguageTranslator by default uses
+JoshuaLanguageTranslator internally for its translation and adds detection on top of that, you won't gain to much by switching over to
 JoshuaLanguageTranslator.  However, if additional translators become available at any time, you can list them with this:
 
 -----------------------
@@ -139,7 +139,7 @@ hoot convert -D convert.ops="hoot::ToEnglishTranslationVisitor" -D language.tran
   input.osm output.osm
 -----------------------
 
-Service language detectors are configurable in a similar fashion to translators.  By default when language detection is used, translators 
+Service language detectors are configurable in a similar fashion to translators.  By default when language detection is used, translators
 attempt to deploy all available language detectors until a detection is made.  To list available language detectors:
 
 -----------------------
@@ -154,7 +154,7 @@ hoot convert -D convert.ops="hoot::ToEnglishTranslationVisitor" -D language.tran
   -D language.hoot.services.detectors="MyDetector1;MyDetector2" input.osm output.osm
 -----------------------
 
-At the time of this writing (9/19/18), all translation is done via the Hootenanny web services.  It is possible to integrate new translation 
+At the time of this writing (9/19/18), all translation is done via the Hootenanny web services.  It is possible to integrate new translation
 technologies with Hootenanny and use them by specifying a new client side, core translator implementation like this:
 
 -------------------
Clone this wiki locally