Details

    • Type: Sub-task Sub-task
    • Status: Closed
    • Priority: Critical Critical
    • Resolution: Fixed
    • Affects Version/s: 2.3
    • Fix Version/s: 2.3
    • Component/s: Book, Language
    • Labels:
    • Testing Instructions:
      Hide

      1. Add a book activity to a course

      2. On the 'Adding a new book' page check that the setting 'Chapter numbering' is now named 'Chapter formatting' and that the help popup reads:

      • None - Chapter and subchapter titles have no formatting
      • Numbers - Chapters and subchapter titles are numbered 1, 1.1, 1.2, 2, ...
      • Bullets - Subchapters are indented and displayed with bullets in the table of contents
      • Indented - Subchapters are indented in the table of contents

      3. Check also that the help popup for 'Custom titles' reads:

      Normally the chapter title is displayed in the table of contents (TOC) AND as a heading above the content.

      If the custom titles checkbox is ticked, the chapter title is NOT displayed as a heading above the content. A different title (perhaps longer than the chapter title) may be entered as part of the content.

      4. Verify that book version is 2012052700 or later.

      5. Check that, with edition enabled, the "Book FAQ" link is not shown anymore in the TOC block.

      6. Go to admin->plugins->activity modules->book settings page and check that the description for the "book | numberingoptions" setting is show properly ("Options for displaying chapters and subchapters in the table of contents").

      Show
      1. Add a book activity to a course 2. On the 'Adding a new book' page check that the setting 'Chapter numbering' is now named 'Chapter formatting' and that the help popup reads: None - Chapter and subchapter titles have no formatting Numbers - Chapters and subchapter titles are numbered 1, 1.1, 1.2, 2, ... Bullets - Subchapters are indented and displayed with bullets in the table of contents Indented - Subchapters are indented in the table of contents 3. Check also that the help popup for 'Custom titles' reads: Normally the chapter title is displayed in the table of contents (TOC) AND as a heading above the content. If the custom titles checkbox is ticked, the chapter title is NOT displayed as a heading above the content. A different title (perhaps longer than the chapter title) may be entered as part of the content. 4. Verify that book version is 2012052700 or later. 5. Check that, with edition enabled, the "Book FAQ" link is not shown anymore in the TOC block. 6. Go to admin->plugins->activity modules->book settings page and check that the description for the "book | numberingoptions" setting is show properly ("Options for displaying chapters and subchapters in the table of contents").
    • Affected Branches:
      MOODLE_23_STABLE
    • Fixed Branches:
      MOODLE_23_STABLE
    • Pull from Repository:
    • Pull Master Branch:
    • Rank:
      40385

      Description

      The book module has now been integrated however the language strings still need a good review. Preferably before 2.3 is released.
      The language files to check are:

      • mod/book/lang/en/book.php
      • mod/book/tool/importhtml/lang/en/booktool_importhtml.php
      • mod/book/tool/print/lang/en/booktool_print.php
      • mod/book/tool/exportimscp/lang/en/booktool_exportimscp.php

      At the same time these files should probably be sorted alphabetically.

        Issue Links

          Activity

          Hide
          Sam Hemelryk added a comment -

          Hi Helen,

          I believe Eloy has already talked to you about the book module and its strings requiring your expert touch.
          It's now been integrated and you should be able to review things. If you could that would be fantastic!

          I made some notes myself during my review of the code:

          • faq_help string details that global search doesn't work for the book module in a way only developers will actually understand. As teachers are going to be the main viewer of that part of the string I think we should refactor it to be polite and generalistic. The book module does not provide a search mechanism. Also artifical line wrappings in that string should be removed. Line wrapping should be determined by the display of the string.
          • customtitles_help string refers to Chapter titles, should that be custom titles.
          • errorchapter string: I wonder whether that should be "Error finding book chapter" not a biggy just wondering.Y
          • numbering_help string I find slightly confusing. I think it should be something like:
            • None - chapter and subchapter titles are not automatically formatted. This allows you to use your own style within the title.
            • Numbers - chapters and subchapters are numbered automatically (1, 1.1, 1.2, 2, ...)
            • Bullets - subchapters are indented and displayed with bullets.
            • Indented - subchapters are indented.

          Cheers
          Sam

          Show
          Sam Hemelryk added a comment - Hi Helen, I believe Eloy has already talked to you about the book module and its strings requiring your expert touch. It's now been integrated and you should be able to review things. If you could that would be fantastic! I made some notes myself during my review of the code: faq_help string details that global search doesn't work for the book module in a way only developers will actually understand. As teachers are going to be the main viewer of that part of the string I think we should refactor it to be polite and generalistic. The book module does not provide a search mechanism. Also artifical line wrappings in that string should be removed. Line wrapping should be determined by the display of the string. customtitles_help string refers to Chapter titles, should that be custom titles. errorchapter string: I wonder whether that should be "Error finding book chapter" not a biggy just wondering.Y numbering_help string I find slightly confusing. I think it should be something like: None - chapter and subchapter titles are not automatically formatted. This allows you to use your own style within the title. Numbers - chapters and subchapters are numbered automatically (1, 1.1, 1.2, 2, ...) Bullets - subchapters are indented and displayed with bullets. Indented - subchapters are indented. Cheers Sam
          Hide
          Helen Foster added a comment -

          Sam, thanks for creating this issue and thanks for your comments.

          Re. the faq_help string, I suggest that it's removed, together with the help button, as we have a page in the docs wiki for FAQ - http://docs.moodle.org/en/Book_FAQ

          Eloy, I'm reassigning this issue to you, as discussed. Please find attached zip file containing 4 lang files.

          Please note that in book.php I have renamed the string numberingoptions_help to numberingoptions_desc since it's an admin setting description, rather than a help popup. (Source http://docs.moodle.org/dev/Help_strings )

          Finally, just noting that the faq_help string mentions a book admin config setting defining the width of a book TOC however I could find no evidence of it. If you could let me know how the book TOC width is defined, I can add it to http://docs.moodle.org/en/Book_FAQ

          Show
          Helen Foster added a comment - Sam, thanks for creating this issue and thanks for your comments. Re. the faq_help string, I suggest that it's removed, together with the help button, as we have a page in the docs wiki for FAQ - http://docs.moodle.org/en/Book_FAQ Eloy, I'm reassigning this issue to you, as discussed. Please find attached zip file containing 4 lang files. Please note that in book.php I have renamed the string numberingoptions_help to numberingoptions_desc since it's an admin setting description, rather than a help popup. (Source http://docs.moodle.org/dev/Help_strings ) Finally, just noting that the faq_help string mentions a book admin config setting defining the width of a book TOC however I could find no evidence of it. If you could let me know how the book TOC width is defined, I can add it to http://docs.moodle.org/en/Book_FAQ
          Hide
          Helen Foster added a comment -

          PS I notice there's a book capability 'Read book' mod/book:read. Should it be changed to 'View book' mod/book:view for consistency?

          Show
          Helen Foster added a comment - PS I notice there's a book capability 'Read book' mod/book:read. Should it be changed to 'View book' mod/book:view for consistency?
          Hide
          Helen Foster added a comment -

          Whilst reviewing the book documentation, I realised that a few of the strings in booktool_importhtml.php needed further rewording. Please find attached improved file.

          Show
          Helen Foster added a comment - Whilst reviewing the book documentation, I realised that a few of the strings in booktool_importhtml.php needed further rewording. Please find attached improved file.
          Hide
          Eloy Lafuente (stronk7) added a comment -

          Sending to integration. Includes:

          • Apply the suggested changes to strings.
          • Take rid of the "Book FAQ" link & help in the TOC.
          • Move the _help string to _desc in settings (AMOS MOV included).

          Regarding renaming the "read" cap to "view", I've divided feelings here. Right now we have 12 activities with "view" cap, versus 10 activities without it (book included). Perhaps we could create a separate issue to discuss about this and decide if we should be enforcing that capability?

          Ciao

          Show
          Eloy Lafuente (stronk7) added a comment - Sending to integration. Includes: Apply the suggested changes to strings. Take rid of the "Book FAQ" link & help in the TOC. Move the _help string to _desc in settings (AMOS MOV included). Regarding renaming the "read" cap to "view", I've divided feelings here. Right now we have 12 activities with "view" cap, versus 10 activities without it (book included). Perhaps we could create a separate issue to discuss about this and decide if we should be enforcing that capability? Ciao
          Hide
          Sam Hemelryk added a comment -

          Thanks guys, this has been integrated now

          Show
          Sam Hemelryk added a comment - Thanks guys, this has been integrated now
          Hide
          Sam Hemelryk added a comment -

          Passing this now thanks

          Show
          Sam Hemelryk added a comment - Passing this now thanks
          Hide
          Helen Foster added a comment -

          Thanks Eloy and Sam for your work on this issue.

          I've created MDL-33363 as suggested for considering renaming the 'Read book' capability.

          Show
          Helen Foster added a comment - Thanks Eloy and Sam for your work on this issue. I've created MDL-33363 as suggested for considering renaming the 'Read book' capability.
          Hide
          Dan Poltawski added a comment -

          Congratulations!

          Your work has made into the latest Moodle release!

          You are only authorised to celebrate after testing 15 Moodle 2.3 QA tests, thanks!

          Show
          Dan Poltawski added a comment - Congratulations! Your work has made into the latest Moodle release! You are only authorised to celebrate after testing 15 Moodle 2.3 QA tests, thanks!

            People

            • Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: