From f29f4a3cf99300010abbe4c2ccc0f1a15114a667 Mon Sep 17 00:00:00 2001 From: Lee Rowlands Date: Tue, 22 Jun 2021 08:29:05 +1000 Subject: [PATCH] Issue #3094482 by jhodgdon, shetpooja04, Amber Himes Matz, andypost, pritish.kumar, ankithashetty, batigolix, catch: Convert action module hook_help() to topic(s), including views bulk operations --- .../help_topics/action.creating.html.twig | 28 +++++++++++++++++ .../help_topics/action.overview.html.twig | 25 ++++++++++++++++ .../help_topics/views.overview.html.twig | 7 ++++- .../views_ui.bulk_operations.html.twig | 30 +++++++++++++++++++ 4 files changed, 89 insertions(+), 1 deletion(-) create mode 100644 core/modules/help_topics/help_topics/action.creating.html.twig create mode 100644 core/modules/help_topics/help_topics/action.overview.html.twig create mode 100644 core/modules/help_topics/help_topics/views_ui.bulk_operations.html.twig diff --git a/core/modules/help_topics/help_topics/action.creating.html.twig b/core/modules/help_topics/help_topics/action.creating.html.twig new file mode 100644 index 00000000000..d4f96168fd2 --- /dev/null +++ b/core/modules/help_topics/help_topics/action.creating.html.twig @@ -0,0 +1,28 @@ +--- +label: 'Creating an advanced action' +related: + - action.overview + - views_ui.bulk_operations +--- +{% set actions_link_text %} + {% trans %}Actions{% endtrans %} +{% endset %} +{% set actions = render_var(help_route_link(actions_link_text, 'entity.action.collection')) %} +{% set action_permissions_link_text %} + {% trans %}Administer actions{% endtrans %} +{% endset %} +{% set action_permissions = render_var(help_route_link(action_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-action'})) %} +{% set action_overview = render_var(help_topic_link('action.overview')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Create an advanced action. You can, for example, create an action to change the author of multiple content items. See {{ action_overview }} for more about actions.{% endtrans %}

+

{% trans %}Who can create actions?{% endtrans %}

+

{% trans %}Users with the {{ action_permissions }} permission (typically administrators) can create actions.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Configuration > System > {{ actions }}. A list of all actions is shown.{% endtrans %}
    2. +
  2. {% trans %}Choose an advanced action from the dropdown and click Create.{% endtrans %}
    3. +
  3. {% trans %}Enter a name for the action in the Label field. This label will be visible for the user.{% endtrans %}
    4. +
  4. {% trans %}Configure any of the other available options. These will depend on the kind of action that you have chosen.{% endtrans %}
    5. +
  5. {% trans %}Click Save. You will be returned to the list of actions, with your new action added to the list.{% endtrans %}
    6. +
  6. {% trans %}To edit an action you have previously created, click Configure in the Operations drop-down list. To delete an action you have previously created, click Delete in the Operations drop-down list.{% endtrans %}
    7. +
diff --git a/core/modules/help_topics/help_topics/action.overview.html.twig b/core/modules/help_topics/help_topics/action.overview.html.twig new file mode 100644 index 00000000000..d3c5642ba32 --- /dev/null +++ b/core/modules/help_topics/help_topics/action.overview.html.twig @@ -0,0 +1,25 @@ +--- +label: 'Configuring actions' +top_level: true +related: + - views.overview + - views_ui.bulk_operations +--- +{% set actions_link_text %} + {% trans %}Actions page{% endtrans %} +{% endset %} +{% set actions_page = render_var(help_route_link(actions_link_text, 'entity.action.collection')) %} +

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

+

{% trans %}Actions are module-defined tasks that can be executed on the site; for example, unpublishing content, sending an email message, or blocking a user.{% endtrans %}

+

{% trans %}What are simple actions?{% endtrans %}

+

{% trans %}Simple actions do not require configuration. They are automatically available to be executed, and are always listed as available on the {{ actions_page }}.{% endtrans %}

+

{% trans %}What are advanced actions?{% endtrans %}

+

{% trans %}Advanced actions require configuration. Before they are available for listing and execution, they need to be created and configured. For example, for an action that sends e-mail, you would need to configure the e-mail address.{% endtrans %}

+

{% trans %}How are actions executed?{% endtrans %}

+

{% trans %}In the core software, actions can be executed through a bulk operations form added to a view; if you have the core Views module installed, see the related topic "Managing content listings (views)" for more information about views and bulk operations.{% endtrans %}

+

{% trans %}Configuring actions overview{% endtrans %}

+

{% trans %}The core Actions module provides a user interface for listing and configuring actions. The core Views UI module provides a user interface for creating views, which may include bulk operations forms for executing actions. See the related topics listed below for specific tasks.{% endtrans %}

+

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

+ diff --git a/core/modules/help_topics/help_topics/views.overview.html.twig b/core/modules/help_topics/help_topics/views.overview.html.twig index a039f6ce7c0..0e93040e452 100644 --- a/core/modules/help_topics/help_topics/views.overview.html.twig +++ b/core/modules/help_topics/help_topics/views.overview.html.twig @@ -3,6 +3,9 @@ label: 'Managing content listings (views)' top_level: true related: - block.overview + - views_ui.bulk_operations + - action.overview + - user.overview ---

{% trans %}What is a view?{% endtrans %}

{% trans %}A view is a listing of items on your site; for example, a block showing the most recent comments, a page listing news items, or a list of registered users. The listings can be formatted in a table, grid, list, calendar, RSS feed, and other formats (some output formats may require you to install additional contributed modules).{% endtrans %}

@@ -14,7 +17,7 @@ related:
  • {% trans %}Fields: if the Format allows, the particular fields to display.{% endtrans %}
  • {% trans %}Filter criteria: criteria to limit the data to output, such as whether the content is published, the type of content, etc. Filters can be exposed to let users choose how to filter the data.{% endtrans %}
  • {% trans %}Sort criteria: how to order the data. Sorting can also be exposed to users.{% endtrans %}
    • -
  • {% trans %}Page settings, Block settings, etc.: settings specific to the display type, such as the URL for a page display.{% endtrans %}
    • +
  • {% trans %}Page settings, Block settings, etc.: settings specific to the display type, such as the URL for a page display. Most display types support an Access setting, where you can choose a Permission or Role that a user must have in order to see the view.{% endtrans %}
  • {% trans %}Header and Footer: content to display at the top or bottom of the view display.{% endtrans %}
  • {% trans %}No results behavior: what to do if the filter criteria result in having no data to display.{% endtrans %}
  • {% trans %}Pager: how many items to display, and how to paginate if there are additional items to display.{% endtrans %}
    • @@ -22,6 +25,8 @@ related:
  • {% trans %}Advanced > Relationships: additional data to pull in and display, related in some way to the base data of the view (such as data about the user who created the content item).{% endtrans %}
  • {% trans %}Advanced > Exposed form: if you have exposed filters or sorts, how to display the form to the user.{% endtrans %}
    • +

    {% trans %}What are bulk operations?{% endtrans %}

    +

    {% trans %}Views using a table display format can include a bulk operations form, which allows users with sufficient permission to select one or more items from the view and apply an administrative action to them. The bulk actions available are specific to the base data type of the view; for example, a view of content items could support bulk publishing and unpublishing actions. If you have the core Actions module installed, see the related topic "Configuring actions" for more about actions.{% endtrans %}

    {% trans %}Managing views overview{% endtrans %}

    {% trans %}The core Views module handles the display of views, and the core Views UI module allows you to create, edit, and delete views in the administrative interface. See the related topics listed below for specific tasks (if the Views UI module is installed).{% endtrans %}

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

    diff --git a/core/modules/help_topics/help_topics/views_ui.bulk_operations.html.twig b/core/modules/help_topics/help_topics/views_ui.bulk_operations.html.twig new file mode 100644 index 00000000000..2ccf9af4fe6 --- /dev/null +++ b/core/modules/help_topics/help_topics/views_ui.bulk_operations.html.twig @@ -0,0 +1,30 @@ +--- +label: 'Adding a bulk operations form to a view' +related: + - action.overview + - action.creating + - views.overview + - views_ui.create + - user.overview +--- +{% set views_link_text %} + {% trans %}Views{% endtrans %} +{% endset %} +{% set views = render_var(help_route_link(views_link_text, 'entity.view.collection')) %} +{% set views_permissions_link_text %} + {% trans %}Administer views{% endtrans %} +{% endset %} +{% set views_permissions = render_var(help_route_link(views_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-views_ui'})) %} +

    {% trans %}Goal{% endtrans %}

    +

    {% trans %}Add one or more existing actions as bulk operations to an existing table-style view. If you have the core Actions module installed, see the related topic "Configuring actions" for more information about actions.{% endtrans %}

    +

    {% trans %}Who can edit views?{% endtrans %}

    +

    {% trans %}The core Views UI module will need to be installed and you will need {{ views_permissions }} permission in order to edit a view.{% endtrans %}

    +

    {% trans %}Steps{% endtrans %}

    +
      +
    1. {% trans %}In the Manage administrative menu, navigate to Structure > {{ views }}. A list of all views is shown.{% endtrans %}
      2. +
    2. {% trans %}Find the view that you would like to edit, and click Edit from the the dropdown button. Note that bulk operations work best in a view with a Page display, and a Table format.{% endtrans %}
      3. +
    3. {% trans %}If there is not already an Operations bulk form in the Fields list for the view, click Add in the Fields section to add it. (The exact name of the bulk form field will vary, and may contain keywords like "bulk update", "form element" or "operations" -- not to be confused with operations links, which are applied to each item in a row.) If the bulk operations field already exists, click the field name to edit its settings.{% endtrans %}
      4. +
    4. {% trans %}Check the action(s) you want to make available in the Selected actions list and click Apply (all displays).{% endtrans %}
      5. +
    5. {% trans %}Verify that the Access settings for the view are at least as restrictive as the permissions necessary to perform the bulk operations. People with permission to see the view, but who don't have permission to do the bulk operations, will experience problems.{% endtrans %}
      6. +
    6. {% trans %}Click Save. The action(s) will be available as bulk operations in the view.{% endtrans %}
      7. +