diff --git a/core/modules/help_topics/help_topics/help.help_topic_search.html.twig b/core/modules/help_topics/help_topics/help.help_topic_search.html.twig index ae57d5eb73..37e802d0c6 100644 --- a/core/modules/help_topics/help_topics/help.help_topic_search.html.twig +++ b/core/modules/help_topics/help_topics/help.help_topic_search.html.twig @@ -1,10 +1,10 @@ --- label: 'Configuring help search' -top_level: true related: - block.place - system.cache - core.cron + - search.overview --- {% set extend_url = render_var(url('system.modules_list')) %} {% set help_url = render_var(url('help.main')) %} diff --git a/core/modules/help_topics/help_topics/search.configuring.html.twig b/core/modules/help_topics/help_topics/search.configuring.html.twig new file mode 100644 index 0000000000..bc41018177 --- /dev/null +++ b/core/modules/help_topics/help_topics/search.configuring.html.twig @@ -0,0 +1,22 @@ +--- +label: 'Configuring search pages' +related: + - search.overview + - search.index +--- +{% set search_settings = render_var(url('entity.search_page.collection')) %} +{% set index_topic = render_var(url('help.help_topic', {'id': 'search.index'})) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Configure one or more search pages.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > Search and Metadata > Search pages.{% endtrans %}
    2. +
  2. {% trans %}Scroll down to the Search pages section. You will see a list of the already-configured search pages on your site.{% endtrans %}
    3. +
  3. {% trans %}To configure an existing search page, click Edit. Or, to add a new search page, select the Search page type and click Add search page.{% endtrans %}
    4. +
  4. {% trans %}Enter the desired Label name and URL Path for the search page.{% endtrans %}
    5. +
  5. {% trans %}For Content search pages, select the desired level of influence in ranking search results of the available Content ranking factors.{% endtrans %}
    6. +
  6. {% trans %}Click Save. You will be returned to the Search pages page.{% endtrans %}
    7. +
  7. {% trans %}Verify that the correct search page is listed as Default in the Status column. If not, click Set as default in the Opreations list for the correct search page.{% endtrans %}
    8. +
  8. {% trans %}Optionally, disable or delete any search pages that you do not want to have available on the site (disabling is temporary, while deleting is permanent).{% endtrans %}
    9. +
  9. {% trans %}Follow the steps in Managing the search index to make sure that the search index is updated.{% endtrans %}
    10. +
diff --git a/core/modules/help_topics/help_topics/search.index.html.twig b/core/modules/help_topics/help_topics/search.index.html.twig new file mode 100644 index 0000000000..09900f256a --- /dev/null +++ b/core/modules/help_topics/help_topics/search.index.html.twig @@ -0,0 +1,23 @@ +--- +label: 'Managing the search index' +related: + - search.overview + - search.configuring +--- +{% set cron_topic = render_var(url('help.help_topic', {'id': 'core.cron'})) %} +{% set search_settings = render_var(url('entity.search_page.collection')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Manage the search index, and make sure that the site is fully indexed for searching.{% endtrans %}

+

{% trans %}What is the search index?{% endtrans %}

+

{% trans %}The Content and Help search types provided by the core software pre-index their content and store the results in several database tables that are collectively called the search index. The process of indexing renders the content and breaks it up into words, which can then be matched more efficiently with keyword queries when users perform searches. Search indexing happens during cron runs; see Running and configuring cron for more information about cron.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > Search and Metadata > Search pages.{% endtrans %}
    2. +
  2. {% trans %}Under Indexing throttle, select the Number of items to index per cron run. A smaller number will make cron runs faster and reduce the possibility of timeout; a larger number will make sure more of your site is indexed in fewer cron runs.{% endtrans %}
    3. +
  3. {% trans %}Under Default indexing settings, enter the desired Minimum word length to index. Words smaller than this length will be dropped from both keywords when searching and content when indexing.{% endtrans %}
    4. +
  4. {% trans %}If your site uses Chinese, Japanese, or Korean languages, optionally check Simple CJK handling under Default indexing settings to provide some support for these languages.{% endtrans %}
    5. +
  5. {% trans %}Click Save configuration, and you should be returned to the Search pages page.{% endtrans %}
    6. +
  6. {% trans %}Click Re-index site if you have changed the indexing configuration, or later on, if you believe that the search index has been corrupted.{% endtrans %}
    7. +
  7. {% trans %}Follow the steps in Running and configuring cron to make sure a cron task has been configured.{% endtrans %}
    8. +
  8. {% trans %}After waiting for cron to run several times, verify that the content has been fully indexed for searching. The overall status is listed under Indexing progress, and the status for each search page is shown in the Indexing progress column of the Search pages section.{% endtrans %}
    9. +
diff --git a/core/modules/help_topics/help_topics/search.overview.html.twig b/core/modules/help_topics/help_topics/search.overview.html.twig new file mode 100644 index 0000000000..0d958bebab --- /dev/null +++ b/core/modules/help_topics/help_topics/search.overview.html.twig @@ -0,0 +1,28 @@ +--- +label: 'Configuring site search' +top_level: true +related: + - user.permissions + - block.place +--- +{% set search_url = render_var(url('search.view')) %} +{% set user_topic = render_var(url('help.help_topic', {'id': 'user.overview'})) %} +

{% trans %}What modules provide site search?{% endtrans %}

+

{% trans %}The core Search module provides the ability to set up search pages; search pages are provided by other core and contributed modules. The core modules that provide search pages are the Node module (for searching content pages), the User module (for searching user profiles), and the Help module (for searching help topics). As an alternative, you can use contributed modules to provide site search. For example, the Apache Solr and Sphinx contributed modules use third-party technology to provide site search.{% endtrans %}

+

{% trans %}What are search pages?{% endtrans %}

+

{% trans %}The core Search module organizes search into pages. Each page allows users to search a particular type of content with a particular configuration, from a URL path that starts with search. When a user visits the Search page, they will see the configured search pages that they have permission to use as tabs or links; each page has a search form, and will display search results after the user enters keywords into the form and clicks the search button.{% endtrans %}

+

{% trans %}What are the limitations of the core Search module?{% endtrans %}

+

{% trans %}There are two main limitations of the core Search module. First, it is not appropriate for very large sites -- if you have a large site, look into other search technologies like Apache Solr. Second, for content search, it only supports exact keyword matching, which is not the behavior that most users will expect. You can improve this by installing a language-specific stemming module for your language (such as Porter Stemmer for American English), which makes it so that, for example, a search for the word walk would match pages containing the words walk, walking, and walked.{% endtrans %}

+

{% trans %}What are the search permissions?{% endtrans %}

+ +

{% trans %}Configuring site search overview{% endtrans %}

+

{% trans %}In order to configure site search using the core Search module, you will need to set up one or more search pages. You will also need to verify or alter permissions so that the desired user roles can search the site (see Managing user accounts and site visitors for more information about roles and permissions). For content search, you will also need to make sure that the search index is configured and that the site is fully indexed. Finally, you may wish to place the Search form block on pages of your site, or add the search page to a navigation menu, to give users easy access to search. See the related topics listed below for specific tasks.{% endtrans %}

+

{% trans %}Additional resources{% endtrans %}

+