MDS Variant: add description for fields in asset creation mask (#792)

CHANGELOG.md

@@ -20,6 +20,7 @@ the detailed section referring to by linking pull requests or issues.
 
 #### Patch
 
+- Added description for fields in asset creation mask
 
 ## [v4.1.1] - 2024-08-09
 
@@ -33,7 +34,8 @@ Various UI improvements and bug fixing
 
 #### Patch
 
-- Copyable contact email and subject fields on asset and data offer detail dialogs
+- Copyable contact email and subject fields on asset and data offer detail
+  dialogs
 - Assets Page search input field is now case-insensitive
 - Markdown support for Reference files description, Conditions for use fields
 - Fixed wrong date format when creating a new data offer

src/app/routes/connector-ui/asset-page/asset-edit-dialog/asset-edit-dialog.component.html

@@ -162,8 +162,15 @@ <h1 mat-dialog-title>
             <mat-label>Data Model</mat-label>
             <input
               matInput
-              placeholder="unspecified"
+              placeholder="proprietary"
               [formControl]="form.advanced.controls.dataModel" />
+            <button
+              class="!scale-[0.9]"
+              mat-icon-button
+              matSuffix
+              matTooltip="Model for data exchange, e.g. DATEX II, TPEG for traffic and travel information">
+              <mat-icon>info_outline</mat-icon>
+            </button>
           </mat-form-field>
 
           <div class="flex flex-row space-x-[10px]">
@@ -182,6 +189,13 @@ <h1 mat-dialog-title>
                 matInput
                 placeholder="Lat/Lon"
                 [formControl]="form.advanced.controls.geoReferenceMethod" />
+              <button
+                class="!scale-[0.9]"
+                mat-icon-button
+                matSuffix
+                matTooltip="The method used for representing of geographical data, e.g GeoJSON, OpenLR">
+                <mat-icon>info_outline</mat-icon>
+              </button>
             </mat-form-field>
           </div>
 
@@ -192,17 +206,30 @@ <h1 mat-dialog-title>
               matInput
               placeholder="Data Owning Company GMBH"
               [formControl]="form.advanced.controls.sovereignLegalName" />
-            <mat-hint>Legal name of the data owner</mat-hint>
+            <button
+              class="!scale-[0.9]"
+              mat-icon-button
+              matSuffix
+              matTooltip="Legal name of the data owner">
+              <mat-icon>info_outline</mat-icon>
+            </button>
           </mat-form-field>
 
           <!-- Data update frequency -->
-          <div class="flex flex-row space-x-[10px] mt-[15px]">
+          <div class="flex flex-row space-x-[10px]">
             <mat-form-field class="grow">
               <mat-label>Data update frequency</mat-label>
               <input
                 matInput
                 placeholder="every month"
                 [formControl]="form.advanced.controls.dataUpdateFrequency" />
+              <button
+                class="!scale-[0.9]"
+                mat-icon-button
+                matSuffix
+                matTooltip="How often is the dataset updated, e.g	'Every 5 min.'">
+                <mat-icon>info_outline</mat-icon>
+              </button>
             </mat-form-field>
 
             <!-- Geo location -->
@@ -212,11 +239,27 @@ <h1 mat-dialog-title>
                 matInput
                 placeholder="40.741895,-73.989308"
                 [formControl]="form.advanced.controls.geoLocation" />
+              <button
+                class="!scale-[0.9]"
+                mat-icon-button
+                matSuffix
+                matTooltip="Simple description of the relevant geolocation, e.g. Hamburg and vicinity">
+                <mat-icon>info_outline</mat-icon>
+              </button>
             </mat-form-field>
           </div>
 
           <!-- NUTS locations -->
-          <div class="form-section-title">NUTS locations</div>
+          <div class="flex flex-row justify-start items-center">
+            <div class="form-section-title">NUTS locations</div>
+            <button
+              class="!scale-[0.9]"
+              mat-icon-button
+              matSuffix
+              matTooltip="NUTS codes are regional identifiers in Germany used for statistical and administrative purposes, covering states, districts, and municipalities. (e.g DE60)">
+              <mat-icon>info_outline</mat-icon>
+            </button>
+          </div>
           <div
             *ngFor="
               let location of form.advanced.controls.nutsLocations.controls;
@@ -247,7 +290,16 @@ <h1 mat-dialog-title>
           </div>
 
           <!-- Data sample URLs -->
-          <div class="form-section-title">Data samples</div>
+          <div class="flex flex-row justify-start items-center">
+            <div class="form-section-title">Data samples</div>
+            <button
+              class="!scale-[0.9]"
+              mat-icon-button
+              matSuffix
+              matTooltip="URLs of Dataset samples if available">
+              <mat-icon>info_outline</mat-icon>
+            </button>
+          </div>
           <div
             *ngFor="
               let sample of form.advanced.controls.dataSampleUrls.controls;
@@ -281,7 +333,17 @@ <h1 mat-dialog-title>
           </div>
 
           <!-- Reference file URLs -->
-          <div class="form-section-title">Reference files</div>
+          <div class="flex flex-row justify-start items-center">
+            <div class="form-section-title">Reference files</div>
+
+            <button
+              class="!scale-[0.9]"
+              mat-icon-button
+              matSuffix
+              matTooltip="URLs of Dataset schemas or other references">
+              <mat-icon>info_outline</mat-icon>
+            </button>
+          </div>
           <div
             *ngFor="
               let file of form.advanced.controls.referenceFileUrls.controls;
@@ -326,7 +388,16 @@ <h1 mat-dialog-title>
                 form.advanced.controls.referenceFilesDescription
               "></textarea>
             <mat-hint
-              >Additional information regarding the reference files
+              >Additional information regarding the reference files.
+              <span class="flex flex-row items-center gap-1"
+                >Supports
+                <a
+                  class="link"
+                  externalLink
+                  href="https://www.markdownguide.org/basic-syntax/"
+                  >Markdown syntax</a
+                >
+              </span>
             </mat-hint>
           </mat-form-field>
 
@@ -346,7 +417,10 @@ <h1 mat-dialog-title>
                 formControlName="toInclusive"
                 placeholder="End date (inclusive)" />
             </mat-date-range-input>
-            <mat-hint>DD/MM/YYYY (optional) – DD/MM/YYYY (optional)</mat-hint>
+            <mat-hint
+              >Start and/or end date when the dataset is available for
+              consumption. DD/MM/YYYY (optional) – DD/MM/YYYY (optional)
+            </mat-hint>
             <mat-datepicker-toggle
               matSuffix
               [for]="picker"></mat-datepicker-toggle>
@@ -368,7 +442,16 @@ <h1 mat-dialog-title>
               "></textarea>
             <mat-hint
               >Additional not legally relevant usage instructions (e.g. how to
-              cite the dataset)
+              cite the dataset). <br />
+              <span class="flex flex-row items-center gap-1"
+                >Supports
+                <a
+                  class="link"
+                  externalLink
+                  href="https://www.markdownguide.org/basic-syntax/"
+                  >Markdown syntax</a
+                >
+              </span>
             </mat-hint>
           </mat-form-field>
         </div>