diff --git a/.github/styles/config/vocabularies/Decidim/accept.txt b/.github/styles/config/vocabularies/Decidim/accept.txt index 9bc269b2d6..96c1d917b2 100644 --- a/.github/styles/config/vocabularies/Decidim/accept.txt +++ b/.github/styles/config/vocabularies/Decidim/accept.txt @@ -3,10 +3,14 @@ Config CSV [Dd]ecidim [Ee]mail +end_date +Etherpad [Ff]aq [Ff]avicon [Gg]amification +[Gg]eocoding initializer +Jitsi [Kk]akogawa Keka Mautic @@ -16,7 +20,10 @@ Mautic [Oo]fficializing [Oo]fficialize [Oo]fficialized +proposals_ids +proposal_url [Rr]eoffficialize +start_date [Un]nfollow [Uu]nhide [Uu]npublish diff --git a/docs/en/modules/ROOT/nav.adoc b/docs/en/modules/ROOT/nav.adoc index f1a6d0f437..2acdf5db2c 100644 --- a/docs/en/modules/ROOT/nav.adoc +++ b/docs/en/modules/ROOT/nav.adoc @@ -104,20 +104,29 @@ **** xref:admin:spaces/conferences/moderations.adoc[Moderations] ** xref:admin:components.adoc[Components] *** xref:admin:components/accountability.adoc[Accountability] +**** xref:admin:components/accountability/results.adoc[Results] +**** xref:admin:components/accountability/statuses.adoc[Statuses] +**** xref:admin:components/accountability/timeline.adoc[Project evolution] +**** xref:admin:components/accountability/import.adoc[Import and export results] *** xref:admin:components/blog.adoc[Blog] *** xref:admin:components/budgets.adoc[Budgets] +**** xref:admin:components/budgets/budgets.adoc[Budgets] +**** xref:admin:components/budgets/projects.adoc[Projects] *** xref:admin:components/debates.adoc[Debates] *** xref:admin:components/meetings.adoc[Meetings] +**** xref:admin:components/meetings/meetings.adoc[Meetings creation] **** xref:admin:components/meetings/registrations.adoc[Registrations] **** xref:admin:components/meetings/agenda.adoc[Agenda] **** xref:admin:components/meetings/polls.adoc[Polls] **** xref:admin:components/meetings/close.adoc[Close] *** xref:admin:components/pages.adoc[Pages] *** xref:admin:components/proposals.adoc[Proposals] -**** xref:admin:components/proposals/amendments.adoc[Amendments] +**** xref:admin:components/proposals/proposals.adoc[Proposal management] **** xref:admin:components/proposals/answers.adoc[Answers] -**** xref:admin:components/proposals/collaborative_drafts.adoc[Collaborative drafts] -**** xref:admin:components/proposals/participatory_texts.adoc[Participatory texts] +**** xref:admin:components/proposals/special_configurations.adoc[Specific proposals configurations] +***** xref:admin:components/proposals/special_configurations/amendments.adoc[Amendments] +***** xref:admin:components/proposals/special_configurations/collaborative_drafts.adoc[Collaborative drafts] +***** xref:admin:components/proposals/special_configurations/participatory_texts.adoc[Participatory texts] *** xref:admin:components/sortitions.adoc[Sortitions] *** xref:admin:components/surveys.adoc[Surveys] ** xref:admin:features.adoc[Features] diff --git a/docs/en/modules/admin/assets/images/components/accountability/component.png b/docs/en/modules/admin/assets/images/components/accountability/component.png new file mode 100644 index 0000000000..27230128be Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/component.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/component_accountability.png b/docs/en/modules/admin/assets/images/components/accountability/component_accountability.png new file mode 100644 index 0000000000..61a0f51141 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/component_accountability.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/example01.png b/docs/en/modules/admin/assets/images/components/accountability/example01.png new file mode 100644 index 0000000000..aa797810c8 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/example02.png b/docs/en/modules/admin/assets/images/components/accountability/example02.png new file mode 100644 index 0000000000..060fa656d3 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/example02.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/export.png b/docs/en/modules/admin/assets/images/components/accountability/export.png new file mode 100644 index 0000000000..6889bbd9c0 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/export.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/import.png b/docs/en/modules/admin/assets/images/components/accountability/import.png new file mode 100644 index 0000000000..2e1f9976cf Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/import.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/import_component.png b/docs/en/modules/admin/assets/images/components/accountability/import_component.png new file mode 100644 index 0000000000..71b26c0157 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/import_component.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/import_csv.png b/docs/en/modules/admin/assets/images/components/accountability/import_csv.png new file mode 100644 index 0000000000..06ad0ff775 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/import_csv.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/new_entry.png b/docs/en/modules/admin/assets/images/components/accountability/new_entry.png new file mode 100644 index 0000000000..699c1266a2 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/new_entry.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/new_result.png b/docs/en/modules/admin/assets/images/components/accountability/new_result.png new file mode 100644 index 0000000000..b4739f3259 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/new_result.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/new_result_button.png b/docs/en/modules/admin/assets/images/components/accountability/new_result_button.png new file mode 100644 index 0000000000..9fea06a9fe Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/new_result_button.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/new_status.png b/docs/en/modules/admin/assets/images/components/accountability/new_status.png new file mode 100644 index 0000000000..0409655616 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/new_status.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/results_entries.png b/docs/en/modules/admin/assets/images/components/accountability/results_entries.png new file mode 100644 index 0000000000..21bfe256c3 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/results_entries.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/results_list_filter.png b/docs/en/modules/admin/assets/images/components/accountability/results_list_filter.png new file mode 100644 index 0000000000..a634ce8c61 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/results_list_filter.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/statuses_button.png b/docs/en/modules/admin/assets/images/components/accountability/statuses_button.png new file mode 100644 index 0000000000..1c6aa0f10b Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/statuses_button.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/statuses_list.png b/docs/en/modules/admin/assets/images/components/accountability/statuses_list.png new file mode 100644 index 0000000000..48d077b9c9 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/statuses_list.png differ diff --git a/docs/en/modules/admin/assets/images/components/accountability/timeline_list.png b/docs/en/modules/admin/assets/images/components/accountability/timeline_list.png new file mode 100644 index 0000000000..9b721f1b88 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/accountability/timeline_list.png differ diff --git a/docs/en/modules/admin/assets/images/components/blog/component.png b/docs/en/modules/admin/assets/images/components/blog/component.png index 1ff675530b..cb328dca9d 100644 Binary files a/docs/en/modules/admin/assets/images/components/blog/component.png and b/docs/en/modules/admin/assets/images/components/blog/component.png differ diff --git a/docs/en/modules/admin/assets/images/components/blog/component_blog.png b/docs/en/modules/admin/assets/images/components/blog/component_blog.png new file mode 100644 index 0000000000..bbc880ecc6 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/blog/component_blog.png differ diff --git a/docs/en/modules/admin/assets/images/components/blog/example01.png b/docs/en/modules/admin/assets/images/components/blog/example01.png index 0d2590f0f2..ab11038364 100644 Binary files a/docs/en/modules/admin/assets/images/components/blog/example01.png and b/docs/en/modules/admin/assets/images/components/blog/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/blog/example02.png b/docs/en/modules/admin/assets/images/components/blog/example02.png index e66f47327e..f53517be84 100644 Binary files a/docs/en/modules/admin/assets/images/components/blog/example02.png and b/docs/en/modules/admin/assets/images/components/blog/example02.png differ diff --git a/docs/en/modules/admin/assets/images/components/blog/manage_posts.png b/docs/en/modules/admin/assets/images/components/blog/manage_posts.png index f789eb6cec..e9853a0080 100644 Binary files a/docs/en/modules/admin/assets/images/components/blog/manage_posts.png and b/docs/en/modules/admin/assets/images/components/blog/manage_posts.png differ diff --git a/docs/en/modules/admin/assets/images/components/blog/new_post.png b/docs/en/modules/admin/assets/images/components/blog/new_post.png index 4663fbc328..e024c397f6 100644 Binary files a/docs/en/modules/admin/assets/images/components/blog/new_post.png and b/docs/en/modules/admin/assets/images/components/blog/new_post.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/component.png b/docs/en/modules/admin/assets/images/components/budgets/component.png deleted file mode 100644 index 68985c9059..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/budgets/component.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/component_01.png b/docs/en/modules/admin/assets/images/components/budgets/component_01.png new file mode 100644 index 0000000000..06fbce19ab Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/budgets/component_01.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/component_02.png b/docs/en/modules/admin/assets/images/components/budgets/component_02.png new file mode 100644 index 0000000000..26b5a1c1ca Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/budgets/component_02.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/component_03.png b/docs/en/modules/admin/assets/images/components/budgets/component_03.png new file mode 100644 index 0000000000..796b06028f Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/budgets/component_03.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/component_budgets.png b/docs/en/modules/admin/assets/images/components/budgets/component_budgets.png new file mode 100644 index 0000000000..947e35eddc Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/budgets/component_budgets.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/example01.png b/docs/en/modules/admin/assets/images/components/budgets/example01.png index eb8d00e4b9..2d57a22d41 100644 Binary files a/docs/en/modules/admin/assets/images/components/budgets/example01.png and b/docs/en/modules/admin/assets/images/components/budgets/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/example02.png b/docs/en/modules/admin/assets/images/components/budgets/example02.png index 8068779873..b0a4bea1dc 100644 Binary files a/docs/en/modules/admin/assets/images/components/budgets/example02.png and b/docs/en/modules/admin/assets/images/components/budgets/example02.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/example03.png b/docs/en/modules/admin/assets/images/components/budgets/example03.png deleted file mode 100644 index b3f1a3dd0e..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/budgets/example03.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/example04.png b/docs/en/modules/admin/assets/images/components/budgets/example04.png deleted file mode 100644 index 95b3000521..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/budgets/example04.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/import_proposals.png b/docs/en/modules/admin/assets/images/components/budgets/import_proposals.png index 5e2c9d924e..9faef967c3 100644 Binary files a/docs/en/modules/admin/assets/images/components/budgets/import_proposals.png and b/docs/en/modules/admin/assets/images/components/budgets/import_proposals.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/manage_budgets.png b/docs/en/modules/admin/assets/images/components/budgets/manage_budgets.png index 3c1f0665b4..83668563f6 100644 Binary files a/docs/en/modules/admin/assets/images/components/budgets/manage_budgets.png and b/docs/en/modules/admin/assets/images/components/budgets/manage_budgets.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/multiple_budgets_front.png b/docs/en/modules/admin/assets/images/components/budgets/multiple_budgets_front.png new file mode 100644 index 0000000000..f6c6249844 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/budgets/multiple_budgets_front.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/new_budget.png b/docs/en/modules/admin/assets/images/components/budgets/new_budget.png index 38410df323..caab558f03 100644 Binary files a/docs/en/modules/admin/assets/images/components/budgets/new_budget.png and b/docs/en/modules/admin/assets/images/components/budgets/new_budget.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/new_budget_button.png b/docs/en/modules/admin/assets/images/components/budgets/new_budget_button.png new file mode 100644 index 0000000000..c71a45e76c Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/budgets/new_budget_button.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/new_project.png b/docs/en/modules/admin/assets/images/components/budgets/new_project.png index 80742cadf6..e7764cbdeb 100644 Binary files a/docs/en/modules/admin/assets/images/components/budgets/new_project.png and b/docs/en/modules/admin/assets/images/components/budgets/new_project.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/new_project_button.png b/docs/en/modules/admin/assets/images/components/budgets/new_project_button.png new file mode 100644 index 0000000000..d91ad0ad5b Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/budgets/new_project_button.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/projects_list_filter.png b/docs/en/modules/admin/assets/images/components/budgets/projects_list_filter.png new file mode 100644 index 0000000000..30bc287555 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/budgets/projects_list_filter.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/results_select_project.png b/docs/en/modules/admin/assets/images/components/budgets/results_select_project.png index 220973ac75..eca437506f 100644 Binary files a/docs/en/modules/admin/assets/images/components/budgets/results_select_project.png and b/docs/en/modules/admin/assets/images/components/budgets/results_select_project.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/results_selected.png b/docs/en/modules/admin/assets/images/components/budgets/results_selected.png index d4b62378e5..e0500b0be6 100644 Binary files a/docs/en/modules/admin/assets/images/components/budgets/results_selected.png and b/docs/en/modules/admin/assets/images/components/budgets/results_selected.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/results_selected_frontend.png b/docs/en/modules/admin/assets/images/components/budgets/results_selected_frontend.png index 3462828021..4e8be53ed3 100644 Binary files a/docs/en/modules/admin/assets/images/components/budgets/results_selected_frontend.png and b/docs/en/modules/admin/assets/images/components/budgets/results_selected_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/budgets/results_unselected.png b/docs/en/modules/admin/assets/images/components/budgets/results_unselected.png deleted file mode 100644 index 3c432661c7..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/budgets/results_unselected.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/components_index_back.png b/docs/en/modules/admin/assets/images/components/components_index_back.png new file mode 100644 index 0000000000..ae3cb074fa Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/components_index_back.png differ diff --git a/docs/en/modules/admin/assets/images/components/components_index_front.png b/docs/en/modules/admin/assets/images/components/components_index_front.png new file mode 100644 index 0000000000..e3097fd99e Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/components_index_front.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/close_debate_backend.png b/docs/en/modules/admin/assets/images/components/debates/close_debate_backend.png index 7061aa69c8..c5bf24a305 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/close_debate_backend.png and b/docs/en/modules/admin/assets/images/components/debates/close_debate_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/close_debate_frontend.png b/docs/en/modules/admin/assets/images/components/debates/close_debate_frontend.png index b0cea6df9a..6418ebce97 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/close_debate_frontend.png and b/docs/en/modules/admin/assets/images/components/debates/close_debate_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/component.png b/docs/en/modules/admin/assets/images/components/debates/component.png index 996368e5bb..cc14f64a55 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/component.png and b/docs/en/modules/admin/assets/images/components/debates/component.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/component_debate.png b/docs/en/modules/admin/assets/images/components/debates/component_debate.png new file mode 100644 index 0000000000..17e5983de5 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/debates/component_debate.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/debate_closed.png b/docs/en/modules/admin/assets/images/components/debates/debate_closed.png index 3e562da893..9dea15dc8e 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/debate_closed.png and b/docs/en/modules/admin/assets/images/components/debates/debate_closed.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/debate_finite.png b/docs/en/modules/admin/assets/images/components/debates/debate_finite.png deleted file mode 100644 index 11ff8d5bab..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/debates/debate_finite.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/debates/debates_list.png b/docs/en/modules/admin/assets/images/components/debates/debates_list.png index d346510d67..ca13aae9a7 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/debates_list.png and b/docs/en/modules/admin/assets/images/components/debates/debates_list.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/example01.png b/docs/en/modules/admin/assets/images/components/debates/example01.png index 48473a94cc..62d3560dd1 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/example01.png and b/docs/en/modules/admin/assets/images/components/debates/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/example02.png b/docs/en/modules/admin/assets/images/components/debates/example02.png deleted file mode 100644 index 84961e6c3d..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/debates/example02.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/debates/manage_debates.png b/docs/en/modules/admin/assets/images/components/debates/manage_debates.png index be604836eb..79be4fbe60 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/manage_debates.png and b/docs/en/modules/admin/assets/images/components/debates/manage_debates.png differ diff --git a/docs/en/modules/admin/assets/images/components/debates/new_debate_backend.png b/docs/en/modules/admin/assets/images/components/debates/new_debate_backend.png index 8374ffdb4c..98bdebe9d0 100644 Binary files a/docs/en/modules/admin/assets/images/components/debates/new_debate_backend.png and b/docs/en/modules/admin/assets/images/components/debates/new_debate_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/agenda/agenda_frontend.png b/docs/en/modules/admin/assets/images/components/meetings/agenda/agenda_frontend.png index 1f381d8e58..4d11623b5b 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/agenda/agenda_frontend.png and b/docs/en/modules/admin/assets/images/components/meetings/agenda/agenda_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/agenda/new_agenda_form.png b/docs/en/modules/admin/assets/images/components/meetings/agenda/new_agenda_form.png index 176540c716..b9522a9de0 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/agenda/new_agenda_form.png and b/docs/en/modules/admin/assets/images/components/meetings/agenda/new_agenda_form.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/close/button_frontend.png b/docs/en/modules/admin/assets/images/components/meetings/close/button_frontend.png new file mode 100644 index 0000000000..4735a5ecec Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/close/button_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/close/form_backend.png b/docs/en/modules/admin/assets/images/components/meetings/close/form_backend.png index 275783a43e..76bb74edeb 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/close/form_backend.png and b/docs/en/modules/admin/assets/images/components/meetings/close/form_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/close/form_frontend.png b/docs/en/modules/admin/assets/images/components/meetings/close/form_frontend.png index 78dc03cf75..cf866320d6 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/close/form_frontend.png and b/docs/en/modules/admin/assets/images/components/meetings/close/form_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/close/frontend.png b/docs/en/modules/admin/assets/images/components/meetings/close/frontend.png index 7b086b8e20..d283d7387e 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/close/frontend.png and b/docs/en/modules/admin/assets/images/components/meetings/close/frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/close/related_meeting.png b/docs/en/modules/admin/assets/images/components/meetings/close/related_meeting.png new file mode 100644 index 0000000000..1e251922e7 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/close/related_meeting.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/close/related_proposal.png b/docs/en/modules/admin/assets/images/components/meetings/close/related_proposal.png index dab23d633c..4eef247b90 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/close/related_proposal.png and b/docs/en/modules/admin/assets/images/components/meetings/close/related_proposal.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/component.png b/docs/en/modules/admin/assets/images/components/meetings/component.png index 65dfeb4b8e..4a3eecce1e 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/component.png and b/docs/en/modules/admin/assets/images/components/meetings/component.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/component_meeting.png b/docs/en/modules/admin/assets/images/components/meetings/component_meeting.png new file mode 100644 index 0000000000..ec6a9b377e Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/component_meeting.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/example01.png b/docs/en/modules/admin/assets/images/components/meetings/example01.png index f8c4fa66ef..018d896bd0 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/example01.png and b/docs/en/modules/admin/assets/images/components/meetings/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/example02.png b/docs/en/modules/admin/assets/images/components/meetings/example02.png deleted file mode 100644 index c2f88fd473..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/meetings/example02.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/example03.png b/docs/en/modules/admin/assets/images/components/meetings/example03.png deleted file mode 100644 index 4ecc8ae155..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/meetings/example03.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/example04.png b/docs/en/modules/admin/assets/images/components/meetings/example04.png deleted file mode 100644 index 7b247ceb92..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/meetings/example04.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/new_meeting_button_front.png b/docs/en/modules/admin/assets/images/components/meetings/new_meeting_button_front.png new file mode 100644 index 0000000000..33f046bd2e Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/new_meeting_button_front.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_backend.png b/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_backend.png index b9d8475945..d3f60c7663 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_backend.png and b/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_frontend01.png b/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_frontend01.png index daddfa4ebf..532aad0805 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_frontend01.png and b/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_frontend01.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_frontend02.png b/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_frontend02.png deleted file mode 100644 index b68014d337..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/meetings/new_meeting_form_frontend02.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/online_meeting_available_before.png b/docs/en/modules/admin/assets/images/components/meetings/online_meeting_available_before.png index adaeb23fdd..2ab4cc4ced 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/online_meeting_available_before.png and b/docs/en/modules/admin/assets/images/components/meetings/online_meeting_available_before.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/online_meeting_available_soon.png b/docs/en/modules/admin/assets/images/components/meetings/online_meeting_available_soon.png index eae042ba6d..f1733281cf 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/online_meeting_available_soon.png and b/docs/en/modules/admin/assets/images/components/meetings/online_meeting_available_soon.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/online_meeting_happening.png b/docs/en/modules/admin/assets/images/components/meetings/online_meeting_happening.png index 15f72bad82..b85f6562c0 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/online_meeting_happening.png and b/docs/en/modules/admin/assets/images/components/meetings/online_meeting_happening.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/online_meeting_happening_embed.png b/docs/en/modules/admin/assets/images/components/meetings/online_meeting_happening_embed.png new file mode 100644 index 0000000000..9bbf076bc6 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/online_meeting_happening_embed.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/polls/backend.png b/docs/en/modules/admin/assets/images/components/meetings/polls/backend.png index d14e49b9ea..98c8fae5b1 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/polls/backend.png and b/docs/en/modules/admin/assets/images/components/meetings/polls/backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/polls/backend_question.png b/docs/en/modules/admin/assets/images/components/meetings/polls/backend_question.png deleted file mode 100644 index c9681071f3..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/meetings/polls/backend_question.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/polls/frontend_before_meeting.png b/docs/en/modules/admin/assets/images/components/meetings/polls/frontend_before_meeting.png new file mode 100644 index 0000000000..a9e42bd670 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/polls/frontend_before_meeting.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/polls/poll_administration_page.png b/docs/en/modules/admin/assets/images/components/meetings/polls/poll_administration_page.png new file mode 100644 index 0000000000..1fb8b77bae Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/polls/poll_administration_page.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/polls/poll_participant_replies_sent.png b/docs/en/modules/admin/assets/images/components/meetings/polls/poll_participant_replies_sent.png new file mode 100644 index 0000000000..e8d17e4bbd Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/polls/poll_participant_replies_sent.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/polls/poll_participant_reply.png b/docs/en/modules/admin/assets/images/components/meetings/polls/poll_participant_reply.png new file mode 100644 index 0000000000..32f6437752 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/polls/poll_participant_reply.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/registrations/backend.png b/docs/en/modules/admin/assets/images/components/meetings/registrations/backend.png index 9ea36572b3..3495826fae 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/registrations/backend.png and b/docs/en/modules/admin/assets/images/components/meetings/registrations/backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/registrations/backend_w_registration_code.png b/docs/en/modules/admin/assets/images/components/meetings/registrations/backend_w_registration_code.png index 8563d621f0..b94260ab1c 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/registrations/backend_w_registration_code.png and b/docs/en/modules/admin/assets/images/components/meetings/registrations/backend_w_registration_code.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_confirm.png b/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_confirm.png index 33267d47b5..8acfbdb419 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_confirm.png and b/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_confirm.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_confirmed_w_code.png b/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_confirmed_w_code.png index ddc4d05738..3df254b9c4 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_confirmed_w_code.png and b/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_confirmed_w_code.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_join_meeting.png b/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_join_meeting.png index 85ad58d445..f91688bae0 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_join_meeting.png and b/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_join_meeting.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_w_code.png b/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_w_code.png new file mode 100644 index 0000000000..61dcc4947b Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/meetings/registrations/frontend_w_code.png differ diff --git a/docs/en/modules/admin/assets/images/components/meetings/registrations/invite_attendee.png b/docs/en/modules/admin/assets/images/components/meetings/registrations/invite_attendee.png index 221e953265..6ccafefc98 100644 Binary files a/docs/en/modules/admin/assets/images/components/meetings/registrations/invite_attendee.png and b/docs/en/modules/admin/assets/images/components/meetings/registrations/invite_attendee.png differ diff --git a/docs/en/modules/admin/assets/images/components/page/component.png b/docs/en/modules/admin/assets/images/components/page/component.png index 9a710711cc..d5e73c3415 100644 Binary files a/docs/en/modules/admin/assets/images/components/page/component.png and b/docs/en/modules/admin/assets/images/components/page/component.png differ diff --git a/docs/en/modules/admin/assets/images/components/page/component_page.png b/docs/en/modules/admin/assets/images/components/page/component_page.png new file mode 100644 index 0000000000..22432bdda0 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/page/component_page.png differ diff --git a/docs/en/modules/admin/assets/images/components/page/example01.png b/docs/en/modules/admin/assets/images/components/page/example01.png index 942a9f2954..3cc96346b2 100644 Binary files a/docs/en/modules/admin/assets/images/components/page/example01.png and b/docs/en/modules/admin/assets/images/components/page/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/page/example02.png b/docs/en/modules/admin/assets/images/components/page/example02.png deleted file mode 100644 index 5d189f7da6..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/page/example02.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/page/new_page.png b/docs/en/modules/admin/assets/images/components/page/new_page.png index 494e10708c..5e0abb38b6 100644 Binary files a/docs/en/modules/admin/assets/images/components/page/new_page.png and b/docs/en/modules/admin/assets/images/components/page/new_page.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/bulk_actions.png b/docs/en/modules/admin/assets/images/components/proposals/bulk_actions.png new file mode 100644 index 0000000000..697ea11952 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/proposals/bulk_actions.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/component.png b/docs/en/modules/admin/assets/images/components/proposals/component.png deleted file mode 100644 index 14001cc5f6..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/component.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/component_01.png b/docs/en/modules/admin/assets/images/components/proposals/component_01.png new file mode 100644 index 0000000000..24676f0832 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/proposals/component_01.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/component_02.png b/docs/en/modules/admin/assets/images/components/proposals/component_02.png new file mode 100644 index 0000000000..6ef7f3f95f Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/proposals/component_02.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/component_03.png b/docs/en/modules/admin/assets/images/components/proposals/component_03.png new file mode 100644 index 0000000000..6c63098dae Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/proposals/component_03.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/component_proposals.png b/docs/en/modules/admin/assets/images/components/proposals/component_proposals.png new file mode 100644 index 0000000000..8d77426938 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/proposals/component_proposals.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/example01.png b/docs/en/modules/admin/assets/images/components/proposals/example01.png index 05fdae6517..470fce59d0 100644 Binary files a/docs/en/modules/admin/assets/images/components/proposals/example01.png and b/docs/en/modules/admin/assets/images/components/proposals/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/example02.png b/docs/en/modules/admin/assets/images/components/proposals/example02.png deleted file mode 100644 index ce1cd68eed..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/example02.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/example03.png b/docs/en/modules/admin/assets/images/components/proposals/example03.png deleted file mode 100644 index 3d07c89f9d..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/example03.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/manage_proposals.png b/docs/en/modules/admin/assets/images/components/proposals/manage_proposals.png index 49995a9c15..6968491773 100644 Binary files a/docs/en/modules/admin/assets/images/components/proposals/manage_proposals.png and b/docs/en/modules/admin/assets/images/components/proposals/manage_proposals.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_backend.png b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_backend.png new file mode 100644 index 0000000000..774d4ab139 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_backend01.png b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_backend01.png deleted file mode 100644 index d80b9c3235..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_backend01.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_backend02.png b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_backend02.png deleted file mode 100644 index 8abdc59aea..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_backend02.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_button_frontend.png b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_button_frontend.png new file mode 100644 index 0000000000..1c6589fe51 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_button_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend.png b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend.png index fd3630f7e6..5cd1a31973 100644 Binary files a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend.png and b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_compare.png b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_compare.png deleted file mode 100644 index d68b14bc13..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_compare.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_complete.png b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_complete.png deleted file mode 100644 index e77589f039..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_complete.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_publish.png b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_publish.png index 5aaaea7f97..4064a5987b 100644 Binary files a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_publish.png and b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_publish.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_published.png b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_published.png index 786fb0abe8..0732e2e04f 100644 Binary files a/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_published.png and b/docs/en/modules/admin/assets/images/components/proposals/new_proposal_frontend_published.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/origin_filter.png b/docs/en/modules/admin/assets/images/components/proposals/origin_filter.png deleted file mode 100644 index 70e9eed93b..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/origin_filter.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/proposals_list_frontend.png b/docs/en/modules/admin/assets/images/components/proposals/proposals_list_frontend.png new file mode 100644 index 0000000000..4b55577c49 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/proposals/proposals_list_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/setting_card_image.png b/docs/en/modules/admin/assets/images/components/proposals/setting_card_image.png deleted file mode 100644 index 741ffebcdb..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/setting_card_image.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/setting_geocoding.png b/docs/en/modules/admin/assets/images/components/proposals/setting_geocoding.png deleted file mode 100644 index 0eccbcb931..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/setting_geocoding.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/setting_hashtag.png b/docs/en/modules/admin/assets/images/components/proposals/setting_hashtag.png deleted file mode 100644 index e95f72e6b2..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/setting_hashtag.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/setting_threshold01.png b/docs/en/modules/admin/assets/images/components/proposals/setting_threshold01.png deleted file mode 100644 index 7c91c984fe..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/setting_threshold01.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/proposals/setting_threshold02.png b/docs/en/modules/admin/assets/images/components/proposals/setting_threshold02.png deleted file mode 100644 index 5021d2f07b..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/proposals/setting_threshold02.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/sortitions/component.png b/docs/en/modules/admin/assets/images/components/sortitions/component.png new file mode 100644 index 0000000000..5e314f44d3 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/sortitions/component.png differ diff --git a/docs/en/modules/admin/assets/images/components/sortitions/component_sortitions.png b/docs/en/modules/admin/assets/images/components/sortitions/component_sortitions.png new file mode 100644 index 0000000000..1eed90813b Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/sortitions/component_sortitions.png differ diff --git a/docs/en/modules/admin/assets/images/components/sortitions/example01.png b/docs/en/modules/admin/assets/images/components/sortitions/example01.png new file mode 100644 index 0000000000..752a8145ba Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/sortitions/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/sortitions/manage_sortitions.png b/docs/en/modules/admin/assets/images/components/sortitions/manage_sortitions.png new file mode 100644 index 0000000000..21ffb14dcb Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/sortitions/manage_sortitions.png differ diff --git a/docs/en/modules/admin/assets/images/components/sortitions/new_sortition_backend.png b/docs/en/modules/admin/assets/images/components/sortitions/new_sortition_backend.png new file mode 100644 index 0000000000..5bb7bb5363 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/sortitions/new_sortition_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/add_question_button.png b/docs/en/modules/admin/assets/images/components/surveys/add_question_button.png deleted file mode 100644 index ba59e3d0a3..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/surveys/add_question_button.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/component.png b/docs/en/modules/admin/assets/images/components/surveys/component.png index 0c3419dd2e..30f1ec1cfd 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/component.png and b/docs/en/modules/admin/assets/images/components/surveys/component.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/component_survey.png b/docs/en/modules/admin/assets/images/components/surveys/component_survey.png new file mode 100644 index 0000000000..0b7857e73f Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/surveys/component_survey.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/conditional_question.png b/docs/en/modules/admin/assets/images/components/surveys/conditional_question.png new file mode 100644 index 0000000000..c7040dae88 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/surveys/conditional_question.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/edit_form.png b/docs/en/modules/admin/assets/images/components/surveys/edit_form.png index 5bf4e52f5e..96f0b15422 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/edit_form.png and b/docs/en/modules/admin/assets/images/components/surveys/edit_form.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/edit_questionnaire.png b/docs/en/modules/admin/assets/images/components/surveys/edit_questionnaire.png index dbb363ba83..3d400fd02f 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/edit_questionnaire.png and b/docs/en/modules/admin/assets/images/components/surveys/edit_questionnaire.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/example01.png b/docs/en/modules/admin/assets/images/components/surveys/example01.png index 319e812e32..689c333703 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/example01.png and b/docs/en/modules/admin/assets/images/components/surveys/example01.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/question_form.png b/docs/en/modules/admin/assets/images/components/surveys/question_form.png index 20b69a7d10..066ca33f5f 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/question_form.png and b/docs/en/modules/admin/assets/images/components/surveys/question_form.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/question_form_backend.png b/docs/en/modules/admin/assets/images/components/surveys/question_form_backend.png new file mode 100644 index 0000000000..a11372cbb1 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/surveys/question_form_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/question_form_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/question_form_frontend.png new file mode 100644 index 0000000000..193db48b3d Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/surveys/question_form_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/question_form_limits_backend.png b/docs/en/modules/admin/assets/images/components/surveys/question_form_limits_backend.png deleted file mode 100644 index e950cd950f..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/surveys/question_form_limits_backend.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/question_form_limits_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/question_form_limits_frontend.png deleted file mode 100644 index c4ddf19f7f..0000000000 Binary files a/docs/en/modules/admin/assets/images/components/surveys/question_form_limits_frontend.png and /dev/null differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/separator.png b/docs/en/modules/admin/assets/images/components/surveys/separator.png new file mode 100644 index 0000000000..d29997de57 Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/surveys/separator.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/title_description_backend.png b/docs/en/modules/admin/assets/images/components/surveys/title_description_backend.png new file mode 100644 index 0000000000..a394a8fd2e Binary files /dev/null and b/docs/en/modules/admin/assets/images/components/surveys/title_description_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_files_backend.png b/docs/en/modules/admin/assets/images/components/surveys/type_files_backend.png index 57b3157375..bc63a8eda8 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_files_backend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_files_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_files_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/type_files_frontend.png index 2bf186a227..ff2a767ec6 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_files_frontend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_files_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_long_answer_backend.png b/docs/en/modules/admin/assets/images/components/surveys/type_long_answer_backend.png index fce754a11f..cf4d318dba 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_long_answer_backend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_long_answer_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_long_answer_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/type_long_answer_frontend.png index 5a34760e0c..0ce74d6885 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_long_answer_frontend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_long_answer_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_matrix_multiple_option_backend.png b/docs/en/modules/admin/assets/images/components/surveys/type_matrix_multiple_option_backend.png index 1986014be5..a153cae4ac 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_matrix_multiple_option_backend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_matrix_multiple_option_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_matrix_multiple_option_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/type_matrix_multiple_option_frontend.png index 6de6a1a396..8afb9d68ec 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_matrix_multiple_option_frontend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_matrix_multiple_option_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_matrix_single_option_backend.png b/docs/en/modules/admin/assets/images/components/surveys/type_matrix_single_option_backend.png index 5fe3e36d64..588975460e 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_matrix_single_option_backend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_matrix_single_option_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_matrix_single_option_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/type_matrix_single_option_frontend.png index 5b35cd653a..22b56a38a2 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_matrix_single_option_frontend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_matrix_single_option_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_multiple_option_backend.png b/docs/en/modules/admin/assets/images/components/surveys/type_multiple_option_backend.png index 1b699b5b92..274decd7ee 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_multiple_option_backend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_multiple_option_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_multiple_option_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/type_multiple_option_frontend.png index e7163d0210..ba01cdd09f 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_multiple_option_frontend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_multiple_option_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_short_answer_backend.png b/docs/en/modules/admin/assets/images/components/surveys/type_short_answer_backend.png index 9bcaa21419..860ca8fff5 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_short_answer_backend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_short_answer_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_short_answer_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/type_short_answer_frontend.png index 4b6496ab18..7cf1107c0a 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_short_answer_frontend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_short_answer_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_single_option_backend.png b/docs/en/modules/admin/assets/images/components/surveys/type_single_option_backend.png index 88926c613f..3ded6a2adf 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_single_option_backend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_single_option_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_single_option_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/type_single_option_frontend.png index 0c33119808..edc29dcaf8 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_single_option_frontend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_single_option_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_sorting_backend.png b/docs/en/modules/admin/assets/images/components/surveys/type_sorting_backend.png index aac11606ed..4796e9a962 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_sorting_backend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_sorting_backend.png differ diff --git a/docs/en/modules/admin/assets/images/components/surveys/type_sorting_frontend.png b/docs/en/modules/admin/assets/images/components/surveys/type_sorting_frontend.png index 8c8a6c71fc..9454beb050 100644 Binary files a/docs/en/modules/admin/assets/images/components/surveys/type_sorting_frontend.png and b/docs/en/modules/admin/assets/images/components/surveys/type_sorting_frontend.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_agenda.png b/docs/en/modules/admin/assets/images/icons/action_agenda.png new file mode 100644 index 0000000000..76ba020729 Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_agenda.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_answers.png b/docs/en/modules/admin/assets/images/icons/action_answers.png new file mode 100644 index 0000000000..759fef74b4 Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_answers.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_attachments.png b/docs/en/modules/admin/assets/images/icons/action_attachments.png new file mode 100644 index 0000000000..2b918cf8b1 Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_attachments.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_close.png b/docs/en/modules/admin/assets/images/icons/action_close.png new file mode 100644 index 0000000000..e3e0590bdc Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_close.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_folder.png b/docs/en/modules/admin/assets/images/icons/action_folder.png new file mode 100644 index 0000000000..ba0805ff51 Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_folder.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_list.png b/docs/en/modules/admin/assets/images/icons/action_list.png new file mode 100644 index 0000000000..e2e4fa8d1d Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_list.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_plus.png b/docs/en/modules/admin/assets/images/icons/action_plus.png new file mode 100644 index 0000000000..1ca0065d72 Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_plus.png differ diff --git a/docs/en/modules/admin/assets/images/icons/action_registrations.png b/docs/en/modules/admin/assets/images/icons/action_registrations.png new file mode 100644 index 0000000000..961f52a75b Binary files /dev/null and b/docs/en/modules/admin/assets/images/icons/action_registrations.png differ diff --git a/docs/en/modules/admin/pages/components.adoc b/docs/en/modules/admin/pages/components.adoc index 6c005aa788..13bebbaeec 100644 --- a/docs/en/modules/admin/pages/components.adoc +++ b/docs/en/modules/admin/pages/components.adoc @@ -1,5 +1,75 @@ = Components +== Understand the basics + Through components an administrator can enable and configure different participatory mechanisms. +All components are available in all the different xref:admin:spaces.adoc[spaces]. + +When you create a participatory space, by default, it won't have any component in it. include::partial$components_list.adoc[] + +== How to find it? + +Components are accessible in each xref:admin:spaces.adoc[space], through the administration secondary navigation bar. + +image::components/components_index_back.png[Component index backend in an assembly] + +To create a component, click the "Add component" button and select the type of component you want to create. + +Once you start publishing components, participants see links to the different components appear in the space "Main data" +content block in the landing page, in the general search engine, and in the dedicated homepage content blocks. + +image::components/components_index_front.png[Component index frontend in an assembly] + +== Manage components + +On this page, you are able to manage components and create new ones. + +You can find all the components of the space on the list, with: + +* *Component name*: title of the component, chosen at its creation and editable. +* *Component type*: type of component. +* *Component scope*: the xref:admin:scopes.adoc[scope] of the component. + +== Actions + +[cols="10h,~,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Manage component icon] +|Manage +|To edit the resources inside the component, like blog posts, proposals, meetings, etc. + +|image:icons/action_share.png[Share icon] +|Share +|Creates a link with a token to share the component with other users. + +|image:icons/action_configure.png[Configure icon] +|Configure +|To edit the general configuration of the component. + +|image:icons/action_publish.png[Publish component icon] +|Publish +|To publish the component. + +|image:icons/action_unpublish.png[Unpublish component icon] +|Unpublish +|To unpublish the component. + +|image:icons/action_preview.png[Preview component icon] +|Preview +|Preview of how the component looks in the user interface. + +|image:icons/action_permissions.png[Permissions icon] +|Permissions +|To configure which kind of xref:admin:participants/authorizations.adoc[Authorizations] +a participant need to have to be able to perform certain actions in a component. + +|image:icons/action_delete.png[Delete component icon] +|Delete +|To delete the component, only possible when there is no participant participation in it. + +|=== + diff --git a/docs/en/modules/admin/pages/components/accountability.adoc b/docs/en/modules/admin/pages/components/accountability.adoc index a213fb8985..006fce3680 100644 --- a/docs/en/modules/admin/pages/components/accountability.adoc +++ b/docs/en/modules/admin/pages/components/accountability.adoc @@ -1,10 +1,104 @@ = Accountability -The Accountability component allows people to follow project implementations. It works like a project management system built into the platform. It offers the following features: +== Understand the basics -* creating results that represent projects to be implemented -* subdividing results into projects or sub-projects -* defining and applying progress in implementation statuses (0% to 100% implemented) around their implementation -* displaying the extent of the results’ implementation grouped by categories and scopes +The Accountability component allows administrators to present a summary of the achievements decided upon in assemblies, during +participatory processes, or any other space. Administrators create Results they can then categorize and link to proposals, meetings, or +investment projects (for example, as part of a participatory budget). -Results, projects and statuses can be updated through a CSV (comma-separated values), or manually by the administration interface. +image::components/accountability/example01.png[Example of results list] + +Results can be closely monitored, with a history of modifications saved, and percentages of completion and milestones +indicating their progress. The results, projects, and states can be updated manually through the administration panel or through a CSV. + +image::components/accountability/example02.png[Example of a result] + +In this documentation section, you can find how to configure and manage all of those items: + +* xref:admin:components/accountability/results.adoc[Results] +* xref:admin:components/accountability/statuses.adoc[Statuses] +* xref:admin:components/accountability/timeline.adoc[Project evolution] +* xref:admin:components/accountability/import.adoc[Import and export results] + +== Configuration + +To create an Accountability component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. + +image::components/accountability/component_accountability.png[Add Accountability component button] + +Then: + +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Accountability" +. Fill the component creation form + +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] in the components list. + +image::components/accountability/component.png[Add component form] + +.Accountability form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Name +|Required +|What is the title of this component. For instance "Accountability" + +|Order position +|Optional +|The order of the component in relation with the other components. Having a lower number means a higher priority. +For instance, if you have two components, "Component a" with weight "10" and "Component b" with weight "0" +then "component b" is first when ordering. + +|=== + +.Global settings +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Scopes enabled +|Optional +|Check if you want to have xref:admin:settings/scopes.adoc[Scopes] filtering available in this component. + +|Scope +|Optional +|Which xref:admin:scopes.adoc[Scope] does this component belongs to. + +|Comments enabled +|Optional +|Whether you want to have comments in the component. + +|Comments max length +|Optional +|The characters limit that participants have when making comments. Leave 0 for the default value. + +|Intro +|Optional +|A general introduction that’ll be displayed on the accountability landing page. + +|Display progress +|Optional +|Check it if you want a progress bar to be displayed on the results with aa progress level. + +|=== + +.Step settings +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Comments blocked +|Optional +|Whether you want to enable comments for this phase. +|=== + +== Examples + +Below, you can find some links to examples Accountability components: + +* https://www.decidim.barcelona/processes/pam/f/8/[2016-2019 Municipal Action Plan in Decidim Barcelona] +* https://ecrivons.angers.fr/processes/BP2022/f/411/[Results for 2022 participatory budget in Angers] diff --git a/docs/en/modules/admin/pages/components/accountability/import.adoc b/docs/en/modules/admin/pages/components/accountability/import.adoc new file mode 100644 index 0000000000..814375ff49 --- /dev/null +++ b/docs/en/modules/admin/pages/components/accountability/import.adoc @@ -0,0 +1,58 @@ += Import results + +== Understand the basics + +Sometimes, the accountability content is used after an internal process in an organization, such as evaluating the cost of +participatory budget projects in external files, so it can be useful to import new results and results modifications in a batch. + +For this, you can use the functionalities of exporting and importing results. + +== Export results + +You can export results and their comments in different formats by clicking the "Export all" button in the results list: + +* Results as CSV +* Results as JSON +* Results as Excel +* Comments as CSV +* Comments as JSON +* Comments as Excel + +image::components/accountability/export.png[Import results from CSV form] + +== Import results + +You can also import results by clicking the "Import" button in the results list in the administration panel. + +image::components/accountability/import.png[Import results from CSV form] + +=== Import from a component + +You can import results directly from a xref:admin:components/budgets.adoc[Budget] component of the same participatory space, +and choose if you want to import all the projects into results or only the one selected for implementation. + +image:components/accountability/import_component.png[Import results from CSV form] + +=== Import from a CSV + +You can also import results from a CSV file. + +image:components/accountability/import_csv.png[Import results from CSV form] + +To do this, you should follow these steps: + +. Create the xref:admin:components/accountability/statuses.adoc[Statuses] for the Results that you want to add +. Create at least one xref:admin:components/accountability/results.adoc[Results] manually through this administration panel +before doing the import, to have a better understanding of the format and what you'll need to fill out. +. Download the xref:_export_results[Export with CSV format] +. Make the changes locally. You can only change the following columns of the CSV: +** category/id: ID for the result category +** scope/id: ID for the result scope +** parent/id: ID of the parent (for related Results). Optional +** title/en: Title in english language. This depends on your platform language configuration. +** description/en: Description in english language. This depends on your platform language configuration. +** start_date: date when the result starts execution (format YYYY-MM-DD) +** end_date: date when the result ends execution (format YYYY-MM-DD) +** status/id: ID of the Status for this result +** progress: Percentage (from 0 to 100) of the execution +** proposals_ids: internal ID of the related proposals (separated with a comma). It gets automatically converted to proposal_url \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/accountability/results.adoc b/docs/en/modules/admin/pages/components/accountability/results.adoc new file mode 100644 index 0000000000..f641296e59 --- /dev/null +++ b/docs/en/modules/admin/pages/components/accountability/results.adoc @@ -0,0 +1,122 @@ += Results + +== Understand the basics + +Results are the entities composing the accountability component. They can be linked to proposals, projects, meetings, and have +categories, statuses and dates assigned. + +== Create a result + +To start creating results, click in the component title in the navigation bar or in the component list, or click in the +image:icons/action_edit.png[Manage component icon] icon on the components list. + +image::components/accountability/new_result_button.png[New result button] + +Then, click the "New result" button on the top right of the page. + +image::components/accountability/new_result.png[New result form] + +.New result form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|Title of the result. + +|Description +|Optional +|Description of the result. + +|Scope +|Optional +|Available when scopes are enabled in the space. + +|Category +|Optional +|Allows categorizing the results on the Accountability landing page. + +|Start date +|Optional +|Expected format: dd/mm/yyyy. + +|End date +|Optional +|Expected format: dd/mm/yyyy. + +|Status +|Optional +|Allows to give a status to results. + +|Progress +|Optional +|Percentage of progression of the result. + +|Proposals +|Optional +|Proposals that originated the result. + +|Included projects +|Optional +|Projects that originated the result. + +|=== + +== Manage results + +On the results list in the administration panel, administrators can see: + +* *ID*: Identification number for this result. +* *Title*: Title of the result. +* *Category*: Category of the result. +* *Scope*: Scope of the result, if enabled in the participatory space. +* *xref:admin:components/accountability/statuses.adoc[Status]*: Status of the result. +* *Progress*: Result percentage progress. +* *Created*: Creation date of the result. + +You can filter and sort this list by clicking the "Filter" button and the columns headers. +You can also search for results by their ID and title in the search bar. + +image::components/accountability/results_list_filter.png[New result button] + +== Actions + +.Actions +[cols="10h,~,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|To edit the result. + +|image:icons/action_plus.png[New result icon] +|New result +|Redirects to the list of sub-results, and allows to create sub-results. + +|image:icons/action_clock.png[Project evolution icon] +|xref:admin:components/accountability/timeline.adoc[Project evolution] +|Allows you to manage the project evolution and timeline entries. + +|image:icons/action_folder.png[Folders icon] +|Folders +|To create folders to classify the attachments. + +|image:icons/action_attachments.png[Attachments icon] +|Attachments +|To create and manage attachments related to the result. + +|image:icons/action_preview.png[Preview icon] +|Preview +|To preview the result in the user panel. + +|image:icons/action_permissions.png[Permissions icon] +|Permissions +|To handle the authorizations needed to comment this specific result. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete this result. + +|=== \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/accountability/statuses.adoc b/docs/en/modules/admin/pages/components/accountability/statuses.adoc new file mode 100644 index 0000000000..9f10bf76b6 --- /dev/null +++ b/docs/en/modules/admin/pages/components/accountability/statuses.adoc @@ -0,0 +1,42 @@ += Statuses + +== Understand the basics + +Statuses allow to create progress states for results. Once you created statuses, you are able to make your results evolve +according to their implementation evolution. It also allows to give results progress percentages, ranging from 0 to 100%. + +== Configuration + +To create Statuses, click the "Statuses" button on the top right of the results list. + +image::components/accountability/statuses_button.png[Statuses button] + +There, you can create and manage the different statuses for the results. + +image::components/accountability/statuses_list.png[Statuses list] + +Click on the "New status" button to start creating statuses. + +image:components/accountability/new_status.png[New status form] + +.New status form +|=== +|Field |Type |Description + +|Key +|Required +|Used as the unique identifier for the xref:admin:components/accountability/import.adoc[CSV Import]. + +|Name +|Required +|Name for this status. + +|Description +|Optional +|Description for this status. + +|Progress +|Optional +|Number with percentage (from 0 to 100) of the progress. + +|=== \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/accountability/timeline.adoc b/docs/en/modules/admin/pages/components/accountability/timeline.adoc new file mode 100644 index 0000000000..2ddeac7ff9 --- /dev/null +++ b/docs/en/modules/admin/pages/components/accountability/timeline.adoc @@ -0,0 +1,36 @@ += Project evolution + +== Understand the basics + +For participants to be able to follow and monitor the evolution of the projects, administrators can create timeline entries by +clicking the image:icons/action_clock.png[Project evolution icon]. + +image::components/accountability/results_entries.png[Result page with timeline entries] + +== Configuration + +image::components/accountability/timeline_list.png[Timeline entries list] + +There, you can create and manage the different implementation phases for the result, and create new timeline entries. + +image::components/accountability/new_entry.png[New timeline entry form] + +.New entry form +|=== +|Field |Type |Description + +|Date +|Required +|Expected format: dd/mm/yyyy + +|Title +|Required +|Title of the timeline entry. + +|Description +|Optional +|Description of the timeline entry. + +|=== + +The timeline entries are then available on the result page. \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/blog.adoc b/docs/en/modules/admin/pages/components/blog.adoc index 3a49f6c37f..eb5e4d55f3 100644 --- a/docs/en/modules/admin/pages/components/blog.adoc +++ b/docs/en/modules/admin/pages/components/blog.adoc @@ -1,66 +1,69 @@ = Blog -The Blog component allows people to read multiple posts ordered by date. +== Understand the basics -Some examples of where this component was used: +The Blog component allows administrators to post news about a participatory space, that participants can read to get updates. -* https://meta.decidim.org/processes/roadmap/f/247/[News in Propose new functionalities for Decidim software] in https://meta.decidim.org[Metadecidim] +image::components/blog/example01.png[Example of blog posts list] -image:components/blog/example01.png[Example of blog posts list] -image:components/blog/example02.png[Example of a blog post] +All blog posts are available in the posts list, and participants can click each blog post to learn more about what's new. -To configure the Blog component: +image::components/blog/example02.png[Example of a blog post] -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". -. Go to components -. Click on "Add component" button -. Click on "Blog" -. Fill the xref:_add_component[Add component] form +== Configuration -== Add component +To create a Blog component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. -image:components/blog/component.png[Add component form] +image::components/blog/component_blog.png[Add Blog component button] + +Then: + +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Blog" +. Fill the component creation form + +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] icon in the components list. + +image::components/blog/component.png[Add component form] .Add component: Blog form +[cols="20h,10h,~"] |=== |Field |Type |Description |Name |Required -|What is the title of this component. For instance, "Blogs" +|The title of this component. For instance, "Blogs" or "Latest news" |Order position |Optional -|Which order will it have in relation to the other blogs. Having a lower number means a higher priority. -For instance, if you have two blogs, "Blog a" with weight "10" and "Blog b" with weight "0", then "Blog b" will be first when ordering. +|Which order it has in relation to the other components. Having a lower number means a higher priority. |=== -.Add component: Blog form - Global settings +.Blog form - Global settings +[cols="20h,10h,~"] |=== |Field |Type |Description |Announcement |Optional -|A general announcement that'll be visible on the general blogs landing page. +|A general announcement visible on the Blog component landing page. |Comments enabled |Optional -|Whether you want to have comments in the meetings. +|Whether you want participants to be able to comment on the blog posts. |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|The characters limit that participants have when making comments. Leave 0 for default value. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in -xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. - -.Add component: Blogs form - Step settings +.Step settings +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -78,33 +81,31 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Endorsements blocked |Optional -|Whether you want to disable adding new endorsements for this phase. +|Whether you want to enable adding new endorsements for this phase. |=== -== Permissions - -An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make -certain actions in the blogs: - -* Comment -* Endorse - == Manage posts +To start creating and managing posts, click in the component title in the navigation bar or in the component list, or click in the +image:icons/action_edit.png[Manage component icon] icon on the components list. + image:components/blog/manage_posts.png[Manage posts table] -=== New post form +== Create a post + +To create a post, click the "New post" button on the top right of the page. image:components/blog/new_post.png[New post form] .New post form +[cols="20h,10h,~"] |=== |Field |Type |Description -|Create post as +|Author |Required -|Participant account or user group that will be the author of the post. +|Participant account or user group authoring the post. |Title |Required @@ -114,32 +115,48 @@ image:components/blog/new_post.png[New post form] |Required |What is the description of this post. +|Publish time +|Optional +|Publication date for the post. If in the future, the post is not published until this date. + |=== -==== Actions +=== Actions .Actions +[cols="10h,20h,~"] |=== |Icon |Name |Definition -|image:action_edit.png[Edit icon] +|image:icons/action_edit.png[Edit icon] |Edit -|Edit form for this post. It's the same form as "New post". +|To edit this post. -|image:action_folder.png[Folder icon] +|image:icons/action_folder.png[Folder icon] |Folder -|For classifying Attachments. +|For classifying attachments. -|image:action_attachments.png[Attachments icon] +|image:icons/action_attachments.png[Attachments icon] |Attachments -|Documents that are related to the post. +|To add documents related to the post. -|image:action_permissions.png[Permissions icon] +|image:icons/action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:icons/action_permissions.png[Permissions icon] |Permissions -|To handle the permissions of this post, depending on the verification a participant has. +|To handle the authorizations needed to comment or endorse this specific blog post. -|image:action_delete.png[Delete icon] +|image:icons/action_delete.png[Delete icon] |Delete |To delete this post. |=== + +== Examples + +Below, you can find some links to examples blog components: + +* https://meta.decidim.org/processes/news/f/1719/posts[Latest news of the Decidim association] +* https://www.decidim.barcelona/processes/volem-decidir/f/6338/posts[News on a participatory process in Barcelona] diff --git a/docs/en/modules/admin/pages/components/budgets.adoc b/docs/en/modules/admin/pages/components/budgets.adoc index 906b1d89db..28e4d65262 100644 --- a/docs/en/modules/admin/pages/components/budgets.adoc +++ b/docs/en/modules/admin/pages/components/budgets.adoc @@ -1,130 +1,125 @@ = Budgets -:page-toclevels: 4 -The Budgets component allows people to vote by selecting projects of their choosing. Depending on the needs and normative -of the organization, this could be configured so people have assigned a total budget (for instance, 100.000 EUR) and then -every project has assigned a value (for instance, 10.000 EUR). Then when people vote on projects, they have a progress bar -where they see how much remaining budget they have to allocate in this voting. +== Understand the basics -From this starting point, there could be other configurations, such as: +The Budgets component allows participants to vote by selecting projects of their choosing. Administrators can decide the voting rules, +to make participants select a defined number of projects, or vote for as many project they want until reaching a certain amount. -* A minimum percentage of budget to be allocated -* A minimum number of projects to be allocated -* Multiple budgets, one for each district or neighborhood +image::components/budgets/example01.png[Budgets example voting] -Some examples of where this component was used: +Administrators have several options for the voting workflow and for the voting rules. -* https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona]. -The city of Barcelona (Spain) has allocated a budget of 30.000.000 EUR so people can present, define, prioritize, vote -and choose which investment projects the city government should execute. -* https://ecrivons.angers.fr/processes/BP2021[2021 Participatory Budgeting Process in Angers]. The city of Angers (France) has allocated -a budget of 1.000.000 EUR so people from 11 years can propose maximum of 3 ideas and then vote for their 5 favorite projects. -* https://omastadi.hel.fi/[2021 Participatory Budgeting Process in Helsinki]. Helsinki has allocated 8.8 million euros to realising -residents’ wishes. The ideas are developed together into proposals that Helsinki residents can vote on. The proposals with the -most votes are realised by the City. +image::components/budgets/example02.png[Budgets example voting] + +In this documentation section, you can find how to configure and manage all of those items: + +* xref:admin:components/budgets/budgets.adoc[Budgets] +* xref:admin:components/budgets/projects.adoc[Projects] + +== Configuration + +To create a Budgets component component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. + +image::components/budgets/component_budgets.png[Add Budgets component button] -image:components/budgets/example01.png[Budgets example voting] -image:components/budgets/example02.png[Budgets example error messagge when exceding the amount of budget] -image:components/budgets/example03.png[Budgets vote confirmation] -image:components/budgets/example04.png[Budgets after voting] +Then: -To configure the Budgets component: +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Budgets" +. Fill the component creation form -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". -. Go to components -. Click on "Add component" button -. Click on "Budgets" -. Fill the xref:_add_component[Add component] form +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] Configure icon in the components list. -== Add component +The component creation form is divided into different sections detailed below. -image:components/budgets/component.png[Add component form] +image::components/budgets/component_01.png[Add component form title] -.Add component: Budgets form +.Budgets form +[cols="20h,10h,~"] |=== |Field |Type |Description |Name |Required -|What is the title of this component. For instance, "Budgets" +|The title of this component. |Order position |Optional -|Which order will it have in relation to the other budgets. Having a lower number means a higher priority. -For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b" with weight "0", then "Budget b" will be first when ordering. +|The order of the component in relation with the other components. Having a lower number means a higher priority. +For instance, if you have two components, "Component a" with weight "10" and "Component b" with weight "0" +then "component b" is first when ordering. |=== -.Add component: Budgets form - Global settings +image::components/budgets/component_02.png[Add component form - Global settings] + +.Budgets form - Global settings |=== |Field |Type |Description |Scopes enabled |Optional -|Check if you want to have Scopes filtering in this component. +|Check if you want to have Scopes filtering available in this component. |Scope |Optional -|Which xref:admin:scopes.adoc[Scope] does this component belongs to. - -|Global scope -|Optional -| +|Which xref:admin:settings/scopes.adoc[Scope] does this component belongs to. -|xref:_workflows[Workflow] +|Workflow |Required -|How the participants can vote if there are multiple budget sets. You can define your own xref:_workflows[Workflow] or use one of the availables. +|How the participants can vote if there are multiple budget sets. You can define your own workflow or use one already available. |Projects per page |Required -|How many projects are displayed per page. +|How many projects are displayed per page on the Budget landing page. |Enable rule: Minimum budget percentage -|Optional, but incompatible with "Minimum number of projects to be voted on" and "Selected projects with minimum and maximum number of projects to be voted on" -|Allows to define a "Vote threshold percent", a percent of the total budget that participants must reach to be able to vote. +|Optional, but incompatible with the 2 other voting rules. +|Allows to define a "Vote threshold percent" meaning a percent of the total budget that participants +must reach to be able to finish voting. |Enable rule: Minimum number of projects to be voted on -|Optional, but incompatible with "Minimum budget percentage" and "Selected projects with minimum and maximum number of projects to be voted on" -|Allows to define a "Minimum number of projects to vote", a number of projects that participants must reach to be able to vote. +|Optional, but incompatible with the 2 other voting rules. +|Allows to define a "Minimum number of projects to vote" meaning a number of projects that participants +must reach to be able to finish voting. |Enable rule: Selected projects with minimum and maximum number of projects to be voted on -|Optional, but incompatible with "Minimum budget percentage" and "Minimum number of projects to be voted on" -|Allows to define a "Minimum amount of projects to be selected" and a "Maximum amount of projects to be selected", the number of projects -that participants will need to vote as a minimum and maximum. +|Optional, but incompatible with the 2 other voting rules. +|Allows to define a "Minimum amount of projects to be selected" and a "Maximum amount of projects to be selected" meaning +the number of projects that participants need to vote as a minimum and maximum to be able to finish voting. |Comments enabled |Optional -|Whether you want to have comments in the meetings. +|Whether you want participants to be able to comment the projects. |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|The characters limit that participants have when making comments. Leave 0 for default value. |Actions permissions can be set for each project |Optional -|Whether you want to be able to set permissions for every one of the projects. Most of the time you will want to leave this option disabled. +|Whether you want to be able to set permissions for every one of the projects. |Announcement |Optional -|A general announcement that'll be visible on the general budgets landing page. +|A general announcement visible on the general budgets landing page. |Budgets landing page |Optional -|What message will be shown in the Budgets landing page when there are multiple budgets. +|The message shown in the Budgets landing page when there are multiple budgets. |More information modal |Optional -|What message will be shown when clicking on the "More information" link. +|The message shown when clicking on the "More information" link. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in -xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. +image::components/budgets/component_03.png[Add component form - Step settings] -.Add component: Budgets form - Step settings +.Budgets form - Step settings +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -134,223 +129,56 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |Voting |Required -|Choose one of the following options depending in the moment of the process: Voting disabled, Voting enabled or Voting finished. +|Choose one of the following options depending in the phase of the process: Voting disabled, Voting enabled or Voting finished. |Show votes |Optional -|Wheter the votes will be shown. We strongly recommend that you only check this option after the voting is finished. +|Wether the votes count are public. We strongly recommend that you only check this option after the voting is finished. |Announcement |Optional -|A general announcement that'll be visible on the general budgets landing page. +|A general announcement visible on the general budgets landing page. |Budgets landing page |Optional -|What message will be shown in the Budgets landing page when there are multiple budgets. +|The message shown in the Budgets landing page when there are multiple budgets for this phase. |More information modal |Optional -|What message will be shown when clicking on the "More information" link. - -|=== - -== Permissions - -Edit permissions - -* Vote -* Comment - -== Workflows - -One neat feature of the Budgets component is the ability to define your own workflows. - -This means that you can define multiple Budgets, for instance one for every Neighberhood or District that a City has, and -you can also define multiple rullings regarding how people can vote on those Budgets. By default you have these workflows: - -* Vote in one: allows participants to vote in any budget, but only in one. -* Vote in all: allows participants to vote in all budgets. -* Vote in a random component: allows participants to vote only in one budget, selected randomly. - -But this can be extended in your application by a developer, by making your own Workflows. For instance for the -https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona], -the people could vote in two districts: the one where they lived and one of their choosing. This was defined in the -https://github.com/AjuntamentdeBarcelona/decidim-barcelona/blob/743be2a210e8745d2dc443166642b285aed2b356/lib/budgets_workflow_pam2021.rb[decidim-barcelona application itself]. - -You can read more about Worfklows in https://github.com/decidim/decidim/blob/1ab5cd8fdabef48f5be94ff9c30c6bb3bc9a2f8f/decidim-budgets/README.md#budget-workflows[decidim-budgets README.md]. - -NOTE: You only want to have a voting without much complications? Like a city-wide vote? Don't worry: if you define only one -Budget, then people will go there directly when click in the Budgets section. - -== Manage budgets - -image:components/budgets/manage_budgets.png[Manage budgets table] - -This window also lets you see the votes that the various projects have received. (Number of votes) and the total number of votes (*Finished votes* and *Pending votes*, that is, that a participant has started voting but has still not cast their vote). - -=== Export all - -Allows to export the projects for this budget in different formats. - -* Projects as CSV -* Projects as JSON -* Projects as Excel - -=== New budget form - -image:components/budgets/new_budget.png[New budget form] - -.New budget form -|=== -|Field |Type |Description - -|Title -|Required -|What is the title of this budget. For instance, "District A" - -|Order position -|Optional -|Which order will it have in relation to the other budgets. Having a lower number means a higher priority. -For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b" with weight "0", then "Budget b" will be first when ordering. - -|Description -|Optional -|What is the description of this budget. - -|Total budget -|Required -|What is the total amount of money that people will have for assigning. - -|=== - -==== Actions - -.Actions -|=== -|Icon |Name |Definition - -|image:action_preview.png[Preview icon] -|Preview -|To see how it's shown in the frontend to participants. - -|image:action_list.png[Manage projects icon] -|xref:_manage_projects[Manage projects] -|Allows you to manage the projects of a budget. - -|image:action_edit.png[Edit icon] -|Edit -|Edit form for a budget. It's the same form as "New budget". - -|image:action_delete.png[Delete icon] -|Delete -|To delete this budget. Only can be done when there aren't any projects. - -|=== - -==== Manage projects - -===== Import proposals to projects - -Depending in the normative, you could want to have a first phase where participants -make proposals, and those proposals are selected (by voting or by technical review), -then you can import those proposals and convert them to projects. - -For this to work: - -. The following settings in the proposals component need to be enabled: -.. Proposal answering enabled -.. Enable costs on proposal answers -. A valuator or administrator need to Answer proposals: -.. Review the proposals -.. Accept or reject them according to your normative -.. Add costs to the proposals if were accepted -. An administrator can Import proposals to projects - -image:components/budgets/import_proposals.png[Import proposals to projects] - -===== Export all - -Allows to export the projects for this budget in different formats. - -* Projects as CSV -* Projects as JSON -* Projects as Excel - -===== New project form - -image:components/budgets/new_project.png[New project form for a Budget] - -.New project form -|=== -|Field |Type |Description - -|Title -|Required -|The title for this project. - -|Description -|Required -|A description of what this project is about. - -|Budget amount -|Required -|What's the budget amount for this project. How much money will it cost to implement this project? - -|Category -|Optional -|Which Category has the project. Used for filtering in the budgets list. - -|Proposals -|Optional -|Choose related proposals for this project. Automatic assingned when importing proposals. - -|Add an image gallery -|Optional -|Add multiple images illustrating what this project is about, or where it will be implemented. +|The message shown when clicking on the "More information" link for this phase. |=== -===== Actions - -.Actions -|=== -|Icon |Name |Definition +== Results -|image:action_preview.png[Preview icon] -|Preview -|To see how it's shown in the frontend to participants. +After the voting has finished, an administrator need to: -|image:action_edit.png[Edit icon] -|Edit -|Edit form for a project. It's the same form as "New project". +. Change the Voting configuration for the Budget component to "Voting finished" +. Go in the projects list and view the results +. On the projects that have been selected, go in each project, edit it and tick the "Selected for implementation" checkbox. -|image:action_folder.png[Folders icon] -|Folders -|For classifying Attachments. +image::components/budgets/results_select_project.png[Select a project for implementation] -|image:action_attachments.png[Attachments icon] -|Attachments -|Documents that are related to the project. +Then, the projects list shows all the project that have been selected for implementation. -|image:action_delete.png[Delete icon] -|Delete -|To delete this project. +image::components/budgets/results_selected.png[Selected projects after voting] -|=== +A filter is also displayed for participants to see which projects have been selected, and find the ones that weren't selected. -== Results +image::components/budgets/results_selected_frontend.png[Selected projects after voting in the frontend] -After the voting step has finished, then an administrator need to: +TIP: Once you have selected projects, then you can enable the xref:components/accountability.adoc[Accountability] +component so participants can see the progress of the projects implementation. -. Change the Voting configuration for the Budget component to "Voting finished" -. Go to the Budgets and view the results -. On the projects that according to the normative have been selected, they will need to go to each project, edit it and -then check the "Selected for implementation". +== Examples -image:components/budgets/results_unselected.png[Unselected projects after voting] -image:components/budgets/results_select_project.png[Select a project for implementation] -image:components/budgets/results_selected.png[Selected projects after voting] -image:components/budgets/results_selected_frontend.png[Selected projects after voting in the frontend] +Some examples of where this component was used: -We strongly recommend that after you have selected projects then you enable the xref:components/accountability.adoc[Accountability] -component so participants can see the grade of impementation. +* https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona]. +The city of Barcelona (Spain) has allocated a budget of 30.000.000 EUR so people can present, define, prioritize, vote +and choose which investment projects the city government should execute. +* https://ecrivons.angers.fr/processes/BP2021[2021 Participatory Budgeting Process in Angers]. The city of Angers (France) has allocated +a budget of 1.000.000 EUR so people from 11 years can propose maximum of 3 ideas and then vote for their 5 favorite projects. +* https://omastadi.hel.fi/[2021 Participatory Budgeting Process in Helsinki]. Helsinki has allocated 8.8 million euros to realising +residents’ wishes. The ideas are developed together into proposals that Helsinki residents can vote on. The proposals with the +most votes are realised by the City. \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/budgets/budgets.adoc b/docs/en/modules/admin/pages/components/budgets/budgets.adoc new file mode 100644 index 0000000000..0b308002b3 --- /dev/null +++ b/docs/en/modules/admin/pages/components/budgets/budgets.adoc @@ -0,0 +1,110 @@ += Budgets + +== Understand the basics + +It's important to understand that Budget is not only the name of the component, but is also an entity of the component. +Indeed, a same Budget component can contain multiple budgets. + +image::components/budgets/multiple_budgets_front.png[Budgets list in frontend] + +This allows to create complex workflows and answer several use cases. + +== Configuration + +Once you created your Budget component, you are redirected to the Budget list. There, you can create and manage the budgets of +your component. Depending on the process you want to organize, you can choose: + +* To create a unique budget, where all your projects to be voted on are displayed. +* To create multiple budgets, with dedicated projects inside each of them. + +The first thing to do is to create your first budget, by clicking the "New budget" button. + +image::components/budgets/new_budget_button.png[New budget button] + +== Budget creation + +image::components/budgets/new_budget.png[New budget form] + +.New budget form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|What is the title of this budget. For instance, "District A" + +|Order position +|Optional +|Which order it has in relation to the other budgets. Having a lower number means a higher priority. +For instance, if you have two budgets, "Budget a" with weight "10" and "Budget b" with weight "0" then "Budget b" is first when ordering. + +|Description +|Optional +|The description of this budget, only displayed visible by participants if there is multiple budgets. + +|Total budget +|Required +|The total amount of money available for this budget. + +|=== + +== Manage budgets + +image::components/budgets/manage_budgets.png[Manage budgets table] + +On the budgets list in the administration panel, administrators can see: + +* *Name*: Name of the budget. +* *Total budget*: The total budget allocated to the budget. +* *Projects count*: The number of projects included in each budget. + +This page also lets you see the finished and pending votes that the various projects have received across all budgets. + +You can also export all the projects of the component in different formats in CSV, JSON and Excel formats. + +=== Actions + +.Actions +[cols="10h,~,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|To edit the budget. + +|image:icons/action_list.png[Manage projects icon] +|xref:admin:components/budgets/projects.adoc[Manage projects] +|Allows to manage the projects of a budget. + +|image:icons/action_preview.png[Preview icon] +|Preview +|To see the budget page in the user interface. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete this budget. Can only be done when there aren't any projects. + +|=== + +== Workflows + +One neat feature of the Budgets component is the ability to define your own workflows. + +This means that you can define multiple Budgets, for instance one for every city neighborhood or district, define multiple +rules regarding how people can vote on those Budgets. By default, three workflows are available: + +* Vote in one: allows participants to vote in any budget, but only in one. +* Vote in all: allows participants to vote in all budgets. +* Vote in a random component: allows participants to vote only in one budget, selected randomly. + +This can be extended in your application by a developer, by developing your own Workflows. For instance for the +https://www.decidim.barcelona/processes/PressupostosParticipatius[2020/2021 Participatory Budgeting Process in Decidim Barcelona], +the people could vote in two districts: the one where they lived and one of their choosing. This was defined in the +https://github.com/AjuntamentdeBarcelona/decidim-barcelona/blob/743be2a210e8745d2dc443166642b285aed2b356/lib/budgets_workflow_pam2021.rb[decidim-barcelona application itself]. + +You can read more about Workflows in https://github.com/decidim/decidim/blob/1ab5cd8fdabef48f5be94ff9c30c6bb3bc9a2f8f/decidim-budgets/README.md#budget-workflows[decidim-budgets README.md]. + +NOTE: You only want to have a voting without much complications? Like a city-wide vote? Don't worry: if you define only one +Budget, then people are redirected directly on the projects list. diff --git a/docs/en/modules/admin/pages/components/budgets/projects.adoc b/docs/en/modules/admin/pages/components/budgets/projects.adoc new file mode 100644 index 0000000000..ae90cad5b7 --- /dev/null +++ b/docs/en/modules/admin/pages/components/budgets/projects.adoc @@ -0,0 +1,130 @@ += Projects + +== Understand the basics + +Projects are the entities making part of the budgets. + +== Create a project + +To access the creation and management of projects, click the title of the budget or the image:icons/action_list.png[Manage projects icon] +icon on the budgets list. + +image::components/budgets/new_project_button.png[New project button] + +Then, click the "New project" button on the top right of the page. + +image::components/budgets/new_project.png[New project form] + +.New project form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|The title for this project. + +|Description +|Required +|A description of what this project is about. + +|Budget amount +|Required +|What's the budget amount for this project. How much money it costs to implement this project? + +|Address +|Optional +|The address of the project. It allows to display a pin on a map for participants to locate the project. + +|Category +|Optional +|Which Category has the project. Used for filtering in the budgets list. + +|Proposals +|Optional +|Choose related proposals for this project. Automatically assigned when importing proposals. + +|Add an image gallery +|Optional +|Add multiple images illustrating what this project is about, mock-ups, etc. + +|=== + +== Manage projects + +image::components/budgets/results_selected.png[Selected projects after voting] + +On the projects list in the administration panel, administrators can see: + +* *ID*: Identification number for this project. +* *Title*: Title of the project. +* *Category*: Category of the project. +* *Scope*: Scope of the project, if enabled in the participatory space. +* *Votes count*: Number of votes on this project. +* *Selected*: If the project is selected for implementation at the end of the process. +* *Map*: Location of the project when it has an address. + +You can filter and sort this list by clicking the "Filter" button and the columns headers. +You can also search for projects by their ID and title in the search bar. + +image::components/budgets/projects_list_filter.png[Projects list filter] + +=== Actions + +.Actions +[cols="10h,20h,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|Edit form for a project. + +|image:icons/action_folder.png[Folders icon] +|Folders +|For classifying Attachments. + +|image:icons/action_attachments.png[Attachments icon] +|Attachments +|To add documents and images related to the project. + +|image:icons/action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:icons/action_permissions.png[Permissions icon] +|Permissions +|To handle the authorizations needed to vote or comment on this specific project. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete this project. + +|=== + +=== Import proposals to projects + +Depending in the normative, you could want to have a first phase where participants +make proposals, and those proposals are selected (by voting or by technical review), +then you can import those proposals and convert them to projects. + +For this to work: + +. The following settings in the proposals component need to be enabled: +.. Proposal answering enabled +.. Enable costs on proposal answers +. A valuator or administrator need to Answer proposals: +.. Review the proposals +.. Accept or reject them according to your normative +.. Add costs to the proposals if were accepted +. An administrator can Import proposals to projects + +image:components/budgets/import_proposals.png[Import proposals to projects] + +=== Export all + +Allows to export the projects for this budget in different formats. + +* Projects as CSV +* Projects as JSON +* Projects as Excel diff --git a/docs/en/modules/admin/pages/components/debates.adoc b/docs/en/modules/admin/pages/components/debates.adoc index 30e50db73b..818015c63c 100644 --- a/docs/en/modules/admin/pages/components/debates.adoc +++ b/docs/en/modules/admin/pages/components/debates.adoc @@ -1,52 +1,49 @@ -= Debate += Debates -The Debate component allows people to have discussions, without voting nor prioritzation. It also allows to close them, -by adding conclusions or a summary of what the discussion was about. +== Understand the basics -From this starting point, there could be other configurations, such as: +The Debate component allows people to have discussions, without voting nor prioritization. It also allows to close debates, +by adding conclusions or a summary of what the discussion was about. -* To allow debates creation by participants -* To have debates with a fixed started and ending date or open -* To show endorsements (public supports) or not +image::components/debates/example01.png[Debates listing example] -Some examples of where this component was used: +== Configuration -* https://meta.decidim.org/processes/roadmap/f/219/[Propose new functionalities for Decidim software in Metadecidim] +To create a Debate component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. -image:components/debates/example01.png[Debates listing example] -image:components/debates/example02.png[Debate example] +image::components/debates/component_debate.png[Add Debate component button] -To configure the Debate component: +Then: -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". -. Go to components -. Click on "Add component" button -. Click on "Debate" -. Fill the xref:_add_component[Add component] form +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Debate" +. Fill the component creation form -== Add component +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] Configure icon in the components list. -image:components/debates/component.png[Add component form] +image::components/debates/component.png[Add component form] .Add component: Debate form +[cols="20h,10h,~"] |=== |Field |Type |Description |Name |Required -|What is the title of this component. For instance, "Debates" +|The title of this component. |Order position |Optional -|Which order will it have in relation to the other debates. Having a lower number means a higher priority. -For instance, if you have two debates, "Debate a" with weight "10" and "Debate b" with weight "0", then "Debate b" will be first when ordering. +|The order of the component in relation with the other components. Having a lower number means a higher priority. +For instance, if you have two components, "Component a" with weight "10" and "Component b" with weight "0" +then "component b" is first when ordering. |=== -.Add component: Debate form - Global settings +.Debate form - Global settings +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -56,19 +53,15 @@ For instance, if you have two debates, "Debate a" with weight "10" and "Debate b |Scope |Optional -|Which xref:admin:scopes.adoc[Scope] does this component belongs to. - -|Global scope -|Optional -| +|Which xref:admin:settings/scopes.adoc[Scopes] does this component belongs to. |Comments enabled |Optional -|Whether you want to have comments in the meetings. +|Whether you want to have comments in the debates. |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|The characters limit that participants have when making comments. Leave 0 for default value. |Announcement |Optional @@ -76,24 +69,22 @@ For instance, if you have two debates, "Debate a" with weight "10" and "Debate b |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in -xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. - .Add component: Debates form - Step settings +[cols="20h,10h,~"] |=== |Field |Type |Description |Endorsements enabled |Optional -|Check if you want that participants show public support for these debates. +|Check if you want to enable participants to show public support for debates. |Endorsements blocked |Optional -| +|Check is you want to block new endorsements to be performed on debates at this phase. -|Debate creation by participants enabled +|Participants can create debates |Optional -|Check if you want to allow the creation of new debates by participants. +|Check if you want to allow the creation of new debates by participants during this phase. |Comments blocked |Optional @@ -105,54 +96,35 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |=== -== Permissions - -An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make -certain actions in the debates: +== Create a debate -* Create -* Endorse - -== Manage debates - -image:components/debates/manage_debates.png[Manage debates table] - -=== Export all - -Allows exporting the comments in the debates in different formats. - -* Comments as CSV -* Comments as JSON -* Comments as Excel - -=== New debate form - -image:components/debates/new_debate_backend.png[New debate backend form] +image::components/debates/new_debate_backend.png[New debate backend form] .New debate form +[cols="20h,10h,~"] |=== |Field |Type |Description |Title |Required -|What is the title of this debate. For instance, "How can we improve this process?" +|The title of this debate. |Description |Required -|What is the description of this debate. +|The description of this debate. |Instructions to participate |Required -|Add a message for the participants. +|Add a message for the participants, displayed on the debate page in an information box. |Information updates |Optional -|Add a message for the participants. +|Add a message for the participants, displayed on the debate page in an information box. |xref:_debate_types[Debate type] |Required |Choose between Finite and Open. Finite means that the debate has a starting and ending date and time, Open means that -there isn't any timeframe. +there isn't any time frame. |Starts at |Required if the debate type is Finite @@ -166,56 +138,83 @@ there isn't any timeframe. |Optional |Which category has the debate. Used for filtering in the debates list. +|Comments enabled +|Optional +|Whether you want participants to be able to comment on this debate. + |=== -==== Debate types +== Manage debates + +To start creating and managing debates, click in the component title in the navigation bar or in the component list, or click in the +image:icons/action_edit.png[Manage component icon] icon on the components list. + +image::components/debates/manage_debates.png[Manage debates table] + +On the debates list in the administration panel, administrators can see: + +* *Title*: Title of the debate. +* *Start date*: Start date of the debate. +* *End date*: End date of the debate. +* *Scope*: Scope of the debate, if enabled in the participatory space. + +You can also export the comments in the debates in CSV, JSON and Excel format by clicking the "Export all" button. + +=== Debate types It's possible to have two kinds of debates: . Finite: with a start and end date . Open: without a start and end date -This is shown publically in the debate list. +This is shown publicly in the debate list. image:components/debates/debates_list.png[Debates list] -image:components/debates/debate_finite.png[Finite debate] -==== Actions +=== Actions + +NOTE: When participants can create debates, administrators have less actions available, and can't edit nor delete the debates. .Actions +[cols="10h,20h,~"] |=== |Icon |Name |Definition -|image:action_edit.png[Edit icon] +|image:icons/action_edit.png[Edit icon] |Edit -|Edit form for a debate. It's the same form as "New debate". +|Edit form for a debate. -|image:action_close.png[Close icon] +|image:icons/action_close.png[Close icon] |Close |Close form for a debate. For adding conclusions. -|image:action_permissions.png[Permissions icon] +|image:icons/action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:icons/action_permissions.png[Permissions icon] |Permissions -|To handle the permissions of this debate, depending on the verification a participant has. +|To handle the authorizations needed to create or endorse debates. -|image:action_delete.png[Delete icon] +|image:icons/action_delete.png[Delete icon] |Delete -|To delete this debate. Only can be done when there aren't any projects. +|To delete this debate. |=== === Close debate form -A debate can be closed. This is useful for adding conclusions. After a debate was closed it can't be edited nor commented any more +A debate can be closed. This is useful for publishing debates conclusions. +After a debate was closed it can't be edited nor commented any more. -image:components/debates/close_debate_backend.png[Close debate backend form] +image::components/debates/close_debate_backend.png[Close debate backend form] -Take in account that if the debate was created by a participant then only that -participant can close it. +Take into account that if the debate was created by a participant, then only that participant can close it. -image:components/debates/close_debate_frontend.png[Close debate frontend form] +image::components/debates/close_debate_frontend.png[Close debate frontend form] .Close debate form +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -227,4 +226,10 @@ image:components/debates/close_debate_frontend.png[Close debate frontend form] The conclusions are shown publicly with the close date and time. -image:components/debates/debate_closed.png[Closed debate] +image::components/debates/debate_closed.png[Closed debate] + +== Examples + +Some examples of where this component is used: + +* https://meta.decidim.org/processes/roadmap/f/219/[Propose new functionalities for Decidim software in Metadecidim] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/meetings.adoc b/docs/en/modules/admin/pages/components/meetings.adoc index 68b7ec471f..5e2cdde182 100644 --- a/docs/en/modules/admin/pages/components/meetings.adoc +++ b/docs/en/modules/admin/pages/components/meetings.adoc @@ -1,51 +1,40 @@ = Meetings -Meetings are where people come together to discuss or inform about a given topic. All the meetings have a given location -(where the meeting will happen) and start and end date and time (when the meeting will happen). +== Understand the basics -Some examples of where this component was used are: +The Meetings component allows administrators to organize, advertise, deal with registration and wrap up in-person or online meetings. +Depending on the component configuration, meetings can be created only by administrators, or also by participants. -* https://www.decidim.barcelona/processes/PAM2020/f/3734/[Procés participatiu del Programa d'Actuació Municipal (PAM) 2020-2023] -in https://www.decidim.barcelona/[Decidim Barcelona] -* https://lejourdapres.parlement-ouvert.fr/processes/ateliers/f/14/[Les ateliers] in https://lejourdapres.parlement-ouvert.fr/[Le jour d'après] +In this documentation section, you can find how to configure and manage all of those items: -image:components/meetings/example01.png[Meetings list in Decidim Barcelona] -image:components/meetings/example02.png[Example meeting detail 01 in Decidim Barcelona] -image:components/meetings/example03.png[Example meeting detail 02 in Decidim Barcelona] -image:components/meetings/example04.png[Meetings list in Le jour d'après] +* xref:admin:components/meetings/meetings.adoc[Meetings creation]: Create official or participant meetings. +* xref:admin:components/meetings/registrations.adoc[Registrations]: Manage how participants can register to attend the meetings. +* xref:admin:components/meetings/agenda.adoc[Agenda]: Announce the meetings topics to be discussed. +* xref:admin:components/meetings/polls.adoc[Polls]: Enable quick voting during an online meeting. +* xref:admin:components/meetings/close.adoc[Close]: Add the final report and minutes of the meeting. -== Types +image::components/meetings/example01.png[Example meeting detail 01] -Regarding the *location*, depending on the configuration of the component, you can have: +== Configuration -* In-person meetings: where you get together in a given location -* Online meetings: where you get together using an external service (for instance Jitsi Meet) +To create a Meetings component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. -Depending in the *author* (who's the person that's making the call): +image::components/meetings/component_meeting.png[Add Meetings component button] -* Official meetings: meetings created by the organization (created by an administrator through the panel) -* Citizens meetings: meetings created by a User participant (a User or an UserGroup). +Then: -== Add the component +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Meetings" +. Fill the component creation form -image:components/meetings/component.png[Add a meetings component] +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] icon in the components list. -For adding the component, you need to: - -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Go to components -. Click on "Add component" button -. Click on "Meetings" -. Fill the xref:_add_component[Add component] form - -== Add component - -For configuring the meeting component you have these settings: +image::components/meetings/component.png[Add a meetings component] .Add component - Meetings form +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -55,42 +44,45 @@ For configuring the meeting component you have these settings: |Order position |Optional -|Which order will it have in relation with the other components. Having a lower number means a higher priority. For instance, -if you have two components, "Proposals" with weight "10" and "Meetiings" with weight "0", then "Meetings" will be first when ordering. +|The order of the component in relation with the other components. Having a lower number means a higher priority. +For instance, if you have two components, "Component a" with weight "10" and "Component b" with weight "0" +then "component b" is first when ordering. |=== .Add component - Meetings form: Global settings +[cols="20h,10h,~"] |=== |Field |Type |Description |Scopes enabled |Optional -|Check if you want to have Scopes filtering in this process. +|Check if you want to have Scopes filtering in this component. |Scope |Optional -|Which scope will be used for this component. +|Which xref:admin:settings/scopes.adoc[Scopes] does this component belongs to. |Announcement |Optional -|A general announcement that'll be visible in the general meetings list. +|A general announcement visible in the meetings list in the participant interface. |Default registration terms |Optional -|What'll be the registration terms of service that the participant would need to accept when registering. +|The registration terms of service that the participant need to accept when registering. |Comments enabled |Optional -|Whether you want to have comments in the meetings. +|Whether you want to have comments creation enabled in the meetings. |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|The characters limit that participants have when making comments. Leave 0 for default value. |Registration code enabled |Optional -|Check if you want to give registration codes to participants. Learn more in xref:components/meetings/registrations.adoc[Registrations]. +|Check if you want to automatically give registration codes to participants. +Learn more in xref:components/meetings/registrations.adoc[Registrations]. |Actions permissions can be set for each meeting |Optional @@ -102,310 +94,32 @@ if you have two components, "Proposals" with weight "10" and "Meetiings" with we |Participants can create meetings |Optional -|Allows participants to create new meetings. See xref:_citizens_meetings[Citizens meetings] +|Allows participants to create new meetings. Learn more in xref:_citizens_meetings[Citizens meetings]. |Maps enabled |Optional -|Wheter you want to show a map in the meetings in the meeting detail. +|Whether you want to show a map with the meetings addresses in the meetings list and pages. |=== .Add component - Meetings form: Step settings +[cols="20h,10h,~"] |=== |Field |Type |Description |Announcement |Optional -|A general announcement that'll be visible in the general meetings list. +|A general announcement visible in the general meetings list for this phase. |Comments enabled |Optional -|Whether you want to have comments in the meetings. - -|=== - -== Create a new meeting - -=== Citizens meetings - -Meetings can be created by participants if the setting is "Participants can create meetings" is checked. - -If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create meetings as that group also. - -image:components/meetings/new_meeting_form_frontend01.png[Create a new meeting form (frontend)] -image:components/meetings/new_meeting_form_frontend02.png[Create a new meeting form (frontend)] - -.Create meeting - Frontend form -|=== -|Field |Type |Description - -|Title -|Required -|What is the title for this meeting. - -|Description -|Required -|A description of what will be discussed in this meeting, like the topics. - -|Type -|Required -|Choose one option between "In person", "Online" or "Booth" - -|Address -|Required if meeting type is "In person" or "Booth" -|Address: used by Geocoder to find the location - -|Location -|Required -|Location: message directed to the users implying the spot to meet at - -|Location hints -|Optional -|Location hints: additional info. Example: the floor of the building - -|Online meeting URL -|Optional -|Which URL will the meeting be held. - -|Show embedded iframe for this URL -|Optional -|Whether or not embed the iframe for this videoconference URL. Only a few services allow embedding (i.e. YouTube, Twitch...) - -|Start Time -|Required -|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii - -|End Time -|Required -|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii - -|Category -|Optional -|Which Category has the meeting. Used for filtering in the meetings list. - -|Registration type -|Required -|Choose one option between "Registration disabled", "On this platform", or "On a different platform" - -|Available slots for this meeting -|Required if "Registration type" is "On this platform" -|How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available - -|Registration terms -|Required if "Registration type" is "On this platform" -|What terms of services participants need to accept to register or join the meeting. Specific to "Citizens meetings" - -|Registration URL -|Required if "Registration type" is "On a different platform" -|Must be an URL. Link to go on the external service that you are using for registrations. - -|Create meeting as -|Required if the participant belongs to a group -|With which identity they want to create this meeting: as their user or as a group that they are reprensenting? - -|=== - -After creating the meeting, participants can also edit and xref:components/meetings/close.adoc[close] it. - -=== Official meetings - -image:components/meetings/new_meeting_form_backend.png[Create a new meeting form (backend)] +|Whether you want to have comments creation enabled in the meetings for this phase. -.Create meeting - Backend form |=== -|Field |Type |Description - -|Title -|Required -|What is the title for this meeting. - -|Description -|Required -|A description of what will be discussed in this meeting, like the topics. - -|Type -|Required -|Choose one option between "In person", "Online" or "Booth" - -|Address -|Required if meeting type is "In person" or "Booth" -|Address: used by Geocoder to find the location - -|Location -|Required -|Location: message directed to the users implying the spot to meet at - -|Location hints -|Optional -|Location hints: additional info. Example: the floor of the building - -|Online meeting URL -|Optional -|Which URL will the meeting be held. - -|Show embedded iframe for this URL -|Optional -|Whether or not embed the iframe for this videoconference URL. Only a few services allow embedding (i.e. YouTube, Twitch...) - -|Start Time -|Required -|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii - -|End Time -|Required -|Which day and time will the meeting start. Expected format: dd/mm/yyyy hh:ii - -|Category -|Optional -|Which Category has the meeting. Used for filtering in the meetings list. - -|Registration type -|Required -|Choose one option between "Registration disabled", "On this platform", or "On a different platform" - -|Available slots for this meeting -|Required if "Registration type" is "On this platform" -|How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available - -|Registration URL -|Required if "Registration type" is "On a different platform" -|Must be an URL. Link to go on the external service that you are using for registrations. - -|Private meeting -|Optional -|Check if the meeting shouldn't be visible for all the visitors. Specific to "Official meetings". - -|Transparent -|Optional -|Related to "Private meeting", check if the meeting should be visible for all the visitors but they shouldn't be able to -participate in. Specific to "Official meetings". Specific to "Official meetings". - -|Customize registration email -|Optional -|Wheter you want to add a message in the registration email. Specific to "Official meetings". - -|Registration email custom content -|Required if "Customize registration email" is checked -|The content of the customized email. This text will appear in the middle of the registration confirmation email. Just -after the registration code. Specific to "Official meetings". - -|=== - -You can also define *Services* inside of a Meeting. These are metadata that allows to comunicate, for instance, if there's -a place for children, deaf assistance, translations, etc. You can have multiple services inside of a meeting. - -.Create meeting - Services -|=== -|Field |Type |Description - -|Title -|Required -|Title of the service. - -|Description -|Optional -|Description of the service. - -|=== - -== Actions - -=== Citizens meetings - -.Actions - Citizens meetings -|=== -|Icon |Name |Definition - -|image:action_preview.png[Preview icon] -|Preview -|To see how it's shown in the frontend to participants. - -|image:action_permissions.png[Permissions icon] -|Permissions -|To handle the permissions of this meeting, depending on the verification a participant has. Allows an admin to configure -who can *Join* a meeting. - -|=== - -=== Official meetings - -.Actions - Official meetings -|=== -|Icon |Name |Definition - -|image:action_publish.png[Publish icon] -|Publish -|To show publicly the meeting. - -|image:action_publish.png[Unpublish icon] -|Unpublish -|To not show publicly the meeting. - -|image:action_preview.png[Preview icon] -|Preview -|To see how it's shown in the frontend to participants. - -|image:action_duplicate.png[Duplicate icon] -|Duplicate -|Allows an admin to duplicate a meeting. - -|image:action_registrations.png[Registrations icon] -|xref:admin:components/meetings/registrations.adoc[Registrations] -|Allows to define who can register for attending to the meeting. - -|image:action_edit.png[Edit icon] -|Edit -|Edit form for a Meeting. It's the same form as "Create a new meeting". - -|image:action_agenda.png[Agenda icon] -|xref:admin:components/meetings/agenda.adoc[Agenda] -|To add the topics that will be discussed in the meeting. - -|image:action_list.png[Poll icon] -|xref:admin:components/meetings/polls.adoc[Polls] -|To manage the polls for this online meeting. - -|image:action_close.png[Close icon] -|xref:admin:components/meetings/close.adoc[Close] -|Allows and admin to Close the meeting and add extra information. - -|image:action_folder.png[Folders icon] -|Folders -|For classifying Attachments. - -|image:action_attachments.png[Attachments icon] -|Attachments -|Documents that are related to the meeting. - -|image:action_permissions.png[Permissions icon] -|Permissions -|To handle the permissions of this meeting, depending on the verification a participant has. Allows an admin to configure -who can *Join* a meeting. - -|image:action_delete.png[Delete icon] -|Delete -|To delete this meeting. - -|=== - -== Meetings features - -There are different kinds of features that can be enabled in meetings, such as: - -* xref:admin:components/meetings/registrations.adoc[Registrations]: for managing how particpant can register to attend the meeting. -* xref:admin:components/meetings/agenda.adoc[Agenda]: for seeing the topics that will be discussed in the meeting by minutes. -* xref:admin:components/meetings/polls.adoc[Polls]: for quick voting during an online meeting. -* xref:admin:components/meetings/close.adoc[Close]: for adding the final report on what was discussed in the meeting. -== Online meetings +== Examples -Depending in the moment and configuration of the meeting, there could be different messages that will be shown to the participants. +Some examples of where this component is used: -. If the "Online meeting URL" ins't set, there'll be a message that says "Link available soon" -image:components/meetings/online_meeting_available_soon.png[Online meeting available soon] -. If the "Online meeting URL" is set, and a few minutes before the meeting start, the mesage will say "The link to join -the meeting will be available a few minutes before it starts" -image:components/meetings/online_meeting_available_before.png[Online meeting available before it starts] -. If the "Online meeting URL" is set, and the start time of the meeting has arrived, then there'll be a message that says -that "the meeting is happening right now", with a link to join the meeting. -image:components/meetings/online_meeting_happening.png[Online meeting available before it starts] +* https://www.decidim.barcelona/processes/PAM2020/f/3734/[Program d'Actuació Municipal (PAM) 2020-2023] +* https://meta.decidim.org/assemblies/coordination-committee/f/1037/meetings[The Decidim association coordination committee meetings] diff --git a/docs/en/modules/admin/pages/components/meetings/agenda.adoc b/docs/en/modules/admin/pages/components/meetings/agenda.adoc index 42d44c47fc..a42638789c 100644 --- a/docs/en/modules/admin/pages/components/meetings/agenda.adoc +++ b/docs/en/modules/admin/pages/components/meetings/agenda.adoc @@ -1,37 +1,31 @@ = Agenda +== Understand the basics + The agenda feature allows an administrator to define the schedule for a meeting. It's possible to define agenda items and -sub-items, with every one of the topics that will be discussed in the meeting, along with a description and the duration +sub-items, with every one of the topics to be discussed in the meeting, along with a description and the duration of every item and sub-item. -image:components/meetings/agenda/agenda_frontend.png[Agenda in the frontend] +image::components/meetings/agenda/agenda_frontend.png[Agenda in the frontend] == New agenda form -To define an agenda for a meeting: - -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click on "Meetings" -. Search the meeting that you want to add the agenda to -. Click on the "Agenda" button image:action_agenda.png[Agenda button] -. Fill the form +To define an agenda for a meeting, click the image:icons/action_agenda.png[Agenda icon] Agenda icon. image:components/meetings/agenda/new_agenda_form.png[New agenda form in the backend] .New agenda form +[cols="20h,10h,~"] |=== |Field |Type |Description |Title |Required -|Title for the agenda. For instance, "Schedule" +|Title for the agenda. |Visible |Optional -|Check if you want to publish the agenda. +|Check if you want the agenda to be visible to participants. |Agenda items |Required @@ -43,6 +37,7 @@ It's possible to create any number of Agenda items and sub-items. You can up or It's also possible to remove and edit the agenda items. .Agenda item form +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -52,11 +47,11 @@ It's also possible to remove and edit the agenda items. |Duration |Required -|How many minutes will the agenda item last. For instance, "15". +|How many minutes the agenda item last. |Description |Optional -|Title for the agenda item +|Title for the agenda item. |Agenda sub-items |Optional @@ -65,27 +60,4 @@ It's also possible to remove and edit the agenda items. |=== The only limitation that agenda items and sub-items have is that they have to respect the duration of the parent. For instance, -if there's an Item that lasts 60 minutes, you can't create a sub-item that lasts 90 minutes. - -As an example, this agenda: - -image:components/meetings/agenda/agenda_frontend.png[Agenda in the frontend] - -Has the following configuration: - -* Title: "Schedule" -* Visible: true -* Agenda item #1: -** Title: Diagnosis -** Duration: 60 -* Agenda item #2: -** Title: Ideation -** Duration: 120 -** Agenda sub-item #2.1: -*** Title: Future thinking -*** Duration: 60 -*** Description: Imagining how we can solve the problem -** Agenda sub-item #2.2: -*** Title: Creating proposals -*** Duration: 60 -*** Description: In the platform +if there's an item that lasts 60 minutes, you can't create a sub-item that lasts 90 minutes. diff --git a/docs/en/modules/admin/pages/components/meetings/close.adoc b/docs/en/modules/admin/pages/components/meetings/close.adoc index b9c058ae8d..bbebc48e26 100644 --- a/docs/en/modules/admin/pages/components/meetings/close.adoc +++ b/docs/en/modules/admin/pages/components/meetings/close.adoc @@ -1,33 +1,27 @@ = Close -After a meeting has passed it's possible and recommened to close the meeting. This allows to adds the minutes, the notes +== Understand the basics + +Once a meeting is over, the meeting author can close the meeting. This allows to adds the meeting minutes, the notes that gives a summary on what was discussed during the meeting, the agreements reached, decisions made, etc. This allows to bring transparency to the meeting and also serves as a record of the different meetings. -It's also possible to add other kind of metadata to the meeting, such as what organizations has attended, how many attendees -and contributions were, and what proposals were discussed. +It's also possible to add other kind of metadata to the meeting, such as the organizations who attended, how many attendees +and contributions there were, and what proposals were discussed. -image:components/meetings/close/frontend.png[Close report in the frontend] +image::components/meetings/close/frontend.png[Close report in the frontend] -== Close meeting form +== Close a meeting === Official meetings -To close a meeting: - -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click on "Meetings" -. Search the meeting that you want to close -. Click on the "Close" button image:action_close.png[Close button] -. Fill the form +To close a meeting as an administrator, click the image:icons/action_close.png[Close button] "Close" icon. -image:components/meetings/close/form_backend.png[Close meeting form in the backend] +image::components/meetings/close/form_backend.png[Close meeting form in the backend] .Close meeting form (backend) +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -41,7 +35,7 @@ image:components/meetings/close/form_backend.png[Close meeting form in the backe |Number of attendees |Required -|Metadata that gets shown in the sidebar of the meeting. Must be a number. +|Number of persons who attended the meeting. Must be a number. |Number of contributions |Optional @@ -49,36 +43,35 @@ image:components/meetings/close/form_backend.png[Close meeting form in the backe |Proposals |Optional -|Choose proposals from this space that were discussed in this meeting +|Choose proposals from this participatory space that were discussed or elaborated in this meeting. |Video URL |Optional -|It's not used for anything. It will be removed in the future. +|Deprecated field. |Audio URL |Optional -|It's not used for anything. It will be removed in the future. +|Deprecated field. |Is visible |Optional -|Check if you want to publish the close report +|Check if you want to publish the close report so it can be read by participants. |=== === Citizens meetings -Just like participants can create meetings, they can also close a meeting. They have fewer fields to fill. +Just like participants can create meetings, they can also close a meeting. They have fewer fields to fill than administrators. -To close a a meeting: +image::components/meetings/close/button_frontend.png[Close meeting button in the frontend] -. Sign in as the participant that created the meeting -. Go to the meeting page -. Click on "Close". This will only be visible after the meeting has passed -. Fill the form +Once the meeting has finished, the author of the meeting can see a "Close meeting" button. By clicking on it, they are redirected to +the closing form. -image:components/meetings/close/form_frontend.png[Close meeting form in the frontend] +image::components/meetings/close/form_frontend.png[Close meeting form in the frontend] .Close meeting form (frontend) +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -88,16 +81,20 @@ image:components/meetings/close/form_frontend.png[Close meeting form in the fron |Number of attendees |Required -|Metadata that gets shown in the sidebar of the meeting. Must be a number. +|Number of persons who attended the meeting. Must be a number. |Proposals |Optional -|Choose proposals from this space that were discussed in this meeting +|Choose proposals from this participatory space that were discussed or elaborated in this meeting. |=== -== Proposals +== Related proposals + +If you link a proposal to a meeting when closing it, the meeting also appears in the proposal page. + +image::components/meetings/close/related_meeting.png[Related meeting in a proposal] -If you relate a proposal to a meeting, the meeting also will be shown in the proposal. +This allows participants to navigate quickly in a proposal journey. -image:components/meetings/close/related_proposal.png[Related meeting in a proposal] +image::components/meetings/close/related_proposal.png[Related proposal in a meeting] diff --git a/docs/en/modules/admin/pages/components/meetings/meetings.adoc b/docs/en/modules/admin/pages/components/meetings/meetings.adoc new file mode 100644 index 0000000000..90dda00a68 --- /dev/null +++ b/docs/en/modules/admin/pages/components/meetings/meetings.adoc @@ -0,0 +1,317 @@ += Meetings + +== Understand the basics + +Meetings are also the entities making part of the Meetings component. +They are usually created by administrators, but participants can also create meetings when the feature is enabled. + +Administrators can perform different actions on meetings, depending if they are created from the administration or by participants. + +== Official meetings + +image::components/meetings/new_meeting_form_backend.png[Create a new meeting form (backend)] + +.Create meeting - Backend form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|The title of the meeting. + +|Description +|Required +|A description of what the meeting is about, like the topics, participants, etc. + +|Type +|Required +|The meeting type, if it's in person, online, or both. + +|Address +|Optional +|Address: used to localize the meeting on a map. Is displayed only for in-person and hybrid meetings types. + +|Location +|Optional +|Location: message directed to the users implying the spot to meet at, like the name of the building, the name of a room, etc. +Is displayed only for in-person and hybrid meetings types. + +|Location hints +|Optional +|Location hints: additional info. Example: the floor of the building if it is an in-person meeting, or the meeting password +if it is an online meeting with restricted access. + +|Online meeting URL +|Optional +|The link for participants to be able to connect directly to the online meeting. + +|Iframe embed type +|Optional +|Allows to say how the online meeting URL is displayed on the meeting page. Choose "None" for no iframe integration, "Embed in +meeting page" for participants to open the meeting directly on the meeting page, "Open in live event page" for participants to be +redirected to the live event page, or "Open URL in a new tab" for participants to open the meetings in a new tab. +Only a few services allow embedding (YouTube, Twitch, Jitsi, ...) + +|Iframe access level +|Required +|Who is able to see the iframe. + +|Start time +|Required +|On which day and time the meeting start. Expected format: dd/mm/yyyy hh:mm. + +|End time +|Required +|On which day and time the meeting start. Expected format: dd/mm/yyyy hh:mm. + +|Category +|Optional +|Which category has the meeting. Used for filtering in the meetings list. + +|Registration type +|Required +|Choose an option between "Registration disabled" for no registrations, "On this platform" to display a registration button linked to +the xref:admin:components/meetings/registrations.adoc[Registrations] or "On a different platform" if you manage meetings Registrations +with another service. + +|Registration URL +|Required if Registration on a different platform +|Must be an URL. Link for participants to go to the external service that you are using for registrations. + +|Private meeting +|Optional +|Check if the meeting shouldn't be visible for all the visitors. This is only available for official meetings. + +|Transparent +|Optional +|If the meeting is private, check if the meeting should be visible for all the visitors but they shouldn't be able to +participate in it. This is only available for official meetings. + +|Comments enabled +|Optional +|Whether you want participants to be able to comment this specific meeting. + +|Comments enabled from +|Optional +|Date from which participants are able to comment on this specific meeting. + +|Comments enabled until +|Optional +|Date until which participants are able to comment on this specific meeting. + +|=== + +You can also define *Services* for a Meeting. These are metadata that allows to communicate, for instance, if there's +a place for children, deaf assistance, translations, etc. You can have multiple services inside of a meeting. + +.Create meeting - Services +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|Title of the service. + +|Description +|Optional +|Description of the service. + +|=== + +=== Actions + +.Actions - Official meetings +[cols="10h,20h,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|To edit a meeting. + +|image:icons/action_duplicate.png[Duplicate icon] +|Duplicate +|Allows an administrator to duplicate quickly a meeting. + +|image:icons/action_folder.png[Folders icon] +|Folders +|For classifying Attachments. + +|image:icons/action_attachments.png[Attachments icon] +|Attachments +|To add documents and images related to the meeting. + +|image:icons/action_registrations.png[Registrations icon] +|xref:admin:components/meetings/registrations.adoc[Registrations] +|Allows to define who can register for attending the meeting. Only available if the registrations are enabled in the meeting form. + +|image:icons/action_agenda.png[Agenda icon] +|xref:admin:components/meetings/agenda.adoc[Agenda] +|To publish the topics to be discussed in the meeting. + +|image:icons/action_list.png[Poll icon] +|xref:admin:components/meetings/polls.adoc[Polls] +|To manage the polls for the online meeting. + +|image:icons/action_close.png[Close icon] +|xref:admin:components/meetings/close.adoc[Close] +|Allows and administrator to close the meeting with the minutes on the discussion and add extra information. + +|image:icons/action_publish.png[Publish icon] +|Publish +|To show publicly the meeting. + +|image:icons/action_unpublish.png[Unpublish icon] +|Unpublish +|To not show publicly the meeting. + +|image:icons/action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:icons/action_permissions.png[Permissions icon] +|Permissions +|To handle the permissions of this meeting, depending on the verification a participant has. Allows an admin to configure +who can *Join* a meeting. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete this meeting. + +|=== + +== Participants meetings + +Meetings can be created by participants if the component setting "Participants can create meetings" is checked. +If a participant belongs to a verified xref:admin:participants/groups.adoc[user group], then they are also able to create meetings +as that group. + +When a participant is on the meetings list, they can click the "New meeting" button. + +image::components/meetings/new_meeting_button_front.png[Create a new meeting button (frontend)] + +Then, they are redirected on the participants meetings creation form. + +image::components/meetings/new_meeting_form_frontend01.png[Create a new meeting form (frontend)] + +.Create meeting - Frontend form +[cols="20h,20h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|The title of the meeting. + +|Description +|Required +|A description of what the meeting is about, like the topics, participants, etc. + +|Type +|Required +|The meeting type, if it's in person, online, or both. + +|Address +|Optional +|Address: used to localize the meeting on a map. Is displayed only for in-person and hybrid meetings types. + +|Location +|Optional +|Location: message directed to the users implying the spot to meet at, like the name of the building, the name of a room, etc. +Is displayed only for in-person and hybrid meetings types. + +|Location hints +|Optional +|Location hints: additional info. Example: the floor of the building if it is an in-person meeting, or the meeting password +if it is an online meeting with restricted access. + +|Online meeting URL +|Optional +|The link for participants to be able to connect directly to the online meeting. + +|Iframe embed type +|Optional +|Allows to say how the online meeting URL is displayed on the meeting page. Choose "None" for no iframe integration, "Embed in +meeting page" for participants to open the meeting directly on the meeting page, or "Open URL in a new tab" for participants to +open the meetings in a new tab. Only a few services allow embedding (YouTube, Twitch, Jitsi, ...) + +|Start time +|Required +|On which day and time the meeting start. Expected format: dd/mm/yyyy hh:mm. + +|End time +|Required +|On which day and time the meeting start. Expected format: dd/mm/yyyy hh:mm. + +|Category +|Optional +|Which category has the meeting. Used for filtering in the meetings list. + +|Registration type +|Required +|Choose an option between "Registration disabled" for no registrations, "On this platform" to display a registration button linked to +the xref:admin:components/meetings/registrations.adoc[Registrations] or "On a different platform" if you manage meetings Registrations +with another service. + +|Available slots for this meeting +|Required if Registration on this platform +|How many slots are available for this meeting? Leave it to 0 if you have unlimited slots available. + +|Registration terms +|Required if Registration on this platform +|What terms of services participants need to accept to register or join the meeting. + +|Registration URL +|Required if Registration on a different platform +|Must be an URL. Link for participants to go to the external service that you are using for registrations. + +|Create meeting as +|Required if the participant belongs to a group +|With which identity this meeting is created, the participant or the user group one. + +|=== + +After creating the meeting, participants can also edit and xref:components/meetings/close.adoc[close] it. + +=== Actions + +.Actions - Citizens meetings +[cols="10h,20h,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:icons/action_permissions.png[Permissions icon] +|Permissions +|To handle the authorizations needed to join, comment or reply to the poll for this specific meeting. + +|=== + +== Online meetings + +For online meetings, depending in the moment and configuration of the meeting, different messages are shown to the participants to +inform them on how to join the online meeting. + +If the "Online meeting URL" isn't set yet, a message that says "Link available soon" is displayed. + +image::components/meetings/online_meeting_available_soon.png[Online meeting available soon] + +If the "Online meeting URL" is set, a few minutes before the meeting start, the message says "The link to join +the meeting will be available a few minutes before it starts" + +image::components/meetings/online_meeting_available_before.png[Online meeting available before it starts] + +If the "Online meeting URL" is set, the start time of the meeting has arrived, and you chose the Iframe embed type to be +"Open URL in a new tab" then the message says that "the meeting is happening right now" with a link to join the meeting. + +image::components/meetings/online_meeting_happening.png[Online meeting available before it starts] + +If the "Online meeting URL" is set, the start time of the meeting has arrived, and you chose the Iframe embed type to be +"Embed in meeting page" then the message says that "the meeting is happening right now" with the meeting embedded in the block. + +image::components/meetings/online_meeting_happening_embed.png[Online meeting available before it starts] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/meetings/polls.adoc b/docs/en/modules/admin/pages/components/meetings/polls.adoc index dcd7b48134..7e7546c688 100644 --- a/docs/en/modules/admin/pages/components/meetings/polls.adoc +++ b/docs/en/modules/admin/pages/components/meetings/polls.adoc @@ -1,29 +1,61 @@ = Polls -CAUTION: this feature is still in active development and can't be used in production yet. +== Understand the basics -Through the manage polls feature is possible to define a poll that will be displayed when an online meeting is ocurring. -This is useful to see quick feedback and make a decision inside the meeting without having to leave the meeting and use -other kind of tools (like surveys or proposals). +Meetings polls allow administrators to define questions prior to an online meeting, that participants to the meeting can answer +while it's happening. It can be very useful to gather quick feedback and make decisions during meetings without having to leave the meeting and use +other kind of tools. -With this feature an administrator can define questions and also manage when these questions and its results will be shown +With this feature, administrators can define questions and manage when these questions and their results are shown to participants. -== Enable polls for a meeting +== Configuration -To enable polls for a meeting: +To configure polls for a specific meeting, click the image:icons/action_list.png[Manage polls button] "Manage polls" button. -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click on "Meetings" -. Search the meeting that you want to define polls for -. Click on the "Manage polls" button image:action_list.png[Manage polls button] -. Fill the form +image::components/meetings/polls/backend.png[Backend for meeting polls] -The form is pretty much the Decidim form builder, with one caveat: you can only define Single and Multiple option questions. +.Polls questions form +[cols="20h,10h,~"] +|=== +|Field |Type |Description -image:components/meetings/polls/backend.png[Backend for meeting polls] +|Statement +|Required +|Title for the question -image:components/meetings/polls/backend_question.png[Definining a question in meeting polls] +|Type +|Required +|Choose between single or multiple options question. + +|Answer options +|Required +|Each possible answer. + +|=== + +You can add as many questions and answer options as you want. + +== Manage + +Prior to the meeting, if the administrators already configured the polls questions, participants can see a button "Reply poll" +on the meeting page, warning them that a poll is going to be published on this meeting. + +image::components/meetings/polls/frontend_before_meeting.png[Reply poll page before meeting] + +When the meeting starts, the administrator can go to the poll administration page in the frontend to start sending the questions +to the participants. + +image::components/meetings/polls/poll_administration_page.png[Polls administration page] + +On their end, once a question is sent, the participants see it appear on the polls page, and can answer it. + +image::components/meetings/polls/poll_participant_reply.png[Polls question for participant] + +Then, administrators can decide to send the questions results to participants, so they know what option is the most voted. + +image::components/meetings/polls/poll_participant_replies_sent.png[Polls replies view for participant] + +== Export + +Participants answers can be exported through the "Export all" button in CSV, JSON, Excel and PDF. \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/meetings/registrations.adoc b/docs/en/modules/admin/pages/components/meetings/registrations.adoc index 8c09e527ea..c01ababa59 100644 --- a/docs/en/modules/admin/pages/components/meetings/registrations.adoc +++ b/docs/en/modules/admin/pages/components/meetings/registrations.adoc @@ -1,56 +1,56 @@ = Registrations +== Understand the basics + +NOTE: This article is dedicated to registrations "On this platform" when creating or editing a meeting. + Through registrations you can have capacity control of the attendance for a meeting. With this feature for instance you can -limit how many people could attend to the meeting, or you can know before the start of a meeting if you need to find a bigger -room to have the meeting. +limit how many people could attend the meeting, or you can know before the start of a meeting if you need to find a bigger +room to hold the meeting. -Enabling this feature will add a button so that participants can express their wish to go to the meeting. Depending in how -this feature is configured, then: +Enabling this feature adds a "Register" button so that participants can express their wish to go to the meeting. -. it's possible to define how many slots are available for controling the maximum capacity for this meeting -. a xref:_registration_form[custom registration form] for asking information to participants can be configured -. administrators can make xref:_invitations[invitations] to other participants or people that isn't registered in the platform -. it's possible to control attendance to the meeting through xref:_registration_code[registration codes] +image::components/meetings/registrations/frontend_join_meeting.png[Join a meeting button on meeting page] -image:components/meetings/registrations/frontend_join_meeting.png[Join a meeting sidebar button] +Depending in how this feature is configured, then administrators can: -Once participants confirm joining a meeting they get asked if they're reprensenting a group and if they want to show publicly that they're attending. +. define how many slots are available for controlling the maximum capacity for this meeting +. create a xref:_registration_form[custom registration form] to ask information to participants +. send xref:_invitations[invitations] to other participants or people not registered in the platform +. control attendance to the meeting through xref:_registration_code[registration codes] -image:components/meetings/registrations/frontend_confirm.png[Join a meeting confirm modal] +== Register to a meeting -== Enable registrations for a meeting +When a participant clicks on the "Register" button, they get asked -To enable registrations for a meeting: +* if they're representing a xref:admin:participants/groups.adoc[group]. +* if they want to show publicly that they're attending to the meeting. -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Click on "Meetings" -. Search the meeting that you want to enable registrations for -. Click on the "Edit" button image:action_edit.png[Edit button] -. Change the "Registration type" field to "On this platform" -. Define how many slots are available in "Available slots for this meeting" -. Click on the "Update" button -. Click on the "Registrations" button image:action_registrations.png[Registrations button] -. Check the "Registrations enabled" checkbox -. Fill the form +image::components/meetings/registrations/frontend_confirm.png[Join a meeting confirm modal] -== Registrations settings form +== Manage registrations + +Once you chose to deal with registrations "On this platform" when creating a meeting, you can manage registrations by clicking the +image:icons/action_registrations.png[Registrations icon] Registrations icon. image:components/meetings/registrations/backend.png[Registrations settings in a meeting] .Registrations settings form +[cols="20h,10h,~"] |=== |Field |Type |Description +|Validate registration code +|Optional +|To verify participants xref:_registration_code[registration codes], if enabled for this meeting. + |Registrations enabled |Required -|Check to enable the registration for this meeting. +|Check to enable registrations for this meeting. |Registration form enabled |Optional -|Check if you want to enable the registration form +|Check if you want to enable a registration form for this meeting, to ask information about attendees. |Available slots for this meeting |Required @@ -58,7 +58,16 @@ image:components/meetings/registrations/backend.png[Registrations settings in a |Reserved slots |Required -|How many slots are already reserved. Leave it to 0 if you don't have reserved slots +|How many slots are already reserved on the available slots. Leave it to 0 if you don't have reserved slots. + +|Customize registration email +|Optional +|Whether you want to add a message in the registration email. + +|Registration email custom content +|Optional +|The content of the customized email. This text appears in the middle of the registration confirmation email, just +after the registration code if it's enabled. |Registration terms |Required @@ -71,35 +80,42 @@ image:components/meetings/registrations/backend.png[Registrations settings in a This feature allows you to define a custom form like the xref:admin:components/surveys.adoc[Surveys] component to ask participants for registration information. +To create a registration form, check the "Registration form enabled" on the registrations page, and click the "Save" button. +Then, you can click the "Registration form" button in the top right of the page. + == Export all -It's possible to export registrations in multiple formats: CSV, JSON and XLSX (Excel). +You can export registrations in multiple formats: CSV, JSON and XLSX (Excel). -The exported data will have these fields: +The exported data contains these fields: * id: The registration id * code: the xref:_registration_code[registration code] (if this feature is enabled) * user/name: the name of the user * user/email: the email of the user -* user/user_group: the group of the user if they have selected that's representing a group when registering +* user/user_group: the group of the user if they have selected that they represent a group when registering == Invitations -This feature allows you to invite attendes to a meeting. These could be already registered or non-existing participants +This feature allows you to invite attendees to a meeting. They can be active participants or non-existing participants in the platform. -image:components/meetings/registrations/invite_attendee.png[Invite attendee for registration in a meeting] +image::components/meetings/registrations/invite_attendee.png[Invite attendee for registration in a meeting] == Registration code -This feature allows you to check if the attendee is registered in the meeting. They need to provide their code, that gets -entered in this form and it's checked against the database. +This feature allows you to check if an attendee is well registered in the meeting. -image:components/meetings/registrations/backend_w_registration_code.png[Registration code form in a meeting] +After registering, the participant is given a registration code in the confirmation email and on the meeting page. -image:components/meetings/registrations/frontend_confirmed_w_code.png[Registration code in a meeting frontend] +image:components/meetings/registrations/frontend_w_code.png[Registration code in a meeting frontend] -It can receive two kind of responses: +The validation of the code is pending. It means that when attending the meeting, the attendee has to give the code to an organizer +to validate it. +The organizer then enters the code in the "Validate registration code" field, to confirm that it exists in the database. -* Registration code successfully validated. -* This registration code is invalid. +image:components/meetings/registrations/backend_w_registration_code.png[Registration code form in a meeting] + +Once the code gets verified, the attendee is considered to having participated in the meeting, and the code is marked as validated. + +image:components/meetings/registrations/frontend_confirmed_w_code.png[Registration code in a meeting frontend] diff --git a/docs/en/modules/admin/pages/components/pages.adoc b/docs/en/modules/admin/pages/components/pages.adoc index b22abcc555..bf0984c74b 100644 --- a/docs/en/modules/admin/pages/components/pages.adoc +++ b/docs/en/modules/admin/pages/components/pages.adoc @@ -1,85 +1,92 @@ -= Page += Pages -The Page component allows people to get information about a space. It's similar to the general xref:admin:pages.adoc[Pages] admin section, with -the main difference is that this component allows to define pages in a space, and the general Pages admin section allows to -define pages for all the platform (for instance, help pages, terms of services, or FAQs), that aren't associated to a space. +== Understand the basics -From this starting point, there could be other configurations, such as: +The Page component allows people to get information about a space. Administrators can fill a page with informational content, +images, links, to inform and update the participants. -Some examples of where this component was used: +It's similar to the general xref:admin:pages.adoc[Pages], the main difference being that this component allows to define pages inside +a participatory space, and not in the Help section. + +image::components/page/example01.png[Example of a page component in a participatory process] + +== Configuration -* https://www.decidim.barcelona/processes/PressupostosParticipatius/f/4691/[More information page in 2020 Participatory Budgeting process in Decidim Barcelona] +To create a Page component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. -image:components/page/example01.png[More information page in 2020 Participatory Budgeting process in Decidim Barcelona - Frontend] -image:components/page/example02.png[More information page in 2020 Participatory Budgeting process in Decidim Barcelona - Backend] +image::components/page/component_page.png[Add Page component button] -To configure the Page component: +Then: -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Go to components -. Click on "Add component" button -. Click on "Page" -. Fill the xref:_add_component[Add component] form +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Page" +. Fill the component creation form -== Add component +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] icon in the components list. -image:components/page/component.png[Add component form] +image::components/page/component.png[Add component form] .Add component: Page form +[cols="20h,10h,~"] |=== |Field |Type |Description |Name |Required -|What is the title of this component. For instance, "More information". +|The title of this component. |Order position |Optional -|Which order will it have in relation to the other pages. Having a lower number means a higher priority. -For instance, if you have two pages, "Page a" with weight "10" and "Page b" with weight "0", then "Page b" will be first when ordering. +|The order of the component in relation with the other components. Having a lower number means a higher priority. +For instance, if you have two components, "Component a" with weight "10" and "Component b" with weight "0" +then "component b" is first when ordering. |=== .Add component: Page form - Global settings +[cols="20h,10h,~"] |=== |Field |Type |Description |Announcement |Optional -|A general announcement that'll be visible on the general pages landing page. +|A general announcement visible on the top of the page. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in -xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. - .Add component: Pages form - Step settings +[cols="20h,10h,~"] |=== |Field |Type |Description |Announcement |Optional -|A general announcement that'll be visible on the general page landing page. +|A general announcement visible on the top of the page for this phase. |=== -== Permissions - -As this component doesn't allow to do anything, there are no permissions to set up. +== Create a page -=== New page form +Once you created the Page component, click the Edit icon to write the content to be displayed on the page. image:components/page/new_page.png[New page form] .New page form +[cols="20h,10h,~"] |=== |Field |Type |Description |Body |Required -|What is the body for the page. +|The content displayed on the page. You can add images, links, videos, formatting, etc. |=== + +== Examples + +Some examples of where this component was used: + +* https://meta.decidim.org/processes/Welcome/f/1686/[Take the tour page to discover the Decidim community] +* https://www.decidim.barcelona/processes/PressupostosParticipatius/f/4691/[Information page for a Participatory Budget Barcelona] diff --git a/docs/en/modules/admin/pages/components/proposals.adoc b/docs/en/modules/admin/pages/components/proposals.adoc index 3000b0ba8a..3824e923a8 100644 --- a/docs/en/modules/admin/pages/components/proposals.adoc +++ b/docs/en/modules/admin/pages/components/proposals.adoc @@ -1,55 +1,62 @@ = Proposals -The Proposals component allows people to create, comment, endorse, and give support to proposals. +== Understand the basics -From this starting point, there could be other configurations, such as: +The Proposals component allows people to create, comment, like, and give their votes to proposals. It's one of the main components of +Decidim, and propose a large number of configurations. -* how many proposals a participant can create -* how many supports as a maximum a participant can give to proposals -* how many supports as a minimum a participant must give to proposals so their supports are valid -* whether you want to enable that participants comment on proposals -* whether you want that proposals have images, attachments, WYSIWYG editor, geolocated address, scopes, etc. +image::components/proposals/example01.png[Proposals example] -Some examples of where this component was used: +In this documentation section, you can find how to configure and manage all of those items: -* https://futureu.europa.eu/[Conference of the Future of Europe] -* https://meta.decidim.org/processes/roadmap/f/122/[Propose new functionalities for Decidim software] in https://meta.decidim.org/[Metadecidim] +* xref:admin:components/proposals/proposals.adoc[Proposal management] +* xref:admin:components/proposals/answers.adoc[Answers] +* xref:admin:components/proposals/special_configurations.adoc[Specific proposals configurations] +** xref:admin:components/proposals/special_configurations/amendments.adoc[Amendments] +** xref:admin:components/proposals/special_configurations/collaborative_drafts.adoc[Collaborative drafts] +** xref:admin:components/proposals/special_configurations/participatory_texts.adoc[Participatory texts] + +== Configuration -image:components/proposals/example01.png[Proposals list example in COFE] -image:components/proposals/example02.png[Proposals list example in Metadecidim] -image:components/proposals/example03.png[Proposal detail example in Metadecidim] +To create a Proposals component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. -To configure the Proposals component: +image::components/proposals/component_proposals.png[Add Proposals component button] -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies", or "Conferences" -. Go to components -. Click on "Add component" button -. Click on "Proposals" -. Fill the xref:_add_component[Add component] form +Then: -== Add component +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Proposals" +. Fill the component creation form -image:components/proposals/component.png[Add component form] +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] Configure icon in the components list. + +The component creation form is divided into different sections detailed below. + +image::components/proposals/component_01.png[Add component form] .Add component: Proposals form +[cols="20h,10h,~"] |=== |Field |Type |Description |Name |Required -|What is the title of this component. For instance, "Proposals" +|The title of this component. |Order position |Optional -|Which order will it have in relation to the other components. Having a lower number means a higher priority. -For instance, if you have two components, "Proposals" with weight "10" and "Meetings" with weight "0", then "Meetings" will be first when ordering. +|The order of the component in relation with the other components. Having a lower number means a higher priority. +For instance, if you have two components, "Component a" with weight "10" and "Component b" with weight "0" +then "component b" is first when ordering. |=== +image::components/proposals/component_02.png[Add component form] + .Add component: Proposals form - Global settings +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -57,22 +64,25 @@ For instance, if you have two components, "Proposals" with weight "10" and "Meet |Optional |Check if you want to have Scopes filtering in this component. +|Scopes enabled +|Optional +|Check if you want to have Scopes filtering available in this component. + |Scope |Optional -|Which xref:admin:scopes.adoc[Scope] does this component belongs to. +|Which xref:admin:settings/scopes.adoc[Scope] does this component belongs to. -|Support limit per participant +|Vote limit per participant |Optional -|Must be a number. How much supports a participant can give to proposals. +|Must be a number. The maximum number of votes a participant can give to proposals. -|Minimum supports per user +|Minimum votes per user |Optional -|Must be a number. How many supports does a participant needs to give to proposals so their supports are counted. If they don't -reach this number, their supports will not be taken in account. +|Must be a number. The minimum number of votes a participant needs to give to proposals so their votes are taken into account. |Proposal limit per participant |Optional -|Must be a number. How many proposals a participant can create. +|Must be a number. How many proposals a participant can create in this component. |Maximum proposal body length |Optional @@ -80,365 +90,170 @@ reach this number, their supports will not be taken in account. |Proposal editing |Required -|Choose one of these two options: "Allow editing of proposals within a specific timeframe" or "Allow editing proposals -for an infinite amount of time". In case it's within a specific timeframe, you must specify the time in "Proposals can be -edited by authors before this many minutes passes". Note that if you xref:components/proposals/answers.adoc[answer a proposal] -then it can't be edited anymore. +|Choose if participants have a limited time to edit their proposals, or can edit them without limit. +In case it's within a specific time frame, you must specify the time in the field below. +Note that if an administrator xref:components/proposals/answers.adoc[answers a proposal] then it can't be edited anymore. |Proposals can be edited by authors before this many minutes passes -|Required if "Proposal editing" is "Allow editing of proposals within a specific timeframe" +|Required |Must be a number. How many minutes after the creation of a proposal it can be edited by its author. |Threshold per proposal |Optional -|Must be a number. How many supports a proposal needs to have to be considered as "validated". See <>. +|Must be a number. How many votes a proposal needs to have to be considered as accepted. -|Can accumulate supports beyond threshold -|Optional. Only applies if "Threshold per proposal" is configured. -|Whether the proposal can accumulate more supports than the threshold. +|Can accumulate votes beyond threshold +|Optional. +|Whether the proposal can accumulate more votes than the threshold. |Proposal answering enabled |Optional |Whether administrators or valuators can answer proposals. +|Default proposal sorting +|Optional +|The sorting order of the proposals in the proposals list. Automatic means that if the votes are enabled, the proposals are +shown sorted by random, and if the votes are blocked, then they are sorted by the most voted. + |Official proposals enabled |Optional -|Wheter administrators can create official proposals. +|Whether administrators can create official proposals from the administration panel. |Comments enabled |Optional -|Whether you want to have comments in the meetings. +|Whether you want to enable participants to comment the proposals. |Comments max length |Optional -|What are the characters limit that participants will have when making comments. Leave 0 for the default value. +|The characters limit that participants have when making comments. Leave 0 for default value. |Geocoding enabled |Optional -|Wheter participants can define a geocoding address for their proposals. Need to have xref:configure:geocoding[Geocoding] enabled. See <>. +|Whether participants can define a geocoding address for their proposals. +You need to have xref:configure:geocoding[Geocoding] enabled. |Allow attachments |Optional -|Check to allow participants to attach files to their proposals. - -|Allow card image -|Optional -|Check to show a card image when participants attach images to their proposals. See <>. +|Check to allow participants to attach files to their proposals. By enabling this option, proposals will default to grid mode, +and the first image appears on the card. |Actions permissions can be set for each proposal |Optional -|Whether you want to be able to set permissions for every one of the proposals. Most of the time you will want to leave this option disabled. +|Whether you want to be able to set permissions for every proposals. |Collaborative drafts enabled |Optional -|Check to enable xref:components/proposals/collaborative_drafts.adoc[collaborative drafts] in proposals. +|Check to enable xref:components/proposals/special_configurations/collaborative_drafts.adoc[collaborative drafts] in proposals. |Participatory texts enabled |Optional -|Check to enable xref:components/proposals/participatory_texts.adoc[participatory texts] in proposals. +|Check to enable xref:components/proposals/special_configurations/participatory_texts.adoc[participatory texts] in proposals. |Amendments enabled |Optional -|Check to enable xref:components/proposals/amendments.adoc[amendments] in proposals. If active, configure Amendment features for each step. +|Check to enable xref:components/proposals/special_configurations/amendments.adoc[amendments] in proposals. +If active, configure Amendment settings for each step. |Amendments Wizard help text -|Optional. Visible if the "Amendments enabled" option is checked. -|What's the help text visible when creating new amendments. +|Optional. +|The help text visible when creating new amendments. |Announcement |Optional -|A general announcement that'll be visible on the general proposals landing page. +|A general announcement visible on the proposals list page. |New proposal body template |Optional -|A pre-defined text that will be used when creating new proposals. Useful if you want to define a format that participants need to +|A pre-defined text used when creating new proposals. Useful if you want to define a format that participants need to follow when creating new proposals. |New proposal help text |Optional -|What's the help text visible when creating new proposals. +|The help text visible when creating new proposals. |Proposal wizard "Create" step help text |Optional -|What's the help text visible when creating new proposals in the "Create" step. - -|Proposal wizard "Compare" step help text -|Optional -|What's the help text visible when creating new proposals in the "Compare" step. - -|Proposal wizard "Complete" step help text -|Optional -|What's the help text visible when creating new proposals in the "Complete" step. +|The help text visible when creating new proposals in the "Create" step. |Proposal wizard "Publish" step help text |Optional -|What's the help text visible when creating new proposals in the "Publish" step. +|The help text visible when creating new proposals in the "Publish" step. |=== -[#setting-threshold] -*Example of threshold setting* - -image::components/proposals/setting_threshold01.png[Example of threshold setting] -image::components/proposals/setting_threshold02.png[Example of threshold setting] - -[#setting-card-image] -*Example of card image setting* - -image::components/proposals/setting_card_image.png[Example of card image setting] - -[#setting-geocoding] -*Example of geocoding setting* - -image::components/proposals/setting_geocoding.png[Example of geocoding setting] - --- -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in -xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. +image::components/proposals/component_03.png[Add component form] .Add component: Proposals form - Step settings +[cols="20h,10h,~"] |=== |Field |Type |Description -|Announcement -|Optional -|A general announcement that'll be visible on the general proposal landing page. - |Endorsements enabled |Optional -|Check if you want that participants show public support for these proposals. +|To enable participants to show public support for these proposals, with a "Like" button. |Endorsements blocked |Optional -|Whether participants will be able to see the endorsments but don't make any. +|Check for participants to be able to see the existing endorsements but not make any new one. -|Supports enabled +|Votes enabled |Optional -|Whether participants will be able to support proposals in this step. +|To enable participants to vote for proposals in this phase. -|Supports blocked +|Votes blocked |Optional -|Whether participants will be able to support proposals in this step. +|Check for participants to be able to see the existing votes but not make any new one. -|Supports hidden +|Votes hidden |Optional -|If supports are enabled, checking this will hide the number of supports. +|If votes are enabled, checking this hides the number of votes to participants. |Comments blocked |Optional |Whether you want to enable comments for this phase. -|Proposal creation enabled +|Participants can create proposals |Optional -|Whether you want to enable proposal creation by participants for this phase. See xref:_new_proposal_form[New proposal form] +|Whether you want to enable proposal creation by participants for this phase. |Proposal answering enabled |Optional -|Whether you want to enable xref:components/proposals/answers.adoc[proposal answering]. +|Whether you want to enable xref:components/proposals/answers.adoc[proposal answering] by administrators. |Publish proposal answers immediately |Optional -|Wheter you want that the answers of proposals are published at the same time that you're xref:components/proposals/answers.adoc[answering] them or you want to control when to publish the answers. +|Whether you want that the answers of proposals are published directly when administrators are +xref:components/proposals/answers.adoc[answering] them or you want to control when to publish the answers. |Enable costs on proposal answers |Optional -|Wheter you want to add economical costs to proposal answers. Useful for importing to xref:components/budgets.adoc[budgets]. - -|Amendment creation enabled -|Optional. Visible if "Amendments enabled" option is checked. -|Participant can amend proposals. See xref:components/proposals/amendments.adoc[Amendments]. +|Whether you want to add economical costs to proposal answers. Useful for importing proposals to xref:components/budgets.adoc[budgets]. -|Amendment reaction enabled -|Optional. Visible if "Amendments enabled" option is checked. -|Proposal's authors will be able to accept or reject Participant's emendations. - -|Amendment promotion enabled -|Optional. Visible if "Amendments enabled" option is checked. -|Emandation authors will be able to promote to Proposal the rejected emendation. - -|Amendments visibility -|Required. Visible if "Amendments enabled" option is checked. -|Choose one of "Amendments are visible to all" or "Amendments are visible only to their authors" +|Default proposal sorting +|Optional +|The sorting order of the proposals in the proposals list for this phase. Automatic means that if the votes are enabled, the proposals +are shown sorted by random, and if the votes are blocked, then they are sorted by the most voted. |Announcement |Optional -|A general announcement that'll be visible on the general proposals landing page. +|A general announcement visible on the proposals list page for this phase. |Hashtags added to all proposals |Optional -|Automatically add a hashtag to every proposal. See <>. +|Automatically add hashtags to every proposal. |Hashtags suggested to participants for new proposals |Optional -|Suggest hashtags to participants for new proposals. Participants can select more than one hashtag. See <>. - -|=== - -[#setting-hashtags] -*Example of hashtags setting* - -image::components/proposals/setting_hashtag.png[Example of hashtag setting] - -== Permissions - -An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make -certain actions in the proposals: - -* Endorse -* Support -* Create -* Withdraw -* Amend -* Comment -* Vote comment - -== Manage proposals - -image:components/proposals/manage_proposals.png[Manage proposals table] - -=== Export - -Allows exporting the proposals in different formats. - -* Proposals as CSV -* Proposals as JSON -* Proposals as Excel -* Comments as CSV -* Comments as JSON -* Comments as Excel - -=== Import - -* Import from another component -* Import from a file - -=== New proposal form - -==== Citizens proposals - -image:components/proposals/new_proposal_frontend.png[New proposal form] - -Proposals can be created by participants if the setting is "Proposal creation enabled" is checked for the active phase. - -If a participant belongs to a xref:admin:participants/groups.adoc[user group], then they will be able to create proposals as that group also. - -This form depends a lot in which settings you've enabled in this component. It can be really short (with only a Title and -Body by default) or very long (Title, Body, Hashtags, Address, Scope, Category, Image and Attachment). - -.New proposal form - default (by a participant) -|=== -|Field |Type |Description - -|Title -|Required -|What is the title of this proposal. For instance, "Bike lane in Main Street". Must have at least 15 characters as minimum -and 150 characters as maximum. Must start with a capital letter. - -|Body -|Optional -|What is the full description for this proposal. Must have at least 15 characters as minimum and 450 characters as maximum -by default but can be changed with the setting "Maximum proposal body length". - -|=== - -To detect duplicated proposals before publishing them, the proposal creation has a wizard form with multiple steps. This also -allows participants to save proposals drafts (unpublished) in case they need to fill too many fields. - -image:components/proposals/new_proposal_frontend_compare.png[New proposal form (by a participant) - Compare] - -As an example of what the form could look depending in the settings enabled, here's a screenshot of the form for a proposal -with the following settings: "Hashtags added to all proposals", "Hashtags suggested to participants for new proposals", -"Geocoding enabled", "Allow attachments", "Allow card image" and "Scopes enabled". - -image:components/proposals/new_proposal_frontend_complete.png[New proposal form (by a participant) - Complete] - -After completing these fields the participant can see a preview of their proposal before publishing. They can also modify -the proposal before publishing it. - -image:components/proposals/new_proposal_frontend_publish.png[New proposal form (by a participant) - Publish] - -image:components/proposals/new_proposal_frontend_published.png[Published proposal made by a participant] - -==== Official proposals - -Administrators can create official proposals. There will be a filter to show only official proposals in the proposals navigation page. - -image:components/proposals/new_proposal_backend01.png[New proposal form - default (official proposals)] - -.New proposal form - default (official proposals) -|=== -|Field |Type |Description - -|Title -|Required -|What is the title of this proposal. For instance, "Bike lane in Main Street". Must have at least 15 characters as minimum -and 150 characters as maximum. Must start with a capital letter. - -|Body -|Optional -|What is the full description of this proposal. Must have at least 15 characters as minimum and 450 characters as maximum -by default but can be changed with the setting "Maximum proposal body length". - -|This proposal comes from a meeting -|Optional -|Check if this proposal comes from a meeting. - -|Select a meeting -|Required if the "This proposal comes from a meeting" checkbox is checked -|Dropdown selector with all the meetings of this space. The author of the proposal will be the meeting. +|Suggest hashtags to participants creating new proposals. Participants can select more than one hashtag. |=== -As an example of what the form could look like depending on the settings enabled, here's a screenshot of the form for a proposal -with the following settings: "Hashtags added to all proposals", "Hashtags suggested to participants for new proposals", -"Geocoding enabled", "Allow attachments", "Allow card image" and "Scopes enabled". - -image:components/proposals/new_proposal_backend02.png[New proposal form - with multiple settings (official proposals)] - -==== Actions - -.Actions -|=== -|Icon |Name |Definition - -|image:action_edit.png[Edit icon] -|Edit -|Edit form for a proposal. It's the same form as "New proposal". Only visible when the proposal is an xref:_official_proposals["Official proposal"]. - -|image:action_answer.png[Answer proposal icon] -|xref:components/proposals/answers.adoc[Answer proposal] -|Allows you to answer a proposal. - -|image:action_permissions.png[Permissions icon] -|Permissions -| +== Examples -|image:action_preview.png[Preview icon] -|Preview -|To see how it's shown in the frontend to participants. - -|=== - -== Origin filter - -When navigating in the proposals listing, you can filter the proposals by origin. - -image:components/proposals/origin_filter.png[Proposals origin filter] - -There are five origin options: - -* All: select all the origins -* xref:_official_proposals[Official]: proposals created by administrators -* xref:_citizens_proposals[Citizens]: proposals created by participants -* Groups: proposals created by participants that belong to a user group and choose that option when creating the proposal -* Meetings: proposals created by administrators that have checked this option when creating the proposal - -== Proposal types and mechanisms - -There are different kind of proposals mechanisms that can be enabled in proposals, such as: +Some examples of where this component was used: -* xref:admin:components/proposals/amendments.adoc[Amendments] -* xref:admin:components/proposals/answers.adoc[Answers] -* xref:admin:components/proposals/collaborative_drafts.adoc[Collaborative drafts] -* xref:admin:components/proposals/participatory_texts.adoc[Participatory texts] +* https://www.decidim.barcelona/assemblies/accionssostenibilitat/f/6259/proposals[Sustainable actions in Barcelona City 2024] +* https://futureu.europa.eu/[Conference of the Future of Europe] +* https://meta.decidim.org/processes/roadmap/f/122/[Propose new functionalities for Decidim software] \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/proposals/proposals.adoc b/docs/en/modules/admin/pages/components/proposals/proposals.adoc new file mode 100644 index 0000000000..5128aabe87 --- /dev/null +++ b/docs/en/modules/admin/pages/components/proposals/proposals.adoc @@ -0,0 +1,192 @@ += Proposals + +== Understand the basics + +It's important to understand that Proposals is not only the name of the component, but is also the entities of the component. + +image::components/proposals/proposals_list_frontend.png[Proposals list frontend] + +== Configuration + +Once you created your Proposals component, you are redirected to the Proposals list. There, you can create and manage the proposals of +your component. + +Depending on whether you want to gather only participants proposals, or you also want to create official proposals, read the +relevant section. + +== Proposals creation + +=== Official proposals + +To start creating official proposals, the first thing to do is to create your first proposal, by clicking the "New proposal" button. + +image::components/proposals/new_proposal_backend.png[New proposal form - with multiple settings (official proposals)] + +.New proposal form - default (official proposals) +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|The title of this proposal. It must have 15 characters at minimum and 150 characters as maximum and start with a capital letter. + +|Body +|Required +|The full description for this proposal. Must have 15 characters at minimum and 450 characters at maximum +by default, but it can be changed with the setting "Maximum proposal body length" in the component configuration. + +|Suggested hashtags +|Optional +|If xref:admin:features/social_features/hashtags.adoc[hashtags] were configured, participants can select the ones related to their proposal. + +|This proposal comes from a meeting +|Optional +|Check if this proposal comes from a meeting. It displays a link in the proposal page to the meeting. + +|Select a meeting +|Required +|Dropdown selector with all the meetings of this participatory space. Field displayed if the "This proposal comes from a meeting" checkbox is checked. +The author of the proposal becomes the meeting. + +|Address +|Optional +|If enabled, geocoding allow participant to locate their proposals on a specific location. Proposals with an address are then +displayed on the map in the proposals list. + +|Category +|Optional +|To which predefined category the proposal belongs. Used for filtering in the proposals list. + +|Add documents +|Optional +|If enabled, participants can add files and images to their proposal. The first image added is also added as the proposal image in +the proposal grid list. + +|=== + +=== Participants proposals + +Once you enabled participant proposals creation for the active phase, participants can see a "New proposal" button on the proposal +listing page. + +image::components/proposals/new_proposal_button_frontend.png[New proposal button on proposals list] + +When they click the button, they are redirected on a two step form, enabling them to create their proposal. +This form depends a lot on which settings you've enabled in the component. + +image::components/proposals/new_proposal_frontend.png[New proposal form - Create] + +.New participant proposal form - Creation step +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|The title of this proposal. It must have 15 characters at minimum and 150 characters as maximum and start with a capital letter. + +|Body +|Required +|The full description for this proposal. Must have 15 characters at minimum and 450 characters at maximum +by default, but it can be changed with the setting "Maximum proposal body length" in the component configuration. + +|Suggested hashtags +|Optional +|If xref:admin:features/social_features/hashtags.adoc[hashtags] were configured, participants can select the ones related to their proposal. + +|Address +|Optional +|If enabled, geocoding allow participant to locate their proposals on a specific location. Proposals with an address are then +displayed on the map in the proposals list. + +|Category +|Optional +|To which predefined category the proposal belongs. Used for filtering in the proposals list. + +|Add documents +|Optional +|If enabled, participants can add files and images to their proposal. The first image added is also added as the proposal image in +the proposal grid list. + +|Create proposal as +|Optional +|If the participant belongs to a verified xref:admin:participants/groups.adoc[user group], they can create a proposal in the name of +this group + +|=== + +Once the proposal is written and all properties are set, the participant can click the preview button to review their proposal. +The proposal is saved as a draft in case participants want to modify it later. + +image::components/proposals/new_proposal_frontend_publish.png[New proposal form (by a participant) - Publish] + +They can click the "Publish" button to finalize the publication of the proposal. + +image::components/proposals/new_proposal_frontend_published.png[Published proposal made by a participant] + +== Manage proposals + +Once there are multiple proposals in the process, administrators can manage them. + +image::components/proposals/manage_proposals.png[Manage proposals table] + +On the proposals list in the administration panel, administrators can see: + +* *Title*: Title of the proposal. +* *Published at*: Publication date of the proposal. +* *Comments*: The number of comments this proposal has. +* *Notes*: The number of votes this proposal has. +* *Valuators*: The number of valuators for this proposal. +* *Status*: The status of the xref:admin:components/proposals/answers.adoc[answer] of this proposal. + +You can filter and sort this list by clicking the "Filter" button and the columns headers. +You can also search for proposals by their title or ID in the search bar. + +=== Actions + +.Actions +[cols="10h,20h,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|Edit form, only for xref:_official_proposals[Official proposals]. + +|image:icons/action_answers.png[Answer proposal icon] +|xref:components/proposals/answers.adoc[Answer the proposal] +|Allows administrators and valuators to give an official answer to a proposal. + +|image:icons/action_preview.png[Preview icon] +|Preview +|To see how it's shown in the frontend to participants. + +|image:icons/action_permissions.png[Permissions icon] +|Permissions +|To handle the authorizations needed to like, amend, vote on comment or comment on this specific proposal. + +|=== + +=== Bulk actions + +When managing proposals, you can select multiple proposals at the same time to perform bulk actions. + +image::components/proposals/bulk_actions.png[Proposals bulk actions] + +=== Export + +The "Export all" button allows administrators to export the proposals and their comments in different formats. + +* Proposals as CSV +* Proposals as JSON +* Proposals as Excel +* Comments as CSV +* Comments as JSON +* Comments as Excel + +=== Import + +* Import proposals from another component: Allows to import proposals from a proposal component of the same space. +* Import proposals from a file +* Import answers from a file diff --git a/docs/en/modules/admin/pages/components/proposals/special_configurations.adoc b/docs/en/modules/admin/pages/components/proposals/special_configurations.adoc new file mode 100644 index 0000000000..ece89c2e88 --- /dev/null +++ b/docs/en/modules/admin/pages/components/proposals/special_configurations.adoc @@ -0,0 +1 @@ += Special configurations \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/proposals/amendments.adoc b/docs/en/modules/admin/pages/components/proposals/special_configurations/amendments.adoc similarity index 100% rename from docs/en/modules/admin/pages/components/proposals/amendments.adoc rename to docs/en/modules/admin/pages/components/proposals/special_configurations/amendments.adoc diff --git a/docs/en/modules/admin/pages/components/proposals/collaborative_drafts.adoc b/docs/en/modules/admin/pages/components/proposals/special_configurations/collaborative_drafts.adoc similarity index 100% rename from docs/en/modules/admin/pages/components/proposals/collaborative_drafts.adoc rename to docs/en/modules/admin/pages/components/proposals/special_configurations/collaborative_drafts.adoc diff --git a/docs/en/modules/admin/pages/components/proposals/participatory_texts.adoc b/docs/en/modules/admin/pages/components/proposals/special_configurations/participatory_texts.adoc similarity index 100% rename from docs/en/modules/admin/pages/components/proposals/participatory_texts.adoc rename to docs/en/modules/admin/pages/components/proposals/special_configurations/participatory_texts.adoc diff --git a/docs/en/modules/admin/pages/components/skeleton.adoc b/docs/en/modules/admin/pages/components/skeleton.adoc index 3df58fde7b..51fcf166df 100644 --- a/docs/en/modules/admin/pages/components/skeleton.adoc +++ b/docs/en/modules/admin/pages/components/skeleton.adoc @@ -1,32 +1,32 @@ = Skeleton +== Understand the basics + The Skeleton component allows people to XXX From this starting point, there could be other configurations, such as: * -Some examples of where this component was used: - -* +How the component looks like in front office: image:components/skeleton/example01.png[] image:components/skeleton/example02.png[] image:components/skeleton/example03.png[] image:components/skeleton/example04.png[] -To configure the Skeleton component: +== Configuration -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". -. Go to components -. Click on "Add component" button -. Click on "Skeleton" -. Fill the xref:_add_component[Add component] form +To create a Blog component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. -== Add component +image::components/skeleton/component_skeleton.png[Add component button] + +Then: + +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Skeleton" +. Fill the component creation form image:components/skeleton/component.png[Add component form] @@ -40,8 +40,7 @@ image:components/skeleton/component.png[Add component form] |Order position |Optional -|Which order will it have in relation to the other skeletons. Having a lower number means a higher priority. -For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skeleton b" with weight "0", then "Skeleton b" will be first when ordering. +|Which order it has in relation to the other skeletons. Having a lower number means a higher priority. |=== @@ -67,11 +66,11 @@ For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skel |Comments max length |Optional -|What is the characters limit that participants will have when making comments. Leave 0 for default value. +|What is the characters limit that participants have when making comments. Leave 0 for default value. |Actions permissions can be set for each skeleton |Optional -|Whether you want to be able to set permissions for every one of the skeletons. Most of the time you will want to leave this option disabled. +|Whether you want to be able to set permissions for every one of the skeletons. |Announcement |Optional @@ -79,9 +78,6 @@ For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skel |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in -xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. - .Add component: Skeletons form - Step settings |=== |Field |Type |Description @@ -96,14 +92,6 @@ xref:admin:spaces/processes.adoc[Participatory Processes], then you can also def |=== -== Permissions - -An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make -certain actions in the skeletons: - -* Create -* Endorse - == Manage skeletons image:components/skeleton/manage_skeletons.png[Manage skeletons table] @@ -119,7 +107,7 @@ Allows exporting the skeletons in different formats. * Comments as JSON * Comments as Excel -=== New skeleton form +== New skeleton form image:components/skeleton/new_skeleton.png[New skeleton form] @@ -134,7 +122,6 @@ image:components/skeleton/new_skeleton.png[New skeleton form] |Order position |Optional |Which order will it have in relation to the other skeletons. Having a lower number means a higher priority. -For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skeleton b" with weight "0", then "Skeleton b" will be first when ordering. |Description |Optional @@ -158,10 +145,16 @@ For instance, if you have two skeletons, "Skeleton a" with weight "10" and "Skel |image:action_edit.png[Edit icon] |Edit -|Edit form for a skeleton. It's the same form as "New skeleton". +|Edit form for a skeleton. |image:action_delete.png[Delete icon] |Delete |To delete this skeleton. Only can be done when there aren't any projects. |=== + +== Examples + +Some examples of where this component was used: + +* \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/sortitions.adoc b/docs/en/modules/admin/pages/components/sortitions.adoc index 8be4473e8d..19b828e192 100644 --- a/docs/en/modules/admin/pages/components/sortitions.adoc +++ b/docs/en/modules/admin/pages/components/sortitions.adoc @@ -1,3 +1,140 @@ = Sortitions -The Sortitions component allows to select a number of proposals (e.g. candidates for a jury) with random, yet reproducible, procedures that guarantees non-biased and uniform distributions. +== Understand the basics + +The Sortitions component allows to sort a number of proposals with random, yet reproducible, procedures that guarantees non-biased +and uniform distributions. + +For example, it can be useful for sorting candidates for a jury, or participatory budgeting proposals. + +to conduct a sortition, you need a dice or another random way to generate a number from 1 to 6, as well as witnesses. + +image::components/sortitions/example01.png[Example of a sortition] + +== Configuration + +To create a Sortitions component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. + +image::components/sortitions/component_sortitions.png[Add Sortitions component button] + +Then: + +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Sortitions" +. Fill the component creation form + +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] Configure icon in the components list. + +image::components/sortitions/component.png[Add component form] + +.Add component: Sortitions form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Name +|Required +|Title of this component. + +|Order position +|Optional +|The order of the component in relation with the other components. Having a lower number means a higher priority. +For instance, if you have two components, "Component a" with weight "10" and "Component b" with weight "0" +then "component b" is first when ordering. + +|=== + +.Add component: Sortitions form - Global settings +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Comments enabled +|Optional +|Whether you want to have comments in the sortitions. + +|Comments max length +|Optional +|The characters limit that participants have when making comments. Leave 0 for default value. + +|=== + +== Create a sortition + +image::components/sortitions/new_sortition_backend.png[New sortition backend form] + +.New sortition form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Title +|Required +|The title of this sortition. + +|Proposals set +|Required +|The proposal component to base the sortition on. Both components must be in the same space. + +|Categories of the set of proposals in which you want to apply the draw +|Optional +|If you have categories, can allow to do the sortition only inside one of the categories. + +|Number of proposals to be selected +|Required +|Indicate the number of proposals you want to be selected by drawing lots of the group of proposals you have previously chosen. + +|Witnesses +|Required +|The witnesses attending the draw and who can vouch for its authenticity. + +|Sortition information +|Required +|Explanation on why the sortition is done. + +|Result of die roll +|Required +|Roll a 6-sided die, or look for another random way to generate a number from 1 to 6, and enter here the resulting +number in front of some witnesses. This contributes to the quality and guarantees of the randomness of the result. + +|=== + +== Manage sortitions + +To start creating and managing sortitions, click in the component title in the navigation bar or in the component list, or click in the +image:icons/action_edit.png[Manage component icon] Manage icon on the components list. + +image::components/sortitions/manage_sortitions.png[Manage sortitions table] + +On the sortitions list in the administration panel, administrators can see: + +* *Reference*: Reference of the sortition. +* *Title*: Title of the sortition. +* *Creation date*: Creation date of the sortition. + +=== Actions + +.Actions +[cols="10h,20h,~"] +|=== +|Icon |Name |Definition + +|image:icons/action_edit.png[Edit icon] +|Edit +|Edit form for a sortition. + +|image:icons/action_preview.png[Preview icon] +|Sortition details +|To see the results of the sortition in the administration panel. + +|image:icons/action_permissions.png[Permissions icon] +|Permissions +|To handle the authorizations needed to comment sortitions. + +|image:icons/action_delete.png[Delete icon] +|Delete +|To delete this debate. + +|=== \ No newline at end of file diff --git a/docs/en/modules/admin/pages/components/surveys.adoc b/docs/en/modules/admin/pages/components/surveys.adoc index 5a0cb85ede..bbd84f9a84 100644 --- a/docs/en/modules/admin/pages/components/surveys.adoc +++ b/docs/en/modules/admin/pages/components/surveys.adoc @@ -1,57 +1,52 @@ = Survey -The Survey component allows people to answer questionnaires. This is useful when an organization wants to receive private -feedback, although it's possible to publish the answers manually as well. It allows defining a set of questions with multiple kinds of answers. +== Understand the basics -From this starting point, there could be other configurations, such as: +The Survey component allows participants to answer questionnaires. This is useful when an organization wants to receive private +feedback from participants. It allows defining a set of questions with multiple kinds of questions. -* if the answering is limited to a time period -* what answer types should have the questions, like short (one line), long (multiple lines), single or multiple options, -sorting through a list, etc. -* if there's an answer validation like how many characters as maximum should have an answer -* if there's a maximum number of options to select in multiple options questions +NOTE: Once a survey is answered by participants, it's not possible to modify its questions, as that would affect the integrity +of the answers. If you need to modify the questions, create a new survey and unpublish the original one. -Some examples of where this component was used: +image::components/surveys/example01.png[Example of a survey] -* https://consultation.quebec.ca/processes/donneesquebec/f/82/[Data Quebec: participate in its improvement! (Données Québec : participez à son amélioration!) in Québec consultations] -* https://meta.decidim.org/conferences/decidimfest2020/f/1403/?locale=en[DecidimFest2020 Assessment Survey] +== Configuration -image:components/surveys/example01.png[Example of a survey] +To create a Survey component, first go in the xref:admin:spaces.adoc[participatory space] where you want to create it. -To configure the Survey component: +image::components/surveys/component_survey.png[Add Survey component button] -. Sign in as admin -. Go to admin panel -. In the main sidebar, click in the button for the space that you want to configure the component for. -For instance, it could be "Processes", "Assemblies" or "Conferences". -. Go to components -. Click on "Add component" button -. Click on "Survey" -. Fill the xref:_add_component[Add component] form +Then: -Once a survey is already answered by some users it's not possible to modify its questions, as that would affect the integrity -of the answers. If it's needed to modify the questions, then it's needed to create a new survey and unpublish the original one. +. Click on the "Components" item in the secondary menu +. Click the "Add component" button +. Select "Survey" +. Fill the component creation form -== Add component +You can still update this form and the configuration after creating the component, by clicking the +image:icons/action_configure.png[Configure icon] Configure icon in the components list. -image:components/surveys/component.png[Add component form] +image::components/surveys/component.png[Add component form] .Add component: Survey form +[cols="20h,10h,~"] |=== |Field |Type |Description |Name |Required -|What is the title of this component. For instance, "Surveys" +|Title of this component. |Order position |Optional -|Which order will it have in relation to the other surveys. Having a lower number means a higher priority. -For instance, if you have two surveys, "Survey a" with weight "10" and "Survey b" with weight "0", then "Survey b" will be first when ordering. +|The order of the component in relation with the other components. Having a lower number means a higher priority. +For instance, if you have two components, "Component a" with weight "10" and "Component b" with weight "0" +then "component b" is first when ordering. |=== .Add component: Survey form - Global settings +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -61,94 +56,93 @@ For instance, if you have two surveys, "Survey a" with weight "10" and "Survey b |Scope |Optional -|Which xref:admin:scopes.adoc[Scope] does this component belongs to. +|Which xref:admin:settings/scopes.adoc[Scopes] does this component belongs to. |Answers accepted from |Optional -|Start date when you want to receive answers. Leave blank for no specific date. Expected format: dd/mm/yyyy hh:ii +|Start date when you want to start receiving answers. Leave blank for no specific date. Expected format: dd/mm/yyyy hh:mm. |Answers accepted until -|End date when you want to stop receiving answers. Leave blank for no specific date. Expected format: dd/mm/yyyy hh:ii +|Optional +|End date when you want to stop receiving answers. Leave blank for no specific date. Expected format: dd/mm/yyyy hh:mm. |Announcement |Optional -|A general announcement that'll be visible on the general surveys landing page. +|A general announcement visible on the survey page. |Delete answers when publishing the survey |Optional -|Check if you want to delete answers in the moment that the survey is published. Useful for when you want to test the survey before publishing it. +|Check if you want to delete answers when the survey is published. Useful for testing the survey before publishing it. |=== -In the cases where the space that this component will be used has xref:admin:spaces/processes/phases.adoc[Phases], for instance, in -xref:admin:spaces/processes.adoc[Participatory Processes], then you can also define different behaviors per Step. - .Add component: Surveys form - Step settings +[cols="20h,10h,~"] |=== |Field |Type |Description |Allow answers |Optional -|Check if you want to receive answers in this survey. +|Check if you want to receive answers in this survey for this phase. |Allow unregistered users to answer the survey |Optional -|If active, no login will be required in order to answer the survey. This may lead to poor or unreliable data and it will -be more vulnerable to automated attacks. Use with caution! Mind that this option only allows an answer by browser session, +|If active, no login is required to answer the survey. This may lead to poor or unreliable data and make you more vulnerable to +automated attacks. Please use with caution. Mind that this option only allows an answer by browser session, but participants can use the Private navigation option and make multiple answers with the same device. |Announcement |Optional -|A general announcement that'll be visible on the general survey landing page. +|A general announcement visible on the survey page for this phase. |=== -== Permissions - -An administrator can choose which kind of xref:customize:authorizations.adoc[Authorizations] a participant need to have to make -certain actions in the surveys: +== Create a survey -* Answer +NOTE: Do you have repetitive surveys? For instance the same feedback form for every process? You can have a survey that +gets copied and is used as a blueprint so you don't have to manually configure the same survey each time. Learn more +on xref:admin:templates/questionnaires.adoc[Questionnaires templates]. -== New survey form +image::components/surveys/edit_questionnaire.png[Choose template form] -When you create a new survey you'll need to fill the form with the following fields: +First, select a xref:admin:templates/questionnaires.adoc[Questionnaires templates] if you want, or Skip this step. -image:components/surveys/edit_form.png[Edit survey form] +Then you need to fill the form with the following fields: -NOTE: Do you have repetitive surveys? For instance the same feedback form for every process? You can have a survey that -gets copied and is used as a blueprint for so you don't have to manually configure the same survey everytime. Learn more -about xref:_templates[Templates]. +image::components/surveys/edit_form.png[Edit survey form] .New survey form +[cols="20h,10h,~"] |=== |Field |Type |Description |Title |Required -|What is the title of this survey. For instance, "Feedback" +|The title of this survey. |Description |Optional -|What is the description of this survey. +|The description of the survey. |Terms of service |Required -|Legal conditions that the participants must agree to in order to answer the survey. +|Legal conditions that the participants must meet to answer the survey. |=== -In the bottom of this form there's a button that allows you to "Add question". +=== Questions -image:components/surveys/add_question_button.png[] +==== Add a question -You can add multiple questions per survey, and reorder or delete them. It's possible to also add separators between questions. +Then, click the "Add question" button to start creating your survey. +You can add multiple questions per survey, and reorder or delete them. -Every question has to have a statement and a type as a minimum. +Every question must have a statement and a type as a minimum. -image:components/surveys/question_form.png[] +image::components/surveys/question_form.png[Question form on survey creation] .Add question form +[cols="20h,10h,~"] |=== |Field |Type |Description @@ -158,15 +152,15 @@ image:components/surveys/question_form.png[] |Description |Optional -|Explanation of the question being made. +|Additional information on the question if needed. |Mandatory |Optional -|Check if this question is required to respond to submit the answer. +|Check if participants must answer this question to complete the survey. |Character limit |Optional -|How many characters has as a maxim the answer to this question. Leave to 0 if no limit. Compatible with Short and Long answer question types. +|The maximum characters the answer can have. Leave to 0 if no limit. Compatible with Short and Long answer question types. |Type |Required @@ -175,28 +169,14 @@ or Matrix (Multiple option). See xref:_question_types[Question types] for more i |=== -Depending in the question type, it's possible to add validations to the answers, like if the question is mandatory (participants -would need to provide an answer in order to submit the form) or if the answer is limited to a certain number of characters as maximum in -short and long answers. +image::components/surveys/question_form_backend.png[] -image:components/surveys/question_form_limits_backend.png[] +image::components/surveys/question_form_frontend.png[] -image:components/surveys/question_form_limits_frontend.png[] +==== Questions types -== Question types - -A survey can have multiple questions with different types, such as: - -- Short answer -- Long answer -- Single option -- Multiple option -- Sorting -- Files -- Matrix (Single option) -- Matrix (Multiple option) - -.Question types (click to view image in detail) +.Question types (click to view images in detail) +[cols="10h,~,~,~"] |=== |Type|Frontend |Backend |Description @@ -213,47 +193,102 @@ A survey can have multiple questions with different types, such as: |Single option |image:components/surveys/type_single_option_frontend.png[Single option type - frontend,link=../_images/components/surveys/type_single_option_frontend.png] |image:components/surveys/type_single_option_backend.png[Single option type - backend,link=../_images/components/surveys/type_single_option_backend.png] -|Participants will have to choose a single option, with radio buttons. At least 2 options always. It's possible to define a "Free text" option, so participants can submit their own answer. +|Participants have to choose a single option, with radio buttons. Add at least 2 answer options. +It's possible to define a "Free text" option, for participants to submit their own answer. |Multiple option |image:components/surveys/type_multiple_option_frontend.png[Multiple option type - frontend,link=../_images/components/surveys/type_multiple_option_frontend.png] |image:components/surveys/type_multiple_option_backend.png[Multiple option type - backend,link=../_images/components/surveys/type_multiple_option_backend.png] -|Participants will have to choose multiple options, with checkboxes. At least 2 options always. It's possible to add a validation, with the maximum number of choices. It's possible to define a "Free text" option, so participants can submit their own answer. +|Participants can choose multiple options, with checkboxes. Add at least 2 answer options. It's possible to add a validation, +with the maximum number of choices. It's possible to define a "Free text" option, for participants to submit their own answer. |Sorting |image:components/surveys/type_sorting_frontend.png[Sorting type - frontend,link=../_images/components/surveys/type_sorting_frontend.png] |image:components/surveys/type_sorting_backend.png[Sorting type - backend,link=../_images/components/surveys/type_sorting_backend.png] -|At least 2 options always. Participants will click in order of preference to sort. +|Add at least 2 answer options. Participants can drag and drop answer options to order them. |Files |image:components/surveys/type_files_frontend.png[Files type - frontend,link=../_images/components/surveys/type_files_frontend.png] |image:components/surveys/type_files_backend.png[Files type - backend,link=../_images/components/surveys/type_files_backend.png] -|Participants will be able to upload files. +|Allow participants to upload files. |Matrix (Single option) |image:components/surveys/type_matrix_single_option_frontend.png[Matrix (Single option) type - frontend,link=../_images/components/surveys/type_matrix_single_option_frontend.png] |image:components/surveys/type_matrix_single_option_backend.png[Matrix (Single option) type - backend,link=../_images/components/surveys/type_matrix_single_option_backend.png] -|Participants will have to choose between rows and columns of single options, with radio buttons. +|Participants have to choose between rows and columns of single options, with radio buttons. |Matrix (Multiple option) |image:components/surveys/type_matrix_multiple_option_frontend.png[Matrix (Multiple option) type - frontend,link=../_images/components/surveys/type_matrix_multiple_option_frontend.png] |image:components/surveys/type_matrix_multiple_option_backend.png[Matrix (Multiple option) type - backend,link=../_images/components/surveys/type_matrix_multiple_option_backend.png] -|Participants will have to choose between rows and columns of multiple options, with checkboxes. +|Participants have to choose between rows and columns of multiple options, with checkboxes. + +|=== + +==== Conditional questions + +Once you saved your survey, you can see that a new "Add display condition" button is added in the questions blocks. +This feature allows administrators to create complex surveys with conditionality, meaning that some questions are displayed +only if participants chose a specific answer in the previous questions. + +TIP: Conditional questions can be difficult to configure, so be sure to test the survey behaviour before publishing it. + +image::components/surveys/conditional_question.png[Display condition in backend] + +.Add display condition form +[cols="20h,10h,~"] +|=== +|Field |Type |Description + +|Question +|Required +|The previous question that is the condition for displaying this question. + +|Condition +|Required +|To define the condition needed for this question to be displayed. + +|Answer option +|Required +|This field propose the answer options to the questions that need to be chose by participants to realize the condition. +Only available for "Equal" and "Not Equal" conditions. + +|Included text +|Required +|Only available for "Includes text" conditions. + +|This condition needs to be satisfied always regardless the status of other conditions +|Optional +|Check if this condition is essential, even if other conditions would make the display of the question possible. |=== -== Templates +=== Separators + +You can also add separators between questions, when you have a long survey or different topics. +They allow to display the forms questions in different steps. + +Separators can only be ordered or deleted. + +image::components/surveys/separator.png[Separator in front end] -For the cases where administrators need to define multiple surveys that are mostly the same but used in different contexts, -it's possible to define a template. When there's one defined for a survey, then it'll ask to select the Template and create -the survey based on this one or in the other hand if there's no need to use a template, then it's possible to Skip the template -selection. +=== Title and description -image:components/surveys/edit_questionnaire.png[Choose template form] +You can also add a title and description section, to bring clarity to the form and separate it in different sections. +Coupled with separators, they allow to give titles and descriptions to the survey steps. +They can also be used alone, in a one page survey. + +image::components/surveys/title_description_backend.png[Title and description in back end] == Export answers It's possible to export the survey participant answers to different formats: CSV, JSON, XLSX (Excel) or PDF. -Note that the platform doesn't handle the answers processing nor presenting results or summary to the users, that need to be +NOTE: The platform doesn't handle the answers processing nor presenting results or summary to the users, that need to be done externally. + +== Examples + +Some examples of where this component is used: + +* https://consultation.quebec.ca/processes/donneesquebec/f/82/[Data Quebec: participate in its improvement in Québec consultations] +* https://meta.decidim.org/conferences/decidimfest2020/f/1403/?locale=en[DecidimFest2020 Assessment Survey] \ No newline at end of file