Multilingual features for the OpenEuropa project.
This package is auto-updated.
Last update: 2021-11-25 10:18:15 UTC
The OpenEuropa Multilingual module offers default multilingual features for the OpenEuropa project, like:
- Enable all 24 official EU languages
- Provide an optional language switcher block on the OpenEuropa Theme site header region
- Make sure that the administrative interface is always set to English
- Allow English to be translated so that the default English copy may be fixed or improved, if necessary
- Configure the site to follow IPG rules for Language Negotiation, using the path suffix. (optional)
Table of contents:
- Demo module
The recommended way of installing the OpenEuropa Multilingual module is via Composer.
composer require openeuropa/oe_multilingual
In order to enable the module in your project run:
./vendor/bin/drush en oe_multilingual
The OpenEuropa Multilingual project contains all the necessary code and tools for an effective development process, such as:
- All PHP development dependencies (Drupal core included) are required by composer.json
- Project setup and installation can be easily handled thanks to the integration with the Task Runner project.
- All system requirements are containerized using Docker Composer
Download all required PHP code by running:
This will build a fully functional Drupal test site in the
./build directory that can be used to develop and showcase
the module's functionality.
Before setting up and installing the site make sure to customize default configuration values by copying runner.yml.dist
./runner.yml and overriding relevant properties.
This will also:
- Symlink the module in
./build/modules/custom/oe_multilingualso that it's available for the test site
- Setup Drush and Drupal's settings using values from
- Setup PHPUnit and Behat configuration files using values from
Please note: project files and directories are symlinked within the test site by using the OpenEuropa Task Runner's Drupal project symlink command.
If you add a new file or directory in the root of the project, you need to re-run
drupal:site-setup in order to make
sure they are be correctly symlinked.
If you don't want to re-run a full site setup for that, you can simply run:
$ ./vendor/bin/run drupal:symlink-project
After a successful setup install the site by running:
- Install the test site
- Enable the OpenEuropa Multilingual module
- Enable the OpenEuropa Multilingual Demo module and Configuration development modules
- Enable and set the OpenEuropa Theme as default
Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration.
By default, Docker Compose reads two files, a
docker-compose.yml and an optional
By convention, the
docker-compose.yml contains your base configuration and it's provided by default.
The override file, as its name implies, can contain configuration overrides for existing services or entirely new
If a service is defined in both files, Docker Compose merges the configurations.
Find more information on Docker Compose extension mechanism on the official Docker Compose documentation.
To start, run:
It's advised to not daemonize
docker-compose so you can turn it off (
CTRL+C) quickly when you're done working.
However, if you'd like to daemonize it, you have to add the flag
docker-compose up -d
docker-compose exec web composer install docker-compose exec web ./vendor/bin/run drupal:site-install
Using default configuration, the development site files should be available in the
build directory and the development site
should be available at: http://127.0.0.1:8080/build.
To run the grumphp checks:
docker-compose exec web ./vendor/bin/grumphp run
To run the phpunit tests:
docker-compose exec web ./vendor/bin/phpunit
To run the behat tests:
docker-compose exec web ./vendor/bin/behat
To enable step debugging from the command line, pass the
XDEBUG_SESSION environment variable with any value to
docker-compose exec -e XDEBUG_SESSION=1 web <your command>
Please note that, starting from XDebug 3, a connection error message will be outputted in the console if the variable is set but your client is not listening for debugging connections. The error message will cause false negatives for PHPUnit tests.
To initiate step debugging from the browser, set the correct cookie using a browser extension or a bookmarklet like the ones generated at https://www.jetbrains.com/phpstorm/marklets/.
Manually disabling Drupal 8 caching is a laborious process that is well described here.
Alternatively you can use the following Drupal Console commands to disable/enable Drupal 8 caching:
./vendor/bin/drupal site:mode dev # Disable all caches. ./vendor/bin/drupal site:mode prod # Enable all caches.
Note: to fully disable Twig caching the following additional manual steps are required:
parameters: twig.config: cache: false
- Rebuild Drupal cache:
This is due to the following Drupal Console issue.
The OpenEuropa Multilingual module ships with a demo module which provides all the necessary configuration and code needed to showcase the modules' most important features.
The demo module includes a translatable content type with automatic URL path generation.
./vendor/bin/drush en oe_multilingual_demo -y
Enabling English string translation can have unintended consequences when making changes to translatable configuration entities. If these strings are available in locale, the change would get saved as EN translations.
This is optional and should be done only if your website should follow the IPG rules for language negotiation.
./vendor/bin/drush en oe_multilingual_url_suffix -y
After enabling the module:
- Go to
- Disable the
Interface text language detectionand
Content language detection;
- Enable the
URL suffixmethod in
Interface text language detectionand
Content language detection;
- Make sure that the
URL suffixmethod is located on top of list but after the
Administration pagesnegotiation method, if you use it
- Save new order
- If necessary configure the
URL suffixmethod by clicking on
- Rebuild cache
It is strongly recommended to avoid an usage of the language suffix separator (
_) in their pathauto patterns/aliases as it might lead to unexpected behaviors.
Drush user:login(uli) implementation does not currently work with oe_multilingual_url_suffix module. The following patch is required to correctly generate the url.
Please read the full documentation for details on our code of conduct, and the process for submitting pull requests to us.