Background:
This issue is part of the task to update the hook_help texts of the Drupal 8 modules:
#1908570: [meta] Update or create hook_help() texts for D8 core modules

Tasks:
- review / write the hook_help text according to help guidelines

Files: 
CommentFileSizeAuthor
#14 drupal8.book-module.2091385-14.patch4.81 KBlostkangaroo
PASSED: [[SimpleTest]]: [MySQL] 59,033 pass(es).
[ View ]
#14 interdiff.txt1.3 KBlostkangaroo
#8 book-2091385-8.patch4.8 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 59,019 pass(es).
[ View ]
#8 diff.txt2.36 KBbatigolix
#5 book-2091385-5.patch5.11 KBdietmarg
PASSED: [[SimpleTest]]: [MySQL] 58,571 pass(es).
[ View ]
#3 book-hook_help_urls-2091385-3.patch4.84 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 59,033 pass(es).
[ View ]
#1 book-hook_help_urls-2091385-1.patch3.92 KBtankerjoe
PASSED: [[SimpleTest]]: [MySQL] 59,484 pass(es).
[ View ]

Comments

tankerjoe’s picture

Status:Active» Needs review
StatusFileSize
new3.92 KB
PASSED: [[SimpleTest]]: [MySQL] 59,484 pass(es).
[ View ]

The text for the hook_help looks good in my opinion, however the url() calls needed to be updated to the drupal-8 style. This patch does that.

lostkangaroo’s picture

Component:documentation» book.module
Issue tags:+Help text

one small thing, the tokens for routes should use ! rather than @

'@link' becomes '!link'
batigolix’s picture

StatusFileSize
new4.84 KB
PASSED: [[SimpleTest]]: [MySQL] 59,033 pass(es).
[ View ]

Patch changes '@link' to '!link'

lostkangaroo’s picture

This sentence seems like it could use a touch of reengineering from a word smith.
You can assign separate permissions for creating, editing, and deleting book content, as well as adding content to books, and creating new books.

Other than that everything seems to be in order and receives a passing grade.

dietmarg’s picture

Assigned:Unassigned» dietmarg
StatusFileSize
new5.11 KB
PASSED: [[SimpleTest]]: [MySQL] 58,571 pass(es).
[ View ]

Changed sentence from #4 to

You can assign separate permissions for creating new books as well as creating, editing, and deleting book content.
lostkangaroo’s picture

Status:Needs review» Reviewed & tested by the community

Excellent, the permissions section reads much easier and all the technical bits are working as intended. Good Work everyone!

alexpott’s picture

Status:Reviewed & tested by the community» Needs work
+++ b/core/modules/book/book.module
@@ -21,13 +21,13 @@ function book_help($path, $arg) {
+      $output .= '<dd>' . t('You can assign separate permissions for <em>creating new books</em> as well as<em>creating</em>, <em>editing</em> and <em>deleting</em> book content. Users with the <em>Administer book outlines</em> permission can add <em>any</em> type of content to a book by selecting the appropriate book outline while editing the content. They can also view a list of all books, and edit and rearrange section titles on the <a href="!admin-book">Book administration page</a>.', array('!admin-book' => \Drupal::url('book.admin'))) . '</dd>';

This looks wrong <em>creating new books</em> as well as<em>creating</em> no space between as and creating.

batigolix’s picture

Status:Needs work» Needs review
StatusFileSize
new2.36 KB
new4.8 KB
PASSED: [[SimpleTest]]: [MySQL] 59,019 pass(es).
[ View ]

patch:
- fixes #7
- changes http:// to https://

batigolix’s picture

Assigned:dietmarg» Unassigned

unassign

lostkangaroo’s picture

Status:Needs review» Reviewed & tested by the community

Just manually reviewed the patch and it is good to go as far as this issue is concerned. I did find an issue #2112237: Regression: Remove EntityFormControllerNG from book module, but this does not block this task since the page exists, it is only sick for the time being.

webchick’s picture

Component:book.module» documentation
Assigned:Unassigned» jhodgdon

Probably makes sense for Jennifer to give this a sign-off.

jhodgdon’s picture

Status:Reviewed & tested by the community» Needs work

Sorry, I apparently missed this one!

In About, the reference to the online docs is not following our current template.

Other than that, this looks good!

jhodgdon’s picture

Assigned:jhodgdon» Unassigned
lostkangaroo’s picture

StatusFileSize
new1.3 KB
new4.81 KB
PASSED: [[SimpleTest]]: [MySQL] 59,033 pass(es).
[ View ]

Fixed the online docs link

lostkangaroo’s picture

Status:Needs work» Needs review
batigolix’s picture

Status:Needs review» Reviewed & tested by the community

Patch applies, links are okay and text is conform the guidelines

jhodgdon’s picture

Thanks for the new patch and quick review! Agree this is ready to commit.

jhodgdon’s picture

Status:Reviewed & tested by the community» Fixed

Thanks all! Committed to 8.x.

Status:Fixed» Closed (fixed)

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