In the permissions page, the documentation for "Add content and child pages to books" isn't as clear as it should be. It should have a short description stating that without this, users won't be able to manipulate book hierarchies. We should better describe that permission in order to help people use the book module correctly.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

benelori’s picture

Issue summary: View changes
FileSize
598 bytes

Added description for 'add content to books' permission on the permission page.

benelori’s picture

Status: Active » Needs review
jhedstrom’s picture

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

This would need to be for 8.1 I think since it adds strings.

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

Drupal 8.1.0-beta1 was released on March 2, 2016, which means new developments and disruptive changes should now 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.

Anul’s picture

Status: Needs review » Needs work

git apply -v add_description_permission-1866932-1.patch
Checking patch core/modules/book/book.module...
error: while searching for:
),
'add content to books' => array(
'title' => t('Add content and child pages to books'),
),
'access printer-friendly version' => array(
'title' => t('View printer-friendly books'),

error: patch failed: core/modules/book/book.module:89
error: core/modules/book/book.module: patch does not apply

When i applied this patch it couldn't find the particular line of code inside book.module
So this #1 patch is out dated now..

Anul’s picture

Status: Needs work » Needs review
FileSize
612 bytes

Added New Patch for the description to add to permissions page.

hesnvabr’s picture

Status: Needs review » Reviewed & tested by the community

Tested and reviewed this patch it looks fine.

xjm’s picture

Status: Reviewed & tested by the community » Needs work

I actually don't think this is the best change. In general, we should try to label things clearly enough so that they do not need descriptions, because added text increases the burden on the user and degrades user experience. A lot of work has been done in Drupal 7 and 8 to remove descriptions.

If we want to improve this, let's see if we can improve the title instead to contain the needed information. Once we've a proposal for that, we can look at a usability review of the proposed text.

Anul’s picture

Status: Needs work » Needs review
FileSize
653 bytes

I totally agree on the point mentioned in the comment #8. So here is the improved solution for this with the improved label. I am adding a new patch.

hesnvabr’s picture

Status: Needs review » Reviewed & tested by the community

I applied this patch it looks fine.I think conditions/criteria are also fulfilled.

xjm’s picture

Title: Documentation about adding content to Books » Update book permission description
Status: Reviewed & tested by the community » Needs review

Thanks, I think that's a much better direction!

I think it could be a little clearer:
Add content and child pages to books, and manage their hierarchies.

How about that?

Anul’s picture

Status: Needs review » Needs work

Yes Awesome!!
Thank You @xjm.

"manage their hierarchies" seems more standardised then "to manipulate hierarchies".

Anul’s picture

Status: Needs work » Needs review
FileSize
657 bytes

So here is the new patch i have added for more improved label.

Status: Needs review » Needs work

The last submitted patch, 13: improved_label_1866932_#11.patch, failed testing.

naveenvalecha’s picture

Component: book.module » documentation
Issue tags: -access permissions +Novice

This seems to be the documentation change. correct me if I'm wrong.

The last submitted patch, 13: improved_label_1866932_#11.patch, failed testing.

Anul’s picture

Component: documentation » book.module
Status: Needs work » Needs review
FileSize
657 bytes

Adding a new patch as previous one failed testing.

Anul’s picture

Component: book.module » documentation

@naveen yes this is related to documentation of Book Module.

Status: Needs review » Needs work

The last submitted patch, 17: new_improved_label_1866932.patch, failed testing.

Anul’s picture

Status: Needs work » Needs review
FileSize
657 bytes

The last submitted patch, 17: new_improved_label_1866932.patch, failed testing.

hesnvabr’s picture

Status: Needs review » Reviewed & tested by the community

According to that #11 this patch is almost fulfill the requirements.

  • xjm committed 8c04cd1 on 8.2.x
    Issue #1866932 by Anul, benelori, pranavbabbar, xjm, jhedstrom, RobLoach...
xjm’s picture

Component: documentation » book.module
Status: Reviewed & tested by the community » Fixed
Issue tags: +String change in 8.2.0, +Usability

Great, thanks @Anul! Committed 8c04cd1 and pushed to 8.2.x. This is a good usability improvement.

By the way, "Documentation" is generally reserved for our in-code and handbook documentation that does not affect Drupal functionally, whereas this one is a user interface string. So retroactively moving it back to the book module for that reason.

  • xjm committed 8c04cd1 on 8.3.x
    Issue #1866932 by Anul, benelori, pranavbabbar, xjm, jhedstrom, RobLoach...

  • xjm committed 8c04cd1 on 8.3.x
    Issue #1866932 by Anul, benelori, pranavbabbar, xjm, jhedstrom, RobLoach...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

hesnvabr’s picture