From 0f7faa63871307cba472f850fe94eb85c80f21f4 Mon Sep 17 00:00:00 2001 From: Lee Rowlands Date: Tue, 22 Jun 2021 17:26:51 +1000 Subject: [PATCH] Issue #3095739 by jhodgdon, siddhant.bhosale, pratik_kamble, andypost, ayushmishra206, SenthilMohith, kleiton_rodrigues, daffie, catch, snehalgaikwad: Convert admin UI-related modules: contextual, help, inline_form_errors, quickedit, settings_tray, shortcut, toolbar, tour module hook_help() to topic(s) --- .../help_topics/core.quick_edit.html.twig | 19 ++++++++++++++ .../core.ui_accessibility.html.twig | 4 ++- .../help_topics/core.ui_components.html.twig | 26 +++++++++++++++---- 3 files changed, 43 insertions(+), 6 deletions(-) create mode 100644 core/modules/help_topics/help_topics/core.quick_edit.html.twig diff --git a/core/modules/help_topics/help_topics/core.quick_edit.html.twig b/core/modules/help_topics/help_topics/core.quick_edit.html.twig new file mode 100644 index 00000000000..21d22d55dc6 --- /dev/null +++ b/core/modules/help_topics/help_topics/core.quick_edit.html.twig @@ -0,0 +1,19 @@ +--- +label: 'Using in-line (quick) editing' +related: + - core.ui_components +--- +

{% trans %}Goal{% endtrans %}

+

{% trans %}Edit content or settings in place.{% endtrans %}

+

{% trans %}What is quick editing?{% endtrans %}

+

{% trans %}Quick editing is editing either content or settings inline. Content quick editing is provided by the core Quick Edit module, and settings quick editing is provided by the core Settings Tray module; both of them require the core Contextual Links module in order to expose the links that let you edit in place.{% endtrans %}

+

{% trans %}Who can edit content and settings in place?{% endtrans %}

+

{% trans %}In order to follow these steps to edit content in place, the core Quick Edit module must be installed; to edit settings, the core Settings Tray module must be installed. Also, either the core Toolbar module or a contributed replacement must be installed. You will need to have Use contextual links permission, as well as permission to edit the particular content or settings.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}Find and visit a page on your site that has either content or settings that you would like to edit.{% endtrans %}
    2. +
  2. {% trans %}Click the contextual links Edit button on the toolbar (in most themes, it looks like a pencil). Contextual Edit links with the same icon will appear all over your page.{% endtrans %}
    3. +
  3. {% trans %}Find the contextual link for the part of the page you want to edit. For example, if you want to edit the settings for a block, the link should be in the top-right corner of the block, or top-left for right-to-left languages.{% endtrans %}
    4. +
  4. {% trans %}Click the link to open the contextual links menu, and click Quick edit. An editing form for the settings or content should appear on the page.{% endtrans %}
    5. +
  5. {% trans %}Make your edits and submit the form.{% endtrans %}
    6. +
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 083454fd22d..b848f7b346d 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 @@ -4,8 +4,10 @@ related: - core.ui_components ---

{% 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 %}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 or improved interface. These 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 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 %}
+
{% trans %}Enabling inline form errors{% endtrans %}
+
{% trans %}Errors that occur when you submit a form, such as not filling in a required field, are sometimes difficult for users to understand and locate. In order to make these errors easier to find, the best practice is to put a summary of the errors at the top of the form page. To make them easier to understand, the best practice is to display error messages with the form fields they are related to. Both of these practices are implemented by the core Inline Form Errors module.{% 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 f8aab0dd46a..503b0e91f58 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 @@ -4,15 +4,31 @@ top_level: true related: - block.overview --- -

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

-

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

+{% set accessibility_topic = render_var(help_topic_link('core.ui_accessibility')) %} +{% set quick_edit_topic = render_var(help_topic_link('core.quick_edit')) %} +{% set admin_link = render_var(help_route_link('/admin', 'system.admin')) %} +

{% trans %}What administrative interface components are available?{% endtrans %}

+

{% trans %}The following administrative interface components are provided by Drupal core and its modules (some contributed modules offer additional functionality):{% endtrans %}

- -

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

+

{% trans %}What are the sections of the administrative menu?{% endtrans %}

+

{% trans %}The administrative menu, which you can navigate by visiting {{ admin_link }} on your site or by using an administrative toolbar, has the following sections (some may not be available, depending on which modules are currently installed on your site, and your permissions):{% endtrans %}

+ +

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

+

{% trans %}Install the core modules mentioned above to use the corresponding aspect of the administrative interface. See the related topics listed below for more details on some aspects of the administrative interface.{% endtrans %}