Problem/Motivation

For the Article and Basic Page content types that come with Core, the suggestion is to actually provide a default "submission guideline" so that some instruction text appears at the top of the node/add/* forms. Currently this is blank by default, so these forms have no instructions. During the Minnesota Drupal 8 accessibility testing sessions, users reported that they "didn't know what to do" on this page and that it "needed to be explained".

Proposed resolution

Suggest adding "submissions guidelines" to the Article and Basic Page content types by default. Of course site-builders can change or remove this to fit their needs. In addition, this issue includes details about adding an ARIA described-by attribute as well as an ID attribute so that these instructions can be properly connected to the first form field. This will cause the instructions to be read for screenreader users who jump into that first field.

Remaining tasks

Create a patch using the screenshots and this issue summary as guidance.

User interface changes

None. Everything proposed here will use existing CSS and existing appearance.

API changes

None.

More ARIA issues: https://drupal.org/node/1643410 (fixed) and https://drupal.org/node/1802566 (fixed).

Original report by @bowersox

Comments

bowersox’s picture

Issue tags: +Accessibility

tag

falcon03’s picture

Is there any "proposed" text to use as submission guidelines?

I 100% agree with adding it; I'm not sure about associating the help text to the first form field, though. In fact, the "help text" refers to the whole form, not to a single field; in addition to this, aria-describedby could be used to associate a field with its help text.

mgifford’s picture

StatusFileSize
new160.02 KB

When editing a content type for an article (/admin/structure/types/manage/article), the "Explanation or submission guidelines" are defined by:

    $form['description'] = array(
      '#title' => t('Description'),
      '#type' => 'textarea',
      '#default_value' => $type->description,
      '#description' => t('Describe this content type. The text will be displayed on the <em>Add new content</em> page.'),
    );

Which doesn't look great at the moment in Core.

I'm not sure where to insert the default text though or what it should be. I'd have expected it in in a yml file somewhere, but not sure where that (or $type->description) is defined.

mgifford’s picture

Status: Active » Needs review
StatusFileSize
new2.98 KB

Ok, this doesn't work locally, but it looks like it should.

mgifford’s picture

Issue tags: +aria
mgifford’s picture

Status: Needs review » Needs work
Issue tags: +Needs reroll
rbomhof’s picture

Status: Needs work » Needs review
Issue tags: -Needs reroll
StatusFileSize
new2.85 KB

Re-rolled

Bojhan’s picture

I am not sure about this at all and considering to won't fix this.

The page says its about creating content, and previously you get the instructions what type of content you are creating. So unless the flow that people took was wrong, I don't see how this text is needed. Also on a real website, people will have a much better idea about this since - the content types will map to the type of content shown on the website.

I'd like to know if this is a nice-to-have or a need-to-have because, this adds significant clutter on a key page.

Status: Needs review » Needs work

The last submitted patch, 8: default-instructions-2084611-8.patch, failed testing.

cachee’s picture

I liked the idea about the text, but needs a little more information to help out the new drupal developers and users. Suggestions are:

  1. Use this form to enter your static information such as "About-us", "Directions".
  2. Use this form to enter your changing or time-sensitive information such as "News", "Updates".
rbomhof’s picture

StatusFileSize
new2.87 KB
rbomhof’s picture

Status: Needs work » Needs review
mgifford’s picture

Status: Needs review » Needs work
StatusFileSize
new22.86 KB

We could make the help text invisible so that it is there as a hint for screen reader users.

I don't know how often this would come up as a concern. Like much of user testing it seems there are challenges in knowing what you can extrapolate from.

Here's a screenshot of the patch.

Image with patch showing description text.

It does seem to disrupt the flow as it is now.

mgifford’s picture

Issue tags: +Usability, +d8ux

This would need to get approval for the UX changes. I know it's not the direction that the team has been going.

The last submitted patch, 12: default-instructions-2084611-12.patch, failed testing.

Bojhan’s picture

Status: Needs work » Closed (won't fix)

Definitely a won't fix, this is not a crucial value proposition and can be discovered through other means.