xili-languageWordPress Plugin

xili-language provides for a bilingual (or multilingual) website an automatic selection of language (.mo) in theme according to the language of current post(s) or page. Theme’s behaviour can be fully personalized through settings, hooks and api. Ready for CMS developers and designers.

• W A r n I N G – see tab and chapters in changelog – further versions are in github repository

• xili-language plugin provides an automatic selection of language in theme according to the language of displayed post, series of posts, page or articles. If the post is in gaelic, the texts of the theme will be in gaelic if the author checks the post as gaelic and if the theme contains the right .mo file for this target language.

• A very readable interface with a list of titles (and links) to help you write/edit/modify articles and their translations.

• To help authoring, current user can choose language of his dashboard.

• xili-language select on the fly the multilingual .mo files present in the theme’s folder (no cookies, no redirections like “301”).

• xili-language uses a custom taxonomy to specify language of post, page and custom post. Full compatible with WP JSON REST API

• xili-language plugin works on WordPress installation in mono (standalone) or on one site belonging to a multisite (network) install.

• xili-language plugin works on WordPress installation for WebApp with JSON REST API – see changelog because WP JSON REST API 1.2.1 in under full development but yet powerful.

• As educational plateform in constant changing since 2009, xili-language trilogy tries to use most of the wordpress core functions and features (Custom taxonomy, API, metabox, pointer, help, pomo libraries, …). The options are adjustable.

TESTERS WANTED

According some users, current versions can be stable with recent wp versions. BUT since 2 years, a new version is fully rewritten and tested in few websites. These new versions are available in Github and here in wp repository in tag Advanced View. Your feedback will be very valuable.

Version 2.21.2

• Last Updated 2017-04-17 (readme for new look of plugins repository – tested in websites with wp 4.7.3), further versions are in github
• W A R N I N G – see tab and chapters in changelog

For bbPress users, xili xl-bbp-addon plugin is no more a plugin. Components are optionally (if bbPress active) included. An option is also added in experts tab of settings.

Prequisite

• A project of a website with articles in different languages.
• A localizable theme : Every themes with localization (or translation-ready like twentyfourteen) can be easily used (and improved) for realtime multilingual sites.
• A tool to translate .po files of the theme and built .mo files (poEdit or better xili-dictionary – see below ).
• see this page in wiki.xiligroup.org.

What to prepare before and during installation before activating

• verify that your theme is translation-ready. Collect .po files of theme for target languages.
• if rtl languages are used, verify that theme contains rtl.css file.

Links and documentation to read before activating

• Check out the screenshots to see it in action and other tabs here.
• latest news inside twentyfourteen-xili example,
• latest bundled child theme of twentyfifteen: twentyfifteen-xili example,
• xili wiki,
• news and history,
• forum to read experience of users and obtain some support,
• For webmaster: Before to be moved in wiki, table summarizes all the technical features (widgets, template tags, functions and hooks) of this powerful plugin for personalized cms created by webmaster,

• For german speaking webmaster some documentations and posts are written by YogieAnamCara of sensorgrafie

• and finally the source code of the plugin itself if you read php!

themes provided as examples

• Since WordPress 4.1, the default theme named twentyfifteen can be used without php coding for a multilingual site as shown here twentyfifteen-xili.
• Other child theme examples of bundled parent themes: twentyeleven twentyeleven-xili, twentytwelve twentytwelve-xili, twentythirteen twentythirteen-xili, twentyfourteen twentyfourteen-xili, twentyfifteen twentyfifteen-xili.

Other compatible plugins by xiligroup dev

TRILOGY FOR MULTILINGUAL CMS WEBSITE

including xili-language plugin

Please verify that you have installed the latest versions of:

• xili-dictionary plugin: With xili-dictionary, it is easier to create or update online, via admin/dashboard UI, the files .mo of each language.
• xili-tidy-tags plugin: With xili-tidy-tags, it is now possible to display sub-selection (cloud) of tags according language and semantic trans-language group (trademark,…).

That this plugin does not

With around 8000 php lines, xili-language is not everything…

• xili-language plugin does not create additional tables in the database, do not create cookies and only use 4 lines in Options table. xili-language simply makes proper use of the taxonomy tables and postmeta table offered by WordPress to define language and link items between them. Because xili-language plugin does not modify deeply the post edit ui, it is possible to use iPhone / ipod touch WordPress app to prepare and draft the post.

• xili-language plugin does not replace the author or the editor. No automatic translation. content strategist is the master of the languages, the contents and the navigation inside the website. With xili-dictionary, webmaster can translate the theme’s items and when .mo files are in place, xili-dictionary can be deactivated. For design, the creator is free to choose text or graphic. xili-language does not provide flags (or few as example in child-theme example like twentytwelve-xili )!

Newbie, WP user, Developer,…

• Dear Newbie: originally built for webmaster and developer, the plugin trilogy progress since 6 years to be more and more plug and play for newbies who can read and spend a little time mainly for translation.

• xili-language is also dedicated for theme’s creator or webmaster with knowledges in CMS and WP and having (or not) tools to create .mo language files. Through API (hook), the plugin add automatic tools (or links or filters) for sidebar or top menus. Categories or Archives lists are translated also.

• xili-language provides also series of functions which can be hooked in the functions.php file of the theme that you create i.e. for a cms like multilingual website.

Licence, donation, services, “as is”, …

Contrary to popular belief, GPL doesn’t say that everything must be zero-cost, just that when you receive the software (plugin or theme) that it not restrict your freedoms in how you use it. free open source plugin does not mean free services

• Texts of licence: GPLv2
• Donation link via paypal in sidebar of dev.xiligroup site
• Services : As authors of plugin, dev.xiligroup team is able to provide services (consulting, training, support) with affordable prices for wp multilingual contexts in corporate or commercial websites.
• Plugin is shipped as is : see no warranty chapter in license gplv2.

Roadmap

• Improved documentation for getting starts, template tags and functions – here in news or here by Vladimir.
• Delivery of a premium services kit (with powerful features and attractive fees) packaged with professional training and support.
• Updating sources (parts are 6 years old) with new libraries provided since wp 4.2.
• Contributions are welcome ?

More infos

1. Technical infos
   

   1.1. Prerequisite
   

   1.2. CMS
   

   1.3. Documentation for developers
   

   1.4. More infos and docs

2. Flags
3. Compatibility

1. Technical infos

• REMEMBER : xili-language follows the wordpress story since more than 6 years. Initially designed for webmasters with knowledge in WP, PHP,… step by step the plugin will improved to be more and more plug and play. So don’t forget to visit this latest demo and news, see this other demo and Forum.

1.1. Prerequisite

Verify that your theme is international (translation ready) compatible (translatable terms like _e('the term','mythemedomaine') and no displayed texts ‘hardcoded’ (example in default bundled themes of WP named twentyfourteen or twentyfifteen ).

• This latest version works with WP 4.0+ in mono or multisite.

1.2. CMS

• CMS = Content Management System
• Contains features dedicated to multilingual theme’s creators and webmasters. Don’t forget to read documented source code.

1.3. Documentation for developers

A table summarizes all the technical features (widgets, template tags, functions and hooks) of this powerful plugin for personalized CMS created by webmaster.

• provides infos about text direction ltr ou rtl of languages (arabic, hebraic,…) of theme and of each post in loop
• unique id for category link hook see expert’s corner posts
• hooks to define header metas or language attributes in html tag.

1.4. More infos and docs

• Other posts, articles and more descriptions here and here in action.
• Visit also Forum to obtain more support or contribute to others by publishing reports about your experience.

2. Flags

Default flags provided in bundled child themes like twentyfourteen-xili 2014 came from famfamfam. To be compliant to the design and look, choose your own series of flags. Be aware of size and file naming.

3. Compatibility

xili-language is compatible with the plugin xili-dictionary which is able to deliver .mo files on the fly through the wp admin ui (and .po files translatable by other translators). xili-dictionary used a specific taxonomy without adding tables in WP database.

xili-language is compatible with the plugin xili-tidy-tags. xili-tidy-tags lets you create multiple group of tags. That way, you can have a tag cloud for tags in English, another cloud for French tags, another for Spanish ones, and so on. You can also use the plugin for more than multilingual blogs. Basically, you can create any group of tags you want.

xili-language is full compatible with the plugin xilitheme-select to be used with iPhone, iPod Touch or other mobiles. Also with xili re/un-attach media !

More informations about other plugins in the website dev.xiligroup.com or in WP Repository

The plugin is frequently updated. Visit Other versions.

see also the dev.xiligroup Forum.

* Tags from previous readme : theme, post, plugin,posts,page,category,admin, bilingual, dictionary,.po file, widget,international, i18n, l10n, WP network, multisite, blogroll, japanese, khmer, rtl, translation-ready, bbpress, jetpack, polylang

© 2008-2018 – ms – dev.xiligroup.com

READ CAREFULLY ALL THE README FILE AND PREREQUISITES

Read this recent page and also wiki for older versions and features.

1. Upload the folder containing xili-language.php and language files to the /wp-content/plugins/ directory,
2. Verify that your theme is international compatible – translatable terms like _e('the term','mytheme') and no text hardcoded – and contains .mo and .po files for each target language – (application poEdit and/or plugin xili-dictionary can be used)
3. Verify that a domain name is defined in your theme – see note at end list below,
4. Activate the plugin through the ‘Plugins’ menu in WordPress,
5. Go to the dashboard settings tab – languages – and adapt default values if necessary by adding your languages in the catalog. You can set the order (1,2,3…) of the series. (used in language_attributes() template_tag).
6. Modify each post by setting (checking) the language in xili-language box (under the content box) before publishing.
7. Other settings and parts (Browser detection, widgets, shortcode, template tags) see below… and examples.

Some steps to prepare a rich installation:

Tabs of settings

Settings are progressively reorganized in 6 tabs:

1. Languages list: Where you define the list of languages needed in your multilingual website.
2. Languages front-end settings: Where you define some rules and behaviour when visitor arrives in the website or navigates inside.
3. Settings for experts: Where experts are able to set and recovers previous sets. (backwards compatibility)
4. Managing language files: To import .mo files for theme or dashboard (if available in GlotPress or Automattic servers).
5. Managing Authoring rules: To define rules and settings in the dashboard side and help authoring.
6. xili-language support: A form to send an email to xiligroup support.

(online help on the top right tab for each settings page)

Additional infos

1. Before using your own theme, to understand how xili-language works, install the example child theme of one of the bundled themes like TwentyFourteen shown in this commented demo site.
2. Child of bundled themes include a navigation menu – see links in FAQ -. In xili-language settings, it is possible to insert automatically languages list in the menu previously set by you.
3. If you are webmaster and want to add lot of personalizations in your theme, read source and visit latest news.

Browser detection for visitors or authors

To change the language of the frontpage according to the language of the visitor’s browser, check the popup in right small box in settings.
To change the default language of a new post according to the language of the author’s browser, check the popup in right small box in settings.

xili-language and widgets

Three widgets are created to enrich sidebar : list of languages, recent posts and recent comments with sub-selection according current language.

xili-language and shortcode

SHORTCODE to add a link to other language inside content of a post like:

[linked-post-in lang="fr_fr"]Voir cet article[/linked-post-in]

by default use context ‘linktitle’ for translation ‘A similar post in %s’ text of link title attribut.

SHORTCODE to display only content if current language:

[xili-show-if lang=fr_FR ]contenu de la page boutique multilingue[/xili-show-if]

param lang can be ISO or slug.

SHORTCODE to insert translated msgid content according current language

Easy to insert .mo item in your current content.
[xili18n msgid=’yes’]
domain by default is here theme textdomain
[xili18n msgid=’yes’ ctxt=’front’ textdomain=’default’]
above it is the WP core textdomain

SHORTCODE to insert URL of flag set with a language:
[xili-flag lang=’fr_FR’] returns url of french flag

xili-language and template tags

• xili-language “translates” template tags and permits some variations for webmasters:

The most current template tags don’t need special work: wp_list_categories(), wp_title(),…

wp_get_archives

Possible that very special permalinks need to use hook named xiliml_get_archives_link. –
Sub selection of archives for wp_get_archives() with &lang= (see § below)

wp_list_pages() with optional query tag &lang=

• xili-language “provides” new template tags (or widgets) to solve issues from WP core or add new features for CMS:

  xili_language_list() – outside loop (sidebar) display the languages of the site (used also by widget)

  xiliml_the_category() – replace the_category() template tag of WP Core

improved xiliml_the_others_posts() function and theme tag to be used in multilingual category loop and by option (array) to return an array of linked posts in other languages (useful for CMS webmasters) (array of lang and id ) – the id is easily transformable in permalink with function get_permalink() when using this array.

xili-language and specific functions

Requires knowledges in php and WP !
After class in sources files, some functions are available – see sources for details.

• the_curlang() returns by default the slug of the current language of the displayed webpage (alias xili_curlang() since 2.11+). If param is specified, return ISO, Full Name or alias of current webpage – see sources –

• is_xili_curlang( $lang ) tests (returns true or false) after testing language of current webpage. Param can be a language slug (as string) or a list of slugs (as an array). Example: is_xili_curlang( 'fr_fr' ) returns true if webpage is in french – since 2.11+

• widget for recent comments that can subselect those for current language. (a function xiliml_recent_comments() is also available if you want to create a template tag with resulting objects array).

Archives selection

Archives tags is a very complex template tag in his background and not very easy source hookable. So we decided to add few features : by adding query in vars of the function, it will be possible to display a monthly list of archives for a selected language – wp_get_archives('..your.vars..&lang=fr_fr') – or the current the theme language – wp_get_archives('..your.vars..&lang=') -. The displayed list of links will be translated and link restrited to display only archives of this language.