Use case #3: Translate a WordPress object

[lecoqlibre]

Description

The WP administrator sets up a WP object for translating. To do so, the WP object is assigned to a WP component that refers to a Weblate component which contains the translated content. This use case is frequently used to allow translating the website's content.

Postconditions

Minimal guarantees

• a WP object is created or updated

Success guarantees

• the created/updated WP object is set with:
  • a source language
  • a list of translation language(s)
  • a WP component associated with the Weblate component
• the translations of the created/updated WP object are published on the website
• a new WP component is created or updated and associated with the Weblate component
• a Weblate component is created or updated onto the Weblate instance:
  • its name is the same as the WP component's one
  • its source language is the same as the WP object's one
  • it contains a Weblate translation for each translation language of the WP object
  • it can contains the following Weblate units:
    • title of the object with context "title"
    • slug of the object with context "slug"
    • each string from the content of the object with context "content"
    • other units depending on the object type

Preconditions

• Scope: WP admin area
• Actor: WP administrator

Scenario

1. add a new WP object (like post, page)
2. set the source language of the WP object (eg. "English")
3. add language(s) to translate this object into (eg. "French and Spanish")
4. indicate this WP object refers to a new WP/Weblate component
5. select the WP project in which the new component must be created
6. set the name of the new component (predefined values can be used like "%object_type%" or %object_title%")
7. enable the automatic creation of the Weblate component associated with this WP component
8. enable the automatic creation of the Weblate translations
9. save
10. a notice indicates that the Weblate component and translations have been successfully created

Extensions

• 1a. An already existing WP object can be used in place.
• 2a. If no supported languages have been set in the plugin settings, the default language is selected then go to step 9. Only the WP object will be created.
• 3a. If no translation is selected, go to step 9. Only the WP object will be created.
• 4a. If the component already exists, the administrator select the existing one then goes to step 9.
• 5a. If no WP project already exists, go to step 6 then 9. Once the WP project is created, the WP component must be assigned to it.
• 6a. If name is already taken by an another component, show an error and repeat this step until a valid name is chosen.
• 7a. When disabled, go to step 8. The Weblate components and translations will not be created.
• 8a. When disabled, go to step 8. The Weblate translations will no be created.
• 10a. It does not appear with scenario extensions 2 to 7. The notice indicate that only the Weblate component is created if scenario extension is 8.

[nijel]

Maybe one component per WordPress object is not too fine-grained? It can easily grow to hundredths of components what will be hard to navigate.

[lecoqlibre]

With the scenario extension 4a, the WP admin is able to select an already existing component. So two WP objects can refer to the same Weblate component. This can reduce the amount of Weblate components needed. Is it OK for you?

By the way, could you provide some other organizations of Weblate project/components for a website translation? How do people organize their Weblate for large website?

[nijel]

Right now, the only option to organize within a component are labels. We will add more structuring options.