TranslateThis Button for WordPress Documentation

Getting Started

First download the plugin, unzip and upload the entire folder to your WordPress plugins directory (/wp-content/plugins).

Next activate the plugin from your Manage Plugins screen (/wp-admin/plugins.php).

You may now set options in the TranslateThis Button Settings page, and display the button on your site using either a template tag or the sidebar widget.



Template Tag

You can display the TranslateThis Button anywhere on your blog using the template tag translate_this_button().

Example:

<?php
    if ( function_exists('translate_this_button') ) translate_this_button();
?>


Sidebar Widget

To use the sidebar widget, simply head to Appearance > Widgets in your WordPress admin section.

From here drag the 'TranslateThis Button' widget into your sidebar. The only setting you can change here is the "Title", which is displayed as text above the TranslateThis Button.

Set title to blank if you only want to display the button.

You can set other display, language and miscellaneous options in the regular TranslateThis Button Settings page.



Setting Options

The TranslateThis Button WordPress Plugin offers a variety of options that can be customized easily through the WordPress admin area.

Head over to Settings > TranslateThis Button to modify any of the default settings.

Here's a breakdown of what each option does:


Google Analytics Tracking

Enables Google Analytic tracking for some click events in the TranslateThis Button. Automatically ties into Google Analytics if the tracking script is available, and fails silently otherwise.


Translation Scope

Whether to translate the entire page or just the content area (the content area is the area contained in the element with id content.


Use Cookie

Whether to use the cookie to automatically translate all the pages on your site after a user has translated one. Set to false to only translate single page.


From Language

The language your blog is written in. Set to unknown if using multiple languages (and the Google Language API will determine the from language automatically). However if your site is in a single language you can get a slight performance gain by setting this.


Main Panel Text

The descriptive text above the flag dropdown and overlay.


More Languages Text

Text for the 'More Languages' link that calls up the overlay.


Busy Translating Text

Text shown in the overlay while the translation is processing.


Cancel Translation Text

The text for the cancel link in the overlay that shows while the translation is processing.


Undo Text

The text shown in the undo translation bar that shows for a couple seconds after the translation completes.


Use Default Languages in Dropdown

Whether to use the default set of languages in the dropdown. Unchecking this brings up checkboxes you can use to select any of the 58 languages supported by the TranslateThis Button.


Disable Button Image

Set this to use text instead of the TranslateThis Button image.


Alternate Button Text

The text to display if Disable Button Image is set.


Alternate Button Image Path

Use a custom image for the translation button by putting the path here. If you use this, be sure to set the Button Width and Button Height values.


Button Width

The width of your custom button image. Leave blank if using the default button.


Button Height

The height of your custom button image. Leave blank if using the default button.


Disable Flag Thumbnails

Use text-only links for the various languages instead of the default flag icons with text.



TranslateThis Button WordPress Plugin Changelog

Version 0.1

Released February 24, 2010



License Info for the TranslateThis Button For WordPress

The TranslateThis Button For WordPress is released under the FreeBSD license:

Copyright (c) 2010 Jon Raasch (http://jonraasch.com/)

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY JON RAASCH 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JON RAASCH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Jon Raasch, who is the man.

Only the WordPress plugin is released under this license. For terms and conditions of use for the TranslateThis Button script, click here.