Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Problem/Motivation
Functionality of the book module has changed since the help text was written.
- The book module adds a new content type "Book page" that is by default allowed in book outlines and as child pages. Any other content types first need to be enabled on the Book settings page.
- The help text refers to the "Blocks Administration page" but the page is now called "Blocks layout page".
Proposed resolution
- Rewrite the first use "Adding and managing book content", including mentioning the "Book outline" options on the content edit form. We also need to check the functionality. On the first glance it looks like any number of content types can be book outlines, but only one at a time can be book child pages.
- Changing the wording in the Use "Book navigation"
Remaining tasks
User interface changes
API changes
| Comment | File | Size | Author |
|---|---|---|---|
| #32 | Screenshot from 2015-04-29 12:23:50.png | 123.66 KB | darol100 |
| #31 | interdiff-2471751-29-31.txt | 4.59 KB | botris |
| #31 | help-text-Book-Module-2471751-31.patch | 5.07 KB | botris |
| #29 | 2471751-help-text-Book-29.patch | 5.05 KB | oceankrish76 |
| #28 | book.txt | 23.7 KB | oceankrish76 |
Comments
Comment #1
jhodgdonfixing bullets...
Also I think this is still working the same as it was in D7, which is that you can allow any content type to be used as pages in books?
Comment #2
ifrikOn the first glance it looks like the functionality has changed with checkboxes for book outline pages, and a radio button for child pages.
Comment #3
ifrikComment #4
jhodgdonAh. So that radio button says "When someone clicks the Add child page link, use this content type". So yes, it should be choosing just one type.
And the checkboxes say "Allow people to add these types of pages to the outline". So that should allow multiple types.
This UI makes sense to me... In the help I would explain this similar to what I wrote here?
Comment #5
ifrikYes, I think the help text could be written like that. Maybe it needs a sentence to also say what an "outline" is?
Comment #6
jhodgdonIndeed, good idea.
Comment #7
botrisWorking on this
Comment #8
botrisComment #9
botrisFollowing up tomorrow.
Comment #10
botrisAttached a preliminary patch, but first we should wait for #2473089: Book settings page has wrong settings label to be commited
Comment #11
botrisComment #13
botrisfixed typo
Comment #14
botrisComment #15
jhodgdonThanks for the patch!
A few things to fix:
a) We don't usually use backquotes like
‘book outline’in our help. Actually we would normally use
<em>book outline</em>to indicate terminology.b) I don't think that the points in the issue summary have all been addressed. What we need to make sure to cover is:
- There's a content type called Book page. This should go in the About section.
- The Book page content type is always available for adding to books or creating books.
- If you want other content types to be available for books, you need to enable this on the settings page.
- You can also configure the content type that is used if you click "Add child page"
==> probably these 3 items should be covered in a new topic, maybe called "Configuring content types for books"
- The Blocks layout page name change
c) The patch seems to have deleted existing information from the help, which we also don't want to do.
Comment #16
botrisThanks for the feedback.
Hereby the new patch.
Most of you issues have been addressed. But the remark "The Book page content type is always available for adding to books or creating books" is not true. Not sure if that should be the case, but to me it makes sense that you can remove any content type from the book outline.
Comment #17
botrisAlso, it might be best to first review the patch here #2473089: Book settings page has wrong settings label
Comment #18
botrisand a new patch including the solution for #2473105: Update hook_help texts that link to modules that can be uninstalled
Comment #19
ifrikThanks this looks pretty good, and thanks for fixing the link to the block module already.
Just some small issues:
There's a comma where it shouldn't be at "The Book content type, is the initial..."
For the "Configuring content types for books", I've made a comment in the other issue.
In order to make the workflow easier, we could also close this issue as a duplicate and add the help text changes to the changes in the UI text. That way it could just be committed alltogether instead of postponing this one.
Comment #20
jhodgdonLooking pretty good, thanks!
A few things to fix:
a) "From the node edit form ...". We don't call it that. Content edit form would be better.
b) Also it needs a comma after form I think?
c) "The Book content type, is the initial content type enabled for book outlines."
==> Remove comma here
d) "you can change or add content types that can used in book outlines."
==> you can configure the content types that can be used ...
e) "underneeth each book node. "
==> Don't use the word node. Ever. Use "content item" or in this case something like "when viewing a content item that is part of a book outline" would probably be better.
Also I don't think we should say "underneath" but if we do it is misspelled.
f) "This link will open a new node of the type you select on the"
==> This link will allow users to create a new content item of the type...
The rest looks good, thanks!
Comment #21
botrisApplied comments to new patch.
Comment #22
jhodgdonGreat!
One more small thing:
"Users with the Add content and child pages to books permission will have a shortcut Add child page when viewing a content item ..."
have a shortcut ==> see a link to
Then I guess we are waiting for #2473089: Book settings page has wrong settings label, or should we just go ahead with this and assume that will get fixed too?
Comment #23
keopxI think this works on #2473089: Book settings page has wrong settings label
Comment #24
ifrikThanks,
all together the text looks really good now.
For consistency, it would be good to change a few last things:
In the About section:
creates a new content type Book.: The content type is called "Book page" so we should use that.rearrange section titles on the Book administration page.: That should be "Books list page". That keeps it consistent the use of "Books listing page" later.Comment #25
ifrikI think this patch doesn't have to wait for the related issue because it describes the uses correctly and doesn't rely on the exact wording in the user interface.
And another note: The link to the block module is also fixed in #2473105: Update hook_help texts that link to modules that can be uninstalled because otherwise the test would fail.
Comment #26
oceankrish76 CreditAttribution: oceankrish76 commentedI'm in sprint and Im working on this.
Comment #27
oceankrish76 CreditAttribution: oceankrish76 commentedMade changes to content type and replaced Book administration page by Book list page.
Comment #28
oceankrish76 CreditAttribution: oceankrish76 commentedComment #29
oceankrish76 CreditAttribution: oceankrish76 commentedComment #30
ifrikThanks for changing the reference to the "Book list page".
But I can't quite see the change of the content type. In the About section it should say
Enabling the module creates a new content type <em>Book page</em>.The same in "Configuring content types" - that should be
The<em> Book page</em> content typeandBy default this is the <em>Book page</em> content type.This should make it clear enough to site builders and editors what the difference is between the content type "Book page" and a book and its pages.
Oceankrish76: In future, it would be good if you also make an interdiff in addition to the patch. Then it's much easier for others to see what has changed between two patches. See https://www.drupal.org/patch for details.
Comment #31
botrisUpdated the "Book page" text.
Comment #32
darol100 CreditAttribution: darol100 commentedI have tested the patch #31 and seem to be working fine. I have attached a screenshot of the hook_help text.
Comment #33
darol100 CreditAttribution: darol100 commentedComment #34
webchickGreat stuff, thanks!
Committed and pushed to 8.0.x.