Sha256: 36f6893596ecafd20b0e3b2e0fed21d8b430e75f11d1f0b4ad47009c7f54cf64

Contents?: true

Size: 1.74 KB

Versions: 65

Compression:

Stored size: 1.74 KB

Contents

# Decidim::Proposals

The Proposals module adds one of the main components of Decidim: allows users to contribute to a participatory process by creating proposals.

## Usage

Proposals will be available as a Component for a Participatory Process.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'decidim-proposals'
```

And then execute:

```bash
bundle
```

### Configuring Similarity

`pg_trgm` is a PostgreSQL extension providing simple fuzzy string matching used in the Proposal wizard to find similar published proposals (title and the body).

Create config variables in your app's `/config/initializers/decidim-proposals.rb`:

```ruby
Decidim::Proposals.configure do |config|
  config.similarity_threshold = 0.25 # default value
  config.similarity_limit = 10 # default value
end
```

`similarity_threshold`(real): Sets the current similarity threshold that is used by the % operator. The threshold must be between 0 and 1 (default is 0.3).

`similarity_limit`: number of maximum results.

## Global Search

This module includes the following models to Decidim's Global Search:

- `Proposals`

## Participatory Texts

Participatory texts persist each section of the document in a Proposal.

When importing participatory texts all formats are first transformed into Markdown and is the markdown that is parsed and processed to generate the corresponding Proposals.

When processing participatory text documents three kinds of secions are taken into account.

- Section: each "Title 1" in the document becomes a section.
- Subsection: the rest of the titles become subsections.
- Article: paragraphs become articles.

## Contributing

See [Decidim](https://github.com/decidim/decidim).

## License

See [Decidim](https://github.com/decidim/decidim).

Version data entries

65 entries across 65 versions & 1 rubygems

Version Path
decidim-proposals-0.28.4 README.md
decidim-proposals-0.27.9 README.md
decidim-proposals-0.28.3 README.md
decidim-proposals-0.27.8 README.md
decidim-proposals-0.28.2 README.md
decidim-proposals-0.27.7 README.md
decidim-proposals-0.28.1 README.md
decidim-proposals-0.27.6 README.md
decidim-proposals-0.26.10 README.md
decidim-proposals-0.26.9 README.md
decidim-proposals-0.28.0 README.md
decidim-proposals-0.27.5 README.md
decidim-proposals-0.28.0.rc5 README.md
decidim-proposals-0.28.0.rc4 README.md
decidim-proposals-0.26.8 README.md
decidim-proposals-0.27.4 README.md
decidim-proposals-0.27.3 README.md
decidim-proposals-0.26.7 README.md
decidim-proposals-0.26.5 README.md
decidim-proposals-0.27.2 README.md