Download & Extend

Help File Fixup: Book Module

Project:Drupal core
Version:7.x-dev
Component:documentation
Category:bug report
Priority:normal
Assigned:Unassigned
Status:closed (fixed)
Issue tags:d7help, documentation

Issue Summary

Original issue: http://drupal.org/node/537828

This one required a bit more updating of the text - needs double checking for D7 accuracy. Also it's pretty lengthy, so open to pieces to cut, but I couldn't get it much more succinct without chopping potentially useful info out.

Also, relocated the help function to the top of the file (it was buried right at the end).

AttachmentSizeStatusTest resultOperations
help_book.patch6.07 KBIdlePassed on all environments.View details
help_book_before.png94.74 KBIgnored: Check issue status.NoneNone
help_book_after.png98.52 KBIgnored: Check issue status.NoneNone

Comments

#1

more looking around tonight.. this one string maybe has one extra word..?

Users with the administer book outlines permission can add any 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 [...]

#2

thanks for the input, but no, that and is certainly supposed to be there - removing it changes the meaning of that half of the sentence!

#3

Status:needs review» needs work

Re #1 - I agree with arianek on that one!

How about moving more of the content currently in "About" into "Uses"? For instance the explanation of how to add content to a book outline, which could have Uses header "Adding content to books". I think the other help pages have how-to information under Uses and general info in About. ???

The patch itself needs minor cleanup (text aside) - all the lines should be indented the same amount. (Possibly you used tabs instead of spaces? Should use spaces only.)

Also, just noticed the word "posts" in the help text for the other two pages (not the main help text). That should be replaced with "content". I know this isn't your fault, but might as well fix it. :)

#4

oy, maybe there were tabs in there i didn't notice, will do - and ya, i need to move more into the Uses for sure. will roll a new one with those edits. thanks!

#5

Status:needs work» needs review

ack, i don't know how i put 6 spaces on some of those, anyway that's fixed. moved a bunch of the content down into uses as suggested. still not sure if the collaborations use needs its own section, but left it there. got rid of those other mentions of "posts". new patch ahoy.

AttachmentSizeStatusTest resultOperations
help_book2.patch6.42 KBIdlePassed on all environments.View details
help_book_after2.png121.24 KBIgnored: Check issue status.NoneNone

#6

fixed indents

AttachmentSizeStatusTest resultOperations
help_book3.patch6.44 KBIdlePassed on all environments.View details

#7

Status:needs review» reviewed & tested by the community

This looks good to me now.

#8

B caps for consistency. Re-RTBC

AttachmentSizeStatusTest resultOperations
help_book4.patch6.44 KBIdlePassed on all environments.View details

#9

Status:reviewed & tested by the community» needs work

The standard for capitalization is not being followed. See http://drupal.org/node/632280 -- should start with "The foo module" not "The Foo module" according to standard.

#10

Status:needs work» reviewed & tested by the community

Caps can remain per consensus in #537828: Help text for core modules - update to conform to new standard so back to RTBC :)

#11

Status:reviewed & tested by the community» fixed

Looks great! Committed to HEAD!

#12

Status:fixed» closed (fixed)

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

nobody click here