'Description' Editor (Project)

This help topic describes the 'Description' editor of the 'Project' PLANT node. This editor can be used for documentation purposes and maintaining a project version history. Several editor areas are available which are described below.

Further Info
Details and information how to use this editor can be found in the topic "Description for Projects, POUs, and Symbols".

This topic contains the following sections:

'Version'

The version history allows you to track the updates being made to the element. Use this editor to enter version information such as the version number, life cycle, author etc.

Column Description

Version Displays the version number that identifies the project version.
The version number is mandatory when you add a new version row to the table.
When you enter a version number into an empty cell and confirm the value by pressing <Enter> or the <Tab> key, the 'Date' and 'Life Cycle' columns are automatically filled and a new empty table row is added.

Date Indicates the date the project version has been created.
The date is automatically filled with the current date (when you enter a version number in the 'Version' column) and can be changed manually.

Life Cycle The cell provides a list of predefined life cycle states that can be selected from the drop-down list. Use this parameter to specify the stage of the development of the element.
The life cycle is automatically set to '-Undefined-' when you enter a version number in the 'Version' column.

Author Indicates which author has added the project version.

Comment Comment about the project version.

Column	Description
Version	Displays the version number that identifies the project version. The version number is mandatory when you add a new version row to the table. When you enter a version number into an empty cell and confirm the value by pressing <Enter> or the <Tab> key, the 'Date' and 'Life Cycle' columns are automatically filled and a new empty table row is added.
Date	Indicates the date the project version has been created. The date is automatically filled with the current date (when you enter a version number in the 'Version' column) and can be changed manually.
Life Cycle	The cell provides a list of predefined life cycle states that can be selected from the drop-down list. Use this parameter to specify the stage of the development of the element. The life cycle is automatically set to '-Undefined-' when you enter a version number in the 'Version' column.
Author	Indicates which author has added the project version.
Comment	Comment about the project version.

'User Metadata'

Tabular editor where you can enter key-value pairs which are included in the metadata file (.json format) that is part of the Device and Update Management (DaUM) package (see the topic "Exporting Data as DAuM Package" for details).

You can specify up to ten custom tags (key-value pairs) for the metadata file. The key-value pairs act as metadata used for organizing and structuring the data.

Column Description

Key User-defined key string with a maximum length of 90 characters.

Value User-defined value string with a maximum length of 90 characters.

Column	Description
Key	User-defined key string with a maximum length of 90 characters.
Value	User-defined value string with a maximum length of 90 characters.

'Documentation'

This editor allows you to enter information on the project, POU, or symbol, using either the Rich Text Format editor or the HTML editor and create HTML5 help files for function/function block POUs.

Field Description

Identifier, Title You can enter any information about the project, for example, a project number and the project name.

Description The content of the project description. Here you can use either the Rich Text Format editor or the HTML editor to edit the description.
Which editor is used by default when creating a new project is set in the 'Extras > Options' dialog under the 'Tool | Description' category.

Note
The support of RTF is deprecated and will be removed in a future version of PnE. We recommend to use HTML5 only.

For each editor there is its own toolbar which provides various commands to edit the content.

Toolbar of the HTML5 description editor

Icon Meaning

Imports contents from an HTML file at the current text cursor position.

Exports the contents (text, images, etc.) to an HTML file.
If you have assigned a CSS file when exporting the contents using the HTML editor, the CSS file is also exported.

Toggles the editor between edit mode (button pressed) and WYSIWYG mode which shows how the content will display.

Imports a help template folder which allows you to use your own help template files and CSS file for documentation purposes.

Language selection list Selects a language for description (provides all user interface languages supported by PLCnext Engineer).
The description can be provided in the languages that are supported by PLCnext Engineer (the list of available user interface languages is shown in the 'Extras > Options' dialog under the 'International > International Settings' category). Depending on the active user interface language, the language-specific POU description is displayed when calling the help for the FU/FB POU in PLCnext Engineer.

Icon	Meaning
	Imports contents from an HTML file at the current text cursor position.
	Exports the contents (text, images, etc.) to an HTML file. If you have assigned a CSS file when exporting the contents using the HTML editor, the CSS file is also exported.
	Toggles the editor between edit mode (button pressed) and WYSIWYG mode which shows how the content will display.
	Imports a help template folder which allows you to use your own help template files and CSS file for documentation purposes.
Language selection list	Selects a language for description (provides all user interface languages supported by PLCnext Engineer). The description can be provided in the languages that are supported by PLCnext Engineer (the list of available user interface languages is shown in the 'Extras > Options' dialog under the 'International > International Settings' category). Depending on the active user interface language, the language-specific POU description is displayed when calling the help for the FU/FB POU in PLCnext Engineer.

Toolbar of the RTF description editor

The RTF editor provides typical text formatting options including font, font size, weight, font color, alignment etc.

Further Info
Details and information how to use this editor can be found in the topic "Description for Projects and POUs".