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 language switcher block only.

Remaining tasks

Create tour yml files for the language switcher block tour:

  • Block config page (admin/structure/block)
    • Place block
    • Place language switcher block (subpage = admin/structure/block/list/block_plugin_ui%253A[theme]/add)
    • Configure language switcher block (subpage = admin/structure/block/add/language_block%253Alanguage_content/[theme])

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

Title: Multilingual tour for block switcher » Multilingual tour for language switcher block
Kristen Pol’s picture

Issue summary: View changes

Updated issue summary.

Kristen Pol’s picture

This one is a bit more challenging as it depends on the theme. I won't mark Novice here.

Each page needs its own "tour". We don't need to worry about tying the tours on different pages together yet.

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 summary: View changes

Updated issue summary.

Kristen Pol’s picture

Status: Active » Postponed

Actually, I don't think this one is do-able as is (on the admin/structure/block) because you can only have one tour per page (it would be great to have multiple tours per page!). So... really, info about the block will need to be surfaced on the other tours.

nick_schuch’s picture

Multiple tours per page is do-able. We have test coverage for this. Have you run into issues with this?

Kristen Pol’s picture

Oh! I guess I just assumed it didn't work :) Not sure when I can get to testing though...

Kristen Pol’s picture

Status: Postponed » Active

I'll un-postpone per #4.

c-c-m’s picture

Assigned: Unassigned » c-c-m

Despite being a complete novice, I will try to help on this issue. Assigning to me.

c-c-m’s picture

Here's a first attempt.

I didn't know how to handle urls', since they depend on the active theme. Is there any token such as [site:url] I can use? (I haven't found anything on Tour API).

Kristen Pol’s picture

Yes, [site:url] works! It just got committed recently:

#2017471-25: Multilingual tour for language section

:)

Thanks!

c-c-m’s picture

Hello Kirsten, do you know if there's a custom token such as [site:theme] I can use in order to create links like
admin/structure/block/list/block_plugin_ui%253A[theme]/add
admin/structure/block/add/language_block%253Alanguage_content/[theme]

Thank you

Kristen Pol’s picture

@c-c-m - I don't see a token with that in the code base but it shouldn't be hard to make one... just not sure where it would go... maybe in system module? I'm not sure it would get in at this late date though... hmm...

Kristen Pol’s picture

I searched and don't see an issue for this. If you want to open an issue, I don't think the patch would be difficult unless I'm not understanding something fundamental. Something like adding the following to system.tokens.inc:

function system_token_info() {
...
  $site['login-url'] = array(
    'name' => t("Login page"),
    'description' => t("The URL of the site's login page."),
  );
  $site['custom-theme'] = array(
    'name' => t("Custom theme"),
    'description' => t("The custom theme of the site."),
  );
...
function system_tokens($type, $tokens, array $data = array(), array $options = array()) {
...
      case 'login-url':
          $replacements[$original] = url('user', $url_options);
          break;
      }
      case 'custom-theme':
          $replacements[$original] = menu_get_custom_theme();
          break;
      }
...
nick_schuch’s picture

Issue tags: +Needs tests
nick_schuch’s picture

Issue summary: View changes

Updated issue summary.

balagan’s picture

Issue summary: View changes
FileSize
224.05 KB
+++ b/core/modules/language/config/tour.tour.language-switcher-block.yml
@@ -0,0 +1,44 @@
+    body: '<p>This page allows to add and arrange blocks into theme''s specific regions.</p><p>"Language Switcher block" is a block that allows users to quickly switch site''s language. Although it may be very useful it is not enabled by default and thus cannot be seen on this page (yet).</p>'
...
+    body: '<p>In order to see "Language Switcher" block in this page you have to create an instance of the block by clicking on the "Place blocks" button.</p>'
...
+    body: '<p>Make sure to click the "Save blocks" button when you are done placing your "Language Switcher" block, otherwise any changes made to this page will be lost.</p>'
...
+  language-block-continue:

Suggestion: Adding the "Language Switcher" block

suggestion: ..."arrange blocks into specific regions of a theme.

The "Language Switcher block" allows users to quickly switch the language of the site."...

The rest of the sentence suggests that we are stupid and evil, and we are not enabling a useful thing for the user by default. I would just stick to the following:
"This is not enabled by default, and unless it is added, cannot be seen on the page."

Suggestion: "In order to see the "Language Switcher" block"...

Suggestion: "After having clicked on the "Place blocks" button a new ..."
There is definately a mistake in the rest of the sentence: "Under one the existing regions"
Suggestion: "under one of the existing regions."

I would also change "Place block"''s page to something like:
""Place block" panel,..."

Also for continuing the link should be saying: Placing the "Language Switcher" block, this is what it is called. There is also an occurence of 'Language Selector' block, that should be changed.

I have enclosed a screenshot of the Language Switcher and the Place block panel.

mgifford’s picture

Assigned: c-c-m » Unassigned
Gábor Hojtsy’s picture

Status: Active » Postponed
mgifford’s picture

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: locale.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.