mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
125 lines
5.4 KiB
Markdown
125 lines
5.4 KiB
Markdown
# Grav LangSwitcher Plugin
|
|
|
|
|
|
|
|
`LangSwitcher` is a [Grav](http://github.com/getgrav/grav) plugin that provides native language text links to switch between [Multiple Languages](http://learn.getgrav.org/content/multi-language) in Grav **0.9.30** or greater.
|
|
|
|
# Installation
|
|
|
|
Installing the LangSwitcher plugin can be done in one of two ways. Our GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
|
|
|
|
## GPM Installation (Preferred)
|
|
|
|
The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal (also called the command line). From the root of your Grav install type:
|
|
|
|
bin/gpm install langswitcher
|
|
|
|
This will install the LangSwitcher plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/langswitcher`.
|
|
|
|
## Manual Installation
|
|
|
|
To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `langswitcher`. You can find these files either on [GitHub](https://github.com/getgrav/grav-plugin-langswitcher) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).
|
|
|
|
You should now have all the plugin files under
|
|
|
|
/your/site/grav/user/plugins/langswitcher
|
|
|
|
# Usage
|
|
|
|
The `langswitcher` plugin doesn't require any configuration. You do however need to add the included Twig partials template into your own theme somewhere you want the available languages to be displayed.
|
|
|
|
```twig
|
|
{% include 'partials/langswitcher.html.twig' %}
|
|
```
|
|
|
|
Something you might want to do is to override the look and feel of the langswitcher, and with Grav it is super easy.
|
|
|
|
Copy the template file [langswitcher.html.twig](templates/partials/langswitcher.html.twig) into the `templates` folder of your custom theme:
|
|
|
|
```
|
|
/your/site/grav/user/themes/custom-theme/templates/partials/langswitcher.html.twig
|
|
```
|
|
|
|
You can now edit the override and tweak it however you prefer.
|
|
|
|
## Usage of the `hreflang` partial
|
|
|
|
A second template is available for `hreflang` annotations in the header of the page. In order to emit language annotations for the available languages of a page you need to add the corrsponding Twig partial template into the `<head>` section of your page, which can typically be found in `base.html.twig`:
|
|
|
|
```twkg
|
|
{% include 'partials/langswitcher.hreflang.html.twig' %}
|
|
```
|
|
|
|
This will generate something like:
|
|
|
|
```html
|
|
<link rel="alternate" href="http://example.com/en" hreflang="en" />
|
|
<link rel="alternate" href="http://example.com/de" hreflang="de" />
|
|
<link rel="alternate" href="http://example.com/zh-cn" hreflang="zh-cn" />
|
|
```
|
|
|
|
# Updating
|
|
|
|
As development for the LangSwitcher plugin continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating LangSwitcher is easy, and can be done through Grav's GPM system, as well as manually.
|
|
|
|
## GPM Update (Preferred)
|
|
|
|
The simplest way to update this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:
|
|
|
|
bin/gpm update langswitcher
|
|
|
|
This command will check your Grav install to see if your LangSwitcher plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type `y` and hit enter. The plugin will automatically update and clear Grav's cache.
|
|
|
|
> Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in `user/config/plugins`) will remain intact.
|
|
|
|
## Configuration
|
|
|
|
Simply copy the `user/plugins/langswitcher/langswitcher.yaml` into `user/config/plugins/langswitcher.yaml` and make your modifications.
|
|
|
|
```yaml
|
|
enabled: true
|
|
built_in_css: true
|
|
```
|
|
|
|
Options are pretty self explanatory.
|
|
|
|
## Redirecting after switching language
|
|
|
|
To have Grav redirect to the default page route after switching language, you must add the following configuration to `user/config/system.yaml`
|
|
|
|
```yaml
|
|
pages:
|
|
redirect_default_route: true
|
|
```
|
|
|
|
## Customization
|
|
|
|
The default format for the displaying of the languages is to use the native language names in a **long** format (e.g. `English`, `Deutsch`, `Français`). However, you can change the default output to use **short** names (e.g. `EN`, `DE`, `FR`).
|
|
|
|
This can be configured via the `langswitcher.yaml` configuration file:
|
|
|
|
```yaml
|
|
language_display: long # long | short are the valid options
|
|
```
|
|
|
|
You can also pass the format in directly via the Twig include:
|
|
|
|
```twig
|
|
{% include 'partials/langswitcher.hreflang.html.twig' with {display_format: 'short'} %}
|
|
```
|
|
|
|
Also you can override the two Twig partials that control the actual display of the **long** and **short** output, by copying the partial int your theme's `templates/partials/` folder and modifying:
|
|
|
|
```twig
|
|
# templates/partials/langswitcher-long.html.twig
|
|
{{ native_name(language)|capitalize }}
|
|
```
|
|
|
|
and
|
|
|
|
```twig
|
|
# templates/partials/langswitcher-short.html.twig
|
|
{{ language|upper }}
|
|
```
|
|
|
|
|