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 content translation settings only.
Remaining tasks
Create tour yml files for the content translation settings tour:
Module page (admin/modules)Enable Content Translation module (can we have a multilingual tour with content translation module first disabled?)Not without stepping on other tours
- Content language settings page (admin/config/regional/content-language)
- Enable entities (Content)
- Choose content types
- Choose fields for translation
- Configure default language per content type
- Configure language selector per content type
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 |
---|---|---|---|
#25 | 2017477-tour-content-translation-25.patch | 3.5 KB | rodrigoaguilera |
#17 | tour-2017477-17.patch | 2.78 KB | kholloway |
#13 | 2017477-12.patch | 2.03 KB | kholloway |
#11 | 2017477-11.patch | 2.03 KB | kholloway |
#8 | tour.tour_.content-translation-settings.yml_.txt | 2.4 KB | Mark_L6n |
Comments
Comment #1
Kristen PolThis can be started by a novice. All of the tips are on the *same* page except that some of the markup is hidden until you click on the "Content" option.
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
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 #3
Kristen PolAdding back novice tag.
#2017471: Multilingual tour for language section can be used as an example.
Comment #4
nick_schuch CreditAttribution: nick_schuch commentedTour needs tests since we now have #2028535
Comment #5
Mark_L6n CreditAttribution: Mark_L6n commentedI'm working on this
Comment #6
tstoecklerMaybe you can use this as a starting point.
Comment #6.0
tstoecklerUpdated issue summary.
Comment #7
Mark_L6n CreditAttribution: Mark_L6n commentedI'm uploading a file that may be used for a tour for configuration of the Content Translation module. To use this file, remove the _.txt extension and install it using these instructions from Technical pointers when creating tour tips:
Add the yml file directly under your active config directory which looks something like:
sites/default/files/config_[gobbly-de-gook]/active
This tour file is a bit unusual, due to limitations with the current state of the Tour Module and Joyride. As a workaround, it asks the user to perform several actions in order to continue the tour and see parts of webpages. Here are the issues I encountered:
Comment #8
Mark_L6n CreditAttribution: Mark_L6n commentedUploaded file for comment #7.
Comment #9
bendev CreditAttribution: bendev commentedCould we add info in the tour on "Content type translation" explaining how to translate menu entries related to this content type?
Comment #10
kholloway CreditAttribution: kholloway commentedI am working on contributing a patch for this issue. The file attached in comment #8 needs to be updated a bit because of how things have evolved since it was created. I am re-working this and will provide a patch for this once I get it working.
Comment #11
kholloway CreditAttribution: kholloway commentedI have taken the file that was posted in #8 by Mark_L6n and updated it to the new structure/architecture of the D8 site.
Relavant change notes are:
- This is actually a patch to the language core module
- The IDs as well as the path targeting structure has been updated to route_name equivalents (url path is no longer used)
- The tour is enabled as an installation item when the "language" module is enabled. This allows the 2 tour steps to be added to the Module enable page to add instruction to enabling and configuring the "content_translation" module
- The routes are actually declared by the language module (not the content_translation module) so making it part of the language module makes more sense
* I am a developer so I cleaned up the text a bit but left the content as it was previously created. Let me know if further content changes should be done.
Comment #13
kholloway CreditAttribution: kholloway commentedSilly Git New Line character error. Adding a patch with a new line :)
Comment #15
larowlanThese are all truncated, and hence missing the closing '
Comment #16
larowlanThese
Comment #17
kholloway CreditAttribution: kholloway commentedSilly error. Didn't realize my patch was being truncated. Uploading a complete patch :)
Comment #18
pameeela CreditAttribution: pameeela commentedI think we need two separate tours here - one generic for before the module is enabled, explaining what the various translation modules do.
The second tour can be attached to the content translation module and describe the page at admin/config/regional/content-language
I also think it needs just a bit more clarification around the interaction required to use this tour properly. If you don't check the Content option, the tour doesn't make sense. Might have a think about how to handle that.
Just one last thing, not sure whether it is a bug but the third tip appears at the bottom of the page and you can't see it unless you scroll down. Is it possible to anchor it to something a little higher on the page?
Tours are hard :(
Comment #21
rodrigoaguileraI think is not a good idea to have a multilingual tour on the modules list (or Extend) page.
I confirmed that is not possible to have two sets of tips on the same page so this tour cannot take over that page to another future tour that explains the functionality of the Extend page.
I don't know how to handle the fact that the "Content language" page is provided by the language module and extended by the content translation module. You need tips for the language module and more tips once you enable "Content translation" module. As I said above there's is no way we can have two sets of tips.
I'm thinking that maybe the configuration provided in a yaml can be extended by another yaml and add more tips to that tour
I think the tour can be made more generic and don't rely on the standard installation profile. Not talking about Articles will make this tour suitable for any drupal installation that doesn't have that content type installed.
Comment #22
rodrigoaguileraI created an issue to have the possibility to be more flexible with the tours
#2443713: Provide a way to have different set of tour tips for the same page
The tour is telling you to check it. I think is reasonable to make the following tips depend on that user action.
Apart from my comments and issues that need to be resolved to make this tour perfect and awesome I think this can go forward by providing a tour on the content translation module explaining everything that we can in the content translation settings page. It can be later splitted into more tours.
Comment #23
rodrigoaguileraComment #24
rodrigoaguileraComment #25
rodrigoaguileraHere's a patch. There's no interdiff because I only took some strings from the previous tour.
Comment #26
jhodgdonAs I commented on the other issue, you can use a tour tips alter to add a few items to a tour on an existing page, when a new module is enabled.
Comment #27
Gábor Hojtsy#1940590: META: Write a multipage multilingual tour is postponed on lack of directional decisions, so this one should be postponed too AFAIS.
Comment #28
mgiffordComment #41
quietone CreditAttribution: quietone as a volunteer commentedThis tour module is being deprecated, see #3336033: [Meta] Tasks to deprecate Tour module. It will be removed from core and moved to a contrib project, #3376099: [11.x] [Meta] Tasks to remove Tour.
This is now Postponed. The status is set according to two policies. The Remove a core extension and move it to a contributed project and the Extensions approved for removal policies.