Follow up for #1940590: META: Write a multipage multilingual tour.
Problem/Motivation
Multilingual configuration is spread throughout the site. It would be useful to have a tour to help users know how to configure the site for multilingual. There should be individual tours for certain multilingual features and these can be linked together to make a multipage tour later via #1940590: META: Write a multipage multilingual tour.
Proposed resolution
Write individual tours for the interface translation only.
Remaining tasks
Create tour yml files for the interface translation tours:
- Module page (admin/modules)
- Enable Interface Translation module (can we have a multilingual tour with interface translation module first disabled?)
- Interface translation page (admin/config/regional/translate)
- Search for interface strings
- Edit interface strings
- (optional?) Import a .po file (subpage = admin/config/regional/translate/import)
- (optional?) Export a .po file (subpage = admin/config/regional/translate/export)
- Configure interface language settings (subpage = admin/config/regional/translate/settings)
User interface changes
New tours
API changes
None
Technical pointers when creating tour tips
See: https://drupal.org/node/1921152#tour-tips-tech-note for tech notes on making tour tips.
Related issues
#1921152: META: Start providing tour tips for other core modules.
#1942576: Tour tips to be able to link to other pages and start tour's automatically.
#1940590: META: Write a multipage multilingual tour
Comment | File | Size | Author |
---|---|---|---|
#29 | ui-translation-tour-2017475-25.patch | 4.71 KB | Outi |
#24 | ui-translation-tour-2017475-24.patch | 4.9 KB | rodrigoaguilera |
#23 | ui-translation-tour-2017475-23.patch | 1.2 MB | rodrigoaguilera |
#21 | interdiff.txt | 1.25 KB | rodrigoaguilera |
#21 | ui-translation-tour-2017475-21.patch | 3.21 KB | rodrigoaguilera |
Comments
Comment #1
Kristen PolThis can be started by a novice. Particularly:
Search for interface strings
Edit interface strings
Separate tours could be made for the import page and export page and settings page which would make those pretty simple too.
The yml files are pretty simple. You just need to know how to inspect the HTML to know what CSS tags to target. See:
https://drupal.org/node/1921152#tour-tips-tech-note
Comment #2
pwieck CreditAttribution: pwieck commentedassigning to myself per Kristen Pol
Comment #3
Kristen Pol@pwieck - Thanks! Like I mentioned... just focus on:
Interface translation page (admin/config/regional/translate)
* Search for interface strings
* Edit interface strings
For now and we can go from there ;) That way it's just one page and just a couple things to highlight. We are still needing to write some tour guidelines but what I did for my first one was:
* Overview tip
* Tip 1
* Tip 2
* etc.
* Closing tip
I think this is a good pattern and I will propose this in the tour guidelines doc once we get one together! :)
Comment #4
Kristen Pol@pwieck - check out what @clemens.tolboom is building:
#1921152-41: META: Start providing tour tips for other core modules.
https://drupal.org/project/tour_builder
!!!
I haven't tried it but... sounds cool :)
Comment #5
pwieck CreditAttribution: pwieck commentedI am postponing work on this as their seems to be a bug in the new token patch - https://drupal.org/node/2019469#comment-7544517
The User interface translation page located at admin/config/regional/translate is useless until you add a language and I think their really needs an intro tip with a link to the add language page.
Examlpe:
Note: To make use of this page you must first <a href="[site:url]/admin/config/regional/language">add a language</a>
Comment #6
pwieck CreditAttribution: pwieck commentedI will start back working on this now the token bug is fixed
Comment #7
Kristen PolSee note in #2017501-3: Multilingual tour for language switcher block. It would be good to mention the language switcher block in this tour at the end.
Comment #8
Outi CreditAttribution: Outi commentedpwieck, I didn't realize that you were already working on this and so I created a small tour for this page (admin/config/regional/translate). I will join my patch here but if you have already worked on your side, I hope you'll post your tour as well.
I am not sure if I've included all the functionalities of the page on the tour and if everything I've written about them is correct. And I hope that English speakers will revise the language when needed :). This is a kind of draft to be improved.
There are 8 steps on the tour but on an English language installation without added languages only 6 of them will be displayed.
Comment #9
Outi CreditAttribution: Outi commentedComment #10
pwieck CreditAttribution: pwieck commented@Outi, Maybe in the future you should pay more attention and even ask before starting an issue. I was just side tracked after I discovered the bug in tokens that made the links you used even possible. @Kristen Pol, sorry but I'm out on these tours. Like others here, my time is too valuable to work on something for nothing.
Comment #11
Outi CreditAttribution: Outi commentedpwieck, I'm sorry, I was really hesitating if I should post my patch at all or not because I didn't want to make you feel having worked for nothing. I asked advice and as I was encouraged to post it anyway, I did. But as I said I hope that you would post yours, too, because it might be much better than mine and I don't mind if we don't use mine because I know that you were on this issue first. And I learned that I should pay more attention!
Comment #12
Kristen PolSorry there was some miscommunication here :/
@pwieck - Thank you for your time and effort. I don't think @Outi meant any offense. Those new to the IQ sometimes don't know the "protocol". I know it took me awhile to figure out that you could *assign* an issue to yourself for core issues if you want to work on them.
@Outi - You already know now but good to contact the person via IRC and/or contact page if their name is on it and you are wanting to help.
Hugs to everyone!
Comment #13
nick_schuch CreditAttribution: nick_schuch commentedTour needs tests since we now have #2028535
Comment #13.0
nick_schuch CreditAttribution: nick_schuch commentedUpdated issue summary.
Comment #14
balagan CreditAttribution: balagan commentedThere is a trailing space after label: Translation language
Comment #15
balagan CreditAttribution: balagan commentedI have fixed the trailing space, some stylings, and removed the erronous last three lines from the patch.
Comment #17
balagan CreditAttribution: balagan commentedRerolled the patch from the appropriate commit.
Comment #18
Outi CreditAttribution: Outi commentedSo I updated this tour so that it has the same structure than the views_ui tour has now. I added the route_name array.
Comment #20
rodrigoaguileraJust some rephrasing for step 4
label: 'Filtering the search'
body: 'You can choose wether you search in all the words and sentences or if you want to filter. You can search for untranslated strings if you want to translate something that isn''t translated yet. If you want to modify an existing translation, you might want to search only for translated strings.'
I'll look into the test issue later
I also edited the docs
https://drupal.org/developing/api/tour
for the problem I had not seeing the tour yaml file in my active/staging config
Comment #21
rodrigoaguileraadded my string corrections and removed route yaml since is already declared in routes (making tests fail)
Comment #22
rodrigoaguileraI just wanted to see what was making the testbot fail. I'll try to work on the test this evening at drupaldevdays
Comment #23
rodrigoaguileraI think ready and explains well how the interface for translation works
Comment #24
rodrigoaguileraUps I forgot the rebase, that's the reason for the big patch
If you want to review this apply the patch, enable locale and tour go to /admin/config/regional/translate and you should see a tour link at the right top, take it (8 steps) and check spelling.
Comment #25
MathieuSpil CreditAttribution: MathieuSpil commentedTo test this you also need to enable tour, translation, and configuration translation.
Changed the patch so texts are a bit more logical or better structured:
People who want to translate the interface of their Drupal site, know that they will be translating content on their site only. No need to specify 'On your site'
The last popup already explained that you will need multiple languages.
Less complex sentence but with same information
Cleaner sentence.
Added a ","
Export them to instead of export them on.
Comment #26
rodrigoaguileraThanks for reviewing and correcting. I agree with your changes of the strings. An interdiff would have been nice
For the test I'm pretty sure you only need tour and locale modules (There's no module called Translation)
About the other tours that are specified in the issue summary I really don't see the point of having them when you already have text in the interface that explain quite good the options, there's no boxes to point at.
For this reasons I'm marking it as RTBC
Comment #27
Outi CreditAttribution: Outi commentedThanks for the language revision. I would only like to add a point or a semi colon to the third step, between the "Enter the specific word or sentence you want to translate" and "you can also write just a part of a word", but I don't know if it's worth of a new patch :).
By the way, if you test this in a site that's installed in another language than in English, the necessary modules are already installed. Seemingly that means also that if you apply the patch after the installation, you must manually copy the .yml file to the configuration files.
Comment #29
Outi CreditAttribution: Outi commentedOh no, did I accidentally delete the latest patch? I'm so sorry, here it is again!
Comment #31
visabhishek CreditAttribution: visabhishek commented29: ui-translation-tour-2017475-25.patch queued for re-testing.
Comment #32
visabhishek CreditAttribution: visabhishek commentedit was a random test failure, rather than anything wrong with the patch.
Comment #33
penyaskitoAdding to the D8MI Sprint board
Comment #34
alexpottCommitted ec9d52b and pushed to 8.x. Thanks!
Comment #36
Gábor HojtsyYay. thanks!