Part of #1921152: META: Start providing tour tips for other core modules.

Problem/Motivation

Write tour integration for field_ui.module

Proposed resolution

Create tour yml files for required admin screens in interface translation.

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.

Files: 
CommentFileSizeAuthor
#32 1960824-field-ui-tour-32.patch9.31 KBclemens.tolboom
FAILED: [[SimpleTest]]: [MySQL] 63,569 pass(es), 15 fail(s), and 0 exception(s). View
#27 interdiff.txt5.58 KBpameeela
#27 1960824-field-ui-tour-27.patch10.11 KBpameeela
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 1960824-field-ui-tour-27.patch. Unable to apply patch. See the log in the details link for more information. View
#26 interdiff.txt5.98 KBkim.pepper
#25 interdiff.txt0 byteskim.pepper
#25 1960824-field-ui-tour-25.patch10.88 KBkim.pepper
PASSED: [[SimpleTest]]: [MySQL] 59,528 pass(es). View
#24 1960824-field-ui-tour-24.patch8.28 KBgrisendo
PASSED: [[SimpleTest]]: [MySQL] 59,974 pass(es). View
#24 1960824-field-ui-tour-22_24.interdiff.txt1.55 KBgrisendo
#22 1960824-field-ui-tour-22.patch8.19 KBgrisendo
FAILED: [[SimpleTest]]: [MySQL] 59,906 pass(es), 7 fail(s), and 1 exception(s). View
#18 1960824-field-ui-tour-18.inderdiff.txt2.82 KBnick_schuch
#18 1960824-field-ui-tour-18.patch9.01 KBnick_schuch
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 1960824-field-ui-tour-18.patch. Unable to apply patch. See the log in the details link for more information. View
#14 1960824-field-ui-tour-14.patch9.06 KBkim.pepper
FAILED: [[SimpleTest]]: [MySQL] 58,133 pass(es), 2 fail(s), and 4 exception(s). View
#7 1960824-7-field-ui-tour.patch6.48 KBLewisNyman
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 1960824-7-field-ui-tour.patch. Unable to apply patch. See the log in the details link for more information. View
#5 1960824-5-field-ui-tour.interdiff.txt3.01 KBnick_schuch
#5 1960824-5-field-ui-tour.patch6.35 KBnick_schuch
PASSED: [[SimpleTest]]: [MySQL] 54,119 pass(es). View
#1 1960824-1-field-ui-tour.patch6.37 KBnick_schuch
PASSED: [[SimpleTest]]: [MySQL] 53,889 pass(es). View

Comments

nick_schuch’s picture

Status: Active » Needs review
FileSize
6.37 KB
PASSED: [[SimpleTest]]: [MySQL] 53,889 pass(es). View

I have written the following tour based on the "Manage field" and "Display field" admin interfaces.

A screencast is available here: http://youtu.be/SRcrJTQzuzA

joelpittet’s picture

Just a couple language suggestions, use them if they help.

+++ b/core/modules/field_ui/config/tour.tour.field-ui-display.yml
@@ -0,0 +1,38 @@
+    body: <p>The following page is used for managing the display of fields declared in 'Manage fields'.</p><p>Tasks that can be performed include:</p><ul><li>Change settings for field display.</li><li>Arranging the order in which fields are displayed.</li><li>Hide and show fields via dragging.</li><li>Enable additional field displays and settings.</li></ul>

"This page is used to manage how the fields from 'Manage fields' will be displayed on different parts of your site."

"Show and hide fields."

"Configure additional field displays and its settings."

+++ b/core/modules/field_ui/config/tour.tour.field-ui-fields.yml
@@ -0,0 +1,44 @@
+    body: <p>The widget type is a reference to how the data will appear for both content entry and display.</p><p>eg. Select list or checkboxes.</p>

You can remove extra language: "... a reference to ..." to make these sentences more clear. And a 'widget' is more towards content entry than display. Field formatters provide the display but they are tied to the widget so maybe...

"The type of widget will control how the data will be entered and also provide options to how it will eventually be formatted on a page."
eg. Date field type, date popup widget, countdown formatter. or something...

Hope that helps a bit, cheers.

nick_schuch’s picture

Thanks joelpittet!

Configure additional field displays and its settings.

I think I will need to reword this. This was in relation to the additional settings that can be provided from contrib modules under this tab.

The others look good to me. Will update.

joelpittet’s picture

It's a tough balance between technically accurate and user friendly:)

nick_schuch’s picture

FileSize
6.35 KB
PASSED: [[SimpleTest]]: [MySQL] 54,119 pass(es). View
3.01 KB

Here is the latest patch with the advice from joelpittet taken into account.

Cheers!

aspilicious’s picture

Status: Needs review » Needs work
+++ b/core/modules/field_ui/config/tour.tour.field-ui-display.ymlundefined
@@ -0,0 +1,38 @@
+    body: <p>Display modes allow for content to be viewed in many different ways.</p><p>eg. The content type's content on a page will different to a smaller subset of content displayed in a list.</p> ¶

Trailing whitespace

+++ b/core/modules/field_ui/config/tour.tour.field-ui-display.ymlundefined
@@ -0,0 +1,38 @@
+    body: <p>Formats are used to display field information in different ways.</p><p>eg. Tags can be display in plain text or link form.</p> ¶

Same

+++ b/core/modules/field_ui/config/tour.tour.field-ui-display.ymlundefined
@@ -0,0 +1,38 @@
+    body: <p>Allow for addition settings that other modules use to extend field display functionality.</p><p>Core provides the ability to enable additional view modes.</p> ¶

Same

+++ b/core/modules/field_ui/config/tour.tour.field-ui-fields.ymlundefined
@@ -0,0 +1,44 @@
+    body: <p>The field type is the type of data that this field will store.</p><p>eg. A list of items.</p> ¶

Same

I advise you to find a plugin for your editor that strips away those trailing whitespaces.
Will make your contrib life much easier! :)

LewisNyman’s picture

Status: Needs work » Needs review
FileSize
6.48 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 1960824-7-field-ui-tour.patch. Unable to apply patch. See the log in the details link for more information. View

Rerolled

swentel’s picture

+++ b/core/modules/field_ui/config/tour.tour.field-ui-display.ymlundefined
@@ -0,0 +1,38 @@
+  - admin/structure/types/manage/*/display

This now only shows on content types, just wondering whether we want to add this to taxonomy, user and comments paths too ?

nick_schuch’s picture

Issue tags: +Needs tests, +Tour

Tour needs tests since we now have #2028535

amateescu’s picture

Also, the widget stuff is gone from the 'Manage fields' screen :)

clemens.tolboom’s picture

Issue tags: -Needs tests, -Tour

#7: 1960824-7-field-ui-tour.patch queued for re-testing.

Status: Needs review » Needs work
Issue tags: +Needs tests, +Tour

The last submitted patch, 1960824-7-field-ui-tour.patch, failed testing.

kim.pepper’s picture

Assigned: Unassigned » kim.pepper

Working on this

kim.pepper’s picture

Status: Needs work » Needs review
FileSize
9.06 KB
FAILED: [[SimpleTest]]: [MySQL] 58,133 pass(es), 2 fail(s), and 4 exception(s). View

This is a re-roll of #7, plus added a tour test and fixed incorrect selector in tour.tour.field-ui-fields.yml

Still need tests for display page.

Status: Needs review » Needs work

The last submitted patch, 1960824-field-ui-tour-14.patch, failed testing.

clemens.tolboom’s picture

  1. +++ b/core/modules/field_ui/config/tour.tour.field-ui-display.yml
    @@ -0,0 +1,38 @@
    +label: Field UI display
    +langcode: en
    

    module is missing. I'm not sure that's required (Tour UI #2072649: module is not set for new tour.)

  2. +++ b/core/modules/field_ui/config/tour.tour.field-ui-display.yml
    @@ -0,0 +1,38 @@
    +    body: <p>This page is used to manage how the fields from 'Manage fields' will be displayed on different parts of your site.</p><p>Tasks that can be performed include:</p><ul><li>Change settings for field display.</li><li>Arranging the order in which fields are displayed.</li><li>Show and hide fields.</li><li>Enable additional field displays and display options.</li></ul>
    

    attributes is missing according to test result.

    I noted on http://tour.drutch.nl/admin/config/user-interface/tour-builder/field-ui-... that it has the attribute but it is an empty string.

    attributes: ''

Not sure this helps :-/

kim.pepper’s picture

nick_schuch’s picture

Status: Needs work » Needs review
FileSize
9.01 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 1960824-field-ui-tour-18.patch. Unable to apply patch. See the log in the details link for more information. View
2.82 KB

1) I agree. So I have added those in.
2) If no attributes are provided then it is rendered as a modal. The error is actually in relation to the xpath query sting and there being list elements in the body. I have updated the base test accordingly.

This should get us back on track. Ill update the blocker ticket with these findings.

I have also removed one of the "widget" tips as the Field UI has changed. We (might) need more tour tip content to cover this.

kim.pepper’s picture

Issue tags: -Needs tests, -Tour

#18: 1960824-field-ui-tour-18.patch queued for re-testing.

Status: Needs review » Needs work
Issue tags: +Needs tests, +Tour

The last submitted patch, 1960824-field-ui-tour-18.patch, failed testing.

kim.pepper’s picture

Issue tags: +Needs reroll

Needs re-roll

kim.pepper’s picture

Issue summary: View changes

Updated issue summary.

grisendo’s picture

Issue summary: View changes
Status: Needs work » Needs review
Issue tags: -Needs reroll
FileSize
8.19 KB
FAILED: [[SimpleTest]]: [MySQL] 59,906 pass(es), 7 fail(s), and 1 exception(s). View

Re-rolled

Status: Needs review » Needs work

The last submitted patch, 22: 1960824-field-ui-tour-22.patch, failed testing.

grisendo’s picture

FileSize
1.55 KB
8.28 KB
PASSED: [[SimpleTest]]: [MySQL] 59,974 pass(es). View

Updated some API changes, reflected in interdiff

kim.pepper’s picture

FileSize
10.88 KB
PASSED: [[SimpleTest]]: [MySQL] 59,528 pass(es). View
0 bytes

This patch:

  • Removes a couple of field settings which are no longer there: e.g. add existing field
  • Fixes selectors for a few that were broken
  • Adds a new tour for form display page
kim.pepper’s picture

FileSize
5.98 KB

Missing interdiff.

pameeela’s picture

FileSize
10.11 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 1960824-field-ui-tour-27.patch. Unable to apply patch. See the log in the details link for more information. View
5.58 KB

Updated patch with interdiff. A bunch of text changes, nothing else. Spoke to Nick about the need to get some consistency in how these are written, so going to start here.

kim.pepper’s picture

Awesome. Thanks pameeela!

We should start putting together guidelines for how to write a tip.

kim.pepper’s picture

27: 1960824-field-ui-tour-27.patch queued for re-testing.

kim.pepper’s picture

27: 1960824-field-ui-tour-27.patch queued for re-testing.

The last submitted patch, 27: 1960824-field-ui-tour-27.patch, failed testing.

clemens.tolboom’s picture

FileSize
9.31 KB
FAILED: [[SimpleTest]]: [MySQL] 63,569 pass(es), 15 fail(s), and 0 exception(s). View

A re-roll attempt.

clemens.tolboom’s picture

+++ b/core/modules/filter/tests/filter_test/lib/Drupal/filter_test/Plugin/Filter/FilterTestReplace.php
@@ -29,7 +29,7 @@ class FilterTestReplace extends FilterBase {
-    $text[] = 'Filter: ' . $this->getLabel() . ' (' . $this->getPluginId() . ')';
+    $text[] = 'Filter: ' . $this->getLabel() . ' (' . $this->getPluginID() . ')';

I assumed this was a type so ignored this.

kim.pepper’s picture

32: 1960824-field-ui-tour-32.patch queued for re-testing.

Status: Needs review » Needs work

The last submitted patch, 32: 1960824-field-ui-tour-32.patch, failed testing.

nielsonm’s picture

Assigned: kim.pepper » nielsonm
webchick’s picture

Status: Needs work » Postponed

This one seems like a good thing to do, but postponed on #1921152-109: META: Start providing tour tips for other core modules. for now.

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.