Skip to content
Snippets Groups Projects
Commit d9dfacd9 authored by catch's avatar catch
Browse files

Issue #3047722 by jhodgdon, shetpooja04, mohrerao, anmolgoyal74, nitesh624,...

Issue #3047722 by jhodgdon, shetpooja04, mohrerao, anmolgoyal74, nitesh624, _m, ankithashetty, batigolix, gaurav.kapoor, daffie, shwetaneelsharma: Convert content_moderation, workflows module hook_help() to topic(s)

(cherry picked from commit b4f1de67)
parent 97f33acf
No related branches found
No related tags found
No related merge requests found
---
label: 'Moving content between workflow states'
related:
- workflows.overview
- content_moderation.configuring_workflows
- core.content_structure
---
{% set workflow_topic = render_var(url('help.help_topic', {'id': 'workflows.overview'})) %}
{% set entity_topic = render_var(url('help.help_topic', {'id': 'core.content_structure'})) %}
{% set content_moderation_permissions = render_var(url('user.admin_permissions', {}, {'fragment': 'module-content_moderation'})) %}
{% set content = render_var(url('system.admin_content')) %}
<h2>{% trans %}Goal{% endtrans %}</h2>
<p>{% trans %}Change the workflow state of a particular entity. See <a href="{{ workflow_topic }}">Managing content moderation workflows</a> for an overview of workflows, and <a href="{{ entity_topic }}">Managing content structure</a> for an overview of content entities.{% endtrans %}</p>
<h2>{% trans %}Who can change workflow states?{% endtrans %}</h2>
<p>{% trans %}Users with the <a href="{{ content_moderation_permissions }}">content moderation permissions</a> can change workflow states. There are separate permissions for each transition.{% endtrans %}</p>
<h2>{% trans %}Steps{% endtrans %}</h2>
<ol>
<li>{% trans %}Find the entity that you want to moderate in either the content moderation view page, if you created one, or the appropriate administrative page for managing that type of entity (such as the <a href="{{ content }}">Content</a> administration page for content items).{% endtrans %}</li>
<li>{% trans %}Click <em>Edit</em> to edit the entity.{% endtrans %}</li>
<li>{% trans %}At the bottom of the page, select the new workflow state under <em>Change to:</em> and click <em>Save</em>.{% endtrans %}</li>
</ol>
---
label: 'Configuring workflows'
related:
- workflows.overview
- content_moderation.changing_states
- core.content_structure
- views_ui.create
---
{% set entities_topic = render_var(url('help.help_topic', {'id': 'core.content_structure'})) %}
{% set user_topic = render_var(url('help.help_topic', {'id': 'user.overview'})) %}
{% set permissions_topic = render_var(url('help.help_topic', {'id': 'user.permissions'})) %}
{% set workflows_overview = render_var(url('help.help_topic', {'id': 'workflows.overview'})) %}
{% set content_moderation_permissions = render_var(url('user.admin_permissions', {}, {'fragment': 'module-content_moderation'})) %}
{% set workflows_permissions = render_var(url('user.admin_permissions', {}, {'fragment': 'module-workflows'})) %}
{% set workflows_url = render_var(url('entity.workflow.collection')) %}
<h2>{% trans %}Goal{% endtrans %}</h2>
<p>{% trans %}Create or edit a workflow with various workflow states (for example <em>Concept</em>, <em>Archived</em>, etc.) for moderating content. See <a href="{{ workflows_overview }}">Content moderation workflows</a> for more information on workflows.{% endtrans %}</p>
<h2>{% trans %}Who can configure a workflow?{% endtrans %}</h2>
<p>{% trans %}Users with the <em><a href="{{ workflows_permissions }}">Administer workflows</a></em> permission (typically administrators) can configure workflows.{% endtrans %}</p>
<h2>{% trans %}Steps{% endtrans %}</h2>
<ol>
<li>{% trans %}Make a plan for the new workflow:{% endtrans %}
<ul>
<li>{% trans %}Decide which workflow states you need; for example, <em>Concept</em>, <em>Review</em>, and <em>Final</em>.{% endtrans %}</li>
<li>{% trans %}Decide on the settings for each state:{% endtrans %}
<ul>
<li>{% trans %}<em>Label</em>: the state name{% endtrans %}</li>
<li>{% trans %}<em>Published</em>: if checked, when content reaches this state it will be made visible on the site (to users with permission).{% endtrans %}</li>
<li>{% trans %}<em>Default revision</em>: if checked, when content reaches this state it will become the default revision of the content; published content is automatically the default revision.{% endtrans %}</li>
</ul>
</li>
<li>{% trans %}Decide which state content should be created in.{% endtrans %}</li>
<li>{% trans %}Decide on the list of allowed transitions between states. For example, you might want a transition between <em>Concept</em> and <em>Review</em>. Each transition has a label; for example, the Concept to Review transition might be labeled "Review concept".{% endtrans %}</li>
<li>{% trans %}Decide which roles should have permissions to make each transition; see <a href="{{ user_topic }}">Managing user accounts and site visitors</a> for an overview of roles and permissions.{% endtrans %}</li>
<li>{% trans %}Decide which <a href="{{ entities_topic }}">entity types</a> and subtypes the workflow should apply to. Only entity types that support revisions are possible to define workflows for.{% endtrans %}</li>
</ul>
</li>
<li>{% trans %}To implement your plan, in the <em>Manage</em> administrative menu, navigate to <em>Configuration</em> &gt; <em>Workflow</em> &gt; <a href="{{ workflows_url}}"><em>Workflows</em></a>. A list of workflows is shown, including the default workflow <em>Editorial</em> that you can adapt.{% endtrans %}</li>
<li>{% trans %}Click <em>Add workflow</em>.{% endtrans %}</li>
<li>{% trans %}Enter a name in the <em>Label</em> field, select <em>Content moderation</em> from the <em>Workflow type</em> field, and click <em>Save</em>.{% endtrans %}</li>
<li>{% trans %}Verify that the <em>States</em> list matches your planned states. You can add missing states by clicking <em>Add a new state</em>. You can edit or delete states by clicking <em>Edit</em> or <em>Delete</em> under <em>Operations</em> (if the <em>Delete</em> option is not available, you will first need to delete any <em>Transitions</em> to or from this state).{% endtrans %}</li>
<li>{% trans %}Verify that the <em>Transitions</em> list matches your plan. You can add missing transitions by clicking <em>Add a new transition</em>. You can edit or delete transitions by clicking <em>Edit</em> or <em>Delete</em> under <em>Operations</em>.{% endtrans %}</li>
<li>{% trans %}Under <em>This workflow applies to:</em>, find the entity type that you want this workflow to apply to, such as Content revisions, Custom block revisions, or Taxonomy term revisions. Click <em>Select</em>.{% endtrans %}</li>
<li>{% trans %}Check the entity subtypes that you want to apply the workflow to. For example, you might choose to apply your workflow to the <em>Page</em> content type, but not to <em>Article</em>.{% endtrans %}</li>
<li>{% trans %}Click <em>Save</em>.{% endtrans %}</li>
<li>{% trans %}Under <em>Workflow settings</em>, select the <em>Default moderation state</em> for new content.{% endtrans %}</li>
<li>{% trans %}Click <em>Save</em> to save your workflow.{% endtrans %}</li>
<li>{% trans %}Follow the steps in <a href="{{ permissions_topic }}">Modifying the permissions for a role</a> to assign permissions for each transition to roles. The permissions are listed under the <em><a href="{{ content_moderation_permissions }}">Content Moderation</a></em> section; there is one permission for each transition in each workflow.{% endtrans %}</li>
<li>{% trans %}Optionally (recommended), create a view for your custom workflow, to provide a page for content editors to see what content needs to be moderated. You can do this if the Views UI module is installed, by following the steps in the related <em>Creating a new view</em> topic listed below under <em>Related topics</em>. When creating the view, under <em>View settings</em> &gt; <em>Show</em>, select the revision data type you configured the workflow for, and be sure to display the <em>Workflow State</em> field in your view.{% endtrans %}</li>
</ol>
---
label: 'Managing content moderation workflows'
top_level: true
related:
- core.content_structure
---
{% set configuring_workflows = render_var(url('help.help_topic', {'id': 'content_moderation.configuring_workflows'})) %}
{% set changing_states = render_var(url('help.help_topic', {'id': 'content_moderation.changing_states'})) %}
<h2>{% trans %}What is a content moderation workflow?{% endtrans %}</h2>
<p>{% trans %}On some sites, new content and content revisions need to be <em>moderated</em>. That is, they need to pass through several <em>states</em> before becoming visible to site visitors. The collection of states and the definition of the transitions between states is known as a <em>workflow</em>. For example, new content might start out in a <em>Draft</em> state, and then might need to pass through several <em>Review</em> states before it becomes <em>Published</em> on the live site.{% endtrans %}</p>
<p>{% trans %}The core software allows you to <a href="{{ configuring_workflows }}">define custom workflows</a> in which each transition has an associated permission that can be granted to a particular role.{% endtrans %}</p>
<p>{% trans %}Users with sufficient permissions can <a href="{{ changing_states }}">move content through the various workflow transitions</a>.{% endtrans %}</p>
<h2>{% trans %}Overview of content moderation workflows{% endtrans %}</h2>
<ul>
<li>{% trans %}The core Content Moderation module allows you to expand on core software's "unpublished" and "published" states for content. It allows you to have a published version that is live, but have a separate working copy that is undergoing review before it is published. This is achieved by using workflows to apply different states and transitions to entities as needed.{% endtrans %}</li>
<li>{% trans %}The core Workflows module allows you to manage workflows with states and transitions.{% endtrans %}</li>
</ul>
<p>{% trans %}See the related topics listed below for specific tasks and background information.{% endtrans %}</p>
<h2>{% trans %}Additional resources{% endtrans %}</h2>
<ul>
<li><a href="https://www.drupal.org/docs/8/core/modules/content-moderation/overview">{% trans %}On-line documentation about Content Moderation{% endtrans %}</a>
</li>
</ul>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment