diff --git a/docs/en/modules/ROOT/nav.adoc b/docs/en/modules/ROOT/nav.adoc index 77717bfd6..67c1d9454 100644 --- a/docs/en/modules/ROOT/nav.adoc +++ b/docs/en/modules/ROOT/nav.adoc @@ -133,8 +133,12 @@ *** xref:admin:features/versions.adoc[Versions] ** xref:admin:newsletters.adoc[Newsletters] ** xref:admin:global_moderations.adoc[Global moderations] -*** xref:admin:moderations/reported_users.adoc[Reported users] *** xref:admin:moderations/reported_content.adoc[Reported content] +*** xref:admin:moderations/reported_users.adoc[Reported users] +** xref:admin:templates.adoc[Templates] +*** xref:admin:templates/questionnaires.adoc[Questionnaires templates] +*** xref:admin:templates/block_users.adoc[Block user messages] +*** xref:admin:templates/proposal_answers.adoc[Proposal answers] * xref:contribute:index.adoc[Contribute] ** xref:contribute:governance.adoc[Governance] diff --git a/docs/en/modules/admin/assets/images/icons/action_duplicate.png b/docs/en/modules/admin/assets/images/icons/action_duplicate.png new file mode 100644 index 000000000..9282f2272 Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_duplicate.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_edit.png b/docs/en/modules/admin/assets/images/icons/action_edit.png new file mode 100644 index 000000000..a97d1588f Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_edit.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_block_user_backend_form.png b/docs/en/modules/admin/assets/images/templates/templates_block_user_backend_form.png new file mode 100644 index 000000000..225b09060 Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_block_user_backend_form.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_block_user_choice.png b/docs/en/modules/admin/assets/images/templates/templates_block_user_choice.png new file mode 100644 index 000000000..c6f4c632d Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_block_user_choice.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_menu.png b/docs/en/modules/admin/assets/images/templates/templates_menu.png new file mode 100644 index 000000000..7ce4e1a86 Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_menu.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_proposal_answers_backend_form.png b/docs/en/modules/admin/assets/images/templates/templates_proposal_answers_backend_form.png new file mode 100644 index 000000000..3f015fce8 Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_proposal_answers_backend_form.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_proposal_answers_choice.png b/docs/en/modules/admin/assets/images/templates/templates_proposal_answers_choice.png new file mode 100644 index 000000000..483ff6dcd Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_proposal_answers_choice.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_proposal_answers_choice_component.png b/docs/en/modules/admin/assets/images/templates/templates_proposal_answers_choice_component.png new file mode 100644 index 000000000..6817ed125 Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_proposal_answers_choice_component.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_questionnaires_backend_form.png b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_backend_form.png new file mode 100644 index 000000000..1482aa009 Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_backend_form.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_questionnaires_backend_survey_form.png b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_backend_survey_form.png new file mode 100644 index 000000000..50bd5af51 Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_backend_survey_form.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_questionnaires_backend_survey_preview.png b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_backend_survey_preview.png new file mode 100644 index 000000000..4cbc4bc20 Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_backend_survey_preview.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_questionnaires_list.png b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_list.png new file mode 100644 index 000000000..fd73d61cc Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_list.png differ diff --git a/docs/en/modules/admin/assets/images/templates/templates_questionnaires_survey_choice.png b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_survey_choice.png new file mode 100644 index 000000000..440086a01 Binary files /dev/null and b/docs/en/modules/admin/assets/images/templates/templates_questionnaires_survey_choice.png differ diff --git a/docs/en/modules/admin/pages/templates.adoc b/docs/en/modules/admin/pages/templates.adoc new file mode 100644 index 000000000..fdc851e58 --- /dev/null +++ b/docs/en/modules/admin/pages/templates.adoc @@ -0,0 +1,38 @@ += Templates + +== Understand the basics + +The templates tab allow you to create templates and to save time when managing your instance. +You can create templates for three different items: + +* *Questionnaires*: for creating template surveys in the xref:admin:components/surveys.adoc[survey component] +* *Block user messages*: for creating template justification for blocking xref:admin:moderations/reported_users.adoc[reported users] +* *Proposal answers*: for creating template xref:admin:components/proposals/answers.adoc[answers to proposals] + +Once created, those templates are available to all the administrators, and help them manage the instance more efficiently. + +== Configuration + +To access the Templates configuration panel, go in the administration panel and click the "Templates" item in the administration navigation bar. + +image::templates/templates_menu.png[Pages: Access templates panel] + +There, you can start creating and managing: + +* xref:admin:templates/questionnaires.adoc[Questionnaires templates] +* xref:admin:templates/block_users.adoc[Block user messages] +* xref:admin:templates/proposal_answers.adoc[Proposal answers] + +image::templates/templates_questionnaires_list.png[Backend: templates panel] + +== Examples + +At the end of each of the participatory processes you do, you want to collect the feedback of the participants. +Creating a questionnaire template makes the survey creation quicker than re-creating the survey and its questions for each process. + +On some platforms, you can also have spam users, that you want to be able to block quickly for the same reason each time. +Creating a justification template allow you to quickly choose this justification when blocking a spam user, rather than writing it +again each time. + +Same goes for proposal answers, sometimes you want to give a same answer to a lot of different proposals. Creating a proposal +answer template allows you and the processes administrators to manage proposals more efficiently. diff --git a/docs/en/modules/admin/pages/templates/block_users.adoc b/docs/en/modules/admin/pages/templates/block_users.adoc new file mode 100644 index 000000000..0cf819ca7 --- /dev/null +++ b/docs/en/modules/admin/pages/templates/block_users.adoc @@ -0,0 +1,58 @@ += Block user messages templates + +In this section, you can create, edit, and delete block user justification templates, that you can then use when moderating users. + +== Create a block user message template + +To create a new block user message template, you need to click the "New template" button. + +image::templates/templates_block_user_backend_form.png[Backend: new template form] + +.New questionnaire template form +|=== +|Field |Type |Description + +|Name +|Required +|Title of this template. Choose a clear title, describing precisely what the message is for, like "spam users." + +|Description +|Required +|Block user message that is used for justifying the blocking of the participant. + +|=== + +== Manage + +All the block user messages templates appear in the templates list: + +* *Template*: name of the template. +* *Created at*: date of creation. + +You can edit a template at any moment. + +=== Actions + +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit template] +|Edit +|To edit the block user message. + +|image:icons/action_duplicate.png[Duplicate template] +|Duplicate +|To duplicate the template. + +|image:icons/action_delete.png[Delete template] +|Delete +|To delete the template. + +|=== + +=== Use the template + +To use the template, go to the xref:admin:moderations/reported_users.adoc[reported users] panel, and click a "Block user" icon. +You then see a page proposing you to choose a template for the justification to block this participant. + +image::templates/templates_block_user_choice.png[Backend: choose template when blocking user] diff --git a/docs/en/modules/admin/pages/templates/proposal_answers.adoc b/docs/en/modules/admin/pages/templates/proposal_answers.adoc new file mode 100644 index 000000000..38a8ce56b --- /dev/null +++ b/docs/en/modules/admin/pages/templates/proposal_answers.adoc @@ -0,0 +1,71 @@ += Proposal answers templates + +In this section, you can create, edit, and delete proposal answers templates, that you can then use when answering proposals. + +== Create a proposal answers template + +NOTE: To be able to create a proposal answers template, you need to have created at least one +xref:admin:components/proposals.adoc[proposals] component. + +To create a new proposal answers template, you need to click the "New template" button. + +image::templates/templates_proposal_answers_choice_component.png[Backend: Proposal component choice for template] + +Choose the participatory space and component for which you want to create proposal answers to see the template answer form. + +image::templates/templates_proposal_answers_backend_form.png[Backend: new proposal answer template form] + +.New proposal answer template form +|=== +|Field |Type |Description + +|Name +|Required +|Title of this answer template. Choose a clear title, describing precisely what the answer is for, like "accepted proposal". + +|Description +|Required +|Content of the answer provided to the proposals for which you choose this template. You can use variables in your answer. + +|Proposal state +|Required +|By default, you can choose Evaluating, Accepted, or Rejected. + +|=== + +== Manage + +All the templates appear in the proposal answers templates list: + +* *Template*: name of the proposal answer template. +* *Internal state*: state given to proposals when using this template. +* *Add constraint*: proposal component where you can use this template. +* *Created at*: date of creation. + +You can edit a template and its fields at any moment. + +=== Actions + +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit template] +|Edit +|To edit the proposal answer. + +|image:icons/action_duplicate.png[Duplicate template] +|Duplicate +|To duplicate the template. + +|image:icons/action_delete.png[Delete template] +|Delete +|To delete the template. + +|=== + +=== Use the template + +To use the template, go to one of the proposal component for which you created a proposal answer template, and click an "Answer" icon. +You can choose an answer template to fill the answer field. + +image::templates/templates_proposal_answers_choice.png[Backend: choose template when answering proposal] diff --git a/docs/en/modules/admin/pages/templates/questionnaires.adoc b/docs/en/modules/admin/pages/templates/questionnaires.adoc new file mode 100644 index 000000000..d3162a286 --- /dev/null +++ b/docs/en/modules/admin/pages/templates/questionnaires.adoc @@ -0,0 +1,76 @@ += Questionnaires templates + +In this section, you can create, edit, and delete questionnaire templates, that you can then use in any survey component. + +== Create a questionnaire template + +To create a new questionnaire template, you need to click the "New template" button. + +image::templates/templates_questionnaires_backend_form.png[Backend: new template form] + +.New questionnaire template form +|=== +|Field |Type |Description + +|Name +|Required +|Title of this template. Choose a clear title, describing precisely what the survey is for, like "feedback survey." + +|Description +|Required +|Description of what the template is made for. This description is only available in the templates panel, to describe precisely what +the survey is for. + +|=== + +Click the "Save" button to continue creating your template questionnaire. + +image::templates/templates_questionnaires_backend_survey_form.png[Backend: new survey template form] + +Then, click the "Edit" button. You enter the survey creation process. Click the "Skip" button if you don't want to use an existing template. + +On the next page, you can create a survey. Please refer to the xref:admin:components/surveys.adoc[Surveys] documentation for more information. + +Click the "Save" button to see a preview of your survey. + +image::templates/templates_questionnaires_backend_survey_preview.png[Backend: new survey template preview] + +Click on the "Save" button again to save your template. + +== Manage templates + +All the templates appear in the questionnaire templates list: + +* *Template*: name of the template. +* *Questionnaire Title*: name of the survey by default when choosing this template. +* *Number of questions*: number of different questions in the survey. +* *Created at*: date of creation. + +You can edit a template and its questions at any moment. Also, please note that when you choose a template when creating a survey, +you can also change the questions, add some or delete some for this specific component. + +=== Actions + +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit template] +|Edit +|To edit the template and the survey questions. + +|image:icons/action_duplicate.png[Duplicate template] +|Duplicate +|To duplicate the template. + +|image:icons/action_delete.png[Delete template] +|Delete +|To delete the template. + +|=== + +=== Use the template + +To use the template, create a xref:admin:components/surveys.adoc[survey] component in a participatory space, then edit it. +You then see a page proposing you to choose a template for this survey. + +image::templates/templates_questionnaires_survey_choice.png[Backend: choose template when creating survey]