Chapter 10 Making Your Site Multilingual seems to start well and then chapter 10.5 Translating Configuration for some inexplicable reason launches into how to translate a recipes view. Would it be possible to break chapter 10.5 down into sub-chapters that cover topics such as how to translate menus, field names, site name, maintenance text etc. Would it also be a good place to explain how to detect language in a Twig template and output text based on the language of the page being displayed?

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

steve65140 created an issue. See original summary.

jhodgdon’s picture

Regarding configuration translation.. Yes, we could write some new topics on how to translate things other than Views.. It seems like for most of them, the procedure is:
a) Go to the page where you would edit the configuration.
b) Find the Translate button, click it, and translate.

We gave Views as one example, because it's quite a bit more complicated than some of the other configuration to translate, in that the UI for translating a View doesn't look much like the UI for creating/editing a view. For other types of configuration, such as menu items, the translation UI is much more understandable.

So... that said, maybe we should split the topic up into two (or more) topics:
1) General introduction to translating configuration, that gives a few examples of how to find the Translate page for different types of configuration.
2) One or more specific examples, such as the one we have now about Views, each in its own topic. I think these should be given only for ones that are difficult to figure out, like Views (and maybe Fields?).

jhodgdon’s picture

Your other question about Twig... Can you make that into a separate issue please, and expand upon what you mean? Given that the User Guide does not cover theme building at all, I think it's unlikely that we would cover it in the guide but maybe I am not understanding what you are talking about, so a separate issue would be better. Also it doesn't seem related to the issue title... thanks!

jhodgdon’s picture

Status: Active » Needs review
FileSize
3.98 KB

I took a closer look at this topic, and would like to propose this edit, which I think will take care of these concerns without having to separate it into multiple topics.

What I did:

a) Added a section at the top of Steps that gives general steps for translating any configuration.

b) Framed the Views steps as "Views are a bit different, here are the steps".

c) Added some more examples of how to translate configuration to the Expand your understanding section at the bottom.

Thoughts?

Oh, (d) I also noticed that one of the navigation steps was incorrect -- the name of the "Site information" page has changed to "Basic site settings" (much better title!). So I fixed that in this topic and in the config-basic topic. Should I put that in a separate patch?

Anyway, here's a patch for review... I've built the page on my local development server and it parses correctly and displays fine...

jhodgdon’s picture

Would someone like to review the proposed changes here for this topic? Thanks!

jhodgdon’s picture

Assigned: Unassigned » jhodgdon
eojthebrave’s picture

> So I fixed that in this topic and in the config-basic topic. Should I put that in a separate patch?

I think it's probably fine to leave that in this patch, but we'll want to make sure we notify translation teams about changes to that file as well.


I'm not all the familiar with the translation UI so ...

+++ b/source/en/language-config-translate.txt
@@ -29,6 +29,28 @@ must have at least two languages. See <<language-add>>.
+. Find a link, tab, or button on the page that says "Translate" or something
+similar. Click this link, tab, or button.
+
+. Find a button that will let you add a translation in the desired language, and
+click this button.

Is this uniform enough that it would be worth including a screenshot? Or does it vary page by page so having a screenshot wouldn't be representative enough?

Other than that I think this clarification makes sense. We explain the fairly generic process used by most configuration and specifically call-out any exceptions to the norm.

jhodgdon’s picture

The buttons are all over the map as far as what they say, where they are located, etc. I didn't think a screenshot of one button would be useful.

Thanks for the review!

eojthebrave’s picture

Status: Needs review » Reviewed & tested by the community
jhodgdon’s picture

Status: Reviewed & tested by the community » Fixed

Committed to all languages, and I'll go update the issues now too. Thanks for the review! And thanks @steve65140 for creating this issue and bringing this to our attention!

  • jhodgdon committed 1e7f6d1 on 8.x-2.x
    Issue #2855660 by jhodgdon, eojthebrave: Expand chapter 10.5 Translating...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.