Merge pull request #468 from creative-commoners/pulls/5/userhelp-fix

DOC Correct title for userhelp

docs/en/userguide/about-workflows.md

@@ -1,3 +1,6 @@
+---
+title: What is a Workflow?
+---
 # What is a Workflow?
 Workflows enforce content changes to go through approval processes before being published.
 For example, you might have a team of staff who author content, but they are not allowed to publish that content publicly

docs/en/userguide/index.md

@@ -1,5 +1,7 @@
+---
 title: Managing publishing workflows
 summary: Setting up and using a publishing workflow with the Advanced Workflow module.
+---
 
 # Managing publishing workflows
 

docs/en/userguide/setting-up-workflows.md

@@ -1,7 +1,10 @@
+---
+title: Setting up a simple CMS workflow
+---
 # Setting up a simple CMS workflow
 Since workflows can vary greatly across websites, there's no default workflow.
 
-You will need to configure the workflow in the _Workflows_ admin interface. Here, we'll create a simple ‘Review and 
+You will need to configure the workflow in the _Workflows_ admin interface. Here, we'll create a simple ‘Review and
 Approve’ workflow with the following features:
 - 'Content Authors' make a change and request approval from 'Content Publishers'.
 - An email is sent to the Content Publishers for approval.
@@ -11,15 +14,15 @@ Approve’ workflow with the following features:
 ![Flow diagram of advanced workflow objective](_images/advancedworkflow-review-and-approve.jpg)
 
 ## Step 1. Set up user groups
-CMS administrators must first set up user groups to be configured in the Workflow. See 
-[Changing and managing users](https://userhelp.silverstripe.org/en/managing_your_website/changing_and_managing_users/) 
+CMS administrators must first set up user groups to be configured in the Workflow. See
+[Changing and managing users](https://userhelp.silverstripe.org/en/managing_your_website/changing_and_managing_users/)
 for setting up users and groups in the _Security_ left-hand navigation menu item.
 
 For this example workflow set up the following user groups:
  1. Content Authors
 -- The users creating and maintaining content on the website. These users will change content and apply for approval.
  2. Content Publishers
--- The users who will review and approve any content changes on the website before they are published to the live web 
+-- The users who will review and approve any content changes on the website before they are published to the live web
 site.
 
 You must ensure the above user groups have the following _Advanced Workflow_ permissions checked:
@@ -34,17 +37,17 @@ Once your user groups are set, you can apply Workflow actions to these user grou
 
 See [more on workflow permissions.](workflow-permissions.md)
 
-<div class="alert alert-info" markdown="1">Note: Any user with "full administrative rights" set will see all Workflow 
-action buttons in the CMS, plus they will have the ability to draft and publish content regardless of whether or not a 
+<div class="alert alert-info" markdown="1">Note: Any user with "full administrative rights" set will see all Workflow
+action buttons in the CMS, plus they will have the ability to draft and publish content regardless of whether or not a
 workflow is configured on a page.</div>
 
 ## Step 2. Create a workflow definition
-There is no default workflow in SilverStripe CMS since actual workflows vary greatly across web sites and hence one 
+There is no default workflow in SilverStripe CMS since actual workflows vary greatly across web sites and hence one
 must be created.
 
 ### Using a workflow template (optional)
 Workflow provides a simple "Review and Approve" template that can be selected when setting up a workflow definition.
-This is a 2 step workflow (one person authors content and another approves and publishes it) that you can use as a 
+This is a 2 step workflow (one person authors content and another approves and publishes it) that you can use as a
 starting point for more complex workflows.
 Once you have added a template, you will need to configure it with your custom settings.
 
@@ -58,35 +61,35 @@ Now, the workflow must be assigned to users in two areas.
 
 The first is the workflow process itself, that is, which users will be restricted to the workflow.
 
-This is set via the workflow definition ‘Restrict to Users’ or ‘Restrict to Groups’ fields. In this example, we apply 
-the workflow restrictions to Content Authors who wish to make content changes. Select'Content Authors' from the drop 
+This is set via the workflow definition ‘Restrict to Users’ or ‘Restrict to Groups’ fields. In this example, we apply
+the workflow restrictions to Content Authors who wish to make content changes. Select'Content Authors' from the drop
 down.
 
 ![Restrict to users](_images/advancedworkflow-restrictworkflow.png)
 
-Next, you must assign the correct users to each action. For example, when a Content Author triggers the workflow, it is 
+Next, you must assign the correct users to each action. For example, when a Content Author triggers the workflow, it is
 the Content Publishers who must then receive and action the next step in the workflow process.
 
 First select the “Edit” button on the "Apply for approval" action.
 
-For this workflow action, select 'Content Publishers' from the "Groups" dropdown menu. These users will now receive the 
-email notifications of content changes in the workflow, once the “Apply for approval” button is clicked by the Content 
+For this workflow action, select 'Content Publishers' from the "Groups" dropdown menu. These users will now receive the
+email notifications of content changes in the workflow, once the “Apply for approval” button is clicked by the Content
 Authors.
 
-Next, select the "Notify users" action and fill out the "Notification Email". You can use several placeholders to 
-create your email template. Set the "from email", "address", and "subject" fields. See the "Formatting Help" drop down 
+Next, select the "Notify users" action and fill out the "Notification Email". You can use several placeholders to
+create your email template. Set the "from email", "address", and "subject" fields. See the "Formatting Help" drop down
 for help.
 
 ![Notify users](_images/advancedworkflow-notify-users.png)
 
-Repeat these steps for the other actions  - "Assign Initiator Publish", "Notify Initiator Publish", "Assign Initiator 
+Repeat these steps for the other actions  - "Assign Initiator Publish", "Notify Initiator Publish", "Assign Initiator
 Cancel", and "Notify Initiator Cancel" - but this time setting the user to the "Initiator".
 
 ![Assign initiator](_images/advancedworkflow-assign-initiator.png)
 
 ![](_images/advancedworkflow-email-notification.png)
 
-<div class="alert alert-info" markdown="1">You can further restrict certain actions and transitions to specific users, 
+<div class="alert alert-info" markdown="1">You can further restrict certain actions and transitions to specific users,
 if desired, using the “Users” check boxes and the “Restricted users” tabs on transition forms.</div>
 
 ## Step 4. Assign workflows to a page
@@ -101,11 +104,11 @@ To do this:
  4. Select the desired workflow from the "Applied Workflow" drop down
  5. Save your page
 
-Your workflow has now been associated with your page (or section of pages). If you select the _Content_ tab, you should 
-notice a new button available labelled as per your first workflow action. For example, this may read "Apply for 
+Your workflow has now been associated with your page (or section of pages). If you select the _Content_ tab, you should
+notice a new button available labelled as per your first workflow action. For example, this may read "Apply for
 approval".
 
-<div class="alert alert-info" markdown="1">The default workflow selection is "Inherit from parent" so you can 
+<div class="alert alert-info" markdown="1">The default workflow selection is "Inherit from parent" so you can
 assign a workflow to a parent page and each child page will use that workflow without any further configuration.</div>
 
 ![Apply workflow](_images/advancedworkflow-apply-workflow.png)
@@ -114,12 +117,12 @@ assign a workflow to a parent page and each child page will use that workflow wi
 ## Testing and using your new workflow
 
  1. Logout of the CMS and log back in again as your 'Content Author' user.
- 2. Navigate to the page you created in the previous step, enter some text into the "Content" area, select the "Apply 
+ 2. Navigate to the page you created in the previous step, enter some text into the "Content" area, select the "Apply
  for approval" button, now depending on users and groups assigned to your transitions and
-content-permissions. 
- 3. Following this documentation's example, the page should now no longer be editable after refreshing. It will remain 
+content-permissions.
+ 3. Following this documentation's example, the page should now no longer be editable after refreshing. It will remain
  so until it has progressed through the workflow instance to the final Content Publisher's "Publish item" action.
- 
+
 ![](_images/advancedworkflow-readonly.png)
 
 Notice that if you select the "Workflows" left-hand navigation menu item once again, you should see a list of your "Submitted items".
@@ -135,17 +138,17 @@ attention.
 
 Click anywhere on the table row and in the "Next Action" drop-down menu, make your choice as Editor, then select "Save". You can also see a log of the actions.
 
-<div class="alert alert-info" markdown="1"> You are also able to select the blue content-title text to view the page 
-itself within the CMS and manually review the changes before committing to accepting or rejecting them. If you now go 
+<div class="alert alert-info" markdown="1"> You are also able to select the blue content-title text to view the page
+itself within the CMS and manually review the changes before committing to accepting or rejecting them. If you now go
 back to the _Workflow_ left-hand navigation menu item, you'll notice that the items that were in the "Your Pending Items" list, are no longer
 there. This is because the action is now with the users of the "Content Publishers" group.</div>
 
-Logout of the CMS, and login as your "Content Publisher" user. Select the "Workflows" left-hand navigation menu item, 
+Logout of the CMS, and login as your "Content Publisher" user. Select the "Workflows" left-hand navigation menu item,
 and notice that there is a similar list to before, entitled "Your pending items", again with the "Workflow Test" page being the only item. Click on this item and make your selection as manager, and then select
 the "Save" button.
 
-If you were to go and check the edit screen for this page, you'll notice now, having gone through the full workflow, 
-that the action button at the bottom shows "Apply for approval" once again. Logging back-in as a 'Content Author', this 
+If you were to go and check the edit screen for this page, you'll notice now, having gone through the full workflow,
+that the action button at the bottom shows "Apply for approval" once again. Logging back-in as a 'Content Author', this
 user is now able to make further changes.
 
 ## Adding workflow actions (optional)

docs/en/userguide/using-workflows.md

@@ -1,23 +1,26 @@
+---
+title: Using workflows
+---
 # Using workflows
 
 ## Requesting publication (authors)
 
-Depending on the specific permissions content authors have, authors may only have the ability to create or edit content 
+Depending on the specific permissions content authors have, authors may only have the ability to create or edit content
 and to request publication, but not to actually publish content - making it publicly viewable - themselves.
 
- * **Content Author - Non-admin**: To request publication, press the "Apply for Approval" button (or equivalent, 
+ * **Content Author - Non-admin**: To request publication, press the "Apply for Approval" button (or equivalent,
  depending on how your workflow has been setup) in the same bottom menu of the Editing Pane.
  * **Content Publisher - Admin**: You will be asked to add a comment about your edits. This comment will become a part of the audit trail for your content, and we recommend adding this information.
 However, it is not enforced, and you can safely proceed while leaving this field blank.
 
-Depending on how your workflow is setup, users and/or groups configured with "approval" permissions will be alerted via 
-email. They are able to login to the CMS and see your page as a pending approval request when they view the Workflow 
+Depending on how your workflow is setup, users and/or groups configured with "approval" permissions will be alerted via
+email. They are able to login to the CMS and see your page as a pending approval request when they view the Workflow
 lefthand navigation menu item in the CMS. The publisher will then need to review your request and publish it.
 
 ## Approving and publishing content (publishers)
 
-Depending on the setup of workflow, Content Publishers may receive an e-mail when Content Authors have requested 
-publication. Publishers then select the 'Workflow' navigation item to view a report of pending items and by selecting 
-one from the list, are able to access the approval step. In the following screen, the drop-down menu will display the 
-next approval step based on the workflow for this page. Publishers are also able to enter in comments here, detailing 
+Depending on the setup of workflow, Content Publishers may receive an e-mail when Content Authors have requested
+publication. Publishers then select the 'Workflow' navigation item to view a report of pending items and by selecting
+one from the list, are able to access the approval step. In the following screen, the drop-down menu will display the
+next approval step based on the workflow for this page. Publishers are also able to enter in comments here, detailing
 their approval or cancel/deny the approval, if necessary.

docs/en/userguide/workflow-advanced-setup.md

@@ -1,3 +1,6 @@
+---
+title: Advanced Transitions
+---
 # Advanced Transitions
 
 Sometimes an action will have a single transition from itself to the next action; when the workflow begins execution,

docs/en/userguide/workflow-export-import.md

@@ -1,6 +1,9 @@
+---
+title: Importing and exporting workflows
+---
 # Importing and exporting workflows
 
-In the Workflow CMS left-hand navigation menu item, authorised users are able to export a WorkflowDefinition from one 
+In the Workflow CMS left-hand navigation menu item, authorised users are able to export a WorkflowDefinition from one
 SilverStripe installation, and import it into another.
 
 ## Export a workflow
@@ -10,15 +13,15 @@ You should be prompted to download a file which you should save to your local co
 
 ## Import a workflow
 
-Simply login to another SilverStripe installation and navigate to the Workflow Admin of that CMS. You should see an 
+Simply login to another SilverStripe installation and navigate to the Workflow Admin of that CMS. You should see an
 'Import' heading at the bottom of the central CMS pane with a 'Browse' button below that.
 
 Select the 'Browse' button and locate the downloaded file in your computer's file-browser that will automatically appear, then select the
 'Import Definition' button. That's it!
 
 # Exported related user and group data
 
-Because users and groups can be related to Workflow Actions and Transitions, these associations are also exported. 
-However, these relations will only be made at the import stage if the same Groups and/or Users also exist in the target 
-CMS. If the latter is not the case, you will need to manually re-create the users and groups and re-assign them to the 
+Because users and groups can be related to Workflow Actions and Transitions, these associations are also exported.
+However, these relations will only be made at the import stage if the same Groups and/or Users also exist in the target
+CMS. If the latter is not the case, you will need to manually re-create the users and groups and re-assign them to the
 imported workflow.

docs/en/userguide/workflow-permissions.md

@@ -1,9 +1,12 @@
+---
+title: Workflow permissions
+---
 # Workflow permissions
 
 ## Adding groups and users
 
-First of all, login to the CMS as an administrator. Ensure you have "Authors", "Editors" and "Managers" groups created 
-with a single user linked to each group (in the standard "Security" admin). Assign the six "Advanced Workflow" 
+First of all, login to the CMS as an administrator. Ensure you have "Authors", "Editors" and "Managers" groups created
+with a single user linked to each group (in the standard "Security" admin). Assign the six "Advanced Workflow"
 permissions to each group.
 
 ## Workflow permissions
@@ -40,4 +43,4 @@ A user with this permission can reassign active workflows to different users and
 
 ### Editable embargoed item in workflow
 
-A user with this permission can edit items that have been embargoed by a workflow.
+A user with this permission can edit items that have been embargoed by a workflow.