Translating configuration
by Chaz Chumley, Matt Glaman, Richard Jones, Nick Abbott
Drupal 8: Enterprise Web Development
- Drupal 8: Enterprise Web Development
- Table of Contents
- Drupal 8: Enterprise Web Development
- Credits
- Preface
- 1. Module 1
- 1. Introduction
- 2. Installation
- 3. Basic Concepts
- 4. Getting Started with the UI
- 5. Basic Content
- 6. Structure
- 7. Advanced Content
- 8. Configuration
- 9. Users and Access Control
- 10. Optional Features
- 11. Reports
- 12. Extending Drupal
- 13. Theming Drupal
- 14. Getting Support
- 2. Module 2
- 1. Up and Running with Drupal 8
- 2. The Content Authoring Experience
- 3. Displaying Content through Views
- 4. Extending Drupal
- 5. Frontend for the Win
- 6. Creating Forms with the Form API
- 7. Plug and Play with Plugins
- 8. Multilingual and Internationalization
- 9. Configuration Management – Deploying in Drupal 8
- 10. The Entity API
- 11. Off the Drupalicon Island
- 12. Web Services
- 13. The Drupal CLI
- 3. Module 3
- 1. Setting Up Our Development Environment
- 2. Theme Administration
- 3. Dissecting a Theme
- Setting up a local development environment
- Default themes versus custom themes
- Folder structure and naming conventions
- Managing configuration in Drupal 8
- Reviewing the new info.yml file
- The role of templates in Drupal
- Creating our first basic theme
- Introducing Twig
- Template variables
- The role of the theme file in Drupal
- Summary
- 4. Getting Started – Creating Themes
- 5. Prepping Our Project
- 6. Theming Our Homepage
- Creating our HTML wrapper
- Creating our homepage
- Implementing our Header Top region
- Implementing our Header region
- Adding a logo
- Enabling Site branding
- Printing our Header region
- Creating Block templates
- Implementing our search form block
- Placing our search form block
- Creating a search form block template
- Adding custom JavaScript
- Creating an input element template
- Working with menus
- Creating a menu template
- Creating System Menu block template
- Creating a sticky header
- Implementing our Headline Region
- Implementing our Before Content region
- Implementing the footer
- Summary
- 7. Theming Our Interior Page
- 8. Theming Our Blog Listing Page
- Reviewing the Blog Listing mockup
- Creating our blog listing
- Creating a Post Listing view
- Managing our Post Listing block
- Implementing our Node template
- Adding CSS classes to Twig
- Working with content variables
- Using the without filter
- Creating our post image slider
- Working with field templates
- Adding the Owl Carousel library
- Using Twig filters for dates
- Printing title and teaser
- Creating our post metadata
- Field templates and taxonomy
- Handling comments in Drupal 8
- Creating a theme file
- Creating a Categories block
- Managing our Categories block
- Implementing responsive sidebars
- Theming a Block template
- Drupal Views and Twig templates
- Managing popular versus recent content
- Adding the About Us block
- Summary
- 9. Theming Our Blog Detail Page
- Reviewing the Blog detail mockup
- Previewing our Blog detail page
- Creating a Post Full template
- Working with comments
- Implementing social sharing capabilities
- Summary
- 10. Theming Our Contact Page
- 11. Theming Our Search Results
- 12. Tips, Tricks, and Where to Go from Here
- A. Biblography
- Index
The Configuration translation module provides an interface for translating configurations with Interface translation and Language as dependencies. This module allows you to translate configuration entities. The ability to translate configuration entities adds an extra level of internationalization.
Interface translation allows you to translate strings provided in your Drupal site's code base. Configuration translation allows you to translate importable and exportable configuration items that you have created, such as your site title or date formats.
In this recipe, we will translate date format configuration entities. We will provide localized date formats for Danish to provide a more internationalized experience.
Your Drupal site needs to have two languages enabled in order to use Configuration Translation. Install Danish from the Languages interface.
- Go to the Extend and install the Configuration Translation module. It will prompt you to enable the Interface Translation, Language, File, and Field modules to be installed as well if they are not.
- After the module is installed, go to the Configuration. Go to the Configuration translation page under the Regional and Language section.
- Click on the list for the Date format option in the configuration entity option table:
- We will translate the Default long date format to represent the Danish format. Click on the Translate for the Default long date format row.
- Click on Add to create a Danish translation:
- For Danish, we will provide the following PHP date format: l j. F, Y – H.i. This will display the day of the week, day of the month, the month, full year, and 24 hour notation for time.
- Click on Save translation.
- Whenever a user is browsing your Drupal site with Danish as their language, the date format will now be localized for their experience.
The Configuration translation module requires Interface translation; however, it does not work in the same fashion. The module modifies all entity types that extend the DrupalCoreConfigEntityConfigEntityInterface interface. It adds a new handler under the config_translation_list key. This is used to build a list of available configuration entities and their bundles.
The module alters the configuration schema in Drupal and updates the default configuration element definitions to use a specified class under Drupalconfig_translationForm. This allows Drupalconfig_translationFormConfigTranslationFormBase and its child classes proper saved translated configuration data that can be modified through the configuration translation screens.
When the configuration is saved, it is identified as being part of a collection. The collection is identified as language.LANGCODE and all translated configuration entities are saved and loaded by this identifier. Here is an example of how the configuration items are stored in the database:
When browsing the site in the es language code, the appropriate block.block.bartik_account_menu configuration entity will be loaded. If you are using the default site, or no language code, the configuration entity with an empty collection will be used.
Configuration entities and the ability to translate them are a big part of Drupal 8's multilingual capabilities. We'll explore them in detail in the next recipe.
Modules have the ability to invoke the hook_config_translation_info_alter hook to alter discovered configuration mappers. For instance, the Node module does this to modify the node_type configuration entity:
/**
* Implements hook_config_translation_info_alter().
*/
function node_config_translation_info_alter(&$info) {
$info['node_type']['class'] = 'Drupal
odeConfigTranslationNodeTypeMapper';
}This updates the node_type definition to use the Drupal
odeConfigTranslationNodeTypeMapper custom mapper class. This class adds the node type's title as a configurable translation item.
- In recipe Creating a Multilingual View of Chapter 8, Multilingual and Internationalization
-
No Comment