From 0211e1ebee5c981a3e8f6cdf063d988c09bbdb9c Mon Sep 17 00:00:00 2001 From: Lee Rowlands Date: Tue, 22 Jun 2021 06:12:28 +1000 Subject: [PATCH] Issue #3067727 by jhodgdon, batigolix, shetpooja04, NitinLama, Pooja Ganjage, anmolgoyal74, andypost, nitesh624, kishor_kolekar, iyyappan.govind, mrinalini9, Gayathri J, daffie, catch: Convert comment, node, path, taxonomy module hook_help() to topic(s) --- .../help_topics/comment.configuring.html.twig | 43 +++++++++++++++++++ .../comment.creating_type.html.twig | 32 ++++++++++++++ .../help_topics/comment.disabling.html.twig | 28 ++++++++++++ .../help_topics/comment.moderating.html.twig | 34 +++++++++++++++ .../help_topics/comment.overview.html.twig | 29 +++++++++++++ .../node.creating_content.html.twig | 36 ++++++++++++++++ .../help_topics/node.creating_type.html.twig | 36 ++++++++++++++++ .../help_topics/node.editing.html.twig | 39 +++++++++++++++++ .../help_topics/node.overview.html.twig | 19 ++++++++ .../help_topics/path.creating_alias.html.twig | 28 ++++++++++++ .../help_topics/path.editing_alias.html.twig | 26 +++++++++++ .../help_topics/path.overview.html.twig | 24 +++++++++++ .../taxonomy.configuring.html.twig | 36 ++++++++++++++++ .../help_topics/taxonomy.overview.html.twig | 24 +++++++++++ 14 files changed, 434 insertions(+) create mode 100644 core/modules/help_topics/help_topics/comment.configuring.html.twig create mode 100644 core/modules/help_topics/help_topics/comment.creating_type.html.twig create mode 100644 core/modules/help_topics/help_topics/comment.disabling.html.twig create mode 100644 core/modules/help_topics/help_topics/comment.moderating.html.twig create mode 100644 core/modules/help_topics/help_topics/comment.overview.html.twig create mode 100644 core/modules/help_topics/help_topics/node.creating_content.html.twig create mode 100644 core/modules/help_topics/help_topics/node.creating_type.html.twig create mode 100644 core/modules/help_topics/help_topics/node.editing.html.twig create mode 100644 core/modules/help_topics/help_topics/node.overview.html.twig create mode 100644 core/modules/help_topics/help_topics/path.creating_alias.html.twig create mode 100644 core/modules/help_topics/help_topics/path.editing_alias.html.twig create mode 100644 core/modules/help_topics/help_topics/path.overview.html.twig create mode 100644 core/modules/help_topics/help_topics/taxonomy.configuring.html.twig create mode 100644 core/modules/help_topics/help_topics/taxonomy.overview.html.twig diff --git a/core/modules/help_topics/help_topics/comment.configuring.html.twig b/core/modules/help_topics/help_topics/comment.configuring.html.twig new file mode 100644 index 000000000000..2fd76b831d62 --- /dev/null +++ b/core/modules/help_topics/help_topics/comment.configuring.html.twig @@ -0,0 +1,43 @@ +--- +label: 'Configuring comments' +related: + - comment.overview + - comment.creating_type + - comment.disabling + - field_ui.add_field +--- +{% set comment_permissions_link_text %} +{% trans %}Administer comments and comment settings{% endtrans %} +{% endset %} +{% set comment_permissions_link = render_var(help_route_link(comment_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-comment'})) %} +{% set content_structure_topic = render_var(help_topic_link('core.content_structure')) %} +{% set comment_type_topic = render_var(help_topic_link('comment.creating_type')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Configure a content entity type/subtype to allow commenting, using a comment type that you have configured. See {{ content_structure_topic }} for more about content entities and fields, and {{ comment_type_topic }} to configure a comment type.{% endtrans %}

+

{% trans %}Who can configure comments?{% endtrans %}

+

{% trans %}In order to follow these steps, the Field UI module must be installed. You'll need the Comment module's {{ comment_permissions_link }} permission, in order to change comment settings for a comment field. You'll also need to have the appropriate permission for adding fields to the entity type or subtype that the comments are attached to. For example, to add a comment field to content items provided by the Node module, you would need the Node module's Administer content types permission.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}Follow the steps in the related Adding a field to an entity sub-type topic to add a field of type Comments to the desired entity type or sub-type.{% endtrans %}
    2. +
  2. {% trans %}On the first field settings page, choose the Comment type to use for this entity type or sub-type. You'll also notice that the Allowed number of values field cannot be changed for comment fields.{% endtrans %}
    3. +
  3. {% trans %}On the next field settings page, enter the desired settings for the comment field:{% endtrans %} +
      +
    • {% trans %}Threading: whether or not the comments are collected by threads, with people able to reply to particular comments instead of to the content entity itself.{% endtrans %}
      • +
    • {% trans %}Comments per page: the maximum number of comments displayed on one page (a pager will be added if you exceed this limit).{% endtrans %}
      • +
    • {% trans %}Anonymous commenting: whether or not anonymous commenters are allowed or required to leave contact information with their comments (only applies if anonymous users have permission to post comments).{% endtrans %}
      • +
    • {% trans %}Show reply form on the same page as comments: whether the comment reply form is displayed on the same page as the comments. If this is not selected, clicking Reply will open a new page with the reply form.{% endtrans %}
      • +
    • {% trans %}Preview comments: whether previewing comments before submission is Required, Optional, or Disabled.{% endtrans %}
      • +
    • {% trans %}Default value: each individual entity has its own comment settings, but here you can set defaults for the comment settings for this entity type or subtype. The comment settings values are:{% endtrans %} +
        +
      • {% trans %}Open: comments are allowed.{% endtrans %}
        • +
      • {% trans %}Closed: past comments remain visible, but no new comments are allowed.{% endtrans %}
        • +
      • {% trans %}Hidden: past comments are hidden, and no new comments are allowed.{% endtrans %}
        • +
      +
      • +
    +
    4. +
+

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

+ diff --git a/core/modules/help_topics/help_topics/comment.creating_type.html.twig b/core/modules/help_topics/help_topics/comment.creating_type.html.twig new file mode 100644 index 000000000000..0d1e07ff62ca --- /dev/null +++ b/core/modules/help_topics/help_topics/comment.creating_type.html.twig @@ -0,0 +1,32 @@ +--- +label: 'Creating a comment type' +related: + - field_ui.add_field + - field_ui.manage_display + - field_ui.manage_form + - comment.overview + - comment.configuring +--- +{% set comment_types_link_text %} + {% trans %}Comment types{% endtrans %} +{% endset %} +{% set comment_types_link = render_var(help_route_link(comment_types_link_text, 'entity.comment_type.collection')) %} +{% set comment_permissions_link_text %} + {% trans %}Administer comment types and settings{% endtrans %} +{% endset %} +{% set comment_permissions_link = render_var(help_route_link(comment_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-comment'})) %} +{% set comment_overview_topic = render_var(help_topic_link('comment.overview')) %} +{% set content_structure_topic = render_var(help_topic_link('core.content_structure')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Create a new comment type. See {{ comment_overview_topic }} for information about comments and comment types.{% endtrans %}

+

{% trans %}Who can create a comment type?{% endtrans %}

+

{% trans %}Users with the {{ comment_permissions_link }} permission (typically administrators) can create comment types.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Structure > {{ comment_types_link }}.{% endtrans %}
    2. +
  2. {% trans %}Click Add comment type.{% endtrans %}
    3. +
  3. {% trans %}In the Label field, enter a name for the comment type, which is how it will be listed in the administrative interface.{% endtrans %}
    4. +
  4. {% trans %}In the Target entity type field, select the entity type to be commented on. See {{ content_structure_topic }} for more about content entities and fields.{% endtrans %}
    5. +
  5. {% trans %}Click Save. The comment type will be created.{% endtrans %}
    6. +
  6. {% trans %}Optionally, if you have the core Field UI module installed you can follow the steps in the related topics to add fields to the new comment type, set up the editing form, and configure the display.{% endtrans %}
    7. +
diff --git a/core/modules/help_topics/help_topics/comment.disabling.html.twig b/core/modules/help_topics/help_topics/comment.disabling.html.twig new file mode 100644 index 000000000000..77ec431fcec3 --- /dev/null +++ b/core/modules/help_topics/help_topics/comment.disabling.html.twig @@ -0,0 +1,28 @@ +--- +label: 'Disabling comments' +related: + - comment.overview + - comment.configuring +--- +{% set comment_permissions_text %} +{% trans %}Administer comments and comment settings{% endtrans %} +{% endset %} +{% set comment_permissions_link = render_var(help_route_link(comment_permissions_text, 'user.admin_permissions', {}, {'fragment': 'module-comment'})) %} +{% set comment_config_topic = render_var(help_topic_link('comment.configuring')) %} +{% set content_structure_topic = render_var(help_topic_link('core.content_structure')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Turn off commenting for a particular entity (see {{ content_structure_topic }} for more about content entities and fields). Note that if you want to turn off commenting for all entities of an entity type or subtype, you will need to edit the field settings for the comment field; see {{ comment_config_topic }} for more about configuring the comment field.{% endtrans %}

+

{% trans %}Who can disable comments?{% endtrans %}

+

{% trans %}You will need the {{ comment_permissions_link }} permission in order to disable commenting. You will also need permission to edit the entity that the comments are on.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}Find the entity you want to disable comments for, and edit it. For example, to turn off comments on a content item, you could find it by navigating in the Manage administrative menu to Content, filtering to find the content item, and clicking Edit.{% endtrans %}
    2. +
  2. {% trans %}Under Comment settings, select the desired comment setting:{% endtrans %} +
      +
    • {% trans %}Open: comments are allowed.{% endtrans %}
      • +
    • {% trans %}Closed: past comments remain visible, but no new comments are allowed.{% endtrans %}
      • +
    • {% trans %}Hidden: past comments are hidden, and no new comments are allowed.{% endtrans %}
      • +
    +
    3. +
  3. {% trans %}Save the entity.{% endtrans %}
    4. +
diff --git a/core/modules/help_topics/help_topics/comment.moderating.html.twig b/core/modules/help_topics/help_topics/comment.moderating.html.twig new file mode 100644 index 000000000000..6013c033fd0b --- /dev/null +++ b/core/modules/help_topics/help_topics/comment.moderating.html.twig @@ -0,0 +1,34 @@ +--- +label: 'Moderating comments' +related: + - comment.overview + - comment.configuring + - comment.disabling +--- +{% set comment_unpublished_link_text %} + {% trans %}Unapproved comments{% endtrans %} +{% endset %} +{% set comment_unpublished_link = render_var(help_route_link(comment_unpublished_link_text, 'comment.admin_approval')) %} +{% set comment_published_link_text %} + {% trans %}Comments{% endtrans %} +{% endset %} +{% set comment_published_link = render_var(help_route_link(comment_published_link_text, 'comment.admin')) %} +{% set comment_permissions_link_text %} + {% trans %}Administer comments and comment settings{% endtrans %} +{% endset %} +{% set comment_permissions_link = render_var(help_route_link(comment_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-comment'})) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Decide which comments are shown on the website.{% endtrans %}

+

{% trans %}Who can moderate comments?{% endtrans %}

+

{% trans %}Users with the {{ comment_permissions_link }} permission (typically administrators) can moderate comments. You will also need the Access the Content Overview page permission from the Node module (if it is installed) to navigate to the comment management page.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Content > {{ comment_published_link }}. A list of all comments is shown.{% endtrans %}
    2. +
  2. {% trans %}To unpublish comments, select one or more comments by checking the boxes on the left side (right side in right-to-left languages). Then select Unpublish comment from the Action select list and click Apply to selected items. If you select the Delete comment action, you can instead delete the unwanted comments.{% endtrans %}
    3. +
  3. {% trans %}To change the content of a comment click Edit from the dropdown button for a particular comment.{% endtrans %}
    4. +
  4. {% trans %}To publish comments that are not yet visible on the website, navigate to the {{ comment_unpublished_link }} tab. Select one or more comments by checking the boxes on the left side (right side in right-to-left languages). Then select Publish comment from the Action select list and click Apply to selected items.{% endtrans %}
    5. +
+

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

+ diff --git a/core/modules/help_topics/help_topics/comment.overview.html.twig b/core/modules/help_topics/help_topics/comment.overview.html.twig new file mode 100644 index 000000000000..660d3770e1da --- /dev/null +++ b/core/modules/help_topics/help_topics/comment.overview.html.twig @@ -0,0 +1,29 @@ +--- +label: 'Managing comments' +top_level: true +related: + - comment.moderating + - comment.configuring + - comment.creating_type + - comment.disabling + - field_ui.add_field + - field_ui.manage_display + - field_ui.manage_form +--- +{% set content_structure_topic = render_var(help_topic_link('core.content_structure')) %} +{% set users_overview_topic = render_var(help_topic_link('user.overview')) %} +

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

+

{% trans %}A comment is a piece of content, typically posted by a website visitor, which provides discussion or commentary on other content like forum topics, blog posts, and news articles. Comments are a type of content entity, and can have fields that store text, HTML markup, and other data. Comments are attached to other content entities via Comment fields. See {{ content_structure_topic }} for more about content entities and fields.{% endtrans %}

+

{% trans %}What is a comment type?{% endtrans %}

+

{% trans %}Comments are divided into comment types, which are the entity sub-types for the comment entity type. Each comment type has its own fields and its own form and display settings; each type can be used to comment on a single entity type. You can set up different comment types for different commenting purposes on your web site; for example, you might set up a comment type for recipes that has fields "How did it taste?" and "Did the instructions work?", and another comment type for blog entries that has only a generic comment body field.{% endtrans %}

+

{% trans %}What is moderation?{% endtrans %}

+

{% trans %}Moderation is a workflow where comments posted by some users on your site are verified before being published, to prevent spam and other bad behavior. The core software provides basic moderation functionality: you can configure permissions so that new comments posted by some user roles start as unpublished until a user with a different role reviews and publishes them. Contributed modules provide additional moderation and spam-reduction functionality, such as requiring untrusted users pass a CAPTCHA test before submitting comments and letting community members flag comments as possible spam. See {{ users_overview_topic }} for more about users, permissions, and roles.{% endtrans %}

+

{% trans %}Overview of managing comments{% endtrans %}

+

{% trans %}The core Comment module provides the following functionality:{% endtrans %}

+ +

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

diff --git a/core/modules/help_topics/help_topics/node.creating_content.html.twig b/core/modules/help_topics/help_topics/node.creating_content.html.twig new file mode 100644 index 000000000000..ea28358ebb75 --- /dev/null +++ b/core/modules/help_topics/help_topics/node.creating_content.html.twig @@ -0,0 +1,36 @@ +--- +label: 'Creating a content item' +related: + - node.overview + - node.creating_type + - path.creating_alias +--- +{% set content_link_text %} + {% trans %}Content{% endtrans %} +{% endset %} +{% set content_link = render_var(help_route_link(content_link_text, 'system.admin_content')) %} +{% set content_permissions_link_text %} + {% trans %}Access the Content overview page{% endtrans %} +{% endset %} +{% set content_permissions_link = render_var(help_route_link(content_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-node'})) %} +{% set content_overview_topic = render_var(help_topic_link('node.overview')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Create and publish a content item. See {{ content_overview_topic }} for more about content types and content items.{% endtrans %}

+

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

+

{% trans %}Users with the {{ content_permissions_link }} permission can visit the Content page as described in this topic. Each content type has its own create permissions. For example, to create content of type Article, a user would need the Article: Create new content permission. In addition, users with the Bypass content access control or Administer content permission can create content items of all types. Some contributed modules change the permission structure for creating content.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to {{ content_link }}.{% endtrans %}
    2. +
  2. {% trans %}Click Add content.{% endtrans %}
    3. +
  3. {% trans %}If there is more than one content type defined on your site that you have permission to create, click the name of the type of content you want to create.{% endtrans %}
    4. +
  4. {% trans %}On the content edit form, enter the Title of your content, which will show as the page title when the content item is displayed on a page, and also as the label for the content item in administration screens.{% endtrans %}
    5. +
  5. {% trans %}Fill in the other fields shown on the edit form for this specific content type.{% endtrans %}
    6. +
  6. {% trans %}Leave the Published field checked to publish the content immediately, or uncheck it to make it unpublished. Unpublished content is generally not shown to non-administrative site users.{% endtrans %}
    7. +
  7. {% trans %}Optionally, click Preview to preview the content.{% endtrans %}
    8. +
  8. {% trans %}Click Save. You will see the content displayed on a page.{% endtrans %}
    9. +
+

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

+ diff --git a/core/modules/help_topics/help_topics/node.creating_type.html.twig b/core/modules/help_topics/help_topics/node.creating_type.html.twig new file mode 100644 index 000000000000..424b9c8f5f44 --- /dev/null +++ b/core/modules/help_topics/help_topics/node.creating_type.html.twig @@ -0,0 +1,36 @@ +--- +label: 'Creating a content type' +related: + - node.overview + - core.content_structure + - field_ui.add_field + - field_ui.manage_display + - field_ui.manage_form +--- +{% set content_permissions_link_text %} + {% trans %}Administer content types{% endtrans %} +{% endset %} +{% set content_permissions_link = render_var(help_route_link(content_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-node'})) %} +{% set content_types_link_text %} + {% trans %}Content types{% endtrans %} +{% endset %} +{% set content_types_link = render_var(help_route_link(content_types_link_text, 'entity.node_type.collection')) %} +{% set content_overview_topic = render_var(help_topic_link('node.overview')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Create a new content type. See {{ content_overview_topic }} for more about content types.{% endtrans %}

+

{% trans %}Who can create a content type?{% endtrans %}

+

{% trans %}Users with the {{ content_permissions_link }} permission (typically administrators) can create new content types.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Structure > {{ content_types_link }}.{% endtrans %}
    2. +
  2. {% trans %}Click Add content type.{% endtrans %}
    3. +
  3. {% trans %}In the Name field, enter a name for the content type, which is how it will be listed in the administrative interface.{% endtrans %}
    4. +
  4. {% trans %}Optionally, enter a Description for the content type. You may also want to adjust some of the settings in the vertical tabs section of the edit page.{% endtrans %}
    5. +
  5. {% trans %}Click Save and manage fields. Your content type will be created, and assuming you have the core Field UI module installed, you will be taken to the Manage fields page for the content type. (If you do not have the core Field UI module installed, the button will say Save instead.){% endtrans %}
    6. +
  6. {% trans %}If you have the core Field UI module installed, follow the steps in the related topics to add fields to the new content type, set up the editing form, and configure the display.{% endtrans %}
    7. +
+

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

+ diff --git a/core/modules/help_topics/help_topics/node.editing.html.twig b/core/modules/help_topics/help_topics/node.editing.html.twig new file mode 100644 index 000000000000..2c0351aa0df2 --- /dev/null +++ b/core/modules/help_topics/help_topics/node.editing.html.twig @@ -0,0 +1,39 @@ +--- +label: 'Editing a content item' +related: + - node.overview + - node.creating_content +--- +{% set content_link_text %} + {% trans %}Content{% endtrans %} +{% endset %} +{% set content_link = render_var(help_route_link(content_link_text, 'system.admin_content')) %} +{% set content_permissions_link_text %} + {% trans %}Access the Content overview page{% endtrans %} +{% endset %} +{% set content_permissions_link = render_var(help_route_link(content_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-node'})) %} +{% set node_overview_topic = render_var(help_topic_link('node.overview')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Find a content item and edit it, or update a group of content items in bulk. See {{ node_overview_topic }} for more about content types and content items.{% endtrans %}

+

{% trans %}Who can find and edit content?{% endtrans %}

+

{% trans %}Users with the {{ content_permissions_link }} permission can use the Content page to find content. Each content type has its own edit permissions. For example, to edit content of type Article, a user would need the Article: Edit own content permission to edit an article they created, or the Article: Edit any content permission to edit an article someone else created. In addition, users with the Bypass content access control or Administer content permission can edit content items of all types. Some contributed modules change the permission structure for editing content.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to {{ content_link }}.{% endtrans %}
    2. +
  2. {% trans %}Optionally, use filters to reduce the list of content items shown:{% endtrans %} +
      +
    • {% trans %}Title: key word(s) from the title{% endtrans %}
      • +
    • {% trans %}Content type{% endtrans %}
      • +
    • {% trans %}Published status{% endtrans %}
      • +
    • {% trans %}Language{% endtrans %}
      • +
    + {% trans %}If you enter or select filter values, click Filter to apply the filters.{% endtrans %}
    3. +
  3. {% trans %}Optionally, sort the list by clicking a column header. Click again to reverse the order.{% endtrans %}
    4. +
  4. {% trans %}To edit the title or other field values for one content item, click Edit in the row of the content item. Update the values and click Save.{% endtrans %}
    5. +
  5. {% trans %}A few types of edits can be done in bulk to multiple content items. For example, to publish several unpublished content items, check the boxes in the left column (right column in right-to-left languages) to select the desired content items. For Action, select the Publish content action. Click Apply to selected items to make the change. The other actions under Action work in a similar manner.{% endtrans %}
    6. +
+

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

+ diff --git a/core/modules/help_topics/help_topics/node.overview.html.twig b/core/modules/help_topics/help_topics/node.overview.html.twig new file mode 100644 index 000000000000..1f28f60611db --- /dev/null +++ b/core/modules/help_topics/help_topics/node.overview.html.twig @@ -0,0 +1,19 @@ +--- +label: 'Managing content' +top_level: true +related: + - core.content_structure + - field_ui.add_field + - field_ui.manage_display + - field_ui.manage_form + - node.creating_type + - node.creating_content + - node.editing +--- +{% set content_structure_topic = render_var(help_topic_link('core.content_structure')) %} +

{% trans %}What is a content item?{% endtrans %}

+

{% trans %}A content item is a type of content entity for page-level content, which can have fields that store text, HTML markup, images, attached files, and other data. See {{ content_structure_topic }} for more about content entities and fields.{% endtrans %}

+

{% trans %}What is a content type?{% endtrans %}

+

{% trans %}Content items are divided into content types, which are the entity sub-types for the content item entity type; each content type has its own fields and display settings. For example, you might set up content types for pages, articles, recipes, events, and blog entries on your web site.{% endtrans %}

+

{% trans %}Overview of managing content{% endtrans %}

+

{% trans %}The core Node module allows you to define content types, and add and edit content items. The core Field UI module allows you to attach fields to each content type and manage the edit form and display for each content type. See the related topics listed below for specific tasks. Many other core and contributed modules and installation profiles provide pre-defined content types, modify the permission structure for content items, and provide other functionality.{% endtrans %}

diff --git a/core/modules/help_topics/help_topics/path.creating_alias.html.twig b/core/modules/help_topics/help_topics/path.creating_alias.html.twig new file mode 100644 index 000000000000..28162d2e4982 --- /dev/null +++ b/core/modules/help_topics/help_topics/path.creating_alias.html.twig @@ -0,0 +1,28 @@ +--- +label: 'Creating a URL alias for a content item' +related: + - path.overview + - path.editing_alias + - node.creating_content + - node.editing +--- +{% set path_permissions_link_text %} +{% trans %}Create and edit URL aliases{% endtrans %} +{% endset %} +{% set path_permissions_link = render_var(help_route_link(path_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-path'})) %} +{% set overview_topic = render_var(help_topic_link('path.overview')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Give a content item page a human- or SEO-friendly URL alias; you can follow similar steps to create an alias for a taxonomy term page. See {{ overview_topic }} for more about aliases.{% endtrans %}

+

{% trans %}Who can create URL aliases?{% endtrans %}

+

{% trans %}Users with the {{ path_permissions_link }} permission can create aliases. To follow the steps in this topic, you will also need permission to edit the content item.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}Locate and open the content edit form for the content item, or create a new content item (see related topics on creating and editing content).{% endtrans %}
    2. +
  2. {% trans %}Under URL alias on the edit form, enter the desired alias (for example, "/about-us"). Make sure the alias starts with a "/" character.{% endtrans %}
    3. +
  3. {% trans %}Click Save.{% endtrans %}
    4. +
  4. {% trans %}Verify that the page can be visited with the new alias, for example https://example.com/about-us.{% endtrans %}
    5. +
+

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

+ diff --git a/core/modules/help_topics/help_topics/path.editing_alias.html.twig b/core/modules/help_topics/help_topics/path.editing_alias.html.twig new file mode 100644 index 000000000000..518525bed80d --- /dev/null +++ b/core/modules/help_topics/help_topics/path.editing_alias.html.twig @@ -0,0 +1,26 @@ +--- +label: 'Editing a URL alias' +related: + - path.overview + - path.creating_alias +--- +{% set path_permissions_link_text %} + {% trans %}Administer URL aliases{% endtrans %} +{% endset %} +{% set path_permissions_link = render_var(help_route_link(path_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-path'})) %} +{% set path_aliases_link_text %} + {% trans %}URL aliases{% endtrans %} +{% endset %} +{% set path_aliases_link = render_var(help_route_link(path_aliases_link_text, 'entity.path_alias.collection')) %} +{% set path_overview_topic = render_var(help_topic_link('path.overview')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Change an existing URL alias, to correct the path or the alias value. See {{ path_overview_topic }} for more about aliases.{% endtrans %}

+

{% trans %}Who can manage URL aliases?{% endtrans %}

+

{% trans %}Users with the {{ path_permissions_link }} permission can edit aliases.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administration menu, navigate to Configuration > Search and metadata > {{ path_aliases_link }}. A list of all the site's aliases will appear.{% endtrans %}
    2. +
  2. {% trans %}Click Edit in the dropdown button for the alias that you would like to change.{% endtrans %}
    3. +
  3. {% trans %}Make the required changes and click Save. You will be returned to the URL alias list page.{% endtrans %}
    4. +
  4. {% trans %}Note that you can also add new aliases from this page, for any path on your site.{% endtrans %}
    5. +
diff --git a/core/modules/help_topics/help_topics/path.overview.html.twig b/core/modules/help_topics/help_topics/path.overview.html.twig new file mode 100644 index 000000000000..d2982de00466 --- /dev/null +++ b/core/modules/help_topics/help_topics/path.overview.html.twig @@ -0,0 +1,24 @@ +--- +label: 'Configuring aliases for URLs' +top_level: true +related: + - path.creating_alias + - path.editing_alias +--- +

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

+

{% trans %}URL is the abbreviation for "Uniform Resource Locator", which is the page's address on the web. It is the "name" by which a browser identifies a page to display. In the example "Visit us at example.com.", https://example.com would be the URL for the home page of your website. Users use URLs to locate content on the web.{% endtrans %}

+

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

+

{% trans %}A path is the unique, last part of the URL for a specific function or piece of content. For example, for a page whose full URL is https://example.com/node/7, the path is node/7. Here are some examples of paths you might find in your site:{% endtrans %}

+ +

{% trans %}What is an alias?{% endtrans %}

+

{% trans %}The core software allows you to provide more understandable URLs for pages on your site, which are called aliases. For example, if you have an "About Us" page with the path node/7, you can set up an alias of about so that your visitors will see it as https://www.example.com/about.{% endtrans %}

+

{% trans %}Overview of configuring paths, aliases, and URLs{% endtrans %}

+

{% trans %}The core Path module provides the URL aliasing functionality. The contributed Pathauto module allows you to configure automatically-generated URL aliases for content items and other pages. See the related topics listed below for specific tasks.{% endtrans %}

+

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

+ diff --git a/core/modules/help_topics/help_topics/taxonomy.configuring.html.twig b/core/modules/help_topics/help_topics/taxonomy.configuring.html.twig new file mode 100644 index 000000000000..aa032f3d79c8 --- /dev/null +++ b/core/modules/help_topics/help_topics/taxonomy.configuring.html.twig @@ -0,0 +1,36 @@ +--- +label: 'Configuring taxonomy' +related: + - taxonomy.overview + - field_ui.reference_field + - field_ui.manage_display + - field_ui.manage_form +--- +{% set taxonomy_permissions_link_text %} + {% trans %}Administer vocabularies and terms{% endtrans %} +{% endset %} +{% set taxonomy_permissions_link = render_var(help_route_link(taxonomy_permissions_link_text, 'user.admin_permissions', {}, {'fragment': 'module-taxonomy'})) %} +{% set taxonomy_admin_link_text %} + {% trans %}Taxonomy{% endtrans %} +{% endset %} +{% set taxonomy_admin_link = render_var(help_route_link(taxonomy_admin_link_text, 'entity.taxonomy_vocabulary.collection')) %} +{% set taxonomy_overview_topic = render_var(help_topic_link('taxonomy.overview')) %} +{% set content_structure_topic = render_var(help_topic_link('core.content_structure')) %} +

{% trans %}Goal{% endtrans %}

+

{% trans %}Create a taxonomy vocabulary and add a reference field for that vocabulary to a content entity. See {{ taxonomy_overview_topic }} for information about taxonomy and {{ content_structure_topic }} for more on content entities.{% endtrans %}

+

{% trans %}Who can configure a taxonomy vocabulary?{% endtrans %}

+

{% trans %}Users with the {{ taxonomy_permissions_link }} permission can configure a vocabulary. To add a field in the administrative interface, the core Field UI module must be installed, and you will also need the Administer fields permission for the entity you are adding the field to.{% endtrans %}

+

{% trans %}Steps{% endtrans %}

+
    +
  1. {% trans %}In the Manage administrative menu, navigate to Structure > {{ taxonomy_admin_link }}.{% endtrans %}
    2. +
  2. {% trans %}Click Add vocabulary.{% endtrans %}
    3. +
  3. {% trans %}In the Name field, enter a name for the vocabulary (for example "Ingredients"), which is how it will be shown in the administrative interface. Optionally, add a description.{% endtrans %}
    4. +
  4. {% trans %}Click Save. Your vocabulary will be created and you will see the page that lists all the terms in this vocabulary.{% endtrans %}
    5. +
  5. {% trans %}Optionally, click Add term to add a term to the new vocabulary. In the Name field, enter the term name (for example "Butter"). Click Save. You will receive a confirmation about the term you created. You may optionally continue to add more terms.{% endtrans %}
    6. +
  6. {% trans %}If you have the Field UI module installed, follow the instructions on the related Adding a reference field to an entity sub-type topic to add a taxonomy reference field to the entity type of your choice. The settings page will allow you to choose the Vocabulary that you created as the vocabulary to reference.{% endtrans %}
    7. +
  7. {% trans %}You may also want to configure the display and form display of the new field (see related topics).{% endtrans %}
    8. +
+

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

+ diff --git a/core/modules/help_topics/help_topics/taxonomy.overview.html.twig b/core/modules/help_topics/help_topics/taxonomy.overview.html.twig new file mode 100644 index 000000000000..0e4d77bb85b1 --- /dev/null +++ b/core/modules/help_topics/help_topics/taxonomy.overview.html.twig @@ -0,0 +1,24 @@ +--- +label: 'Managing taxonomy' +top_level: true +--- +{% set content_structure_topic = render_var(help_topic_link('core.content_structure')) %} +

{% trans %}What is taxonomy?{% endtrans %}

+

{% trans %}Taxonomy is used to classify website content. One common example of taxonomy is the tags used to classify or categorize posts in a blog website; a cooking website could use an ingredients taxonomy to classify recipes. Individual taxonomy items are known as terms (the blog tags or recipe ingredients in these examples); and a set of terms is known as a vocabulary (the set of all blog post tags, or the set of all recipe ingredients in these examples). Technically, taxonomy terms are an entity type and the entity subtypes are the vocabularies; see {{ content_structure_topic }} for more on content entities. Like other entities, taxonomy terms can have fields attached; for instance, you could set up an image field to contain an icon for each term.{% endtrans %}

+

{% trans %}An individual vocabulary can organize its terms in a hierarchy, or it could be flat. For example, blog tags normally have a flat structure, while a recipe ingredients vocabulary could be hierarchical (for example, tomatoes could be a sub-term of vegetables, and under tomatoes, you could have green and red tomatoes).{% endtrans %}

+

{% trans %}Taxonomy terms are normally attached as reference fields to other content entities, which is how you can use them to classify content. When you set up a taxonomy reference field, you can let users enter terms in two ways:{% endtrans %}

+
+
{% trans %}Free tagging{% endtrans %}
+
{% trans %}New terms can be created right on the content editing form.{% endtrans %}
+
{% trans %}Fixed list of terms{% endtrans %}
+
{% trans %}The list of terms is curated and managed outside the content editing form, and users can only select from the existing list when editing content.{% endtrans %}
+
+

{% trans %}Taxonomy reference fields can be added to any entity, such as user accounts, custom blocks, or regular content items. If you use them to classify regular content items, your site will automatically be set up with taxonomy listing pages for each term; each of these pages lists all of the content items that are classified with that term.{% endtrans %}

+

{% trans %}Overview of managing taxonomy{% endtrans %}

+

{% trans %}The core Taxonomy module allows you to create and edit taxonomy vocabularies and taxonomy terms. The core Field UI module provides a user interface for adding fields to entities, including the taxonomy reference field, and configuring field editing and display. See the related topics listed below for specific tasks.{% endtrans %}

+

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

+