Extended – reStructuredText

TE1030 | TwinCAT 3 Documentation Generation To improve presentation and gain a larger range of functions in documentation, we recommend using the TE1030 | TwinCAT 3 Documentation Generation tool.

Limited support of reStructuredText as of TwinCAT 3.1 Build 4026 The reStructuredText documentation format is available as an alternative to TE1030 | TwinCAT 3 Documentation Generation. Please note that support of this functionality is limited from Build 4026 and is described below.

Up to and including Build 4024:

• Creation of libraries with reStructuredText documentation as source code (*.library) or compiled library (*.compiled-library)
• Display of the reStructuredText documentation of source code (*.library) or compiled libraries (*.compiled-library)

Build 4026 up to and including version 4026.15:

• No reStructuredText support

Build 4026 from version 4026.16:

• Display of the reStructuredText documentation from compiled libraries (*.compiled-library)
  (Information: After migration from 4024 to 4026, libraries with reStructuredText documentation must be reinstalled in order for the documentation to be displayed correctly).
• To create the *.compiled-library with reStructuredText documentation, use a Remote Manager version with Build 4024.

For a more attractive display of library object documentation in the Library Manager, you can select the documentation format reStructuredText in the project properties of the library (PLC Project Properties > category Common).

reStructuredText is an easy-to-read markup language that uses simple constructs to identify the structure of a document and special text elements such as section headings, bulleted lists and highlighting. More explicit constructs are used to include graphics and notes or to assign a function to text elements (hyperlinks).

Text elements that you mark in the comment above the declaration line of a library object according to the syntax of reStructuredText are structured and formatted in the Documentation tab of the Library Manager during library creation and optionally assigned a function.

The comment above the declaration line of the following objects is interpreted:

• POU objects (program, function block, function)
• Interfaces
• Methods, properties
• Global variable lists, parameter lists
• DUT objects (enumeration, structure, union, alias)

See also:

• Library creation
• Library Manager

• Overview
• Samples
• Syntax elements
• Comment structure
• Text blocks
• Lists
• Tables
• Hyperlinks
• Substitution
• Note elements
• Images
• Codeblock
• Internal comments
• Font style