decidim 0.30.2 → 0.31.0.rc1

data/docs/modules/customize/pages/index.adoc

@@ -21,6 +21,7 @@ Inside of your application you can customize it in different ways:
 * xref:customize:gemfile.adoc[Gemfile]
 * xref:customize:images.adoc[Images]
 * xref:customize:javascript.adoc[JavaScript]
+* xref:customize:localization.adoc[Localization]
 * xref:customize:logic.adoc[Logic]
 * xref:customize:menu.adoc[Menu]
 * xref:customize:admin_filters.adoc[Admin filters]

data/docs/modules/customize/pages/javascript.adoc

@@ -2,9 +2,9 @@
 
 You can add JavaScript code by multiple ways in Decidim:
 
-== Webpacker
+== Shakapacker
 
-Decidim uses Webpack (via Webpacker) to compile assets, including javascript.
+Decidim uses Webpack (via Shakapacker) to compile assets, including javascript.
 
 During the generation of a decidim app, the file `app/packs/src/decidim/decidim_application.js` is created and hooked to Decidim packs, so any javascript written there is compiled within Decidim assets. For example to create a new alert just add:
 
@@ -36,24 +36,11 @@ $(function(){
 == Custom HTML Header snippets
 
 If you need changes on a multitenant installation, you can do so by enabling a configuration
-in your `config/initializers/decidim.rb` file. Please do notice that this has security implications:
+using your environment variables. Please do notice that this has security implications:
 
-[source,ruby]
+[source,bash]
 ----
-  # Custom HTML Header snippets
-  #
-  # The most common use is to integrate third-party services that require some
-  # extra JavaScript or CSS. Also, you can use it to add extra meta tags to the
-  # HTML. Note that this will only be rendered in public pages, not in the admin
-  # section.
-  #
-  # Before enabling this you should ensure that any tracking that might be done
-  # is in accordance with the rules and regulations that apply to your
-  # environment and usage scenarios. This feature also comes with the risk
-  # that an organization's administrator injects malicious scripts to spy on or
-  # take over user accounts.
-  #
-  config.enable_html_header_snippets = true
+export DECIDIM_ENABLE_HTML_HEADER_SNIPPETS=true
 ----
 
 Then you will have a new textarea field called "Header snippets" in Administration -> Configuration -> Appearance (URL `/admin/organization/appearance/edit`):

data/docs/modules/customize/pages/localization.adoc

@@ -0,0 +1,75 @@
+= Localization
+
+Depending on your country, you might want to adapt some details in the configuration.
+
+Some are defined in the locales (your language configuration). If this is the same in all the countries that speak your language, then you can change it directly in the translations. You can read more about  xref:contribute:translations.adoc[how to contribute translations to Decidim]).
+If the changes that you need are only for your country or your installation, then you need to configure it on your application. This page explains how to do that.
+
+== Date and time formats
+
+These are defined in the YAML. You can read more about this in the link:https://guides.rubyonrails.org/i18n.html[Rails Internationalization (i18n) API] and also in the xref:customize:texts.adoc[Texts] page.
+
+The following keys are relevant to time and date format:
+
+```yaml
+  date:
+    formats:
+      decidim_short: "%d/%m/%Y"
+      decidim_short_dashed: "%d-%m-%Y"
+      decidim_short_with_month_name_short: "%d %b %Y"
+      decidim_with_day_and_month_name: "%A %d %b %Y"
+      decidim_with_month_name: "%d %B %Y"
+      decidim_with_month_name_short: "%d %b"
+      help:
+        date_format: 'Format: dd/mm/yyyy'
+      order: d-m-y
+      separator: "/"
+```
+
+If you need to change the format to comply with the United States of America standard, you must do the following:
+
+. Create or update the file `config/locales/en.yml` in your generated application.
+. Add the following snippet:
+```yaml
+en:
+  date:
+    formats:
+      decidim_short: "%m/%d/%Y"
+      decidim_short_dashed: "%m-%d-%Y"
+      decidim_short_with_month_name_short: "%b %d %Y"
+      decidim_with_day_and_month_name: "%A, %b %d %Y"
+      decidim_with_month_name: "%B %d %Y"
+      decidim_with_month_name_short: "%b %d"
+      help:
+        date_format: 'Format: mm/dd/yyyy'
+      order: m-d-y
+      separator: "/"
+```
+. Restart your application server.
+
+Note that in the case of the `order` value, currently it only supports two values:
+
+- `m-d-y`
+- `d-m-y`
+
+== Currency unit
+
+If you are using the xref:admin:components/budgets.adoc[Budget] component or the xref:admin:components/proposals/answers.adoc[Proposals' answers with costs] feature, you may want to change the `DECIDIM_CURRENCY_UNIT` environment variable to a currency other than the default Euro (€). Read more about how to customize xref:configure:environment_variables.adoc[Environment Variables].
+
+If you want to control where the currency unit (like `€`) and the number (like `999`) is shown, then you can do that by changing the order of the values %u and %n (for unit and number respectively).
+
+```yaml
+en:
+  number:
+    currency:
+      format:
+        format: "%u %n"
+        html_format: "<span>%u</span> %n"
+```
+
+Some examples:
+
+- "%u %n" -> Shows it as € 999
+- "%n%u"-> Shows it as 999€
+
+The `html_format` key is used in the budgets component to style better the unit.

data/docs/modules/customize/pages/oauth.adoc

@@ -30,4 +30,16 @@ ActiveSupport::Notifications.subscribe "decidim.user.omniauth_registration" do |
 end
 ----
 
+Note that, if the user is already registered, the `CreateOmniauthRegistration` command will not trigger the "decidim.user.omniauth_registration" event by instead it will trigger the "decidim.user.omniauth_login" event, which has the same payload as the registration event.
+
+For instance, to retrigger the `IdCatMobilVerificationJob` after a user logs in via omniauth, you can subscribe to the "decidim.user.omniauth_login" event as follows:
+
+[source,ruby]
+----
+ActiveSupport::Notifications.subscribe "decidim.user.omniauth_login" do |name, started, finished, unique_id, data|
+  puts "the data: #{data.inspect}"
+  IdCatMobilVerificationJob.perform_later(data[:raw_data])
+end
+----
+
 It is a good practice to delegate the required implementation to a Job to bring a fastest response to the user, also it will avoid that crashes in this code to propagate to the registration process.

data/docs/modules/customize/pages/social_shares.adoc

@@ -44,15 +44,12 @@ If you have the need, you can enable your own service. To do that, as an example
 
 . Alternatively, you can provide any https://remixicon.com/ logo also. Simply as adding the icon key for such social share, e.g. "reddit-line"
 
-. In addition to the remixicon, icon_color property can be added, using an Hex color, e.g. "#ff4500"
-
 . Add the social share service block configuration at the bottom of your Decidim initializer:
 
 [source,ruby]
 ----
 Decidim.register_social_share_service("Foo") do |service|
   service.icon = "foo.svg" # (or "reddit-line")
-  service.icon_color = "#ff4500"
   service.share_uri = "https://foo.example.com/share?url=%{url}"
 end
 ----

data/docs/modules/customize/pages/styles.adoc

@@ -24,24 +24,11 @@ There is an special partial file for adding inline content in every public page.
 == Custom HTML Header snippets
 
 If you need changes on a multitenant installation, you can do so by enabling a configuration
-in your `config/initializers/decidim.rb` file. Please do notice that this has security implications:
+using your environment variables. Please do notice that this has security implications:
 
-[source,ruby]
+[source,bash]
 ----
-  # Custom HTML Header snippets
-  #
-  # The most common use is to integrate third-party services that require some
-  # extra JavaScript or CSS. Also, you can use it to add extra meta tags to the
-  # HTML. Note that this will only be rendered in public pages, not in the admin
-  # section.
-  #
-  # Before enabling this you should ensure that any tracking that might be done
-  # is in accordance with the rules and regulations that apply to your
-  # environment and usage scenarios. This feature also comes with the risk
-  # that an organization's administrator injects malicious scripts to spy on or
-  # take over user accounts.
-  #
-  config.enable_html_header_snippets = true
+export DECIDIM_ENABLE_HTML_HEADER_SNIPPETS=true
 ----
 
 Then you will have a new textarea field called "Header snippets" in Administration -> Configuration -> Appearance (URL `/admin/organization/appearance/edit`):