Merge pull request #1017 from rdmorganiser/short_title

 Short title for Section and Page

rdmo/management/assets/js/components/edit/EditPage.js

@@ -136,6 +136,8 @@ const EditPage = ({ config, page, elements, elementActions }) => {
               <Tab key={index} eventKey={index} title={lang}>
                 <Text config={config} element={page} field={`title_${lang_code }`}
                       onChange={updatePage} />
+                <Text config={config} element={page} field={`short_title_${lang_code }`}
+                      onChange={updatePage} />
                 <Textarea config={config} element={page} field={`help_${lang_code }`}
                           rows={4} onChange={updatePage} />
                 <Text config={config} element={page} field={`verbose_name_${lang_code }`}

rdmo/management/assets/js/components/edit/EditSection.js

@@ -93,6 +93,8 @@ const EditSection = ({ config, section, elements, elementActions }) => {
               <Tab key={index} eventKey={index} title={lang}>
                 <Text config={config} element={section} field={`title_${lang_code }`}
                       onChange={updateSection} />
+                <Text config={config} element={section} field={`short_title_${lang_code }`}
+                      onChange={updateSection} />
               </Tab>
             ))
           }

rdmo/projects/progress.py

@@ -52,7 +52,7 @@ def compute_navigation(section, project, snapshot=None):
         navigation_section = {
             'id': catalog_section.id,
             'uri': catalog_section.uri,
-            'title': catalog_section.title,
+            'title': catalog_section.short_title or catalog_section.title,
             'first': catalog_section.elements[0].id if catalog_section.elements else None
         }
         if catalog_section.id == section.id:
@@ -71,7 +71,7 @@ def compute_navigation(section, project, snapshot=None):
                 navigation_section['pages'].append({
                     'id': page.id,
                     'uri': page.uri,
-                    'title': page.title,
+                    'title': page.short_title or page.title,
                     'show': show,
                     'count': count,
                     'total': total

rdmo/questions/imports.py

@@ -75,6 +75,7 @@ def import_section(element, save=False, user=None):
     set_common_fields(section, element)
 
     set_lang_field(section, 'title', element)
+    set_lang_field(section, 'short_title', element)
 
     validate_instance(section, element, SectionLockedValidator, SectionUniqueURIValidator)
 
@@ -108,6 +109,7 @@ def import_page(element, save=False, user=None):
     page.is_collection = element.get('is_collection') or False
 
     set_lang_field(page, 'title', element)
+    set_lang_field(page, 'short_title', element)
     set_lang_field(page, 'help', element)
     set_lang_field(page, 'verbose_name', element)
 

rdmo/questions/migrations/0094_section_short_title.py

@@ -0,0 +1,38 @@
+# Generated by Django 4.2.8 on 2024-06-06 15:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('questions', '0093_alter_help_text_and_set_default'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='section',
+            name='short_title_lang1',
+            field=models.CharField(blank=True, help_text='The short title for this section (in the primary language), used in the navigation.', max_length=32, verbose_name='Short title (primary)'),
+        ),
+        migrations.AddField(
+            model_name='section',
+            name='short_title_lang2',
+            field=models.CharField(blank=True, help_text='The short title for this section (in the secondary language), used in the navigation.', max_length=32, verbose_name='Short title (secondary)'),
+        ),
+        migrations.AddField(
+            model_name='section',
+            name='short_title_lang3',
+            field=models.CharField(blank=True, help_text='The short title for this section (in the tertiary language), used in the navigation.', max_length=32, verbose_name='Short title (tertiary)'),
+        ),
+        migrations.AddField(
+            model_name='section',
+            name='short_title_lang4',
+            field=models.CharField(blank=True, help_text='The short title for this section (in the quaternary language), used in the navigation.', max_length=32, verbose_name='Short title (quaternary)'),
+        ),
+        migrations.AddField(
+            model_name='section',
+            name='short_title_lang5',
+            field=models.CharField(blank=True, help_text='The short title for this section (in the quinary language), used in the navigation.', max_length=32, verbose_name='Short title (quinary)'),
+        ),
+    ]

rdmo/questions/migrations/0095_page_short_title.py

@@ -0,0 +1,38 @@
+# Generated by Django 4.2.8 on 2024-06-06 15:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('questions', '0094_section_short_title'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='page',
+            name='short_title_lang1',
+            field=models.CharField(blank=True, help_text='The short title for this page (in the primary language), used in the navigation.', max_length=32, verbose_name='Short title (primary)'),
+        ),
+        migrations.AddField(
+            model_name='page',
+            name='short_title_lang2',
+            field=models.CharField(blank=True, help_text='The short title for this page (in the secondary language), used in the navigation.', max_length=32, verbose_name='Short title (secondary)'),
+        ),
+        migrations.AddField(
+            model_name='page',
+            name='short_title_lang3',
+            field=models.CharField(blank=True, help_text='The short title for this page (in the tertiary language), used in the navigation.', max_length=32, verbose_name='Short title (tertiary)'),
+        ),
+        migrations.AddField(
+            model_name='page',
+            name='short_title_lang4',
+            field=models.CharField(blank=True, help_text='The short title for this page (in the quaternary language), used in the navigation.', max_length=32, verbose_name='Short title (quaternary)'),
+        ),
+        migrations.AddField(
+            model_name='page',
+            name='short_title_lang5',
+            field=models.CharField(blank=True, help_text='The short title for this page (in the quinary language), used in the navigation.', max_length=32, verbose_name='Short title (quinary)'),
+        ),
+    ]

rdmo/questions/models/page.py

@@ -106,6 +106,31 @@ class Page(Model, TranslationMixin):
         verbose_name=_('Title (quinary)'),
         help_text=_('The title for this page (in the quinary language).')
     )
+    short_title_lang1 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (primary)'),
+        help_text=_('The short title for this page (in the primary language), used in the navigation.')
+    )
+    short_title_lang2 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (secondary)'),
+        help_text=_('The short title for this page (in the secondary language), used in the navigation.')
+    )
+    short_title_lang3 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (tertiary)'),
+        help_text=_('The short title for this page (in the tertiary language), used in the navigation.')
+    )
+    short_title_lang4 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (quaternary)'),
+        help_text=_('The short title for this page (in the quaternary language), used in the navigation.')
+    )
+    short_title_lang5 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (quinary)'),
+        help_text=_('The short title for this page (in the quinary language), used in the navigation.')
+    )
     help_lang1 = models.TextField(
         blank=True,
         verbose_name=_('Help (primary)'),
@@ -178,6 +203,10 @@ def save(self, *args, **kwargs):
     def title(self):
         return self.trans('title')
 
+    @property
+    def short_title(self):
+        return self.trans('short_title')
+
     @property
     def help(self):
         return self.trans('help')
@@ -214,6 +243,7 @@ def to_dict(self):
             'id': self.id,
             'uri': self.uri,
             'title': self.title,
+            'short_title': self.short_title,
             'is_collection': self.is_collection,
             'attribute': self.attribute.uri if self.attribute else None,
             'conditions': [condition.uri for condition in self.conditions.all()],

rdmo/questions/models/section.py

@@ -89,6 +89,31 @@ class Section(Model, TranslationMixin):
         verbose_name=_('Title (quinary)'),
         help_text=_('The title for this section (in the quinary language).')
     )
+    short_title_lang1 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (primary)'),
+        help_text=_('The short title for this section (in the primary language), used in the navigation.')
+    )
+    short_title_lang2 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (secondary)'),
+        help_text=_('The short title for this section (in the secondary language), used in the navigation.')
+    )
+    short_title_lang3 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (tertiary)'),
+        help_text=_('The short title for this section (in the tertiary language), used in the navigation.')
+    )
+    short_title_lang4 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (quaternary)'),
+        help_text=_('The short title for this section (in the quaternary language), used in the navigation.')
+    )
+    short_title_lang5 = models.CharField(
+        max_length=32, blank=True,
+        verbose_name=_('Short title (quinary)'),
+        help_text=_('The short title for this section (in the quinary language), used in the navigation.')
+    )
 
     class Meta:
         ordering = ('uri', )
@@ -106,6 +131,10 @@ def save(self, *args, **kwargs):
     def title(self):
         return self.trans('title')
 
+    @property
+    def short_title(self):
+        return self.trans('short_title')
+
     @cached_property
     def is_locked(self):
         return self.locked or any(catalog.is_locked for catalog in self.catalogs.all())
@@ -131,6 +160,7 @@ def to_dict(self):
             'id': self.id,
             'uri': self.uri,
             'title': self.title,
+            'short_title': self.short_title,
             'elements': elements,
             'pages': elements
         }

rdmo/questions/renderers/mixins.py

@@ -45,6 +45,7 @@ def render_section(self, xml, section):
 
             for lang_code, lang_string, lang_field in get_languages():
                 self.render_text_element(xml, 'title', {'lang': lang_code}, section['title_%s' % lang_code])
+                self.render_text_element(xml, 'short_title', {'lang': lang_code}, section['short_title_%s' % lang_code])
 
             xml.startElement('pages', {})
             for section_page in section['section_pages']:
@@ -82,6 +83,8 @@ def render_page(self, xml, page):
             for lang_code, lang_string, lang_field in get_languages():
                 self.render_text_element(xml, 'title', {'lang': lang_code},
                                          page['title_%s' % lang_code])
+                self.render_text_element(xml, 'short_title', {'lang': lang_code},
+                                         page['short_title_%s' % lang_code])
                 self.render_text_element(xml, 'help', {'lang': lang_code},
                                          page['help_%s' % lang_code])
                 self.render_text_element(xml, 'verbose_name', {'lang': lang_code},

rdmo/questions/serializers/export.py

@@ -159,6 +159,7 @@ class Meta:
         )
         trans_fields = (
             'title',
+            'short_title',
             'help',
             'verbose_name'
         )
@@ -191,6 +192,7 @@ class Meta:
         )
         trans_fields = (
             'title',
+            'short_title'
         )
 
 

rdmo/questions/serializers/v1/page.py

@@ -64,6 +64,7 @@ class Meta:
             'attribute',
             'is_collection',
             'title',
+            'short_title',
             'help',
             'verbose_name',
             'sections',
@@ -78,6 +79,7 @@ class Meta:
         )
         trans_fields = (
             'title',
+            'short_title',
             'help',
             'verbose_name'
         )

rdmo/questions/serializers/v1/section.py

@@ -47,6 +47,7 @@ class Meta:
             'comment',
             'locked',
             'title',
+            'short_title',
             'catalogs',
             'pages',
             'editors',
@@ -55,6 +56,7 @@ class Meta:
         )
         trans_fields = (
             'title',
+            'short_title'
         )
         parent_fields = (
             ('catalogs', 'catalog', 'section', 'catalog_sections'),

testing/export/project.html

@@ -579,8 +579,8 @@ <h3>Checkboxes</h3>
     <p><strong>checkboxes?</strong></p>
         <h3>Combined</h3>
     <p><strong>combined?</strong></p>
-    <h2>Blocks</h2>
-        <h3>Set</h3>
+    <h2>Blocks of questionsets and questions</h2>
+        <h3>A set of questionsets and questions</h3>
     <p><strong>A?</strong></p>
                     <p>
                         <em>Set &quot;First&quot;, Block #1:</em>&ensp;

testing/fixtures/questions.json

@@ -1570,19 +1570,24 @@
     "pk": 87,
     "fields": {
       "created": "2021-05-28T14:37:33.097Z",
-      "updated": "2021-06-02T14:26:33.898Z",
+      "updated": "2024-06-20T08:21:57.069Z",
       "uri": "http://example.com/terms/questions/catalog/blocks/set",
       "uri_prefix": "http://example.com/terms",
       "uri_path": "catalog/blocks/set",
       "comment": "",
       "locked": false,
       "attribute": 79,
       "is_collection": true,
-      "title_lang1": "Set",
-      "title_lang2": "Set",
+      "title_lang1": "A set of questionsets and questions",
+      "title_lang2": "Ein Set von Fragensets und Fragen",
       "title_lang3": "",
       "title_lang4": "",
       "title_lang5": "",
+      "short_title_lang1": "Set",
+      "short_title_lang2": "Set",
+      "short_title_lang3": "",
+      "short_title_lang4": "",
+      "short_title_lang5": "",
       "help_lang1": "",
       "help_lang2": "",
       "help_lang3": "",
@@ -7408,17 +7413,22 @@
     "pk": 8,
     "fields": {
       "created": "2021-05-28T14:35:31.361Z",
-      "updated": "2021-05-28T14:35:39.559Z",
+      "updated": "2024-06-20T08:20:53.529Z",
       "uri": "http://example.com/terms/questions/catalog/blocks",
       "uri_prefix": "http://example.com/terms",
       "uri_path": "catalog/blocks",
       "comment": "",
       "locked": false,
-      "title_lang1": "Blocks",
-      "title_lang2": "Blocks",
+      "title_lang1": "Blocks of questionsets and questions",
+      "title_lang2": "Blöcke von Fragensets und Fragen",
       "title_lang3": "",
       "title_lang4": "",
       "title_lang5": "",
+      "short_title_lang1": "Blocks",
+      "short_title_lang2": "Blöcke",
+      "short_title_lang3": "",
+      "short_title_lang4": "",
+      "short_title_lang5": "",
       "editors": []
     }
   },