From 608c6bc8fadca0766787e235921f8e8babd8fdad Mon Sep 17 00:00:00 2001 From: webchick Date: Tue, 29 Oct 2019 21:05:47 -0700 Subject: [PATCH] Issue #3072312 by jhodgdon, Amber Himes Matz, andypost: Review/fix/delete existing help topics --- .../help_topics/contextual.overview.html.twig | 19 +++++++++++ .../help_topics/core.config_basic.html.twig | 18 ---------- .../help_topics/core.config_error.html.twig | 14 -------- .../help_topics/core.maintenance.html.twig | 5 --- .../help_topics/core.menu_overview.html.twig | 5 --- .../help_topics/core.security.html.twig | 11 +++++-- .../core.ui_accessibility.html.twig | 7 ++-- .../help_topics/core.ui_components.html.twig | 13 +++++++- .../help_topics/core.ui_contextual.html.twig | 14 -------- .../help_topics/core.ui_tours.html.twig | 9 ----- .../help.help_topic_search.html.twig | 10 +++--- .../help.help_topic_writing.html.twig | 11 ------- .../help_topics/shortcut.overview.html.twig | 19 +++++++++++ .../shortcut.ui_shortcuts.html.twig | 11 ------- .../help_topics/system.config_basic.html.twig | 27 +++++++++++++++ .../help_topics/system.config_error.html.twig | 24 ++++++++++++++ .../help_topics/tour.overview.html.twig | 16 +++++++++ .../user.security_account_settings.html.twig | 33 +++++++++++++++---- .../tests/src/Functional/HelpTopicTest.php | 12 ------- 19 files changed, 162 insertions(+), 116 deletions(-) create mode 100644 core/modules/help_topics/help_topics/contextual.overview.html.twig delete mode 100644 core/modules/help_topics/help_topics/core.config_basic.html.twig delete mode 100644 core/modules/help_topics/help_topics/core.config_error.html.twig delete mode 100644 core/modules/help_topics/help_topics/core.maintenance.html.twig delete mode 100644 core/modules/help_topics/help_topics/core.menu_overview.html.twig delete mode 100644 core/modules/help_topics/help_topics/core.ui_contextual.html.twig delete mode 100644 core/modules/help_topics/help_topics/core.ui_tours.html.twig delete mode 100644 core/modules/help_topics/help_topics/help.help_topic_writing.html.twig create mode 100644 core/modules/help_topics/help_topics/shortcut.overview.html.twig delete mode 100644 core/modules/help_topics/help_topics/shortcut.ui_shortcuts.html.twig create mode 100644 core/modules/help_topics/help_topics/system.config_basic.html.twig create mode 100644 core/modules/help_topics/help_topics/system.config_error.html.twig create mode 100644 core/modules/help_topics/help_topics/tour.overview.html.twig diff --git a/core/modules/help_topics/help_topics/contextual.overview.html.twig b/core/modules/help_topics/help_topics/contextual.overview.html.twig new file mode 100644 index 00000000000..916d193e65e --- /dev/null +++ b/core/modules/help_topics/help_topics/contextual.overview.html.twig @@ -0,0 +1,19 @@ +--- +label: 'Using contextual links' +related: + - core.ui_components +--- +

{% trans %}Goal{% endtrans %}

+

{% trans %}Use contextual links to access administrative tasks without navigating the administrative menu.{% + endtrans %}

+

{% trans %}What are contextual links?{% endtrans %}

+

{% trans %}Contextual links give users with the Use contextual links permission quick access to administrative tasks related to areas of non-administrative pages. For example, if a page on your site displays a block, the block would have a contextual link that would allow users with permission to configure the block. If the block contains a menu or a view, it would also have a contextual link for editing the menu links or the view. Clicking a contextual link takes you to the related administrative page directly, without needing to navigate through the administrative menu system.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}Make sure that the core Contextual Links module is installed, and that you have a role with the Use contextual links permission. Optionally, make sure that a toolbar module is installed (either the core Toolbar module or a contributed module replacement).{% endtrans %}
    2. +
  2. {% trans %}Visit a non-administrative page on your site, such as the home page.{% endtrans %}
    3. +
  3. {% trans %}Locate a block or another area on the page that you want to edit or configure.{% endtrans %}
    4. +
  4. {% trans %}Make the contextual links button visible by hovering your mouse over that area in the page. In most themes, this button looks like a pencil and is placed in the upper right corner of the page area (upper left for right-to-left languages), and hovering will also temporarily outline the affected area. Alternatively, click the contextual links toggle button on the right end of the toolbar (left end for right-to-left languages), which will make all contextual link buttons on the page visible until it is clicked again.{% endtrans %}
    5. +
  5. {% trans %}While the contextual links button for the area of interest is visible, click the button to display the list of links for that area. Click a link in the list to visit the corresponding administrative page.{% endtrans %}
    6. +
  6. {% trans %}Complete your administrative task and save your settings, or cancel the action. You should be returned to the page you started from.{% endtrans %}
    7. +
diff --git a/core/modules/help_topics/help_topics/core.config_basic.html.twig b/core/modules/help_topics/help_topics/core.config_basic.html.twig deleted file mode 100644 index ca423993039..00000000000 --- a/core/modules/help_topics/help_topics/core.config_basic.html.twig +++ /dev/null @@ -1,18 +0,0 @@ ---- -label: 'Changing basic site settings' -top_level: true -related: - - user.security_account_settings ---- -{% set regional_url = render_var(url('system.regional_settings')) %} -{% set information_url = render_var(url('system.site_information_settings')) %} -{% set datetime_url = render_var(url('entity.date_format.collection')) %} -

{% trans %}The settings for your site are configured on various administrative pages, as follows:{% endtrans %}

-
-
{% trans %}Site name, slogan, and email address{% endtrans %}
-
{% trans %}On the Basic site settings page, which you can reach in the main Manage administrative menu, by navigating to Configuration > System > Basic site settings.{% endtrans %}
-
{% trans %}Time zone and country{% endtrans %}
-
{% trans %}On the Regional settings page, which you can reach in the main Manage administrative menu, by navigating to Configuration > Regional and language > Regional settings.{% endtrans %}
-
{% trans %}Date and time formats{% endtrans %}
-
{% trans %}On the Date and time formats page, which you can reach in the main Manage administrative menu, by navigating to Configuration > Regional and language > Date and time formats.{% endtrans %}
-
diff --git a/core/modules/help_topics/help_topics/core.config_error.html.twig b/core/modules/help_topics/help_topics/core.config_error.html.twig deleted file mode 100644 index a8b840ba84f..00000000000 --- a/core/modules/help_topics/help_topics/core.config_error.html.twig +++ /dev/null @@ -1,14 +0,0 @@ ---- -label: 'Configuring error responses, including 403/404 pages' -related: - - core.config_basic - - core.maintenance ---- -{% set log_settings_url = render_var(url('system.logging_settings')) %} -{% set site_settings_url = render_var(url('system.site_information_settings')) %} -

{% trans %}Configuring 403/404 pages{% endtrans %}

-

{% trans %}The core software provides default responses for 403 response (Not Authorized: when someone tries to visit a page they do not have permission to see) and 404 response (Not Found: when someone tries to visit a page that does not exist). You can change what page is displayed for these responses on the Basic site settings page, which you can reach in the main Manage administrative menu, by navigating to Configuration > System > Basic site settings. Note that the pages you want to use must already exist as either system-provided pages or content that you have created.{% endtrans %}

-

{% trans %}Responding to software errors{% endtrans %}

-

{% trans %}Software errors on your site are logged, if you have a logging module installed (such as the core Database Logging module or the core Syslog module). You can configure whether or not error messages are also shown (to both administrators and other site visitors) on the Logging and errors configuration page, which you can reach in the main Manage administrative menu, by navigating to Configuration > Development > Logging and errors.{% endtrans %}

-

{% trans %}Viewing the site log{% endtrans %}

-

{% trans %}If you have the core Database Logging module installed, you can view recent error and informational messages by navigating in the main Manage administrative menu to Reports > Recent log messages. If you are using the core Syslog module for logging, error messages will be logged in your web server''s log files.{% endtrans %}

diff --git a/core/modules/help_topics/help_topics/core.maintenance.html.twig b/core/modules/help_topics/help_topics/core.maintenance.html.twig deleted file mode 100644 index f713192e4e2..00000000000 --- a/core/modules/help_topics/help_topics/core.maintenance.html.twig +++ /dev/null @@ -1,5 +0,0 @@ ---- -label: 'Maintaining and troubleshooting your site' -top_level: true ---- -

{% trans %}The related topics listed here will help you keep your site running and troubleshoot problems.{% endtrans %}

diff --git a/core/modules/help_topics/help_topics/core.menu_overview.html.twig b/core/modules/help_topics/help_topics/core.menu_overview.html.twig deleted file mode 100644 index bb4a2218e2a..00000000000 --- a/core/modules/help_topics/help_topics/core.menu_overview.html.twig +++ /dev/null @@ -1,5 +0,0 @@ ---- -label: 'Defining navigation and URLs' -top_level: true ---- -

{% trans %}The related topics listed here describe how to set up various aspects of site navigation and URLs.{% endtrans %}

diff --git a/core/modules/help_topics/help_topics/core.security.html.twig b/core/modules/help_topics/help_topics/core.security.html.twig index 99e66f55e24..25ef43cf248 100644 --- a/core/modules/help_topics/help_topics/core.security.html.twig +++ b/core/modules/help_topics/help_topics/core.security.html.twig @@ -1,7 +1,12 @@ --- label: 'Making your site secure' top_level: true -related: - - core.menu_overview --- -

{% trans %}The topics listed here will help you make and keep your site secure.{% endtrans %}

+

{% trans %}What are security updates?{% endtrans %}

+

{% trans %}Any software occasionally has bugs, and sometimes these bugs have security implications. When security bugs are fixed in the core software, modules, or themes that your site uses, they are released in a security update. You will need to apply security updates in order to keep your site secure.{% endtrans %}

+

{% trans %}Security tasks{% endtrans %}

+

{% trans %}Keeping track of updates, updating the core software, and updating contributed modules and/or themes are all part of keeping your site secure. See the related topics listed below for specific tasks.{% endtrans %}

+

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

+ diff --git a/core/modules/help_topics/help_topics/core.ui_accessibility.html.twig b/core/modules/help_topics/help_topics/core.ui_accessibility.html.twig index d1f30157ee0..083454fd22d 100644 --- a/core/modules/help_topics/help_topics/core.ui_accessibility.html.twig +++ b/core/modules/help_topics/help_topics/core.ui_accessibility.html.twig @@ -1,10 +1,11 @@ --- -label: 'Accessibility features' +label: 'Accessibility of the administrative interface' related: - core.ui_components --- -

{% trans %}The following features of the administrative user interface may help administrative users with disabilities access your site:{% endtrans %}

+

{% trans %}Overview of accessibility{% endtrans %}

+

{% trans %}The core administrative interface has built-in compliance with many accessibility standards, so that most pages are accessible to most users in their default state. However, certain pages become more accessible to some users through the use of a non-default interface. These replacement interfaces include:{% endtrans %}

{% trans %}Disabling drag-and-drop functionality{% endtrans %}
-
{% trans %}The default drag-and-drop user interface for ordering tables in the administrative interface presents a challenge for some users, including users of screen readers and other assistive technology. The drag-and-drop interface can be disabled in a table by clicking a link labeled Show row weights above the table. The replacement interface allows users to order the table by choosing numerical weights instead of dragging table rows.{% endtrans %}
+
{% trans %}The default drag-and-drop user interface for ordering tables in the administrative interface presents a challenge for some users, including keyboard-only users and users of screen readers and other assistive technology. The drag-and-drop interface can be disabled in a table by clicking a link labeled Show row weights above the table. The replacement interface allows users to order the table by choosing numerical weights (with increasing numbers) instead of dragging table rows.{% endtrans %}
diff --git a/core/modules/help_topics/help_topics/core.ui_components.html.twig b/core/modules/help_topics/help_topics/core.ui_components.html.twig index 0a14a1b61b4..66b67b09763 100644 --- a/core/modules/help_topics/help_topics/core.ui_components.html.twig +++ b/core/modules/help_topics/help_topics/core.ui_components.html.twig @@ -2,4 +2,15 @@ label: 'Using the administrative interface' top_level: true --- -

{% trans %}The related topics listed here describe various aspects of the administrative interface, and tell how to use them.{% endtrans %}

+

{% trans %}Administrative interface overview{% endtrans %}

+

{% trans %}The administrative interface has several components:{% endtrans %}

+ + +

{% trans %}See the related topics listed below for specific tasks.{% endtrans %}

diff --git a/core/modules/help_topics/help_topics/core.ui_contextual.html.twig b/core/modules/help_topics/help_topics/core.ui_contextual.html.twig deleted file mode 100644 index d269556156b..00000000000 --- a/core/modules/help_topics/help_topics/core.ui_contextual.html.twig +++ /dev/null @@ -1,14 +0,0 @@ ---- -label: 'Contextual links' -related: - - core.ui_components ---- -

{% trans %}What are contextual links?{% endtrans %}

-

{% trans %}Contextual links give users with the Use contextual links permission quick access to administrative tasks related to areas of non-administrative pages. For example, if a page on your site displays a block, the block would have a contextual link that would allow users with permission to configure the block. If the block contains a menu or a view, it would also have a contextual link for editing the menu links or the view. Clicking a contextual link takes you to the related administrative page directly, without needing to navigate through the administrative menu system.{% endtrans %}

-

{% trans %}Displaying and using contextual links{% endtrans %}

-

{% trans %}If you have the core Contextual Links module installed, the contextual links related to an area on a page can be displayed by clicking the contextual links button in that area of the page. In most themes, this button looks like a pencil and is placed in the upper right corner of the page area (upper left for right-to-left languages); however, contextual links buttons are normally hidden. Here are two ways to make contextual links buttons visible:{% endtrans %}

- -

{% trans %}While the contextual links button for the area of interest is visible, click the button to display the list of links for that area. Click a link in the list to perform the task.{% endtrans %}

diff --git a/core/modules/help_topics/help_topics/core.ui_tours.html.twig b/core/modules/help_topics/help_topics/core.ui_tours.html.twig deleted file mode 100644 index 4bbaec22098..00000000000 --- a/core/modules/help_topics/help_topics/core.ui_tours.html.twig +++ /dev/null @@ -1,9 +0,0 @@ ---- -label: 'Tours' -related: - - core.ui_components ---- -

{% 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 %}Viewing tours{% endtrans %}

-

{% trans %}If a tour is available on a page, and you have the core Toolbar module installed, a Tour button will appear on the right end of the toolbar (left end for right-to-left languages). Click this button to view the first tip of the tour; click the Next button to advance to the next tip, and End tour at the end to close the tour.{% endtrans %}

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 13ce68fa74f..0dd4d29bf53 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 @@ -2,19 +2,21 @@ label: 'Configuring help search' top_level: true --- +{% set extend_url = render_var(url('system.modules_list')) %} +{% set help_url = render_var(url('help.main')) %}

{% trans %}Goal{% endtrans %}

{% trans %}Set up your site so that users can search for help.{% endtrans %}

{% trans %}Steps{% endtrans %}

    -
  1. {% trans %}From the Extend administrative page (admin/modules), verify that the Search, Help, Help Topics, and Block modules are installed (or install them if they are not already installed).{% endtrans %}
    2. -
  2. {% trans %}In the Manage administrative menu, navigate to Configuration > Search and metadata > Search pages (admin/config/search/pages).{% endtrans %}
    3. +
  3. {% trans %}In the Manage administrative menu, navigate to Extend. Verify that the Search, Help, Help Topics, and Block modules are installed (or install them if they are not already installed).{% endtrans %}
    4. +
  4. {% trans %}In the Manage administrative menu, navigate to Configuration > Search and metadata > Search pages.{% endtrans %}
  5. {% trans %}Verify that a Help search page is listed in the Search pages section. If not, add a new page of type Help.{% endtrans %}
  6. {% trans %}Check the indexing status of the Help search page. If it is not fully indexed, run Cron until indexing is complete.{% endtrans %}
  7. {% trans %}In the future, you can click Rebuild search index on this page, or clear the site cache, in order to force help topic text to be reindexed for searching. This should be done whenever a module, theme, language, or string translation is updated.{% endtrans %}
    8. -
  8. {% trans %}In the Manage administrative menu, navigate to Structure > Block layout (admin/structure/block).{% endtrans %}
    9. +
  9. {% trans %}In the Manage administrative menu, navigate to Structure > Block layout.{% endtrans %}
  10. {% trans %}Click the link for your administrative theme (such as the core Seven theme), near the top of the page.{% endtrans %}
  11. {% trans %}See if there is already a help search block placed in the Help region of your administrative theme.{% endtrans %}
  12. {% trans %}If there is not already a help search block placed, click Place block, and then click Place block in the row next to Search form in the dialog. Choose Help as the search page for the block, and in the Visibility > Pages field, enter /admin/help to make the search form only visible on the main Help page.{% endtrans %}
  13. {% trans %}Fill in the rest of the form and save the block.{% endtrans %}
    14. -
  14. {% trans %}Visit the main Help page (admin/help) to verify that the search block is visible, and try a search.{% endtrans %}
    15. +
  15. {% trans %}In the Manage administrative menu, navigate to Help. Verify that the search block is visible, and try a search.{% endtrans %}
diff --git a/core/modules/help_topics/help_topics/help.help_topic_writing.html.twig b/core/modules/help_topics/help_topics/help.help_topic_writing.html.twig deleted file mode 100644 index b5d1bfd992c..00000000000 --- a/core/modules/help_topics/help_topics/help.help_topic_writing.html.twig +++ /dev/null @@ -1,11 +0,0 @@ ---- -label: 'Writing good help' -top_level: true ---- -

{% trans %}Here are some suggestions for how to make your help topics as useful as possible for readers:{% endtrans %}

- diff --git a/core/modules/help_topics/help_topics/shortcut.overview.html.twig b/core/modules/help_topics/help_topics/shortcut.overview.html.twig new file mode 100644 index 00000000000..683bdee62a4 --- /dev/null +++ b/core/modules/help_topics/help_topics/shortcut.overview.html.twig @@ -0,0 +1,19 @@ +--- +label: 'Creating and using shortcut administrative links' +related: + - core.ui_components +--- +

{% trans %}Goal{% endtrans %}

+

{% trans %}Create, view, and use a set of shortcuts to access administrative pages.{% endtrans %}

+

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

+

{% trans %}Shortcuts are quick links to administrative pages; they are managed by the core Shortcut module. A site can have one or more shortcut sets, which can be shared by one or more users (by default, there is only one set shared by all users); each set contains a limited number of shortcuts. Users need Use shortcuts permission to view shortcuts; Edit current shortcut set permission to add, delete, or edit the shortcuts in the set assigned to them; and Select any shortcut set permission to select a different shortcut set when editing their user profile. There is also an Administer shortcuts permission, which allows an administrator to do any of these actions, as well as select shortcut sets for other users.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}Make sure that the core Shortcut module is enabled, and that you have a role with Edit current shortcut set or Administer shortcuts permission. Also, make sure that a toolbar module is installed (either the core Toolbar module or a contributed module replacement).{% endtrans %}
    2. +
  2. {% trans %}Navigate to an administrative page that you want in your shortcut list.{% endtrans %}
    3. +
  3. {% trans %}Click the shortcut link to add the page to your shortcut list -- in the core Seven administrative theme, the link looks like a star, and is displayed next to the page title. However, if the page is already in your shortcut set, clicking the shortcut link will remove it from your shortcut set.{% endtrans %}
    4. +
  4. {% trans %}Repeat until all the desired links have been added to your shortcut set.{% endtrans %}
    5. +
  5. {% trans %}Click Shortcuts in the toolbar to display your shortcuts, and verify that the list is complete.{% endtrans %}
    6. +
  6. {% trans %}Optionally, click Edit shortcuts at the right end of the shortcut list (left end in right-to-left languages), to remove links or change their order.{% endtrans %}
    7. +
  7. {% trans %}Click any link in the shortcut bar to go directly to the administrative page.{% endtrans %}
    8. +
diff --git a/core/modules/help_topics/help_topics/shortcut.ui_shortcuts.html.twig b/core/modules/help_topics/help_topics/shortcut.ui_shortcuts.html.twig deleted file mode 100644 index 832b89facd0..00000000000 --- a/core/modules/help_topics/help_topics/shortcut.ui_shortcuts.html.twig +++ /dev/null @@ -1,11 +0,0 @@ ---- -label: 'Shortcuts' -related: - - core.ui_components ---- -

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

-

{% trans %}Shortcuts are quick links to administrative pages; they are managed by the core Shortcut module. A site can have one or more shortcut sets, which can be shared by one or more users; each set contains one or more shortcuts. Users need Use shortcuts permission to view shortcuts; Edit current shortcut set permission to add, delete, or edit the shortcuts in the set assigned to them; and Select any shortcut set permission to select a different shortcut set when editing their user profile. There is also an Administer shortcuts permission, which allows an administrator to do any of these actions, and also permits assigning shortcut sets to other users.{% endtrans %}

-

{% trans %}Creating and deleting shortcuts{% endtrans %}

-

{% trans %}When viewing certain administrative pages, you will see a link that allows you to add the page to your current shortcut set. In the core Seven administrative theme, the link looks like a star, and is displayed next to the page title. If the page is already in your shortcut set, you will instead see a link that allows you to remove it.{% endtrans %}

-

{% trans %}Viewing and using shortcuts{% endtrans %}

-

{% trans %}If you have the core Toolbar module installed, click Shortcuts in the toolbar to display your shortcuts. Once they are displayed, click any link in the shortcut bar to go directly to the administrative page. If you are not using the Toolbar module, you can display shortcuts by placing the Shortcuts block in a region of your theme.{% endtrans %}

diff --git a/core/modules/help_topics/help_topics/system.config_basic.html.twig b/core/modules/help_topics/help_topics/system.config_basic.html.twig new file mode 100644 index 00000000000..c1253a2a64a --- /dev/null +++ b/core/modules/help_topics/help_topics/system.config_basic.html.twig @@ -0,0 +1,27 @@ +--- +label: 'Changing basic site settings' +top_level: true +related: + - user.security_account_settings +--- +{% set regional_url = render_var(url('system.regional_settings')) %} +{% set information_url = render_var(url('system.site_information_settings')) %} +{% set datetime_url = render_var(url('entity.date_format.collection')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Configure the basic settings of your site, including the site name, slogan, main email address, default time zone, default country, and the date formats to use.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > System > Basic site settings.{% endtrans %}
    2. +
  2. {% trans %}Enter the site name, slogan, and main email address for your site. {% endtrans %}
    3. +
  3. {% trans %}Click Save configuration. You should see a message indicating that the settings were saved.{% endtrans %}
    4. +
  4. {% trans %}In the Manage administrative menu, navigate to Configuration > Regional and language > Regional settings.{% endtrans %}
    5. +
  5. {% trans %}Select the default country and default time zone for your site.{% endtrans %}
    6. +
  6. {% trans %}Click Save configuration. You should see a message indicating that the settings were saved.{% endtrans %}
    7. +
  7. {% trans %}In the Manage administrative menu, navigate to Configuration > Regional and language > Date and time formats.{% endtrans %}
    8. +
  8. {% trans %}Look at the Patterns for the Default long, medium, and short date formats. If any of them does not match the date format you want to use on your site, click Edit in that row to edit the format.{% endtrans %}
    9. +
  9. {% trans %}Adjust the Format string until the Displayed format matches what you want. (Date format strings are composed of PHP date format codes.){% endtrans %}
    10. +
  10. {% trans %}Click Save format. You should see a message indicating that the format was saved.{% endtrans %}
    11. +
  11. {% trans %}Repeat the previous three steps for any other date formats that need to be changed.{% endtrans %}
    12. +
+

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

+

{% trans %}PHP date format codes reference{% endtrans %}

diff --git a/core/modules/help_topics/help_topics/system.config_error.html.twig b/core/modules/help_topics/help_topics/system.config_error.html.twig new file mode 100644 index 00000000000..c4bed148872 --- /dev/null +++ b/core/modules/help_topics/help_topics/system.config_error.html.twig @@ -0,0 +1,24 @@ +--- +label: 'Configuring error responses, including 403/404 pages' +related: + - system.config_basic +--- +{% set log_settings_url = render_var(url('system.logging_settings')) %} +{% set information_url = render_var(url('system.site_information_settings')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Set up your site to respond appropriately to site errors, including 403 and 404 page responses.{% endtrans %}

+

{% trans %}What are 403 and 404 responses?{% endtrans %}

+

{% trans %}When a user visits a web page, the web server sends a response code in addition to the page content. A normal, non-error response has code 200. If the page does not exist on the site, the response code is 404. If the page exists, but the user is not authorized to visit the page, the response code is 403. The core software provides default responses for both 403 and 404 codes, but if you prefer, you can create your own pages for each.{% endtrans %}

+

{% trans %}What other errors can occur?{% endtrans %}

+

{% trans %}Under some situations, your site can generate error messages. These can be due to user errors (such as entering invalid values in a form, or incorrect configuration), PHP runtime errors, or software bugs. Some errors may result in a white screen of death (a totally blank web page response); less drastic errors will generate error messages. You can configure what happens when an error message is generated.{% endtrans %}

+

{% trans %}Steps {% endtrans %}

+
    +
  1. {% trans %}If desired, create pages to use for 403 and 404 responses. Note the URLs for these pages.{% endtrans %}
    2. +
  2. {% trans %}In the Manage administrative menu, navigate to Configuration > System > Basic site settings.{% endtrans %}
    3. +
  3. {% trans %}In the Error pages section, enter the URL for your 403/403 pages, starting after the site home page URL. For example, if your site URL is https://example.com and your 404 page is https://example.com/not-found, you would enter /not-found.{% endtrans %}
    4. +
  4. {% trans %}Click Save configuration. You should see a message indicating that the settings were saved.{% endtrans %}
    5. +
  5. {% trans %}In the Manage administrative menu, navigate to Configuration > Development > Logging and errors.{% endtrans %}
    6. +
  6. {% trans %}For a production site, select None under Error messages to display. For a site that is in development, select one of the other options, so that you are more aware of the errors the site is generating.{% endtrans %}
    7. +
  7. {% trans %}Click Save configuration. You should see a message indicating that the settings were saved.{% endtrans %}
    8. +
  8. {% trans %}If you have the Database Logging module installed, in the Manage administrative menu, navigate to Reports > Recent log messages to see a report of the error and informational messages your site has generated.{% endtrans %}
    9. +
diff --git a/core/modules/help_topics/help_topics/tour.overview.html.twig b/core/modules/help_topics/help_topics/tour.overview.html.twig new file mode 100644 index 00000000000..af2a19760d1 --- /dev/null +++ b/core/modules/help_topics/help_topics/tour.overview.html.twig @@ -0,0 +1,16 @@ +--- +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. +
  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. +
  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. +
  4. {% trans %}Click the Next button to advance to the next tip, and End tour at the end to close the tour.{% endtrans %}
    5. +
diff --git a/core/modules/help_topics/help_topics/user.security_account_settings.html.twig b/core/modules/help_topics/help_topics/user.security_account_settings.html.twig index fbf5052936d..3898cc9d1ae 100644 --- a/core/modules/help_topics/help_topics/user.security_account_settings.html.twig +++ b/core/modules/help_topics/help_topics/user.security_account_settings.html.twig @@ -1,13 +1,34 @@ --- -label: 'Defining how user accounts are created' +label: 'Configuring how user accounts are created and deleted' related: - core.security --- {% set account_settings_url = render_var(url('entity.user.admin_form')) %} -

{% trans %}On the Account settings page, which you can reach from the Manage administrative menu, by navigating to Configuration > People > Account settings (requires the Administer account settings permission), you can configure several settings related to how user accounts are created:{% endtrans %}

+

{% trans %}Goal{% endtrans %}

+

{% trans %}Configure settings related to how user accounts are created and deleted.{% endtrans %}

+

{% trans %}What are the settings related to user account creation and deletion?{% endtrans %}

+

{% trans %}What are variables in email message text?{% endtrans %}

+

{% trans %}Variables are short text strings, enclosed in square brackets [], that you can insert into configured email message text. When an individual message is generated, data from your site is substituted for the variables. Some commonly-used variables are:{% endtrans %}

+ +

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > People > Account settings.{% endtrans %}
    2. +
  2. {% trans %}Select the method you want to use for creating user accounts, and check or uncheck the box that requires email verification, to match the settings you want for your site.{% endtrans %}
    3. +
  3. {% trans %}Select the desired option for what happens to content that a user created if their account is canceled.{% endtrans %}
    4. +
  4. {% trans %}Optionally, edit the text of email messages related to user accounts.{% endtrans %}
    5. +
  5. {% trans %}Verify that the other settings are correct.{% endtrans %}
    6. +
  6. {% trans %}Click Save configuration. You should see a message indicating that the settings were saved.{% endtrans %}
    7. +
diff --git a/core/modules/help_topics/tests/src/Functional/HelpTopicTest.php b/core/modules/help_topics/tests/src/Functional/HelpTopicTest.php index 0f2a6b40193..957021cf6a6 100644 --- a/core/modules/help_topics/tests/src/Functional/HelpTopicTest.php +++ b/core/modules/help_topics/tests/src/Functional/HelpTopicTest.php @@ -132,18 +132,6 @@ class HelpTopicTest extends BrowserTestBase { $this->container->get('theme_installer')->uninstall(['help_topics_test_theme']); $this->drupalGet('admin/help'); $session->linkNotExists('XYZ Help Test theme'); - - // Verify the Help Topics provided by the Help Topics module for optional - // extensions do not exist. - $this->drupalGet('admin/help/topic/core.ui_components'); - $session->linkNotExists('Shortcuts'); - $session->linkExists('Accessibility features'); - $this->container->get('module_installer')->install(['shortcut']); - $this->drupalGet('admin/help/topic/core.ui_components'); - $session->linkExists('Shortcuts'); - $session->linkExists('Accessibility features'); - $this->clickLink('Shortcuts'); - $session->pageTextContains('What are shortcuts?'); } /**