Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-61256

core_search: Support search of section titles, summaries

    XMLWordPrintable

    Details

    • Testing Instructions:
      Hide
      Setup
      1. Setup Apache Solr.
      2. Log in as admin
      3. Go to site admin and search for the word 'search'. You can find here all settings you need to change:
        • Tick "Enable global search"
        • Configure Moodle to use Solr as its search engine.
      4. Set up a test course or use an existing test course. We assume all the sections on this course have default names.
      5. Edit four of the sections as follows:
        1. Set the title to Title changed fleegletwonk
        2. Leave title default but set summary to Summary changed fleegletwonk
        3. Set title to Title and and summary to summary changed fleegletwonk; also, set this section to hide from students
        4. Create a Word document called test.doc. The text inside the document should include the word fleegletwonk. Edit the section summary to add a link and upload this document. (Don't include the word fleegletwonk in the visible text, only in the Word file.)
      Test
      1. Go to "Site administration / Server / Scheduled tasks"
      2. Run the "Global search indexing" task (\core\task\search_index_task)
        • EXPECTED: The cron log should show that a number of course sections (at least 4) are updated
      3. Using the search bar in the header, search for fleegletwonk
        • EXPECTED: You should see 4 results relating to the 4 sections
      4. Try clicking the link in one of the results
        • EXPECTED: It should take you to the default link for that section (depends on course format - usually this is the course page but scrolled down to that section)
      5. Enrol a test student account on the course
      6. Log in as that student.
      7. Do the search for fleegletwonk
        • EXPECTED: You should see 3 results (all the sections except the one that was hidden)
      Show
      Setup Setup Apache Solr. Log in as admin Go to site admin and search for the word 'search'. You can find here all settings you need to change: Tick "Enable global search" Configure Moodle to use Solr as its search engine. Set up a test course or use an existing test course. We assume all the sections on this course have default names. Edit four of the sections as follows: Set the title to Title changed fleegletwonk Leave title default but set summary to Summary changed fleegletwonk Set title to Title and and summary to summary changed fleegletwonk ; also, set this section to hide from students Create a Word document called test.doc. The text inside the document should include the word fleegletwonk . Edit the section summary to add a link and upload this document. (Don't include the word fleegletwonk in the visible text, only in the Word file.) Test Go to " Site administration / Server / Scheduled tasks " Run the " Global search indexing " task (\core\task\search_index_task) EXPECTED: The cron log should show that a number of course sections (at least 4) are updated Using the search bar in the header, search for fleegletwonk EXPECTED: You should see 4 results relating to the 4 sections Try clicking the link in one of the results EXPECTED: It should take you to the default link for that section (depends on course format - usually this is the course page but scrolled down to that section) Enrol a test student account on the course Log in as that student. Do the search for fleegletwonk EXPECTED: You should see 3 results (all the sections except the one that was hidden)
    • Affected Branches:
      MOODLE_35_STABLE
    • Fixed Branches:
      MOODLE_35_STABLE
    • Pull Master Branch:
      MDL-61256-master

      Description

      (Note: There is an existing issue MDL-55303 which covers this and another issue. Hopefully it's OK to start this new issue to split out just this part.)

      Currently section titles and summaries are not indexed. One of our testers pointed out that text (part of the course content) can be included in these, which is not found when they search.

      (The specific example they're using has a title like 'Case study: Evelyn' and they searched for Evelyn and didn't find anything.)

      This seems like a straightforward limitation of Moodle core search indexing which ought to be resolved.

      I propose adding a new core search area for sections, including the title and summary, called 'Course sections'.Sections will only be indexed if they contain custom text in either the title or summary.

      There is existing standard Moodle logic that can be used around section visibility, URL, etc. Also, I thought I was going to have to add a timemodified field to sections, but thankfully Devang Gaur already did that in MDL-55548.

       

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                quen Sam Marshall
                Reporter:
                quen Sam Marshall
                Peer reviewer:
                Tim Hunt
                Integrator:
                Andrew Nicols
                Tester:
                David Monllaó
                Participants:
                Component watchers:
                Amaia Anabitarte, Bas Brands, Carlos Escobedo, Sara Arjona (@sarjona), Víctor Déniz Falcón
              • Votes:
                1 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Fix Release Date:
                  17/May/18