Skip to main content
Version: 7.0

Object: Edit documentation

The module provides several possibilities to add or change the documentation of objects. All methods of modification can be applied the text and XML documentation. The new text is read from a file.

Designation​

Name
mc.DocumentationEdit
Aliases
ObjectDocumentationEdit, mc.DocuEdit

Configuration​

Test mode (test-mode)
Activates a simulation mode
Type (type)
Defines the documentation typeMögliche Werte: Text (text), XML (xml)
Text (docu)
Name of the file wiht the text to add
XML attributes (xml-attributes)
Reads the text file as a list of attribute definitions. Such a file contains lines like <attribute>=<value>
Text node (text-node)
defines the name of the text docu tab
XML node (xml-node)
If the XML documentation is edited, than the XMl node must be specified as a path. Such a path must start with /<docu tab>/Content. The key <docu tab> is to be replaced by the name of the tab of the structured documentation. Elements of such a path may contain indexes in square brackets as known from XPath definitions (/Details/Content/Test[3]/b4A[2]/Docu).
Create XML node (create-node)
If the XML node does not exist it will be created
Mode (mode)
Defines the mode of operation meaning how to add the text or to show the documentationMögliche Werte: prepend (prepend), append (append), overwrite (overwrite), before (before), after (after), replace (replace)
Pattern (pattern)
A regular expression used as the anchor for the modes 'Before pattern', 'After pattern' and 'Replace pattern'

Description​

The module supports the following modes for editing documentation.

  • Replace pattern: The new text is inserted in place of a defined text line
  • After the pattern: The new text is inserted after a defined line of text
  • Before the pattern: The new text is inserted before a defined line of text
  • Append: The new text is appended to existing documentation
  • Insert before: The new text is inserted before the existing documentation
  • Overwrite: The new text replaces the existing documentation

b4A expressions can be used both in the specified text and in the attributes. For the attributes, this applies to both the names and the values. The following b4A expression attributes are available:

  • object_name
  • object_type
  • object_title
  • object_folder
  • ae_system
  • ae_client
  • b4a_connection