decidim-enhanced_textwork 1.0.1 → 1.0.5

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e50e738133449552794c57d2d7206684929959472339d907b607db25a22161c8
4
- data.tar.gz: e7827f8503056f34a52e0661e810bcb73cd501fd7651376a6cc24a3bdf90b226
3
+ metadata.gz: 8d6cb867750235cd87f60e54dcb6691e431f0ab2ffba105cac1d681d107d02a1
4
+ data.tar.gz: 1fa63c61f5297c9758783e26ddabb1559e8965757c51c58b936d53bfe3fa6bab
5
5
  SHA512:
6
- metadata.gz: 8b717843a437cb1227be1aa8ddd7cbd2da8b6d926712273493febb53f0909a402f57c79a66d012b406a3f0b3e647fc1f30ec0a778234871364848b6c4c2dc75d
7
- data.tar.gz: 03a6ce8a6590b71d015baadfc52dfa9e0f0eca75433a325b373b06c09339c4a4e47fc85b9ccb4e3f3e208f778c7e976f432839cb7ca1fe9c83b312434be98b8c
6
+ metadata.gz: 955f9fc5d16de8f9528af05e2531953090fde0a75da7bd9b57e69f37ceef274790810ab42389e75a150e1d9f00b65cbf4d8a27abd33badb726c756cb14d99464
7
+ data.tar.gz: bcc64e25e99b23dabb6783d1f77195f2be4f5dc690e584e6f5e6982ca1ba78be38c47eb53f39472f701487bde038aacaadbdc514509905a4f64771c551728b36
data/README.md CHANGED
@@ -1,8 +1,9 @@
1
1
  # Decidim::EnhancedTextwork
2
2
 
3
- The EnhancedTextwork module allows users to contribute to a participatory process with text work by creating paragraphs.
3
+ The EnhancedTextwork module allows users to contribute to participatory textwork. They can support text-paragraphs, amend them, comment on them and discuss among each other.
4
4
 
5
- This module is based on decidim-proposals and was developed to improve the existing participatory_texts functionality to better suite specific needs we found in Austria.
5
+
6
+ This module is based on decidim-proposals and was developed to improve the existing participatory_texts functionality to better suit specific needs for participatory textwork, that we found in Austria.
6
7
 
7
8
  ## Usage
8
9
 
@@ -10,7 +11,7 @@ EnhancedTextwork is available as a Component for a Participatory Process.
10
11
 
11
12
  We also extended some javascript code using webpacker.
12
13
 
13
- That means it needs at least **Decidim v0.25.0** to work.
14
+ This module needs at least **Decidim v0.26.0** to work.
14
15
 
15
16
  ## Installation
16
17
 
@@ -24,12 +25,14 @@ And then execute:
24
25
 
25
26
  ```bash
26
27
  bundle
28
+ bin/rails decidim_enhanced_textwork:install:migrations
29
+ bin/rails db:migrate
27
30
  ```
28
31
 
29
32
  ## Improvements
30
33
 
31
- Within the scope of our project we improved a few parts of the feature called “participatory_text”, wich is part of the core module “decidim-proposals”.
32
- Unfortunately after finishing our work the decidim core team in Barcelona did not have available resources to integrate our results in the decidim core. For this reason we created a new module based on “decidim-proposals” including our participatory_text enhancements.
34
+ Within the scope of our project we improved some parts of the feature called “participatory_text”, which is part of the core module “decidim-proposals”.
35
+ Unfortunately after finishing our work the decidim core team in Barcelona did not have resources available to integrate our results into the decidim core. For this reason we created a new module based on “decidim-proposals” including our participatory_text enhancements.
33
36
 
34
37
  We named the base model for participatory texts `Paragraph` (instead of Proposal).
35
38
 
@@ -72,7 +75,7 @@ settings.attribute :hide_participatory_text_titles_enabled, type: :boolean, defa
72
75
 
73
76
  ## Participatory Text Result Export
74
77
 
75
- Because `enhanced_textwork` is based on `proposals`, the `Paragraph` model is based on the `Proposal` model. For this reason all the features existing for proposals can also be used on enhanced_textwork. One of those features is the export of results. Until now exporting results was optimized for proposals and didn’t make a lot of sense for exporting the results of collaborative work on a big text document consisting of many sections.
78
+ Because `enhanced_textwork` is based on `proposals`, the `Paragraph` model is based on the `Proposal` model. For this reason all the features existing for proposals can also be used on enhanced_textwork. One of those features is the export of results. Until now exporting results was optimized for proposals and it didn’t make a lot of sense to export the results of collaborative work on a big text document consisting of many sections.
76
79
 
77
80
  Existing export formats for proposals were defined in [decidim-core](https://github.com/decidim/decidim/tree/develop/decidim-core/lib/decidim/exporters):
78
81
 
@@ -80,7 +83,7 @@ Existing export formats for proposals were defined in [decidim-core](https://git
80
83
  * Excel
81
84
  * JSON
82
85
 
83
- We decided to add a new Word/docx export exclusively in the enhanced_textwork module:
86
+ In a text-based participatory process the export of a text-document can help to continue working with the results. Hence we decided to add a new Word/docx export exclusively in the enhanced_textwork module:
84
87
 
85
88
  [lib/decidim/exporters/word.rb](lib/decidim/exporters/word.rb)
86
89
 
@@ -134,7 +137,7 @@ Participatory texts persist each section of the document in a Paragraph.
134
137
 
135
138
  When importing participatory texts all formats are first transformed into Markdown and is the markdown that is parsed and processed to generate the corresponding Paragraphs.
136
139
 
137
- When processing participatory text documents three kinds of secions are taken into account.
140
+ When processing participatory text documents three kinds of sections are taken into account.
138
141
 
139
142
  - Section: each "Title 1" in the document becomes a section.
140
143
  - Subsection: the rest of the titles become subsections.
@@ -5,7 +5,7 @@ module Decidim
5
5
  module Admin
6
6
  # This class contains helpers needed to show the Paragraphs picker.
7
7
  #
8
- module EnhancedTextworkPickerHelper
8
+ module ParagraphsPickerHelper
9
9
  def paragraphs_picker(form, field, url)
10
10
  picker_options = {
11
11
  id: sanitize_to_id(field),