Skip to content

beyowi/decidim-fictions

Repository files navigation

Decidim::Fictions

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

Usage

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

Installation

Add this line to your application's Gemfile:

gem 'decidim-fictions'

And then execute:

bundle

Configuring Similarity

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

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

Decidim::Fictions.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:

  • Fictions

Participatory Texts

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

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

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.

License

See Decidim.

Releases

No releases published

Packages

No packages published