tour.overview.html.twig

Same filename in other branches
  1. 9 core/modules/help_topics/help_topics/tour.overview.html.twig
  2. 8.9.x core/modules/help_topics/help_topics/tour.overview.html.twig
  3. 10 core/modules/tour/help_topics/tour.overview.html.twig
---
label: 'Taking tours of administrative pages'
related:
  - core.ui_components
---

{% trans %}Goal{% endtrans %}

{% trans %}Take a tour of an administrative page.{% endtrans %}

{% trans %}What are tours?{% endtrans %}

{% trans %}The core Tour module provides users with tours, which are guided tours of the administrative interface. Each tour starts on a particular administrative page, and consists of one or more tips that highlight elements of the page, guide you through a workflow, or explain key concepts. Users need Access tour permission to view tours, and JavaScript must be enabled in their browsers.{% endtrans %}

{% trans %}Steps{% endtrans %}

  1. {% trans %}Make sure that the core Tour module is installed, and that you have a role with the Access tour permission. Also, make sure that a toolbar module is installed (either the core Toolbar module or a contributed module replacement).{% endtrans %}
  2. {% trans %}Visit an administrative page that has a tour, such as the edit view page provided by the core Views UI module.{% endtrans %}
  3. {% trans %}Click the Tour button at the right end of the toolbar (left end for right-to-left languages). The first tip of the tour should appear.{% endtrans %}
  4. {% trans %}Click the Next button to advance to the next tip, and End tour at the end to close the tour.{% endtrans %}

File

core/modules/tour/help_topics/tour.overview.html.twig

View source
  1. ---
  2. label: 'Taking tours of administrative pages'
  3. related:
  4. - core.ui_components
  5. ---
  6. <h2>{% trans %}Goal{% endtrans %}</h2>
  7. <p>{% trans %}Take a tour of an administrative page.{% endtrans %}</p>
  8. <h2>{% trans %}What are tours?{% endtrans %}</h2>
  9. <p>{% trans %}The core Tour module provides users with <em>tours</em>, which are guided tours of the administrative interface. Each tour starts on a particular administrative page, and consists of one or more <em>tips</em> that highlight elements of the page, guide you through a workflow, or explain key concepts. Users need <em>Access tour</em> permission to view tours, and JavaScript must be enabled in their browsers.{% endtrans %}</p>
  10. <h2>{% trans %}Steps{% endtrans %}</h2>
  11. <ol>
  12. <li>{% trans %}Make sure that the core Tour module is installed, and that you have a role with the <em>Access tour</em> permission. Also, make sure that a toolbar module is installed (either the core Toolbar module or a contributed module replacement).{% endtrans %}</li>
  13. <li>{% trans %}Visit an administrative page that has a tour, such as the edit view page provided by the core Views UI module.{% endtrans %}</li>
  14. <li>{% trans %}Click the <em>Tour</em> button at the right end of the toolbar (left end for right-to-left languages). The first tip of the tour should appear.{% endtrans %}</li>
  15. <li>{% trans %}Click the <em>Next</em> button to advance to the next tip, and <em>End tour</em> at the end to close the tour.{% endtrans %}</li>
  16. </ol>

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.