Skip to content

Commit

Permalink
Update categories partial
Browse files Browse the repository at this point in the history
  • Loading branch information
paulinebessoles committed Dec 6, 2024
1 parent f9a3e90 commit 48b309e
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 23 deletions.
Binary file modified docs/en/modules/admin/assets/images/spaces/categories.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 40 additions & 22 deletions docs/en/modules/admin/partials/page_categories.adoc
Original file line number Diff line number Diff line change
@@ -1,57 +1,75 @@
= Categories

== Understand the basics

Categories (and subcategories) are used for classifying resources inside of a space.

An administrator can define them, can be assigned to when creating resources, and then participants can filter the
different resources by these categories. For instance, they can be set up in proposals, meetings and debates.
different resources by these categories. For instance, they can be used in proposals, meetings, and debates.

As an example of this mechanism in action you can see it in https://meta.decidim.org/processes/roadmap/f/122/[Propose new functionalities for Decidim software] process:
. Administrators define categories in a space.
. Participants can create resources and give them a category.
. Participants can then filter by categories.

. Administrators have defined the categories in the process.
. Participants can create proposals that have one category.
. Participants can filter by these categories and navigate among all the proposals.
image::spaces/categories_sidebar.png[Filter categories in proposals]

image:spaces/categories_sidebar.png[Filter categories in proposals]

image:spaces/categories_form.png[Select a category when creating a proposal]

NOTE: Once a category is in use it cannot be removed, as there are resources that are using it.
NOTE: Once a category is in use it cannot be deleted, as there are resources that are linked to it.

Decidim has other ways to classify resources, for instance xref:admin:scopes.adoc[Scopes] and xref:admin:features/hashtags.adoc[Hashtags].
The main difference is that Categories can be defined in a given space, Scopes are global for all the platform, and Hashtags
are defined by the participants.
can be defined by the participants.

Categories can be nested, meaning that a category can have subcategories.

== Create a new category
== How to find it?

To configure categories, click the *Categories* item in any participatory space.

For configuring a new category, go to the space admin panel and click on the "Categories" tab.
image::spaces/categories.png[View categories in a space administration page]

image:spaces/categories.png[View categories in a space admin page]
== Create a new category

Then click in "Add category" and fill the form.
Click in "New category" button on the top right.

image:spaces/categories_new_form.png[Create a new category form]

.Create category
.Create category form
[cols="20h,10h,~"]
|===
|Field |Type |Description

|Name
|Required
|What is the name for this category.

|Weight
|Order position
|Optional
|Which order will it have in relation to the other categories. Having a lower number means a higher priority. For instance, if you have two categories, "Category a" with weight "10" and "Category b" with weight "0", then "Category b" will be first when ordering.

|Description
|Required
|A long description explaining what this category is about.
|Which order it has in relation to the other categories. Having a lower number means a higher priority. For instance, if you have two categories, "Category a" with weight "10" and "Category b" with weight "0" then "Category b" is first when ordering.

|Parent
|Optional
|What is the parent category.
|===

== Manage categories

You can find all the categories on the list in the administration panel, with:

* *Name*: name of the category, given when creating or editing it by the administrator.

== Actions

.Components actions in component list
[cols="20h,10h,~"]
|===
|Icon |Name |Definition

|image:icons/action_edit.png[Edit icon]
|Edit
|To edit the name, the order position and the parent of the category.

|image:icons/action_delete.png[Delete icon]
|Delete
|To delete the category. A category can't be deleted if it has resources attached to it.

|===
4 changes: 3 additions & 1 deletion docs/en/modules/admin/partials/page_components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ You can find all the components on the list in the administration panel, with:
To configure a new component, click the *Add component* from the upper right part of the screen and select the type of
component you want.

image::spaces/components_new_dropdown.png[Add a component in a space]
image::spaces/components/components_new_dropdown.png[Add a component in a space]

== Actions

.Components actions in component list
[cols="20h,10h,~"]
|===
|Icon |Name |Definition

Expand Down

0 comments on commit 48b309e

Please sign in to comment.