Context sensitive help texts for fields.

kitodo · Jun 4, 2021 · 134b43b · 134b43b
1 parent 2111771
commit 134b43b
Show file tree

Hide file tree

Showing 11 changed files with 131 additions and 6 deletions.
diff --git a/Classes/Domain/Model/DocumentFormField.php b/Classes/Domain/Model/DocumentFormField.php
@@ -57,6 +57,13 @@ class DocumentFormField extends AbstractFormElement
      */
     protected $maxInputLength;
 
+    /**
+     * help text
+     *
+     * @var string
+     */
+    protected $helpText = '';
+
     /**
      * @var string
      */
@@ -287,4 +294,47 @@ public function setDepositLicense($depositLicense): void
         $this->depositLicense = $depositLicense;
     }
 
+    /**
+     * @return string
+     */
+    public function getHelpText(): string
+    {
+        return $this->helpText;
+    }
+
+    /**
+     * @param string $helpText
+     */
+    public function setHelpText(string $helpText): void
+    {
+        $this->helpText = $helpText;
+    }
+
+    public function getHelpTextLong()
+    {
+        if ($this->helpText) {
+            $domDocument = new \DOMDocument();
+            $domDocument->loadXML("<html>".$this->helpText."</html>");
+            $xpath = \EWW\Dpf\Helper\XPath::create($domDocument);
+            $nodes = $xpath->query("//p");
+            if ($nodes->length > 1) {
+                $domDocument->firstChild->removeChild($nodes->item(0));
+                return str_replace(['<html>','</html>'], '', $domDocument->saveHTML());
+            }
+        }
+    }
+
+    public function getHelpTextShort()
+    {
+        if ($this->helpText) {
+            $domDocument = new \DOMDocument();
+            $domDocument->loadXML("<html>".$this->helpText."</html>");
+            $xpath = \EWW\Dpf\Helper\XPath::create($domDocument);
+            $nodes = $xpath->query("//p");
+            if ($nodes->length > 0) {
+                return $nodes->item(0)->nodeValue;
+            }
+        }
+    }
+
 }
diff --git a/Classes/Domain/Model/MetadataObject.php b/Classes/Domain/Model/MetadataObject.php
@@ -223,6 +223,13 @@ class MetadataObject extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity impl
      */
     protected $orcidPersonMapping = '';
 
+    /**
+     * help text
+     *
+     * @var string
+     */
+    protected $helpText = '';
+
     /**
      * Returns the name
      *
@@ -785,4 +792,20 @@ public function setDepositLicense($depositLicense): void
     {
         $this->depositLicense = $depositLicense;
     }
+
+    /**
+     * @return string
+     */
+    public function getHelpText(): string
+    {
+        return $this->helpText;
+    }
+
+    /**
+     * @param string $helpText
+     */
+    public function setHelpText(string $helpText): void
+    {
+        $this->helpText = $helpText;
+    }
 }
diff --git a/Classes/Helper/DocumentMapper.php b/Classes/Helper/DocumentMapper.php
@@ -232,6 +232,8 @@ public function getDocumentForm(Document $document, $generateEmptyFields = true)
                             $depositLicense = $this->depositLicenseRepository->findByUid($metadataObject->getDepositLicense());
                             $documentFormField->setDepositLicense($depositLicense);
 
+                            $documentFormField->setHelpText($metadataObject->getHelpText());
+
                             $objectMapping = "";
 
                             preg_match_all('/([A-Za-z0-9]+:[A-Za-z0-9]+(\[.*\])*|[A-Za-z0-9:@\.]+)/', $metadataObject->getRelativeMapping(), $objectMappingPath);
@@ -324,6 +326,8 @@ public function getDocumentForm(Document $document, $generateEmptyFields = true)
                         $depositLicense = $this->depositLicenseRepository->findByUid($metadataObject->getDepositLicense());
                         $documentFormField->setDepositLicense($depositLicense);
 
+                        $documentFormField->setHelpText($metadataObject->getHelpText());
+
                         $documentFormGroup->addItem($documentFormField);
                     }
 

diff --git a/Configuration/TCA/tx_dpf_domain_model_metadataobject.php b/Configuration/TCA/tx_dpf_domain_model_metadataobject.php
@@ -33,14 +33,14 @@
             'starttime' => 'starttime',
             'endtime'   => 'endtime',
         ),
-        'searchFields'             => 'name, display_name, max_iteration, mandatory, data_type, validation, mapping, mods_extension, json_mapping, input_field, deposit_license, max_input_length, input_option_list, fill_out_service, gnd_field_uid, default_value, access_restriction_roles, consent, embargo, fis_person_mapping, fis_organisation_mapping, gnd_person_mapping, gnd_organisation_mapping, ror_mapping, zdb_mapping, unpaywall_mapping, orcid_person_mapping, object_type',
+        'searchFields'             => 'name, display_name, max_iteration, mandatory, data_type, validation, mapping, mods_extension, json_mapping, input_field, deposit_license, max_input_length, input_option_list, fill_out_service, gnd_field_uid, default_value, access_restriction_roles, consent, embargo, fis_person_mapping, fis_organisation_mapping, gnd_person_mapping, gnd_organisation_mapping, ror_mapping, zdb_mapping, unpaywall_mapping, orcid_person_mapping, help_text, object_type',
         'iconfile'                 => 'EXT:dpf/Resources/Public/Icons/default.gif',
     ),
     'interface' => array(
-        'showRecordFieldList' => 'sys_language_uid, l10n_parent, l10n_diffsource, hidden, name, display_name, max_iteration, mandatory, data_type, validation, mapping, mods_extension, json_mapping, input_field, deposit_license, max_input_length, input_option_list, fill_out_service, gnd_field_uid, default_value, access_restriction_roles, consent, embargo, fis_person_mapping, fis_organisation_mapping, gnd_person_mapping, gnd_organisation_mapping, ror_mapping, zdb_mapping, unpaywall_mapping, orcid_person_mapping, object_type',
+        'showRecordFieldList' => 'sys_language_uid, l10n_parent, l10n_diffsource, hidden, name, display_name, max_iteration, mandatory, data_type, validation, mapping, mods_extension, json_mapping, input_field, deposit_license, max_input_length, input_option_list, fill_out_service, gnd_field_uid, default_value, access_restriction_roles, consent, embargo, fis_person_mapping, fis_organisation_mapping, gnd_person_mapping, gnd_organisation_mapping, ror_mapping, zdb_mapping, unpaywall_mapping, orcid_person_mapping, help_text, object_type',
     ),
     'types'     => array(
-        '1' => array('showitem' => 'sys_language_uid, l10n_parent, l10n_diffsource, hidden, --palette--;;1, name, display_name, max_iteration, mandatory, data_type, validation, mapping, mods_extension, json_mapping, input_field, deposit_license, max_input_length, input_option_list, fill_out_service, gnd_field_uid, default_value, access_restriction_roles, consent, embargo, fis_person_mapping, fis_organisation_mapping, gnd_person_mapping, gnd_organisation_mapping, ror_mapping, zdb_mapping, unpaywall_mapping, orcid_person_mapping, object_type, --div--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:tabs.access, starttime, endtime'),
+        '1' => array('showitem' => 'sys_language_uid, l10n_parent, l10n_diffsource, hidden, --palette--;;1, name, display_name, max_iteration, mandatory, data_type, validation, mapping, mods_extension, json_mapping, input_field, deposit_license, max_input_length, input_option_list, fill_out_service, gnd_field_uid, default_value, access_restriction_roles, consent, embargo, fis_person_mapping, fis_organisation_mapping, gnd_person_mapping, gnd_organisation_mapping, ror_mapping, zdb_mapping, unpaywall_mapping, orcid_person_mapping, help_text, object_type, --div--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:tabs.access, starttime, endtime'),
     ),
     'palettes'  => array(
         '1' => array('showitem' => ''),
@@ -467,5 +467,16 @@
                 ],
             ],
         ],
+        'help_text'                => array(
+            'exclude' => 1,
+            'label'   => 'LLL:EXT:dpf/Resources/Private/Language/locallang_db.xlf:tx_dpf_domain_model_metadataobject.help_text',
+            'config'  => array(
+                'type' => 'text',
+                'cols' => 40,
+                'rows' => 15,
+                'eval' => 'trim',
+                'enableRichtext' => true,
+            ),
+        ),
     ),
 );
diff --git a/Resources/Private/Language/de.locallang_csh_tx_dpf_domain_model_metadataobject.xlf b/Resources/Private/Language/de.locallang_csh_tx_dpf_domain_model_metadataobject.xlf
@@ -25,6 +25,10 @@
 			<source>Display name</source>
 			<target>Anzeigename</target>
 		</trans-unit>
+		<trans-unit id="help_text.description">
+			<source>Help text</source>
+			<target>Hilfe-Text</target>
+		</trans-unit>
 		<trans-unit id="fill_out_service.description" approved="yes">
 			<source>Fillout service</source>
 			<target>Fillout Service</target>
@@ -79,4 +83,4 @@
 		</trans-unit>
 		</body>
 	</file>
-</xliff>
+</xliff>
diff --git a/Resources/Private/Language/de.locallang_db.xlf b/Resources/Private/Language/de.locallang_db.xlf
@@ -745,6 +745,10 @@
 			<source>Display Name</source>
 			<target>Anzeigename</target>
 		</trans-unit>
+		<trans-unit id="tx_dpf_domain_model_metadataobject.help_text" approved="yes">
+			<source>Help text</source>
+			<target>Hilfe-Text</target>
+		</trans-unit>
 		<trans-unit id="tx_dpf_domain_model_metadataobject.embargo" approved="yes">
 			<source>Embargo</source>
 			<target>Embargo</target>

diff --git a/Resources/Private/Language/locallang_csh_tx_dpf_domain_model_metadataobject.xlf b/Resources/Private/Language/locallang_csh_tx_dpf_domain_model_metadataobject.xlf
@@ -20,6 +20,9 @@
 		<trans-unit id="display_name.description">
 			<source>Display name</source>
 		</trans-unit>
+		<trans-unit id="help_text.description">
+			<source>Help text</source>
+		</trans-unit>
 		<trans-unit id="fill_out_service.description">
 			<source>Fillout service</source>
 		</trans-unit>
@@ -61,4 +64,4 @@
 		</trans-unit>
 		</body>
 	</file>
-</xliff>
+</xliff>
diff --git a/Resources/Private/Language/locallang_db.xlf b/Resources/Private/Language/locallang_db.xlf
@@ -557,6 +557,9 @@
 		<trans-unit id="tx_dpf_domain_model_metadataobject.display_name">
 			<source>Display Name</source>
 		</trans-unit>
+		<trans-unit id="tx_dpf_domain_model_metadataobject.help_text">
+			<source>Help text</source>
+		</trans-unit>
 		<trans-unit id="tx_dpf_domain_model_metadataobject.embargo">
 			<source>Embargo</source>
 		</trans-unit>

diff --git a/Resources/Private/Partials/DocumentForm/Field.html b/Resources/Private/Partials/DocumentForm/Field.html
@@ -28,8 +28,26 @@
     </div>
 </f:if>
 
+<f:if condition="{fieldItem.helpTextLong}">
+    <div class="collapse" id="collapse{formPageUid}-{formGroupUid}-{groupIndex}-{fieldItem.uid}-{fieldIndex}">
+        <div class="alert alert-primary" role="alert">
+            <a class="close" href="#collapse{formPageUid}-{formGroupUid}-{groupIndex}-{fieldItem.uid}-{fieldIndex}" data-toggle="collapse" aria-label="Close">
+                <span aria-hidden="true">&times;</span>
+            </a>
+            <f:format.raw>{fieldItem.helpTextLong}</f:format.raw>
+        </div>
+    </div>
+</f:if>
+
 <div class="form-group">
     <label for="inp_{fieldItem.uid}" data-index="{fieldIndex}" data-field="{fieldItem.uid}">{fieldItem.displayName}
+        <f:if condition="{fieldItem.helpTextShort}">
+            <a data-toggle="collapse" href="#collapse{formPageUid}-{formGroupUid}-{groupIndex}-{fieldItem.uid}-{fieldIndex}">
+                <span data-toggle="tooltip" title="" data-original-title="{fieldItem.helpTextShort}">
+                    <i class="fas fa-question-circle"></i>
+                </span>
+            </a>
+        </f:if>
         <f:if condition="{fieldItem.mandatory}">
             <span class="mandatory" data-index="{fieldIndex}" data-field="{fieldItem.uid}">*</span>
         </f:if>

diff --git a/Resources/Public/CSS/kitodopublication.css b/Resources/Public/CSS/kitodopublication.css
@@ -479,6 +479,10 @@ ul.error-files-backbutton li {
     margin: 0;
 }
 
+.alert p:last-child {
+    margin-bottom: 0;
+}
+
     /* -- search form--------------------------------------------------- */
 
 #tx-dpf-backoffice.document-manager .searchForm .form-group {
@@ -536,4 +540,4 @@ ul.error-files-backbutton li {
     padding: 0px 0px 0px 3px;
   }
 }
-/* EOF */
+/* EOF */
diff --git a/ext_tables.sql b/ext_tables.sql
@@ -210,6 +210,7 @@ CREATE TABLE tx_dpf_domain_model_metadataobject (
   input_option_list int(11) unsigned default '0',
   default_value text NOT NULL,
   fill_out_service varchar(255) DEFAULT '' NOT NULL,
+  help_text text NOT NULL,
   backend_only tinyint(1) unsigned DEFAULT '0' NOT NULL,
   access_restriction_roles varchar(255) DEFAULT '' NOT NULL,
   consent tinyint(1) unsigned DEFAULT '0' NOT NULL,