diff options
author | Matthew Somerville <matthew@mysociety.org> | 2019-10-07 13:36:46 +0100 |
---|---|---|
committer | Matthew Somerville <matthew@mysociety.org> | 2019-10-07 13:51:08 +0100 |
commit | 78a16842647e3ee843e4bbe9286dfdc1994ca2e9 (patch) | |
tree | 61b3cf6a0218de6619bc8c716bc854cd64ee2482 /docs | |
parent | 8cbe1ccebf47a660fdf74cea30db2eee68a310a7 (diff) |
Add some documentation for new admin category form
Diffstat (limited to 'docs')
-rw-r--r-- | docs/_includes/admin-tasks-content.md | 80 | ||||
-rw-r--r-- | docs/_layouts/pro.html | 1 | ||||
-rw-r--r-- | docs/assets/img/pro-user-guide/edit-category-notice.png | bin | 0 -> 70403 bytes | |||
-rw-r--r-- | docs/assets/img/pro-user-guide/edit-category-page.png | bin | 34822 -> 65237 bytes |
4 files changed, 65 insertions, 16 deletions
diff --git a/docs/_includes/admin-tasks-content.md b/docs/_includes/admin-tasks-content.md index 0cc254c8d..860d1f21c 100644 --- a/docs/_includes/admin-tasks-content.md +++ b/docs/_includes/admin-tasks-content.md @@ -564,6 +564,13 @@ that, a form by which you can create new ones. Input a title for the category, and the email address to which reports in that category should be forwarded. When creating a category, these are the only fields required. +You can also choose a variety of options – whether to automatically hide any +reports made in this category, whether to prevent form submission when this +category is selected, or what parent category or categories a particular +category is in. See below for information on <a +href="#creating-editing-notices">creating/editing extra notices and +questions</a> for a category. + You can set up as many or as few categories as you like, and each category can have its own email address attached to it, so for example, reports about potholes may go to one council email address, while reports about road signs go to another. More than one category may share the @@ -593,22 +600,63 @@ ticked.</span> You can edit categories at any time by clicking on their title within the table at the top of the Categories page. -From here, you can: - -- Change the email address that the reports in this category are routed to -- Set the category’s ‘state’ to Confirmed, Unconfirmed, Inactive or Deleted. This can be - useful when categories are discontinued or changed, for example if responsibilities are - transferred to another council, or your own council reconfigures its departments. - - **Confirmed** indicates that the email address has been verified as correct. - - **Inactive** will remove the category from use when reporting problems, but keep it - available in map filters. It’s useful for categories which have been discontinued, - but which you’d still like users to to be able to view data on. - - **Deleted** will remove the category from use, and from map filters. Use this if you - want to discontinue a category and have no need for it to appear on the site. - - **Unconfirmed** is for categories where the attached email address has not been - verified as correct. This option is not commonly used by councils. Reports sent to - unconfirmed categories are not routed to the council; instead, an alert email is - sent to mySociety staff. +From here, you can change the email address that the reports in this category are routed to, +or any of the other options for the category. + +</div> + +<div class="admin-task" markdown="1" id="creating-editing-notices"> + +### Creating and editing category notices and questions + +<div class="boxout" markdown="1"> + +#### Note + +If your FixMyStreet Pro installation has been integrated with a CRM system, some of this +section may not not apply, e.g. extra questions may be pulled directly from the backend. + +</div> + +<span class="admin-task__permissions">Permissions required: User must be marked as staff; “Add/edit problem categories” must be +ticked.</span> + +Each category can have additional notices and questions associated with it, called “Extra data”. +You can add as many as necessary (though we do recommend as few as possible, to stop people +being put off from filling in your form), reorder them, and update them. No extra data answers +are shown in public by default. + +<img alt="Control the extra notices and questions the site displays when a report is made in this category" + src="/assets/img/pro-user-guide/edit-category-notice.png" class="admin-screenshot" /> + +#### Notices + +A notice is some text that is displayed to the user when the category is +selected. This can be used to provide extra information about the category, +point specific cases elsewhere (e.g. a phone number for urgent enquiries), or +anything else you think the reporter may find useful. + +#### Questions + +A question can ask the user to provide some specific additional information +that you require in order to treat the problem appropriately, such as what +specific type of issue is being reported, or some additional details you +require to take the report forward. It can either be a free-text field, or a +drop-down, where you can specify the options to be picked from. + +You can also selectively disable the form submission process based upon a +drop-down question answer - for example, if you had a question asking if the +situation was dangerous, you could disable the form if the reporter answered +Yes and display a message asking the user to ring a number instead. + +#### Hidden/internal data fields + +As well as questions and notices, you can set up hidden and internal data +fields. A hidden data field will be output in the reporting form HTML (so e.g. +clicking on a map asset could fill this field with the asset’s ID), whereas an +internal data field is not output in the HTML (this is for special fields that +your server knows to accept, e.g. different co-ordinate systems, special +handling of textual input, and so on). </div> diff --git a/docs/_layouts/pro.html b/docs/_layouts/pro.html index f305632ff..5a732e64b 100644 --- a/docs/_layouts/pro.html +++ b/docs/_layouts/pro.html @@ -107,6 +107,7 @@ <li><a href="/pro-manual/admin-tasks/#viewing-editing-reports-offline">Viewing and editing reports offline</a></li> <li><a href="/pro-manual/admin-tasks/#adminstrating-staff-accounts">Administrating staff accounts</a></li> <li><a href="/pro-manual/admin-tasks/#creating-editing-categories">Creating and editing categories</a></li> + <li><a href="/pro-manual/admin-tasks/#creating-editing-notices">Creating and editing category notices/questions</a></li> <li><a href="/pro-manual/admin-tasks/#creating-editing-priorities">Creating and editing priorities</a></li> <li><a href="/pro-manual/admin-tasks/#creating-editing-response-templates">Creating and editing response templates</a></li> <li><a href="/pro-manual/admin-tasks/#view-statistics">Viewing statistics</a></li> diff --git a/docs/assets/img/pro-user-guide/edit-category-notice.png b/docs/assets/img/pro-user-guide/edit-category-notice.png Binary files differnew file mode 100644 index 000000000..67042ea1a --- /dev/null +++ b/docs/assets/img/pro-user-guide/edit-category-notice.png diff --git a/docs/assets/img/pro-user-guide/edit-category-page.png b/docs/assets/img/pro-user-guide/edit-category-page.png Binary files differindex 385633431..8b029faa0 100644 --- a/docs/assets/img/pro-user-guide/edit-category-page.png +++ b/docs/assets/img/pro-user-guide/edit-category-page.png |