Objekt: Dokumentation bearbeiten

Das Modul bietet verschiedene Möglichkeiten die Dokumentation von Objekten zu ergänzen bzw. zu verändern. Alle unterstützten Varianten werden sowohl für die Text- als auch die XML-Dokumentation unterstützt. Der neue Text wird aus einer Datei gelesen.

Bezeichnung

Name

mc.DocumentationEdit

Aliase

ObjectDocumentationEdit, mc.DocuEdit

Konfiguration

Gruppe: Optionen

Test-Modus (test-mode)

Aktiviert einen Simulationsmodus

Typ (type)

Definiert den Typ der Dokumentation

Mögliche Werte: Text (text), XML (xml)

Text (docu)

Name der Datei mit dem hinzuzufügenden Text

XML-Attribute (xml-attributes)

Liest die Textdatei als eine Liste von Attributdefinitionen. Solch eine Datei enthält Zeilen der Form <Attribut>=<Wert>

Textknoten (text-node)

Definiert den Namen des Reiters der Textdokumentation

XML-Element (xml-node)

Wird die XML-Dokumentation bearbeitet, dann muss das XML-Element als Pad angegeben werden. Basis solch eines Pfades ist immer /<Doku-Reiter>/Content. Dabei ist <Doku-Reiter> durch den Namen des Reiters der strukturierten Dokumentation zu ersetzen. In der Angabe können Element-Indizes in eckigen Klammern angeben werden wie es bei XPath möglich ist (/Details/Content/Test[3]/b4A[2]/Docu).

Erstelle XML-Element (create-node)

Wenn das XML-Element nicht existiert wird es erstellt

Modus (mode)

Definiert den Modus für die Operation wie der Text hinzugefügt werden soll bzw. das dieser angezeigt werden soll

Mögliche Werte: Vorne einfügen (prepend), Anhängen (append), Überschreiben (overwrite), Vor dem Muster (before), Hinter dem Muster (after), Ersetze Muster (replace)

Muster (pattern)

Ein regulärer Ausdruck, der als Anker für die Modi ‚Vor dem Muster‘, ‚Hinter dem Muster‘ and ‚Ersetze Muster‘

../../_images/mc-documentationedit-options.png

Beschreibung

Von dem Modul werden die folgenden Modi zum Bearbeiten der Dokumentation unterstützt.

  • Ersetze Muster: Der neue Text wird anstelle einer definierten Textzeile eingefügt

  • Hinter dem Muster: Der neue Text wird hinter einer definierten Textzeile eingefügt

  • Vor dem Muster: Der neue Text wird vor einer definierten Textzeile eingefügt

  • Anhängen: Der neue Text wird an vorhandene Dokumentation angehängt

  • Vorne einfügen: Der neue Text wird vor der vorhandenen Dokumentation eingefügt

  • Überschreiben: Der neue Text ersetzt die vorhandene Dokumentation

Sowohl in dem angegebenen Text als auch in den Attributen können b4A Expressions genutzt werden. Bei den Attributen gilt dies für die Namen als auch für die Werte. Dabei stehen die folgenden b4A Expression Attribute zur Verfügung:

  • object_name

  • object_type

  • object_title

  • object_folder

  • ae_system

  • ae_client

  • b4a_connection