Follow up for #1804688: Download and import interface translations
Problem/Motivation
admin/config/regional/translate/import and other pages have help text that was improved when #1804688: Download and import interface translations was committed. This is tricky since it needs to take into consideration many possible configurations and use cases.
Proposed resolution
No suggested new wording yet.
Remaining tasks
List the pages that have help text dealing with downloading or importing translation files.Copy the current text examples into comments below.- Discuss new wording.
Pages and txt files:
- admin/config/regional/translate/import
- core/INSTALL.txt
User interface changes
Yes, changes to user interface text, this is a ui issue, screenshots in #16.
API changes
No API changes anticipated.
Comments
Comment #1
YesCT CreditAttribution: YesCT commentedactive since #1804688: Download and import interface translations is in.
Comment #2
Kristen PolI'll look at this one.
Comment #2.0
Kristen PolUpdated issue summary.
Comment #3
Kristen PolText change from Kristin Tkoch (@K2-hook42) for admin/config/regional/translate/import:
I'm checking the code for any other places that we might need to change.
Comment #4
pixeliteI've integrated this help into a patch to change the text on this page. I would recommend keeping it to 2 paragraphs, the first one about importing .po files and the second about how to go about producing .po files for Drupal.
Comment #6
Kristen PolThere is also some text in the INSTALL.txt file that needs work or maybe this should just be removed:
Comment #6.0
Kristen PolUpdated issue summary.
Comment #6.1
Kristen PolUpdated issue summary.
Comment #7
Kristen PolI'm making a patch that removes section 2 and adds a small new section after the multisites section.
Comment #8
Kristen PolAttached a patch. This is a combination of pixelite's patch and changes to the INSTALL.txt file.
Comment #9
YesCT CreditAttribution: YesCT commentedI think we don't use phrases like "You ..."
Hm. Can't find guideline on helptext standard: https://drupal.org/node/632280
Content style doesn't appear to say one way or the other. https://drupal.org/node/338208
So, on reading it again, I think "you" might actually be good here since it's pointing out they can be done by individuals... not just that it can be done.
----
Why does it say "original langauge .po files"?
How about:
"Templates of .po files can be.."
Comment #10
Kristen PolHow about changing:
to
?
Getting rid of "original language" seems fine.
Comment #11
YesCT CreditAttribution: YesCT commentedheh, I dont think we can create something by editing it. But I know what you mean (I think).
How about:
.po files can be customized by editing them in a Gettext translation editor
but starting a sentence with .po looks weird.
Customize .po files by editing them in a Gettext translation editor.
Comment #12
Kristen PolHow about switching the order of the sentences... download them first and edit them afterwards:
Comment #13
YesCT CreditAttribution: YesCT commentedtrying out
Template .po files can downloaded from the Drupal translation server, then/and customized by editing them in a Gettext translation editor.
Comment #14
Kristen PolWhat about the export/import stuff?
This could be made into one sentence:
Comment #15
YesCT CreditAttribution: YesCT commentedI wasn't sure what the import url should be. I think the page where that text shows is the import url, and linking to the current page seemed odd.
I used @export since that same url is named like that also in this function.
Comment #16
YesCT CreditAttribution: YesCT commentedold
Here is the old text on
admin/config/regional/translate/import
new
Here is the new text on
admin/config/regional/translate/import
Comment #16.0
YesCT CreditAttribution: YesCT commentedUpdated issue summary.
Comment #17
Kristen PolTested and works, text makes sense to me, and code looks good. Since I helped with the patch, maybe I can't RTBC? I will anyway ;)
Comment #18
Dries CreditAttribution: Dries commentedOverall, I like this but I have two questions:
1. Is the first sentence of the help text telling me that normally I shouldn't have to use this screen? If so, I think we could be even more explicit about it.
2. As a user, what am I supposed to do with "it may be a lengthy process"? It sounds scary and I'm not sure it is all that useful to know. I'm not sure how to act on that information. I guess it is telling me to be patient?
Comment #19
Kristen PolThanks for the review, @Dries!
Regarding 1: Yes, they don't normally need to come here unless they have custom strings. Perhaps something like:
Regarding 2: This text was there before, but, yeah, it does sound scary. The upshot is that it might take awhile to import the strings in. So, "be patient" is good ;) Perhaps something along the lines of:
I don't like that wording but something to indicate that you shouldn't stress if the import is taking awhile, i.e. "be patient".
Comment #20
alexpottJust wondering... when is someone's situation custom or not? I think
For custom situations where translations need to be manually imported,
could be simply put like this...If translations need to be manually imported,
Comment #21
alexpottOh and due to #18 and #20... this is needs work
Comment #22
Kristen Pol@alexpott - Do you have any feedback on the wording for item 2 in #19? I was hoping to get feedback before changing it.
Comment #23
Kristen PolI've included a patch with some new wording.
Comment #24
penyaskitoAs a user, I miss the information about custom translations. Maybe this will help or makes things more complex?
Comment #25
Sutharsan CreditAttribution: Sutharsan commentedWhat about this:
I've created one paragraph about the use of this page, and about customized strings. The notice about the duration of the import is moved into a separate paragraph, since it is a separate subject.
Comment #26
Kristen PolMost excellent! Thanks @Sutharsan for the clear and helpful wording :)
Comment #27
Kristen PolUnassigning ;)
Comment #28
alexpottI think we need some commas:
Manual import may be used for customized translations, translation of custom modules, or themes.
Comment #29
Kristen PolThanks for the review!
Hmmm.... not sure I agree. The way this reads:
It makes it sound like it can be read as:
The first two are fine. The last doesn't sound right ;)
What about:
?
Comment #30
Gábor HojtsyYeah it intended to mean custom modules and themes AFAIS indeed.
Comment #31
Kristen PolI've updated the wording with my suggestion in #29.
Comment #32
YesCT CreditAttribution: YesCT commentedComment #34
Outi CreditAttribution: Outi commentedDrupal\user\Tests\UserPasswordResetTest
One-time link is no longer valid.
UserPasswordResetTest.php 81 Drupal\user\Tests\UserPasswordResetTest->testUserPasswordReset()
This looks like unrelated failure.
Comment #35
Outi CreditAttribution: Outi commented#31: drupal8.translation_download_text_changes.1861934-31.patch queued for re-testing.
Comment #36
Kristen PolAll green... would love a RTBC :)
Comment #37
Sutharsan CreditAttribution: Sutharsan commented$output .= '
' . t('Note that importing large .po files may take several minutes.') . '
';
return $output;
I like the suggestion to add a "Please be patient." (#18, #19) to the last sentence.
Comment #38
Outi CreditAttribution: Outi commentedI tried to follow the instructions of the help text to see if they are useful. I have a minor experience of using .po files a long time ago but I think that if I hadn't have any experience I would have been much more unsure. Now everything went more or less ok, besides a couple of errors that are not related to this issue.
____________________
The unrelated errors:
1.) After exporting the translation from the site, I got an error message that is documenter in this issue: #1789090: Warnings when exporting templates: addcslashes() expects parameter 1 to be string
2.) After importing the .po file, I got this warning message (I didn't find an issue for it):
An AJAX HTTP error occurred.
HTTP Result Code: 200
Debugging information follows.
Path: /drupal/batch?id=6&op=do_nojs&op=do
StatusText: OK
ResponseText: Recoverable fatal error: Argument 2 passed to Drupal\Component\Utility\String::format() must be of the type array, null given, called in /Users/outimunter/Sites/drupal/core/lib/Drupal/Component/Gettext/PoStreamReader.php on line 522 and defined in Drupal\Component\Utility\String::format() (line 89 of /Users/outimunter/Sites/drupal/core/lib/Drupal/Component/Utility/String.php).
The translation was anyway imported.
____________________
Next, I'm going to make the patch asked for in #37.
Comment #39
Kristen PolThanks @Outi! Would you report issue 2 from #38 once you are done updating this patch? :)
Comment #40
Outi CreditAttribution: Outi commentedI added the "Please be patient" suggested on the #37.
Comment #42
Gábor HojtsyComment #43
Gábor HojtsyMoving back to RTBC as per fixes since #28.
Comment #44
Gábor HojtsyDiscussed in person that "please be patient" is the kind of wording that we worked on removing earlier. The prior sentence explains the situation well. So #31 should be RTBC then.
Comment #45
alexpottCommitted 2faba60 and pushed to 8.x. Thanks!
See #1970068: Remove all please(s) from the views UI about using please in the UI
Comment #46
Outi CreditAttribution: Outi commentedI reported it here: #2029505: Exporting translations does not correctly generate empty strings
Comment #47
Outi CreditAttribution: Outi commentedComment #48.0
(not verified) CreditAttribution: commentedlinked to screenshots in a comment. later can embed right in issue summary when text is finalized.