qTranslate-Team / qtranslate-x

Wordpress plugin: Adds user-friendly and database-friendly multilingual content management and translation support.
http://qtranslatexteam.wordpress.com/about/
GNU General Public License v3.0
203 stars 151 forks source link

qTranslate X

Developed by: qTranslate Team based on original code by Qian Qin Contributors: johnclause, chineseleper, Vavooon, grafcom Tags: multilingual, language, multi-language, multilanguage, bilingual, Polyglot, admin, tinymce, widget, switcher, i18n, l10n, professional, human, translation, service, WPML, WPGlobus, Polylang, Ceceppa Multilingua, qTranslate, zTranslate, mqTranslate, qTranslate Plus Requires at least: 3.9 Tested up to: 4.5 Stable tag: 3.4.6.5 License: GPLv3 or later Donate link: https://qtranslatexteam.wordpress.com/donations/ License URI: http://www.gnu.org/licenses/gpl-3.0.html

Adds a user-friendly multilingual dynamic content management.

Description

The plugin offers a way to maintain dynamic multilingual content on a WordPress site. While static localization is already excellently implemented and offered by WordPress framework through po/mo file framework, it is still impossible to maintain dynamic multilingual content without an additional specialized plugin, a kind of which qTranslate-X belongs to. For example, what if you need to make title, content and excerpt of a page to be multilingual? In theory, it could be handled by po/mo files, but in an insanely inconvenient way.

To deal with dynamic content, qTranslate-X provides language switching buttons on applicable admin editing pages, which, once pressed, make all the text of multilingual fields to be filled with the language chosen. The instant language change happens locally in your browser without sending an additional request to the server, which makes it most convenient for bi-lingual or few-lingual sites, for example, owners of which perform the translation of content on their own. qTranslate-X does not provide a way to translate static strings, assuming that this part is already implemented and handled by the WordPress localization framework.

The plugin provides a way to designate which fields on a page or post are to be multilingual. Once a field is declared multilingual, it will be distinguishably highlighted (in a customizable way) on admin side. Pressing one of the Language Switching Buttons (LSB) will change the value of mutlilingual fields allowing to input and edit edit different values for each language. Note, that only the fields configured to be multilingual respond to LSB, while regular fields are not affected and keep the same value for each language. At frontend, the value of active language, as defined by a page viewer, is extracted from multilingual field to be displayed within HTML context. Thus, a concept of multilingual field is in use here, as opposite to a concept of whole separate page or separate site for each language, as it is done in a number of other multilingual content management plugins, see for example, free Polylang or paid WPML. Each plugin has its own pros and cons, please, choose carefully the one which suits your needs the best.

Plugin qTranslate-X provides a convenient way to describe which fields need to be multilingual through a JSON-encoded configuration file as described in Integration Guide. It makes it easy to integrate your theme or other plugins with qTranslate-X. A JSON-encoded file, named i18n-config.json, such as the one used by qTranslate-X itself, may be provided by themes and plugins within their distribution. Plugin qTranslate-X picks up and load those configuration files on activation of a plugin or on the switch of a theme. Such a configuration file can potentially be employed by any other multilingual plugin. The developers are encouraged to contact us to discuss a common standard for the i18n-config.json configuration file.

The plugin does not currently offer any kind of translation services. The team has conducted an online survey to find out how people translate their content. You are welcome to make your entry too. It appears so far, that translation service is not an immediate need. Administrators normally have their ways to translate the content, but they need a convenient way to enter translated content into an appropriate place, which this plugin is designed to help for. Translation services might still be provided in the future releases as a paid feature.

Plugin qTranslate-X makes creation of multilingual content as easy as working with a single language. Here are some features:

The website qTranslate-X explained provides and keeps updated a few useful listings:

If you encounter a conflicting plugin, please let us know, and meanwhile try to use other plugin of similar functionality, if possible.

This plugin has started as a descendant of qTranslate, which has apparently been abandoned by the original author, Qian Qin. At this point, qTranslate-X has many new features and hardly resembles its ancestor. Neither it is a straightforward compatible with older plugin. One will need to carefully read Migration Guide in order to switch a site from old qTranslate to qTranslate-X.

You may still find some useful information through reading qTranslate's original documentation, which is not duplicated here in full. There are also other plugins, which offer multilingual support, but it seems that Qian Qin has a very good original back-end design, and many people have been pleasantly using his plugin ever since. It stores all translations in the same single post, which makes it easy to maintain and to use it with other plugins. However, the user interface of former qTranslate got out of sync with the recent versions of Wordpress, especially after WP went to TinyMCE 4. There has been a number of forks of qTranslate, for example, mqTranslate, qTranslate Plus and zTranslate. Most of them are now retired. They all tried to fix qTranslate's user interface preserving its original back-end, which is what this plugin does too. This plugin is a hybrid of all of them and fixes a few bugs in each of them. It also has many new features too, like theme custom translatable fields, for instance. We hope that this plugin is the most complete working version which combines the best features of the original qTranslate as well as all its forks.

We organized an impersonal entity qTranslate Team to maintain a joint authority of all qTranslate-ish plugins. Anyone is welcome to join with a contribution. Participating plugin authors should share the support efforts for each other.

GitHub repository is available: https://github.com/qTranslate-Team/qtranslate-x.git.

We thank our sponsors for persistent help and support:

Installation

Important: Read migration instructions, if you previously used other multilingual plugin, otherwise initial installation of this plugin is no different from any other standard plugin. It may help to review Startup Guide in order to get an idea on what to expect.

Very Important: Whenever you update the plugin, make sure to deactivate the previous version and then activate the new one. Normal WordPress update does that, and should be sufficient, but if you overwrite plugin files manually, be sure to execute deactivation/activation cycle, otherwise you will miss the execution of activation hooks and some options may become misconfigured. For the sake of performance, plugin is not programmed to run all the necessary checks every time it is loaded, since activation hook is an expensive operation. That is why it is important to execute deactivation/activation cycle.

Otherwise the installation is similar to any other WordPress plugin:

  1. Download the plugin from WordPress or take the latest development version from GitHub.
  2. Use WordPress /wp-admin/plugin-install.php page to install a plugin or extract all the files and upload everything (keeping the directory structure) to the /wp-content/plugins/ directory.
  3. Deactivate plugin qTranslate, mqTranslate, qTranslate Plus, zTranslate or any other multilingual plugin, if you are running any.
  4. Activate qTranslate-X through the 'Plugins' (/wp-admin/plugins.php) configuration page in WordPress.
  5. Open Settings->Languages configuration page and add/delete/disable any languages you need.
  6. Add the "qTranslate Language Chooser" widget or "Language Switcher" menu item to let your visitors switch the language.
  7. For the new installers, it may be useful to read Startup Guide.
  8. Configure theme or other plugins custom fields to be translatable if needed (Settings -> Languages: "Integration").
  9. If your theme shows multilingual fields at front end in raw format, then read Integration Guide.

Frequently Asked Questions

A general FAQ list is available at "qTranslate-X explained" website: https://qtranslatexteam.wordpress.com/faq/, where it is easier to maintain it in between releases.

Developers: please drop new topics here, the text will be moved to qTranslate-X explained at the time of the next release.

Screenshots

  1. Editing screen showing the Language Switching Buttons (LSB). Pressing a button does not make a call to the server, the editing happens locally in browser, until "Update" button is pressed, the same way as it is for one language. Multilingual Fields (MLF) are decorated with a color bar on the left to make it easier to distinct them. The way MLF is marked is customizable. Note, that only the fields configured to be multilingual respond to LSB, while regular fields are not affected and keep the same value for each language.
  2. Language Management Console - tab "General". Read Startup Guide for more information.
  3. Language Management Console - tab "Advanced". Read Startup Guide and FAQ for more information.
  4. Language Management Console - tab "Integration". These are the options to configure custom Multilingual Fields (MLF). Read Integration Guide for more information.
  5. Language Management Console - tab "Import/Export". Read Migration Guide for more information.
  6. Language Management Console - tab "Languages". Read Startup Guide for more information.
  7. Language Management Console - page "Configuration Inspector". This page allows to review the combined resulting JSON-encoded configuration of qTranslate-X. Read Integration Guide for more information.

Upgrade Notice

3.4.8

Introducing new date/time handling method based on the latest WordPress implementation of date/time translation.

3.4.6.6

More of compatibility issues with WP 4.5

3.4.6.5

Compatibility issues with WP 4.5

3.4.6.4

Fix: A fix for Internal Server Error 500 under some circumstances.

3.4.6.2

This version recovers translation of parent of a category on category edit page.

Changelog

3.4.8

3.4.6.8

3.4.6.7

3.4.6.6

3.4.6.5

3.4.6.4 release

3.4.6.2 release

3.4.6.1 release

3.4.6 release

3.4.5.4

3.4.5.3

3.4.5.2

3.4.5.1

3.4.5

3.4.4 release

3.4.3 release

3.4.2 release

3.4.1 release

3.4 release

3.3.9.0

3.3.8.9

3.3.8

3.3.7

3.3.5

3.3.4

3.3.3

3.3.2

3.3.1

3.3 release

3.2.9.9.8 (3.3 RC1)

3.2.9.9.7 alpha

3.2.9.9.6 alpha

3.2.9.9.5 alpha

3.2.9.9.4 alpha

3.2.9.9.3 alpha

3.2.9.9.2 alpha

3.2.9.9.1 alpha

3.2.9.9.0 alpha

3.2.9.8.9 alpha

3.2.9.8.8 alpha

3.2.9.8.5 alpha

3.2.9.8.4 alpha

3.2.9.8.3 alpha

3.2.9.8.2 alpha

3.2.9.8.1 alpha

3.2.9.8 alpha

3.2.9.7 alpha

3.2.9.6 alpha

3.2.9.5

3.2.9.4

3.2.9.3

3.2.9.2

3.2.9.1

3.2.9 release

3.2.7 release

3.2.6

3.2.5

3.2.4

3.2.3

3.2.2 release

3.2.1 release

3.2 release

3.2-b3

3.2-b2

3.2-b1

3.1 release

3.1-a1

3.1-b4

3.1-b3

3.1-b2

3.1-b1

3.0 release

2.9.8.9 alpha

2.9.8.8 alpha

2.9.8.7 alpha

2.9.8.5 alpha

2.9.8.4 alpha

2.9.8.3 alpha

2.9.8.2 alpha

2.9.8.1 alpha

2.9.8.0 alpha

2.9.7.9 beta

2.9.7.8 beta

2.9.7.7 beta

2.9.6 release

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9

2.8

2.7.9

2.7.8

2.7.7

2.7.6

2.7.5

2.7.4

2.7.3

2.7.2

2.7.1

2.7

2.6.4

2.6.3 (2014-12) (initial changes after zTranslate)

Known Issues

It is important to review the list of Known Issues before starting using the plugin.

Credentials

Please, review the credentials page at qTranslate-X explained website.

Desirable Unimplemented Features

A list of desirable features is maintained at qTranslate-X explained website.