refactor: #3565822 Move mention of Search from core help to search module

label: 'Working with help topics'

top_level: true

related:

- help.help_topic_search

- locale.translate_strings

---

{% set help_link_text %}{% trans %}Help{% endtrans %}{% endset %}

{% set help_link = render_var(help_route_link(help_link_text, 'help.main')) %}

{% set translate_text %}{% trans %}User interface translation{% endtrans %}{% endset %}

{% set translate_link = render_var(help_route_link(translate_text, 'locale.translate_page')) %}

{% set help_search_topic = render_var(help_topic_link('help.help_topic_search')) %}

<h2>{% trans %}What is a help topic?{% endtrans %}</h2>

<p>{% trans %}A help topic describes a concept, or steps to accomplish a task, related to a feature provided by one or more modules or themes. If the core Search module is enabled, these topics are also searchable.{% endtrans %}</p>

<p>{% trans %}A help topic describes a concept, or steps to accomplish a task, related to a feature provided by one or more modules or themes.{% endtrans %}</p>

<h2>{% trans %}Where are help topics listed?{% endtrans %}</h2>

<p>{% trans %}The top-level help topics are listed at {{ help_link }}. Links to other topics, including non-top-level help topics, can be found under the "Related" heading when viewing a topic page.{% endtrans %}</p>

<h2>{% trans %}How are help topics provided?{% endtrans %}</h2>

<h2>{% trans %}How are help topics translated?{% endtrans %}</h2>

<p>{% trans %}The title and body text of help topics provided by contributed modules and themes are translatable using {{ translate_link }} (provided by Interface Translation module). Topics provided by custom modules and themes are also translatable if they have been viewed at least once in a non-English language, which triggers putting their translatable text into the translation database.{% endtrans %}</p>

<h2>{% trans %}How can users search for help topics?{% endtrans %}</h2>

<p>{% trans %}To enable users to search help, including help topics, you will need to install the core Search module, configure a search page, and add a search block to the Help page or another administrative page. (A search page is provided automatically, and if you use the core Claro administrative theme, a help search block is shown on the main Help page.) Then users with search permissions, and permission to view help, will be able to search help. See the related topic, {{ help_search_topic }}, for step-by-step instructions.{% endtrans %}</p>

<p>{% trans %}To enable users to search help, including help topics, you will need to install a contributed Search module, configure a search page, and add a search block to the Help page or another administrative page. Then users with search permissions, and permission to view help, will be able to search help.{% endtrans %}</p>

<h2>{% trans %}Additional resources{% endtrans %}</h2>

<ul>

  <li><a href="https://www.drupal.org/node/3074421">{% trans %}Help Topics Standards{% endtrans %}</a></li>

{% set search_link = render_var(help_route_link(search_link_text, 'search.view')) %}

{% set user_overview_topic = render_var(help_topic_link('user.overview')) %}

<h2>{% trans %}What are search pages?{% endtrans %}</h2>

<p>{% trans %}The core Search module organizes site search into <em>pages</em>. Each page allows users to search a particular type of content with a particular configuration. The configuration includes specifying a URL that starts with <em>search</em>, a name for the page, and additional options for some search page types.{% endtrans %}</p>

<p>{% trans %}The Search module organizes site search into <em>pages</em>. Each page allows users to search a particular type of content with a particular configuration. The configuration includes specifying a URL that starts with <em>search</em>, a name for the page, and additional options for some search page types.{% endtrans %}</p>

<p>{% trans %}When users visit the main search page (see {{ search_link }}), they will see the configured search pages that they have access to. Each search page has a search form on it, and the page will display search results after the user enters keywords into the form and clicks the search button.{% endtrans %}</p>

<h2>{% trans %}What modules provide site search?{% endtrans %}</h2>

<p>{% trans %}The core Search module provides the ability to configure search pages; search page types are provided by both core and contributed modules. The core modules that provide search page types are:{% endtrans %}</p>

<p>{% trans %}The Search module provides the ability to configure search pages; search page types are provided by both core and contributed modules. The core modules that provide search page types are:{% endtrans %}</p>

<ul>

  <li>{% trans %}The Node module, for searching content pages{% endtrans %}</li>

  <li>{% trans %}The User module, for searching user profiles{% endtrans %}</li>

  <li>{% trans %}The Help module, for searching help topics{% endtrans %}</li>

</ul>

<p>{% trans %}As an alternative to the core Search module's system of search pages, you can use contributed modules to provide site search. For example, the <a href="https://www.drupal.org/project/apachesolr">Apache Solr</a> and <a href="https://www.drupal.org/project/sphinx">Sphinx</a> contributed modules use third-party technology to provide site search.{% endtrans %}</p>

<h2>{% trans %}What are the limitations of the core Search module?{% endtrans %}</h2>

<p>{% 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, the Node search page type 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 <a href="https://www.drupal.org/project/porterstemmer">Porter Stemmer</a> 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 %}</p>

<p>{% trans %}As an alternative to the Search module's system of search pages, you can use contributed modules to provide site search. For example, the <a href="https://www.drupal.org/project/apachesolr">Apache Solr</a> and <a href="https://www.drupal.org/project/sphinx">Sphinx</a> contributed modules use third-party technology to provide site search.{% endtrans %}</p>

<h2>{% trans %}What are the limitations of the Search module?{% endtrans %}</h2>

<p>{% trans %}There are two main limitations of the 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, the Node search page type 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 <a href="https://www.drupal.org/project/porterstemmer">Porter Stemmer</a> 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 %}</p>

<h2>{% trans %}What are the search permissions?{% endtrans %}</h2>

<ul>

<li>{% trans %}Users with <em>Use search</em> permission can use the <em>Search form</em> block and <em>Search</em> page; this permission is required for any search configured in the core Search module.{% endtrans %}</li>

<li>{% trans %}Users with <em>Use search</em> permission can use the <em>Search form</em> block and <em>Search</em> page; this permission is required for any search configured in the Search module.{% endtrans %}</li>

<li>{% trans %}In addition to <em>Use search</em>, <em>View user information</em> permission is needed for searching users.{% endtrans %}</li>

<li>{% trans %}In addition to <em>Use search</em>, <em>View published content</em> permission is needed for searching content.{% endtrans %}</li>

<li>{% trans %}Users with <em>Use advanced search</em> permission can use more complex search filtering when performing content searches.{% endtrans %}</li>

</ul>

<h2>{% trans %}Configuring site search overview{% endtrans %}</h2>

<p>{% trans %}In order to configure site search using the core Search module, you will need to configure 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 {{ user_overview_topic }} 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 <em>Search form</em> 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 %}</p>

<p>{% trans %}In order to configure site search using the Search module, you will need to configure 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 {{ user_overview_topic }} 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 <em>Search form</em> 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 %}</p>

<h2>{% trans %}Additional resources{% endtrans %}</h2>

<ul>

  <li>{% trans %}<a href="https://www.drupal.org/documentation/modules/search">Online documentation for the Search module</a>{% endtrans %}</li>