Make "Browse" main nav link text configurable in platform settings

Closes #234
VedaWebProject · Jul 9, 2024 · fe817a8 · fe817a8
1 parent 94f3157
commit fe817a8
Show file tree

Hide file tree

Showing 8 changed files with 94 additions and 40 deletions.
diff --git a/Tekst-API/openapi.json b/Tekst-API/openapi.json
@@ -10816,6 +10816,25 @@
         "type": "object",
         "title": "LocationUpdate"
       },
+      "MainNavEntryTranslation": {
+        "properties": {
+          "locale": {
+            "$ref": "#/components/schemas/TranslationLocaleKey"
+          },
+          "translation": {
+            "type": "string",
+            "maxLength": 16,
+            "minLength": 1,
+            "title": "Translation"
+          }
+        },
+        "type": "object",
+        "required": [
+          "locale",
+          "translation"
+        ],
+        "title": "MainNavEntryTranslation"
+      },
       "MaybePrivateUserField": {
         "type": "string",
         "enum": [
@@ -11926,25 +11945,6 @@
         ],
         "title": "PlatformDescriptionTranslation"
       },
-      "PlatformNavInfoEntryTranslation": {
-        "properties": {
-          "locale": {
-            "$ref": "#/components/schemas/TranslationLocaleKey"
-          },
-          "translation": {
-            "type": "string",
-            "maxLength": 16,
-            "minLength": 1,
-            "title": "Translation"
-          }
-        },
-        "type": "object",
-        "required": [
-          "locale",
-          "translation"
-        ],
-        "title": "PlatformNavInfoEntryTranslation"
-      },
       "PlatformSecurityInfo": {
         "properties": {
           "closedMode": {
@@ -12019,9 +12019,19 @@
             "title": "Defaulttextid",
             "description": "Default text to load in UI"
           },
+          "navBrowseEntry": {
+            "items": {
+              "$ref": "#/components/schemas/MainNavEntryTranslation"
+            },
+            "type": "array",
+            "maxItems": 3,
+            "title": "Navbrowseentry",
+            "description": "Custom label for main navigation browse entry",
+            "default": []
+          },
           "navInfoEntry": {
             "items": {
-              "$ref": "#/components/schemas/PlatformNavInfoEntryTranslation"
+              "$ref": "#/components/schemas/MainNavEntryTranslation"
             },
             "type": "array",
             "maxItems": 3,
@@ -12134,9 +12144,19 @@
             "title": "Defaulttextid",
             "description": "Default text to load in UI"
           },
+          "navBrowseEntry": {
+            "items": {
+              "$ref": "#/components/schemas/MainNavEntryTranslation"
+            },
+            "type": "array",
+            "maxItems": 3,
+            "title": "Navbrowseentry",
+            "description": "Custom label for main navigation browse entry",
+            "default": []
+          },
           "navInfoEntry": {
             "items": {
-              "$ref": "#/components/schemas/PlatformNavInfoEntryTranslation"
+              "$ref": "#/components/schemas/MainNavEntryTranslation"
             },
             "type": "array",
             "maxItems": 3,

diff --git a/Tekst-API/tekst/models/settings.py b/Tekst-API/tekst/models/settings.py
@@ -29,7 +29,7 @@ class PlatformDescriptionTranslation(TranslationBase):
     ]
 
 
-class PlatformNavInfoEntryTranslation(TranslationBase):
+class MainNavEntryTranslation(TranslationBase):
     translation: Annotated[
         str,
         StringConstraints(
@@ -102,8 +102,14 @@ class PlatformSettings(ModelBase, ModelFactoryMixin):
             description="Default text to load in UI",
         ),
     ] = None
+    nav_browse_entry: Annotated[
+        Translations[MainNavEntryTranslation],
+        Field(
+            description="Custom label for main navigation browse entry",
+        ),
+    ] = []
     nav_info_entry: Annotated[
-        Translations[PlatformNavInfoEntryTranslation],
+        Translations[MainNavEntryTranslation],
         Field(
             description="Custom label for main navigation info entry",
         ),

diff --git a/Tekst-Web/src/api/schema.d.ts b/Tekst-Web/src/api/schema.d.ts
@@ -2524,6 +2524,12 @@ export interface components {
       /** Label */
       label?: string | null;
     };
+    /** MainNavEntryTranslation */
+    MainNavEntryTranslation: {
+      locale: components['schemas']['TranslationLocaleKey'];
+      /** Translation */
+      translation: string;
+    };
     /** @enum {string} */
     MaybePrivateUserField: 'name' | 'affiliation' | 'bio';
     MaybePrivateUserFields: components['schemas']['MaybePrivateUserField'][];
@@ -3107,12 +3113,6 @@ export interface components {
       /** Translation */
       translation: string;
     };
-    /** PlatformNavInfoEntryTranslation */
-    PlatformNavInfoEntryTranslation: {
-      locale: components['schemas']['TranslationLocaleKey'];
-      /** Translation */
-      translation: string;
-    };
     /** PlatformSecurityInfo */
     PlatformSecurityInfo: {
       /**
@@ -3170,12 +3170,18 @@ export interface components {
        * @description Default text to load in UI
        */
       defaultTextId?: string | null;
+      /**
+       * Navbrowseentry
+       * @description Custom label for main navigation browse entry
+       * @default []
+       */
+      navBrowseEntry?: components['schemas']['MainNavEntryTranslation'][];
       /**
        * Navinfoentry
        * @description Custom label for main navigation info entry
        * @default []
        */
-      navInfoEntry?: components['schemas']['PlatformNavInfoEntryTranslation'][];
+      navInfoEntry?: components['schemas']['MainNavEntryTranslation'][];
       /**
        * Customfonts
        * @description CSS font family names for use in resources
@@ -3246,12 +3252,18 @@ export interface components {
        * @description Default text to load in UI
        */
       defaultTextId?: string | null;
+      /**
+       * Navbrowseentry
+       * @description Custom label for main navigation browse entry
+       * @default []
+       */
+      navBrowseEntry?: components['schemas']['MainNavEntryTranslation'][];
       /**
        * Navinfoentry
        * @description Custom label for main navigation info entry
        * @default []
        */
-      navInfoEntry?: components['schemas']['PlatformNavInfoEntryTranslation'][];
+      navInfoEntry?: components['schemas']['MainNavEntryTranslation'][];
       /**
        * Customfonts
        * @description CSS font family names for use in resources

diff --git a/Tekst-Web/src/components/navigation/navMenuOptions.ts b/Tekst-Web/src/components/navigation/navMenuOptions.ts
@@ -82,11 +82,15 @@ export function useMainMenuOptions(showIcons: boolean = true) {
 
   const menuOptions = computed<MenuOption[]>(() => [
     {
-      label: renderLink(() => $t('nav.browse'), {
-        name: 'browse',
-        params: { text: state.text?.slug },
-        query: { lvl: browse.level, pos: browse.position },
-      }),
+      label: renderLink(
+        () =>
+          pickTranslation(pfData.value?.settings.navBrowseEntry, state.locale) || $t('nav.browse'),
+        {
+          name: 'browse',
+          params: { text: state.text?.slug },
+          query: { lvl: browse.level, pos: browse.position },
+        }
+      ),
       key: 'browse',
       icon: (showIcons && renderIcon(BookIcon)) || undefined,
     },

diff --git a/Tekst-Web/src/forms/formRules.ts b/Tekst-Web/src/forms/formRules.ts
@@ -184,7 +184,7 @@ export const platformSettingsFormRules: Record<string, FormItemRule[]> = {
       trigger: 'blur',
     },
   ],
-  navInfoEntryTranslation: [minMaxCharsRule(1, 42, 'blur')],
+  navEntryTranslation: [minMaxCharsRule(1, 42, 'blur')],
   oskModeKey: [
     requiredRule(() => $t('models.platformSettings.oskModeKey'), 'blur'),
     minMaxCharsRule(1, 32, 'blur'),

diff --git a/Tekst-Web/src/views/admin/AdminSystemSettingsView.vue b/Tekst-Web/src/views/admin/AdminSystemSettingsView.vue
@@ -160,14 +160,24 @@ function resetForm() {
         />
       </n-form-item>
 
+      <!-- TRANSLATE MAIN NAV BROWSE ENTRY -->
+      <translation-form-item
+        v-model="formModel.navBrowseEntry"
+        parent-form-path-prefix="navBrowseEntry"
+        :loading="loading"
+        :main-form-label="$t('models.platformSettings.navBrowseEntry')"
+        :translation-form-label="$t('models.platformSettings.navBrowseEntry')"
+        :translation-form-rule="platformSettingsFormRules.navEntryTranslation"
+      />
+
       <!-- TRANSLATE MAIN NAV INFO ENTRY -->
       <translation-form-item
         v-model="formModel.navInfoEntry"
         parent-form-path-prefix="navInfoEntry"
         :loading="loading"
         :main-form-label="$t('models.platformSettings.navInfoEntry')"
         :translation-form-label="$t('models.platformSettings.navInfoEntry')"
-        :translation-form-rule="platformSettingsFormRules.navInfoEntryTranslation"
+        :translation-form-rule="platformSettingsFormRules.navEntryTranslation"
       />
 
       <!-- DISPLAY OPTIONS -->

diff --git a/Tekst-Web/translations/ui/deDE.yml b/Tekst-Web/translations/ui/deDE.yml
@@ -316,7 +316,8 @@ models:
     infoContactUrl: URL Kontaktperson
     defaultText: Standard-Text
     availableLocales: Verfügbare Sprachen
-    navInfoEntry: Eigene Beschriftung für Info-Eintrag in Hauptnavigation
+    navBrowseEntry: Eigene Beschriftung für "Lesen" in Hauptnavigation
+    navInfoEntry: Eigene Beschriftung für "Info" in Hauptnavigation
     alwaysShowTextInfo: Zeige Textinformationen und -auswahl auch auf nicht-textspezifischen Seiten
     showTekstFooterHint: Zeige einen kleinen Hinweis auf die Tekst-Software in der Fußzeile (Danke!)
     oskModes: Bildschirmtastatur-Modi

diff --git a/Tekst-Web/translations/ui/enUS.yml b/Tekst-Web/translations/ui/enUS.yml
@@ -313,7 +313,8 @@ models:
     infoContactUrl: Contact URL
     defaultText: Default Text
     availableLocales: Available Languages
-    navInfoEntry: Custom label for info entry in main navigation
+    navBrowseEntry: Custom label for "Browse" in main navigation
+    navInfoEntry: Custom label for "Info" in main navigation
     alwaysShowTextInfo: Show text info and selector in header even on non-text-specific pages
     showTekstFooterHint: Show a small hint to the Tekst software in the footer (Thank you!)
     oskModes: On-screen keyboard modes