-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Carolina Romero <carolromero@users.noreply.github.com> Co-authored-by: paulinebessoles <pauline.bessoles@opensourcepolitics.eu>
- Loading branch information
1 parent
ac5460b
commit 4b4d44c
Showing
18 changed files
with
248 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+101 KB
.../en/modules/admin/assets/images/templates/templates_block_user_backend_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+168 KB
docs/en/modules/admin/assets/images/templates/templates_block_user_choice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+181 KB
...dules/admin/assets/images/templates/templates_proposal_answers_backend_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+316 KB
.../en/modules/admin/assets/images/templates/templates_proposal_answers_choice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+230 KB
...s/admin/assets/images/templates/templates_proposal_answers_choice_component.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+99.7 KB
...modules/admin/assets/images/templates/templates_questionnaires_backend_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+193 KB
.../admin/assets/images/templates/templates_questionnaires_backend_survey_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+421 KB
...min/assets/images/templates/templates_questionnaires_backend_survey_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+269 KB
docs/en/modules/admin/assets/images/templates/templates_questionnaires_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+183 KB
...odules/admin/assets/images/templates/templates_questionnaires_survey_choice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] |
71 changes: 71 additions & 0 deletions
71
docs/en/modules/admin/pages/templates/proposal_answers.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] |