<a id="yaml"></a>

# YAML files

<a id="index-0"></a>

The plain YAML files with string keys and values. Weblate also extract strings from lists or dictionaries.

Weblate currently supports several variants of YAML translations:

* Files with nested keys.
* [Ruby YAML files](https://docs.weblate.org/no/latest/formats/ruby.md#ryaml)

#### SEE ALSO
* [YAML](https://docs.translatehouse.org/projects/translate-toolkit/en/latest/formats/yaml.html)
* [Ruby YAML files](https://docs.weblate.org/no/latest/formats/ruby.md#ryaml)

Example of a YAML file:

```yaml
weblate:
  hello: ""
  orangutan: ""
  try: ""
  thanks: ""
```

<!-- AUTOGENERATED START: format-features yaml -->
<!-- This section is automatically generated by `./manage.py list_format_features`. Do not edit manually. -->

#### Supported features

| File extensions                                                                                      | `.pyml`, `.yaml`, `.yml`       |
|------------------------------------------------------------------------------------------------------|--------------------------------|
| Linguality [ⓘ](https://docs.weblate.org/no/latest/formats.md#bimono)                                   | Both monolingual and bilingual |
| Supports plural [ⓘ](https://docs.weblate.org/no/latest/formats.md#format-plurals)                      | `No`                           |
| Supports descriptions [ⓘ](https://docs.weblate.org/no/latest/formats.md#format-description)            | `No`                           |
| Supports explanation [ⓘ](https://docs.weblate.org/no/latest/formats.md#format-explanation)             | `No`                           |
| Supports context [ⓘ](https://docs.weblate.org/no/latest/formats.md#format-context)                     | `No`                           |
| Supports location [ⓘ](https://docs.weblate.org/no/latest/formats.md#format-location)                   | `No`                           |
| Supports flags [ⓘ](https://docs.weblate.org/no/latest/formats.md#format-flags)                         | `No`                           |
| API identifier                                                                                       | `yaml`                         |
| Supports read-only strings [ⓘ](https://docs.weblate.org/no/latest/formats.md#read-only-strings)        | `No`                           |
| Supports removing obsolete strings [ⓘ](https://docs.weblate.org/no/latest/formats.md#obsolete-strings) | `No`                           |
<!-- AUTOGENERATED END: format-features yaml -->

## Weblate configuration

|                                | Typical Weblate [Component configuration](https://docs.weblate.org/no/latest/admin/projects.md#component)   |
|--------------------------------|----------------------------------------------------------------------------------------------------|
| File mask                      | `translations/messages.*.yml`                                                                      |
| Monolingual base language file | `translations/messages.en.yml`                                                                     |
| Template for new translations  | Empty                                                                                              |
| File format                    | YAML file                                                                                          |

## File format parameters

[File format parameters](https://docs.weblate.org/no/latest/formats.md#file-format-params) with the pattern yaml_\* can be used to configure the behavior of the YAML format.
