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

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Kristen Pol’s picture

Issue tags: +Novice

This 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

Kristen Pol’s picture

Issue tags: -Novice

See 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.

Kristen Pol’s picture

Issue tags: +Novice

Adding back novice tag.

#2017471: Multilingual tour for language section can be used as an example.

nick_schuch’s picture

Issue tags: +Needs tests

Tour needs tests since we now have #2028535

Mark_L6n’s picture

Assigned: Unassigned » Mark_L6n

I'm working on this

tstoeckler’s picture

Maybe you can use this as a starting point.

tstoeckler’s picture

Issue summary: View changes

Updated issue summary.

Mark_L6n’s picture

I'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:

  1. The location of a Joyride tip is either an HTML id or the first instance of a class on the page. Thus, you sometimes cannot put the tip exactly where you would like to. (It's surprising that a jQuery tool, with jQuery's excellent selection capabilities, has this limitation—I wonder if it is possible to improve upon this.)
  2. If part of the page is hidden by default, a Joyride tip within that area will not open up that part of the page. For example, on the 'Extend' page, the user needs to click on the text in the Description column in order to see the Help, Permissions and Configure links. Thus, in this tour file, I instruct the user where to click in order to see the Configure link.
  3. You may alter the text of a button, but this cannot contain a link. Joyride has options data-button and data-text which may be used to change the text on the button. However, a link does not work here, which would be useful in the same example for clicking the Configure button, which takes you to a new page. The attached file tries to skirt this problem by embedding a link in the text, instructing the user to click here to go to a new page.
  4. Following the previous click here action, the same tip box still exists on the new page, which would be confusing. To get around this, the attached file asks the user to click here to go to the Configure / Content language settings page, and then click next. Hopefully this informs the user that the click takes them to a new page, where they will still need to click the next button to continue. It would be better if the next Tour tip occurred, though.
  5. The data-options parameter does not seem to work. (See Joyride Demo and Joyride Step 5: Options and Upgrades). This would be useful for among other things placing the tip box. If the HTML element the tip is attached to is too large, the tip box will be unseen under the bottom of the screen. Other times, the tip box obscures the part of the web page you want the user to see. Being able to place the tip box to the left, right, or top might help here.
Mark_L6n’s picture

Uploaded file for comment #7.

bendev’s picture

Could we add info in the tour on "Content type translation" explaining how to translate menu entries related to this content type?

kholloway’s picture

I 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.

kholloway’s picture

Component: locale.module » translation.module
Assigned: Mark_L6n » kholloway
Status: Active » Needs review
FileSize
2.03 KB

I 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.

Status: Needs review » Needs work

The last submitted patch, 11: 2017477-11.patch, failed testing.

kholloway’s picture

Status: Needs work » Needs review
FileSize
2.03 KB

Silly Git New Line character error. Adding a patch with a new line :)

Status: Needs review » Needs work

The last submitted patch, 13: 2017477-12.patch, failed testing.

larowlan’s picture

These are all truncated, and hence missing the closing '

larowlan’s picture

+++ b/core/modules/language/config/install/tour.tour.language.yml
@@ -0,0 +1,49 @@
+    body: 'Specify the parts of the website that may be translated, and default languages for them.<br>N
...
+    body: 'Relevant links and information are displayed here.<br>To continue tour, click <a href="/admin
...
+    body: '<em>Content Entities</em> are configured here for translation. <em>Content Entities</em> typi
...
+    body: 'Individual Content Types may be configured for translation.<br>Check <em>Article</em> and cli
...
+    body: 'The individual fields of a content entity may be separately configured.<br>Even sub-field com

These

kholloway’s picture

Status: Needs work » Needs review
FileSize
2.78 KB

Silly error. Didn't realize my patch was being truncated. Uploading a complete patch :)

pameeela’s picture

I 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 :(

Status: Needs review » Needs work

The last submitted patch, 17: tour-2017477-17.patch, failed testing.

rodrigoaguilera’s picture

Assigned: kholloway » Unassigned

I 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.

rodrigoaguilera’s picture

I 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

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.

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.

rodrigoaguilera’s picture

Issue summary: View changes
rodrigoaguilera’s picture

Issue summary: View changes
rodrigoaguilera’s picture

Status: Needs work » Needs review
FileSize
3.5 KB

Here's a patch. There's no interdiff because I only took some strings from the previous tour.

jhodgdon’s picture

As 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.

Gábor Hojtsy’s picture

Status: Needs review » Postponed

#1940590: META: Write a multipage multilingual tour is postponed on lack of directional decisions, so this one should be postponed too AFAIS.

mgifford’s picture

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

Component: translation.module » tour.module

This 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.

Version: 9.5.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.