Markdown

Einführung

In NocoBase wird Markdown (Markdown) zum Speichern von Inhalten im Markdown-Format verwendet.

Markdown-Felder eignen sich für Dokumentationen, Lösungsbeschreibungen, Wissensdatenbankinhalte, Änderungsprotokolle und ähnliche Inhalte. Gespeichert wird Text, der bei der Anzeige auf der Seite als Markdown gerendert wird.

Wenn Sie eine WYSIWYG-Bearbeitung bevorzugen, können Sie Rich Text oder Markdown Vditor auswählen.

Geeignete Einsatzszenarien

Markdown eignet sich für folgende Geschäftsszenarien:

  • Inhalte von Wissensdatenbanken und Dokumentationen
  • Lösungsbeschreibungen und Fehlerbehebungsprotokolle
  • Versionshinweise und Änderungsprotokolle
  • Lange Textinhalte, die eine leichte Formatierung erfordern

Konfiguration erstellen

Klicken Sie auf der Seite „Configure fields“ einer Datentabelle auf „Add field“ und wählen Sie „Markdown“, um ein Markdown-Feld zu erstellen.

20240512181311

KonfigurationBeschreibung
Field interfaceOberflächentyp des Feldes. Markdown entspricht markdown und legt fest, wie das Feld auf der Seite eingegeben und angezeigt wird.
Field display nameDer in der Benutzeroberfläche angezeigte Name des Feldes, z. B. „Dokumentation“, „Lösungsbeschreibung“ oder „Inhalt“. Es wird empfohlen, einen für die zuständigen Benutzer unmittelbar verständlichen Namen zu verwenden.
Field nameBezeichner des Feldes für interne Verweise in APIs, Beziehungsfeldern, Berechtigungen, Workflows usw. Nach der Erstellung wird er in der Regel nicht mehr geändert. Er darf nur Buchstaben, Zahlen und Unterstriche enthalten und muss mit einem Buchstaben beginnen.
Field typeDatentyp des Feldes auf Datenebene. Markdown-Felder verwenden zum Speichern der Inhalte normalerweise text.
Default valueStandardwert. Wenn beim Anlegen eines Datensatzes kein Wert eingegeben wird, kann dieser automatisch übernommen werden.
Validation rulesValidierungsregeln. Sie können die Länge begrenzen oder die Eingabe als Pflichtfeld festlegen.
DescriptionBeschreibung des Feldes. Hier können die Bedeutung des Feldes, Anforderungen an die Eingabe, die Datenquelle oder die verantwortliche Person angegeben werden.
Hinweis

Der Feldname wird von Seitenblöcken, Berechtigungen, Workflows und APIs referenziert. Prüfen Sie die Benennung vor der Erstellung sorgfältig, um spätere Anpassungen an der Konfiguration zu vermeiden.

Feldeigenschaften

Das Standardverhalten von Markdown-Feldern ist wie folgt:

EigenschaftBeschreibung
Standardmäßiges Field interfacemarkdown.
Standardmäßiger Field typetext.
Optionale Field typestext und string, abhängig von der tatsächlichen Feldkonfiguration.
SeitenkomponenteIm Bearbeitungsmodus wird eine Markdown-Editor-Komponente verwendet.
FilterungTextbasierte Filter werden unterstützt, z. B. „enthält“, „ist leer“ und „ist nicht leer“.
SortierungWird normalerweise nicht zur Sortierung verwendet.
ValidierungTextvalidierungen wie Längenprüfung und Pflichtfeld werden unterstützt.

Konfiguration bearbeiten

Nach der Erstellung können Sie rechts neben dem Feld auf „Edit“ klicken, um die Konfiguration des Markdown-Feldes zu bearbeiten. Die Bearbeitung eines Feldes dient hauptsächlich dazu, dessen Anzeige und Verwendung in NocoBase anzupassen, beispielsweise den Anzeigenamen, die Beschreibung, den Standardwert, die Validierungsregeln oder feldspezifische Einstellungen zu ändern.

Wenn das Feld aus einer bereits synchronisierten Tabelle der Hauptdatenbank stammt, handelt es sich bei der Bearbeitung in der Regel um eine Feldzuordnung – das Datenbankfeld wird einem Field type und einem Field interface in NocoBase zugeordnet.

KonfigurationBearbeitbarBeschreibung
Field display nameJaÄndert den in der Benutzeroberfläche angezeigten Namen des Feldes, nicht jedoch dessen Bezeichner.
Field nameNeinDer Feldbezeichner kann nach der Erstellung normalerweise nicht im Bearbeitungsformular geändert werden.
Field interfaceBedingtBei Feldern aus der Hauptdatenbank oder synchronisierten Feldern kann der Wert im Rahmen der Feldzuordnung angepasst werden. Dies wirkt sich auf die Eingabe, Anzeige und Validierung auf der Seite aus.
Field typeBedingtBei Feldern aus der Hauptdatenbank oder synchronisierten Feldern kann der Wert im Rahmen der Feldzuordnung angepasst werden. Vor der Anpassung muss geprüft werden, ob die vorhandenen Daten mit dem neuen Typ verwendet werden können.
Default valueJaPasst den Standardwert für neu angelegte Datensätze an.
Validation rulesJaPasst die Validierungsregeln des Feldes an.
DescriptionJaErgänzt die Bedeutung des Feldes, Anforderungen an die Eingabe, die Datenquelle oder die verantwortliche Person.
Hinweis

Das Wechseln von Field type oder Field interface ist nicht mit einer einfachen Änderung des Anzeigenamens gleichzusetzen. Es wirkt sich auf die Speicherart des Feldes, die Eingabekomponente, die Validierungsregeln, die Filterbedingungen und die Verwendung von Workflow-Variablen aus. Bei einer großen Menge vorhandener Daten sollte zunächst geprüft werden, ob das Datenformat kompatibel ist.

Feld löschen

Klicken Sie rechts neben dem Feld auf „Delete“, um das Markdown-Feld zu löschen. In der Hauptdatenbank können Sie außerdem mehrere Felder auswählen und anschließend gesammelt löschen.

Beim Löschen eines in der Hauptdatenbank neu erstellten Markdown-Feldes werden normalerweise auch die entsprechende physische Spalte in der Datenbank und die darin vorhandenen Daten gelöscht. Beim Löschen eines Feldes, das aus einer Datenbanksynchronisierung oder einer Zuordnung aus einer externen Datenquelle stammt, hängt der Umfang der Auswirkungen von der jeweiligen Datenquelle und der Herkunft des Feldes ab.

Warnung

Das Löschen eines Feldes kann sich auf Seitenblöcke, Formulare, Filter, Berechtigungen, Workflows, APIs, Importe und Exporte sowie vorhandene Daten auswirken. Prüfen Sie vor dem Löschen, ob das Feld noch von Geschäftskonfigurationen referenziert wird.

Verwendung in der Seitenkonfiguration

Markdown-Felder eignen sich für die Bearbeitung von Inhalten und die Anzeige in Detailansichten. 20260709230801

SzenarioVerwendung
FormularblockMarkdown-Inhalte bearbeiten.
DetailblockAls Markdown gerendert anzeigen.
TabellenblockZusammenfassende Inhalte anzeigen.
WorkflowDen Inhalt als Benachrichtigung oder als Inhalt für die Dokumentgenerierung verwenden.
  • Felder — Erfahren Sie mehr über Zweck, Kategorien und Zuordnungslogik von Feldern
  • Standardtabelle — Felder in einer Standardtabelle erstellen und verwalten
  • Markdown Vditor — Markdown mit Vditor bearbeiten
  • Rich Text — Inhalte mit dem Rich-Text-Editor bearbeiten
  • Mehrzeiliger Text — Lange reine Textinhalte speichern