Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- manual:setup [2023/08/01 09:40] – [Datensatztypen definieren] jwesenberg
+++ manual:setup [2025/05/21 14:27] (aktuell) – [Installation] * GitLab-Wiki-Link sklemm
@@ Zeile 3: / Zeile 3: @@
 ===== Installation =====
-Die Einrichtung des Servers und Installation der Software ist im internen [[https://gitlab-zit.senckenberg.org/sklemm/florawebplus/-/wikis/Installation|GitLab-Wiki]] bzw. der README beschrieben.
+Die Einrichtung des Servers und Installation der Software ist im internen [[https://gitlab.senckenberg.de/florawebplus/sebotacoms/-/wikis/Installation|GitLab-Wiki]] bzw. der README beschrieben.
 :!: Wird im Browser die Startseite des frisch installierten CMS aufgerufen, erscheint eine Fehlermeldung bezüglich eines fehlenden Moduls. Dies ist beabsichtigt und resultiert daraus, dass bisher keinerlei Konfiguration im Backend des CMS erfolgt ist!
@@ Zeile 31: / Zeile 31: @@
   * Menüpunkt **//Konfiguration//** --> **//Datensatztypen//**
   * Button **[Neuer Listeneintrag]**
-  * bei //__Wert__// einen systemweit eindeutigen Bezeichner eingeben, //__Attribut__// ''code'' wählen
-  * Button **[Neuer Einzelwert]**
   * bei //__Wert__// einen beschreibenden deutschen Namen eingeben, //__Attribut__// ''name_de'' wählen
+  * sollen weitere Attribute vergeben werden dann Button **[Neuer Einzelwert]**
+  * :todo: z. B. bei //__Wert__// einen systemweit eindeutigen Bezeichner eingeben, //__Attribut__// ''code'' wählen
   * ggf. die letzten beiden Schritte für weitere Sprachen wiederholen
@@ Zeile 44: / Zeile 44: @@
   * Menüpunkt **//Konfiguration//** --> **//Gliederungspunkte//**
   * Button **[Neuer Listeneintrag]**
-  * einen beschreibenden deutschen Namen eingeben, Attribut ''name_de'' wählen --> Speichern
+  * bei //__Wert__// einen beschreibenden deutschen Namen eingeben, //__Attribut__// ''name_de'' wählen --> Speichern
   * wenn dem Listeneintrag weitere Attribute (z.B. Namen in anderen Sprachen, Beschreibungen, Konfigurationseinstellungen etc.) zugewiesen werden sollen, dann werden neue Einzelwerte hinzugefügt
   * nachfolgendes Beispiel für Konfiguration, dass Gliederungspunkt im Frontend standardmäßig ausgeklappt erscheinen soll (wird keine Konfigurationseinstellung vorgenommen ist der Gliederungspunkt eingeklappt):
      * Button **[Neuer Einzelwert]**
-     * Attribut ''config'' auswählen
+     * //__Attribut__// ''config'' auswählen
-     * unter Wert ''{"show_collapsed":true}''eingeben (Anm. Die Einträge für Konfigurationseinstellungen müssen einen definierten JSON-Format entsprechen --> nur von sehr fortgeschrittenen Nutzern vorzunehmen)
+     * unter //__Wert__// ''{"show_collapsed":true}''eingeben (Anm. Die Einträge für Konfigurationseinstellungen müssen einen definierten JSON-Format entsprechen --> nur von sehr fortgeschrittenen Nutzern vorzunehmen)
      * Speichern
   * ggf. die letzten Schritte für Hinzufügen weiterer Attribute wiederholen
@@ Zeile 57: / Zeile 57: @@
   * Menüpunkt **//Konfiguration//** --> **//Anzeigefelder-Namen//**
   * Button **[Neuer Listeneintrag]**
-  * einen beschreibenden deutschen Namen eingeben, Attribut ''name_de'' wählen --> Speichern
+  * bei //__Wert__// einen beschreibenden deutschen Namen eingeben, //__Attribut__// ''name_de'' wählen --> Speichern
   * wenn dem Listeneintrag weitere Attribute (z.B. Namen in anderen Sprachen, Beschreibungen, Konfigurationseinstellungen etc.) zugewiesen werden sollen, dann werden neue Einzelwerte hinzugefügt
   * nachfolgendes Beispiel für Hinzufügen einer Beschreibung des Feldes:
      * Button **[Neuer Einzelwert]**
-     * Attribut ''description_de'' auswählen
+     * //__Attribut__// ''description_de'' auswählen
-     * unter Wert eine Beschreibung eingeben
+     * unter //__Wert__// eine Beschreibung eingeben
      * Speichern
   * ggf. die letzten Schritte für Hinzufügen weiterer Attribute wiederholen
+==== Bedeutung der Attribute ====
+  * //__name_xy__// -> Der obligatorische Name des Elementes (in diesem Fall des Anzeigefeldes) in der definierten Sprache ''xy''. Dieser wird im Frontend und Backend einheitlich verwendet und sollte möglichst kurz und prägnant sein.
+  * //__description_xy__// -> Ein längerer Beschreibungstext (der Sprache ''xy''), der den Inhalt des Anzeigefeldes näher beschreibt und als Hilfetext bei Eingabe-/Bearbeitungsformularen von Datensätzen im Backend angezeigt wird.
+  * //__placeholder_xy__// -> Ein optionaler Platzhaltertext (der Sprache ''xy''), der in Eingabefeldern bei Eingabe-/Bearbeitungsformularen von Datensätzen im Backend angezeigt wird.
+  * //__tooltip_xy__// -> Ein optionaler Beschreibungstext (der Sprache ''xy''), der mit einem runden "i"-Icon hinter dem Namen des Anzeigefeldes im Frontend und Backend symbolisiert wird. Wird der Mauszeiger über dem Icon platziert (auch "Hoover" oder "Mouse over" genannt), so erscheint der Text schwebend neben dem Mauszeiger als sogenannter "Tooltip".
+  * //__config__// -> Weitere Konfigurationsoptionen, die nur für Datensatztypen und Gliederungspunkte benötigt werden. Diese müssen derzeit noch von Hand im **[[wpde>JSON|JSON]]**-Format angegeben werden. Eine Liste der möglichen Optionen ist im [[https://gitlab.senckenberg.de/florawebplus/sebotacoms/-/wikis/Configuration#data-related-config|GitLab-Wiki]] zu finden.
+{{:manual:backend-elemente_beschriftet_bunt.png?direct|}}
+==== Import der Namen inkl. Attribute ====
+Wenn viele Anzeigefelder verwendet werden sollen, lohnt es sich, die Namen der Anzeigefelder in Form einer Tabelle im **[[wpde>CSV_(Dateiformat)|CSV]]**-Format zu importieren. Diese kann mit LibreOffice Calc, MS Excel oder einem beliebigen Texteditor erstellt werden und muss unbedingt mit der Zeichencodierung **[[wpde>UTF-8|UTF-8]]** gespeichert werden.
+Jede Spalte der Importtabelle entspricht dabei einem zu importierenden Attribut und sollte in der ersten Zeile den Namen des Attributs enthalten, um eine halb-automatische Zuordnung zu ermöglichen. Jede Zeile entspricht einem Anzeigefeld-Namen.
+  * Menüpunkt **//Konfiguration//** --> **//Anzeigefelder-Namen//**
+  * Button **[Importieren]**
+Der Import-Vorgang ist in einem folgenden [[manual:import#auswahllisten|Kapitel]] beschrieben.
+Auch die oben beschriebenen Gliederungspunkte und Datensatztypen können bei Bedarf nach dem gleichen Schema importiert werden.
 ===== Anzeigefelder definieren =====
@@ Zeile 72: / Zeile 95: @@
   * Button **[Neues Anzeigefeld]**
-Der //Name// des Anzeigefeldes sollte kurz sein und bestimmt die Benennung in der Frontend-Anzeige der Datensätze. Es kann aus vorhandenen, vorher definierten Einträgen ([[manual:setup#Namen der Anzeigefelder definieren|Anzeigefelder-Namen]]) ausgewählt oder ein neuer Name vergeben werden. Wird in der Auswahlliste ''---Neu---'' ausgewählt, erscheint eine neues Feld in dem der neu zu vergebende Name eingegeben wird. Dieser erscheint dann auch unter **//Anzeigefelder-Namen//**.
+Der //__Name__// des Anzeigefeldes sollte kurz sein und bestimmt die Benennung in der Frontend-Anzeige der Datensätze. Es kann aus vorhandenen, vorher definierten Einträgen ([[manual:setup#Namen der Anzeigefelder definieren|Anzeigefelder-Namen]]) ausgewählt oder ein neuer Name vergeben werden. Wird in der Auswahlliste ''---Neu---'' ausgewählt, erscheint eine neues Feld in dem der neu zu vergebende Name eingegeben wird. Dieser erscheint dann auch unter **//Anzeigefelder-Namen//**.
-Auswählbar sind immer nur die Namen in der Sprache, die aktuell unter dem Menüpunkt **//Sprache//** ausgewählt ist, d.h. wenn Deutsch ausgewählt ist, stehen nur die Anzeigefeld-Namen zur Auswahl, denen das Attribut ''name_de'' zugeordnet ist. Neu angelegte Namen werden dementsprechend automatisch ebenfalls mit dem der aktuellen Sprache zugeordneten Attribut versehen.
+Auswählbar sind immer nur die Namen in der Sprache, die aktuell unter dem Menüpunkt **//Sprache//** ausgewählt ist, d.h. wenn "Deutsch" ausgewählt ist, stehen nur die Anzeigefeld-Namen zur Auswahl, denen das //__Attribut__// ''name_de'' zugeordnet ist. Neu angelegte Namen werden dementsprechend automatisch ebenfalls mit dem der aktuellen Sprache zugeordneten Attribut versehen.
-Die //Beschreibung// ist prinzipiell frei verwendbar und wird ausschließlich im Backend für bessere Unterscheidbarkeit und genauerer Beschreibung verwendet. Sie sollte idealerweise den Namen des [[manual:glossar#datensatztyp|Datensatztyp]], Namen des [[manual:glossar#gliederungspunkt|Gliederungspunktes]] und den Namen des Anzeigefeldes enthalten: z.B: ''Artdatensatz -> Fundortdaten -> Naturraum''
+Die //__Beschreibung__// ist prinzipiell frei verwendbar und wird ausschließlich im Backend für bessere Unterscheidbarkeit und genauerer Beschreibung verwendet. Sie sollte idealerweise den Namen des [[manual:glossar#datensatztyp|Datensatztyp]], Namen des [[manual:glossar#gliederungspunkt|Gliederungspunktes]] und den Namen des Anzeigefeldes enthalten: z.B: ''Artdatensatz -> Fundortdaten -> Naturraum''
 Wird bei der Definition des Anzeigefeldes auch die //[[manual:glossar#feldzuordnung|Feldzuordnung]]// angelegt (siehe unten), wird das Feld automatisch nach dem oben empfohlenen Schema ''Datensatztyp -> Name des Gliederungspunktes -> Name des Anzeigefeldes'' ausgefüllt.
 Zwingend ist die Auswahl des //[[manual:glossar#datentyp|Datentyp]]//s. Dieser legt fest, welchen Inhalt das Anzeigefeld enthalten und darstellen kann. Dies bestimmt ganz wesentlich die Struktur der zu verwaltenden Datensätze.
-:!: Achten Sie auf die Auswahl des richten Datentyps.
+:!: Achten Sie auf die Auswahl des richtigen Datentyps.
-:!: Es empfiehlt sich, während des Anlegens eines Anzeigefeldes auch die //[[manual:glossar#feldzuordnung|Feldzuordnung]]// anzulegen. Dazu wird der Haken der Checkbox //Eine neue Zuordnung für dieses Anzeigefeld anlegen// gesetzt. Daraufhin wird das Eingabeformular um mehrere Felder erweitert:
+:!: Es empfiehlt sich, während des Anlegens eines Anzeigefeldes auch die //[[manual:glossar#feldzuordnung|Feldzuordnung]]// anzulegen. Dazu wird der Haken der Checkbox //__Eine neue Zuordnung für dieses Anzeigefeld anlegen__// gesetzt. Daraufhin wird das Eingabeformular um mehrere Felder erweitert:
   * Über die ersten beiden Felder wird ausgewählt, welchem der vorher angelegten Datensatztypen und Gliederungspunkte das jeweilige Anzeigefeld zugeordnet werden soll.
-  * Zudem kann bei //Verwendung bei Taxon// definiert werden ob das Anzeigefeld nur bei bestimmten Taxa verwendet werden soll (setzt voraus, dass bereits eine Taxliste vorhanden ist, aus der der einzutragende Wert ausgewählt werden kann).
+  * Zudem kann bei //__Verwendung bei Taxon__// definiert werden ob das Anzeigefeld nur bei bestimmten Taxa verwendet werden soll (setzt voraus, dass bereits eine Taxliste vorhanden ist, aus der der einzutragende Wert ausgewählt werden kann).
-  * Unter //Öffentliche Sichtbarkeit// ist wählbar, ob das Anzeigefeld im Frontend erschienen soll.
+  * Unter //__Öffentliche Sichtbarkeit__// ist wählbar, ob das Anzeigefeld im Frontend erschienen soll.
   * Die beiden letzten Felder erstmal nicht ausfüllen.
@@ Zeile 109: / Zeile 132: @@
   * im sich öffnenden Formular sieht man links, die bereits zugeordneten Anzeigefelder, rechts die noch  nicht zugeordneten
   * im rechten Fenster, die Anzeigefelder auswählen (Mehrfachauswahl mit Taste STRG (oder CTRL)), die die gleichen Zuordnungseinstellungen erhalten werden
-  * darüber den Datensatztyp auswählen, dem die Anzeigefelder zugeordnet werden
+  * darüber den //__Datensatztyp__// auswählen, dem die Anzeigefelder zugeordnet werden
   * darunter die restlichen Einstellungen vornehmen:
-    * //Gliederungspunkt// -> Gliederungspunkt auswählen, dem Anzeigefeld zugeordnet werden soll
+    * //__Gliederungspunkt__// -> Gliederungspunkt auswählen, dem Anzeigefeld zugeordnet werden soll
-    * //Verwendung bei Taxon// -> Einstellung ob das Anzeigefeld nur bei bestimmten Taxa verwendet werden soll (setzt voraus, dass bereits eine Taxliste vorhanden ist, aus der der einzutragende Wert ausgewählt werden kann).
+    * //__Verwendung bei Taxon__// -> Einstellung ob das Anzeigefeld nur bei bestimmten Taxa verwendet werden soll (setzt voraus, dass bereits eine Taxliste vorhanden ist, aus der der einzutragende Wert ausgewählt werden kann).
-    * //Öffentliche Sichtbarkeit// -> Auswahl, ob das Anzeigefeld im Frontend erschienen soll
+    * //__Öffentliche Sichtbarkeit__// -> Auswahl, ob das Anzeigefeld im Frontend erschienen soll
   * die letzten Schritte wiederholen, bis alle Anzeigefelder zugeordnet sind.
@@ Zeile 122: / Zeile 145: @@
   * unter "Anzeigefeld" das Feld auswählen, dessen Feldzuordnung definiert werden soll
   * in den weiteren Felder die Einstellungen vornehmen:
-    * //Datensatztyp// -> Datensatztyp auswählen, dem Anzeigefeld zugeordnet werden soll
+    * //__Datensatztyp__// -> Datensatztyp auswählen, dem Anzeigefeld zugeordnet werden soll
-    * //Gliederungspunkt// -> Gliederungspunkt auswählen, dem Anzeigefeld zugeordnet werden soll
+    * //__Gliederungspunkt__// -> Gliederungspunkt auswählen, dem Anzeigefeld zugeordnet werden soll
-    * //Verwendung bei Taxon// -> Einstellung ob das Anzeigefeld nur bei bestimmten Taxa verwendet werden soll (setzt voraus, dass bereits eine Taxliste vorhanden ist, aus der der einzutragende Wert ausgewählt werden kann).
+    * //__Verwendung bei Taxon__// -> Einstellung ob das Anzeigefeld nur bei bestimmten Taxa verwendet werden soll (setzt voraus, dass bereits eine Taxliste vorhanden ist, aus der der einzutragende Wert ausgewählt werden kann).
-    * //Öffentliche Sichtbarkeit// -> Auswahl, ob das Anzeigefeld im Frontend erschienen soll
+    * //__Öffentliche Sichtbarkeit__// -> Auswahl, ob das Anzeigefeld im Frontend erschienen soll
   * Die beiden letzten Felder erstmal nicht ausfüllen.
-Über die einzelne, manuelle Definition der Feldzuordnungen können für jedes Anzeigefelder auch weitere Feldzuordnungen definiert werden (:!:ein Anzeigefeld kann mehrere verschiedenen Feldzuordnungen haben, z.B. wenn es nicht bei allen Taxa, aber bei verschiedenen Gattungen verwendet wird -> dann sind für das betreffende Anzeigefeld so viele Feldzuordnungen anzulegen, wie es Gattungen gibt bei denen das Feld verwendet wird. Die Konfigurationen unterscheiden sich dann jeweils hinsichtlich der //Verwendung bei Taxon//).
+Über die einzelne, manuelle Definition der Feldzuordnungen können für jedes Anzeigefelder auch weitere Feldzuordnungen definiert werden (:!:ein Anzeigefeld kann mehrere verschiedenen Feldzuordnungen haben, z.B. wenn es nicht bei allen Taxa, aber bei verschiedenen Gattungen verwendet wird -> dann sind für das betreffende Anzeigefeld so viele Feldzuordnungen anzulegen, wie es Gattungen gibt bei denen das Feld verwendet wird. Die Konfigurationen unterscheiden sich dann jeweils hinsichtlich der //__Verwendung bei Taxon__//).
 === Anzeigereihenfolge der Anzeigefelder definieren/ändern===