yvExtensions  English  Russian    Donate  Forum   

Joomla logo yvTransliterate 

Download yvTransliterate   v.1.0.0, (0.02Mb) last changed: September 11, 2008. What's New
Download yvTransliterate: JoomlaCode, local file (unzip before install).

Contents

Short description

yvTransliterate is Transliteration plugin for Joomla! 1.5, and it's free. The plugin transliterates article aliases, that are used in Search engine optimization (SEO) for creation of Search engine friendly (SEF) slugs (URLs).
It takes into account "Content Language" of the article. And it may also be used by any other Joomla! extension to transliterate text strings. Language packs are supported: they contain transliterations for additional languages.

It may be used for site, that uses one non-English language, but it is especially useful for multilingual sites, where different articles are written in different languages.

It doesn't require any hack to the code of Joomla!'s core: you simply have to install one plugin and as many yvTransliterateLanguagePacks, as you need.

This plugin is the result of the work, that was started in March 2007 (see the thread). I hoped, that this _real_ Transliteration functionality will be inserted in Joomla! 1.5 core, but it's not there yet (see 'Language slugs transliteration').

As of 2008-09-11 yvTransliterate has transliterations for Russian and Czech languages only, and it has 'Language pack template', that may be easily adapted for new languages... Now we'll see, how many people really need transliteration (I'm expecting new language translations with transliteration for different languages).

yvTransliterate has open and simple interface, that uses special triggered event.

yvTransliterate is written from scratch specifically for Joomla! 1.5, and it is not compatible with previous versions of Joomla!/Mambo. So it is very deep integrated into Joomla! core and tries to extend and not to duplicate it.

yvTransliterate supports PHP5 only (although it may work under PHP4...).

 The license: GPL. Freeware, i.e. at no cost. If you like this extension, please consider donating to support development.
The Joomla! extension is distributed "as is", without any warranties explicit or implied.
(c) 2007-2008 Yuri Volkov, Moscow, Russia.

Demo sites: (None yet...)

 Troubleshooting and 'Before you begin'

Good luck and let's go!

Upgrading existing installation of yvTransliterate

If you're not upgrading existing installation of yvTransliterate, please skip this section.

The only reliable way to upgrade existing installation of yvTransliterate is to uninstall it (uninstall plugin), and then install new version (as it is described below). To upgrade language pack, you have to uninstall this language pack only and then install newer one.

These are "yvTransliterate plugin" parameters, that are not preserved during upgrade, and you have to set them again after installation. To speed up setting of parameters (and to be sure, that you didn't forget something...), I recommend to open yvTransliterate plugin parameters in new window of your Internet browser before uninstall, leave it open, and use information from this window as a reference for setting parameters of newer version. After uninstallation of old version, installation and configuring of newer one, please close this "reference window". And don't press any buttons on it!

Installation and configuration

1. Installation of Joomla! and it's extension(s)

  1. In a case of any problem during installation, please refer to the Troubleshooting section above.
  2. It is recommended to have Joomla! 1.5.4 (Stable) or newer, because yvTransliterate is not tested to work with earlier builds of Joomla!  (In any case you MUST have at least Joomla! 1.5.3, see the tip. If this is not a case, do not waste your time trying to install yvTransliterate Smile).
  3. For each yvCommentLanguagePack, that you are planning to install, please install 'full' language pack of Joomla! for this language for Administrator interface, downloading it e.g. from Joomla! Accredited Translations.
  4. Install yvTransliterate itself.
    1. It is required to install "yvTransliterate Plugin". Single file distribution package, located on this site,(yvTransliterate.zip) contains Plugin zipped file inside it, so you have to extract yvTransliteratePluginX.XX.XXX.zip from that package and install it.
    3. yvTransliterate distribution package contains English language files only, and in fact, it has this package has no transliterations. So you need to download some of yvTransliterateLanguagePacks from JoomlaCode and install. (yvTransliterateLanguagePacks should not be enabled!)

Now you may continue to the "Preparing for configuration" below.

2. Preparing for configuration

Before going to the configuration, you have to make some additional steps in Administrator interface (backend):

  1. (None yet)

Now you may continue to the "Step-by-step configuration" below.

3. Step-by-step configuration of yvTransliterate plugin

  1. First thing to do is to open yvTransliterate plugin configuration page: in the menu Extensions->Plugin Manager->click "yvTransliterate" Plugin.
    You will see something similar to the picture to the right.
  2. Sample values of yvTransliterate Plugin Papameters. Part 1 of 1. " Extend content table" - set to "Yes" to allow yvTransliterate to add Article alias transliteration functionality without any patch of Joomla! core.
  3. Group of settings, starting from "Debugging mode" is used in Debugging mode only, so there is no need in them. Anyway "Transliteration name" should be left empty (so the plugin will use 'default' name).
  4. Enable plugin (in 'Details' box to the left set 'Enabled' option to 'Yes').
  5. Save new configuration of the yvTransliterate Plugin.

Some tips

yvTransliterate doesn't require user (both in frontend and in backend) to explicitly set 'Content language' of the article, if current language of User interface is the same as 'Content language' of the article. E.g., if you logged in Joomla! site and current language is Czech, yvTransliterate will use 'Czech to English' transliteration by default. If in this scenario, you want to create article in e.g. Russian language, you have to set 'Content language' of the article explicitly in order to tell yvTransliterate, that it needs to use "Russian to English" transliteration for this article.

Currently built-in Joomla! "Submit an Article" menu item doesn't allow to set 'Content language' of the article in the frontend (and there is no such option in "Article Submission Layout"), so in the frontend yvTransliterate will work correctly for one language only: currently selected user interface language.

Feedback

Your feedback is greatly appreciated!

TODO - Future plans and thoughts

Information for Developers

yvTransliterate is written from scratch specifically for Joomla! 1.5 and it is not compatible with previous versions of Joomla!/Mambo. So it is free to use most advanced features of Joomla! 1.5.

My intention is to build extension, that is as much "natural", native to Joomla, and that uses as much built-in (or existing) features (tools, extensions...), as possible.

You may easily add transliteration functionality to your extensions, just adding special trigger event for transliteration:

$StringToTransliterate = 'E.g. something in Russian: Это текст на русском языке';
$langTagOfStringContentLanguage = 'ru-RU';
$dispatcher =& JDispatcher::getInstance();
$dispatcher->trigger('onTransliterate_transliterate', array(&$StringToTransliterate, $langTagOfStringContentLanguage)); 

You may see full example in 'plugins/system/yvtransliterate/table_content/content.php' file.

Debugging mode of yvTransliterate allows you to see, what and how was transliterated...

History of changes

v.1.00 (July 17, 2008)

  1. First published version.

(c) 2007-2008 Yuri Volkov, Moscow, Russia