Skip to content

Commit

Permalink
Update attachment partial
Browse files Browse the repository at this point in the history
  • Loading branch information
paulinebessoles committed Dec 6, 2024
1 parent 48b309e commit 9dfa492
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 20 deletions.
Binary file modified docs/en/modules/admin/assets/images/spaces/attachments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
71 changes: 51 additions & 20 deletions docs/en/modules/admin/partials/page_attachments.adoc
Original file line number Diff line number Diff line change
@@ -1,60 +1,63 @@
= Attachments

Attachments allow an administrator to upload static files to a space.
== Understand the basics

When a space is launched, it is important to provide citizens with as much information as possible about them so that they can participate with knowledge. That is why it is helpful to add files (Attachments) with the information that is considered relevant.
Attachments allow an administrator to upload static files to a space.

Optionally, these documents can be grouped in *Folders*. For example, for a participatory process of remodeling a square, folders could be created with information about possible uses, with plans, with economic information, etc.
When a space is launched, it is important to provide citizens with as much information as possible about them so that they can participate with knowledge.

Check warning on line 7 in docs/en/modules/admin/partials/page_attachments.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is launched'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is launched').", "location": {"path": "docs/en/modules/admin/partials/page_attachments.adoc", "range": {"start": {"line": 7, "column": 14}}}, "severity": "INFO"}

Check warning on line 7 in docs/en/modules/admin/partials/page_attachments.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Contractions] Use 'it's' instead of 'it is'. Raw Output: {"message": "[Google.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "docs/en/modules/admin/partials/page_attachments.adoc", "range": {"start": {"line": 7, "column": 27}}}, "severity": "INFO"}
That is why it is helpful to add files, documents, images with relevant information.

They can be found on the Space homepage:
These documents can be grouped in *Folders*. For example, for a participatory process of remodeling a square, folders could be created with information about possible uses, with plans, with economic information, etc.

image:spaces/attachments_folder.png[View the folder attachments in the public interface]
They can be found on the space xref:admin:spaces/processes/categories.adoc[landing page] when the content block is enabled.

image:spaces/attachments.png[View the attachments in the public interface]

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

image:spaces/attachments_admin.png[View the attachments in the admin interface]
To create and manage attachments, click the *Attachments* item in the left navigation bar of any participatory space.

For creating a new attachment of a space:
image:spaces/attachments_admin.png[View the attachments in the administration interface]

. Sign in as administrator
. Go to the space section in the sidebar
. Click on the space Edit action
. Click on the Attachments link in the sidebar
. Click on the "New attachment" button
There, you are able to manage the attachments and folders, configure them, add new ones, etc.

== Create a new attachment

To create a new attachment, click the "New attachment" button.

image:spaces/attachments_new_form.png[Create a new attachment form]

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

|Attachment or image name
|Required
|What is the title for this attachment.

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

Check failure on line 41 in docs/en/modules/admin/partials/page_attachments.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Quotes] Commas and periods go inside quotation marks. Raw Output: {"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "docs/en/modules/admin/partials/page_attachments.adoc", "range": {"start": {"line": 41, "column": 211}}}, "severity": "ERROR"}

|Description
|Required
|A long description explaining what this file is about.
|A long description explaining what this attachment is about.

|Folder
|Optional
|Which folder this attachment belongs to.

|File
|Required
|Upload the file. Guidance for file: Has to be an image or a document. For images, use preferrably landscape images, the
service crops the image. For CSV files, the separator between columns must be a comma (","). Maximum file size: 10MB. Allowed
|Upload the file. Guidance for file: Has to be an image or a document. Maximum file size: 10 MB. Allowed
file extensions depends in your server configuration.
|===

== Create a new folder

To create and manage attachments folders, click the *Folders* tab.

image:spaces/attachments_new_folder_form.png[Create a new folder for attachments form]

.Create folder
Expand All @@ -65,11 +68,39 @@ image:spaces/attachments_new_folder_form.png[Create a new folder for attachments
|Required
|Name of the folder

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

Check failure on line 73 in docs/en/modules/admin/partials/page_attachments.adoc

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Quotes] Commas and periods go inside quotation marks. Raw Output: {"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "docs/en/modules/admin/partials/page_attachments.adoc", "range": {"start": {"line": 73, "column": 196}}}, "severity": "ERROR"}

|Description
|Required
|A long description explaining what this folder is about.
|===

== Manage attachments

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

* *Title*: title of the attachment, given when creating or editing it.
* *Folder*: folder where the attachment is stored.
* *Type*: extension type of the attachment.
* *Size*: size of the attachment in bites.

You can also access the folders list by clicking the "Folders" tab on top of the attachments list.

== Actions

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

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

|image:icons/action_delete.png[Delete icon]
|Delete
|To delete the attachment.

|===

0 comments on commit 9dfa492

Please sign in to comment.