richie 2.30.1.dev22__tar.gz → 2.30.1.dev23__tar.gz

{richie-2.30.1.dev22 → richie-2.30.1.dev23}/CHANGELOG.md

@@ -17,6 +17,7 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 ### Changed
 
 - Changed `multiple-columns` CSS component so its columns include a padding
+- Changed `CKEditorPlugin` for new field `variant` to choose a variant style;
 
 ## [2.30.0] - 2024-10-16
 

{richie-2.30.1.dev22/src/richie.egg-info → richie-2.30.1.dev23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: richie
-Version: 2.30.1.dev22
+Version: 2.30.1.dev23
 Summary: A CMS to build learning portals for open education
 Author-email: "Open FUN (France Université Numérique)" <fun.dev@fun-mooc.fr>
 License: MIT License

{richie-2.30.1.dev22 → richie-2.30.1.dev23}/UPGRADE.md

@@ -16,6 +16,22 @@ $ make migrate
 
 ## Unreleased
 
+- There is a new Sass settings that can be used to define 'simple-text' box properties:
+  ```scss
+  $r-simpletext-margin-bottom: 0.5rem;
+  $r-simpletext-variant-padding: 1rem;
+  $r-simpletext-variant-radius: 0.75rem;
+  ```
+  These are the default component values but you may customize them if needed.
+
+- Add new `simpletext-variant-box` theme scheme:
+  ```scss
+  simpletext-variant-box: (
+    primary-color: r-color('denim'),
+    secondary-color: r-color('white'),
+  ),
+  ```
+
 - Add new `r-section-grid-sizes` variable
 ```
   $r-section-grid-sizes: (

{richie-2.30.1.dev22 → richie-2.30.1.dev23}/src/frontend/scss/colors/_theme.scss

@@ -147,6 +147,10 @@ $r-theme: (
     content-color: r-color('slate-grey'),
     description-color: r-color('slate-grey'),
   ),
+  simpletext-variant-box: (
+    primary-color: r-color('denim'),
+    secondary-color: r-color('white'),
+  ),
   blogpost-glimpse: (
     card-background: r-color('white'),
     title-color: r-color('black'),

{richie-2.30.1.dev22 → richie-2.30.1.dev23}/src/frontend/scss/components/_index.scss

@@ -59,6 +59,7 @@
 
 @import './templates/courses/plugins/category_plugin';
 @import './templates/courses/plugins/licence_plugin';
+@import './templates/richie/simpletext/simpletext';
 @import './templates/richie/section/section';
 @import './templates/richie/large_banner/large_banner';
 @import './templates/richie/large_banner/compacted_banner';

richie-2.30.1.dev23/src/frontend/scss/components/templates/richie/simpletext/_simpletext.scss

@@ -0,0 +1,43 @@
+// CKEditor 'simple text' plugin
+//
+// This aims to only adjust every possible plugins so they correctly fit since they
+// were done for 100% size only. No colour, font or anything else should be changed
+// here.
+//
+$r-simpletext-margin-bottom: 0.5rem !default;
+$r-simpletext-variant-padding: 1rem !default;
+$r-simpletext-variant-radius: 0.75rem !default;
+
+.simple-text {
+  margin-bottom: $r-simpletext-margin-bottom;
+
+  & > *:last-child {
+    margin-bottom: 0;
+  }
+
+  &__variant-round-box {
+    padding: $r-simpletext-variant-padding;
+    border: 1px solid transparent;
+    border-radius: $r-simpletext-variant-radius;
+  }
+
+  &__variant-stroked {
+    border-color: r-theme-val(simpletext-variant-box, primary-color);
+    background: r-theme-val(simpletext-variant-box, secondary-color);
+
+    h1,
+    h2,
+    h3,
+    h4,
+    h5,
+    h6 {
+      color: r-theme-val(simpletext-variant-box, primary-color);
+    }
+  }
+
+  &__variant-fulfilled {
+    color: r-theme-val(simpletext-variant-box, secondary-color);
+    border-color: r-theme-val(simpletext-variant-box, primary-color);
+    background: r-theme-val(simpletext-variant-box, primary-color);
+  }
+}

{richie-2.30.1.dev22 → richie-2.30.1.dev23}/src/richie/apps/courses/settings/__init__.py

@@ -32,7 +32,7 @@ def richie_placeholder_conf(name):
     """
     return {
         "name": name,
-        "excluded_plugins": ["CKEditorPlugin", "GoogleMapPlugin"],
+        "excluded_plugins": ["GoogleMapPlugin"],
         "parent_classes": {
             "BlogPostPlugin": ["SectionPlugin"],
             "CategoryPlugin": ["SectionPlugin"],
@@ -55,6 +55,7 @@ def richie_placeholder_conf(name):
                 "OrganizationPlugin",
                 "PersonPlugin",
                 "ProgramPlugin",
+                "CKEditorPlugin",
             ],
             "NestedItemPlugin": ["NestedItemPlugin", "LinkPlugin"],
         },

{richie-2.30.1.dev22 → richie-2.30.1.dev23}/src/richie/plugins/simple_text_ckeditor/cms_plugins.py

@@ -32,7 +32,7 @@ class CKEditorPlugin(CMSPluginBase):
     name = _("Simple text")
     render_template = "richie/simple_text_ckeditor/simple_text.html"
 
-    fieldsets = ((None, {"fields": ["body"]}),)
+    fieldsets = ((None, {"fields": ["body", "variant"]}),)
 
     def get_form(self, request, obj=None, change=False, **kwargs):
         """

richie-2.30.1.dev23/src/richie/plugins/simple_text_ckeditor/defaults.py

@@ -0,0 +1,17 @@
+"""Default settings for Richie's simple text plugin."""
+
+from django.conf import settings
+from django.utils.translation import gettext_lazy as _
+
+SIMPLETEXT_CONFIGURATION = getattr(settings, "RICHIE_SIMPLETEXT_CONFIGURATION", [])
+
+SIMPLETEXT_VARIANTS = getattr(
+    settings,
+    "RICHIE_SIMPLETEXT_VARIANTS",
+    [
+        ("", _("None")),
+        ("round-box", _("Transparent box")),
+        ("fulfilled", _("Fulfilled box")),
+        ("stroked", _("Stroked box")),
+    ],
+)

{richie-2.30.1.dev22 → richie-2.30.1.dev23}/src/richie/plugins/simple_text_ckeditor/forms.py

@@ -25,7 +25,7 @@ class CKEditorPluginForm(forms.ModelForm):
 
         model = SimpleText
         widgets = {"body": TextEditorWidget}
-        fields = ["body"]
+        fields = ["body", "variant"]
 
     def clean_body(self):
         """Normalize and unescape the text submitted by CKEditor then remove useless spaces."""

richie-2.30.1.dev23/src/richie/plugins/simple_text_ckeditor/migrations/0002_add_variant_and_cmsplugin_ptr.py

@@ -0,0 +1,42 @@
+# Generated by Django 4.2.16 on 2024-11-13 00:09
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+from ..defaults import SIMPLETEXT_VARIANTS
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cms", "0022_auto_20180620_1551"),
+        ("simple_text_ckeditor", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="simpletext",
+            name="variant",
+            field=models.CharField(
+                blank=True,
+                choices=SIMPLETEXT_VARIANTS,
+                default="",
+                help_text="Enable a themed box to enclose content.",
+                max_length=50,
+                verbose_name="Box variant",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="simpletext",
+            name="cmsplugin_ptr",
+            field=models.OneToOneField(
+                auto_created=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                parent_link=True,
+                primary_key=True,
+                related_name="%(app_label)s_%(class)s",
+                serialize=False,
+                to="cms.cmsplugin",
+            ),
+        ),
+    ]

{richie-2.30.1.dev22 → richie-2.30.1.dev23}/src/richie/plugins/simple_text_ckeditor/models.py

@@ -11,6 +11,8 @@ from django.utils.translation import gettext_lazy as _
 from cms.models.pluginmodel import CMSPlugin
 from djangocms_text_ckeditor.html import clean_html
 
+from .defaults import SIMPLETEXT_VARIANTS
+
 
 class SimpleText(CMSPlugin):
     """
@@ -21,6 +23,14 @@ class SimpleText(CMSPlugin):
     """
 
     body = models.TextField(_("body"))
+    variant = models.CharField(
+        _("Box variant"),
+        max_length=50,
+        blank=True,
+        choices=SIMPLETEXT_VARIANTS,
+        default="",
+        help_text=_("Enable a themed box to enclose content."),
+    )
 
     def __str__(self):
         return Truncator(strip_tags(self.body)).words(6, truncate="...")

richie-2.30.1.dev23/src/richie/plugins/simple_text_ckeditor/templates/richie/simple_text_ckeditor/simple_text.html

@@ -0,0 +1,3 @@
+{% spaceless %}{% if instance.variant %}<div class="simple-text simple-text__variant-round-box simple-text__variant-{{ instance.variant }}">{% endif %}
+{{ instance.body|safe }}
+{% if instance.variant %}</div>{% endif %}{% endspaceless %}