Export (0) Print
Expand All

Customizing the Web Widget V2 (Deprecated)

JJ715966.alert_note(en-us,MSDN.10).gif Note

This version of the Translator Widget is now deprecated and will not be supported. You can now upgrade to the new Translator Widget and enjoy the new experience while maintaining all your data! Upgrade here!

Certain components of the Microsoft Translator Widget can be manually edited to support customizations. Below is the list of the string parameters for customization.

String Parameter

Description

from

Source language of the page.

mode

Translation “behavior” of the widget, default is manual however the user can always override the behavior which persists for the browser session.

  • =manual
  • – Translation is only invoked when the user clicks “go” on the widget.
  • =notify
  • – If the browser locale is different than the page and is a supported MT language then show the toolbar and offer to translate the page.
  • =auto
  • – If the browser locale is different than the page and is a supported MT language then kickoff translation automatically.
  • =preview
  • – The widget appears normally but all functionality is disabled. This is used on the adoption portal.

widget

Whether or not to display the widget control, default is to display it.

  • =none
  • – Hide widget control. Should generally only be applied when mode is notify or auto. It can technically be applied when mode is manual but that would be rather pointless since there’d be no way to invoke translation.

toolbar

Display mode for the toolbar, default is inject.

  • =none
  • – Do not display the toolbar.
  • =inject
  • – Float the toolbar at the top of the window but inject whitespace at the top of the page to accommodate it.
  • =overlay
  • – Float the toolbar at the top of the window but don’t inject any whitespace, which may result in covering the page’s header content.
  • =thin
  • – The toolbar appears narrower (approx 24px tall), the logo is replaced with a small icon and some text that typically indicates the progress percentage.

loc

Override the UI locale, default is according to the client’s browser accept-language setting. We accept any .NET supported language and fallback to English if it is something we do not localize to.

showLanguages

Comma delimited list of additional languages to show. For instance:

"/ajax/v2/widget.aspx?mode=manual&from=en&showlanguages=fr,de,it"
We accept any valid .NET language however unless the API accepts it the page will not get translated. Note that it is possible to add languages whose names we do not localize in which case the language name will always appear in English.

hideLanguages

Comma delimited list of languages to hide. For instance:

"/ajax/v2/widget.aspx?mode=manual&from=en&hidelanguages=fr,de,it"

defaultLanguage

Language code to override the default target language.

ctfLanguages

Comma delimited list of languages to enable for CTF. Allows you to limit feedback to certain languages. For non-CTF widget snippets, this parameter has no effect.

showDashboard

When set to either "false" or "no" the dashboard link is not shown in the CTF tooltip.

category

Use this value as the category field for all API calls.

"/ajax/v2/widget.aspx?mode=manual&from=en&layout=ts&category=<category ID>

While it does not impact the widget snippet there is also a feature that triggers translation on any page hosting the widget by appending “#mstto=(target language)” to the page URL. Here’s an example: "http://blogs.msdn.com/b/translation/#mstto=ko".

Show:
© 2014 Microsoft