Note
This glossary is still a work in progress. We intend to provide improved explanations and additional topics in future versions of CODESYS. If you think an important term is missing, please send us an email.
The Application Composer is a development tool for efficient creation of application variants that consist of recurring function blocks. End users "compose" machine applications based on modules and their parameterization. CODESYS then automatically generates the complete PLC program.
(We intend to provide an improved explanation in future versions of CODESYS.)
Controller Development System (see the CODESYS homepage)
The CODESYS Store is a great way to distribute your library to a large audience of CODESYS users.
see: Common Libraries
Compatibility of two libraries usually means that they react in the same way according to the requirements of an application. An interface library is backwards compatible if CODESYS does not require an online change after updating the application with the newer library.
An interface library is not backwards compatible if the newer version...
... changes the init value of constants,
... changes the signature of INTERFACE types (method, property),
... changes the init value of ENUM members,
... changes the sequence or type of STRUCT members,
... adds or removes a library reference to or from library manager,
... changes the compiler version, or
adds data types or operators (for example, __XWORD, __UXINT, __XINT,...) which are not defined by the current compiler version setting of the library.
see: Container Libraries
This term is used for a file produced by the export command of the CODESYS LibDoc Scripting Collection. The file format follows the JSON specification and provides all the necessary information for automatically generating documentation of the related CODESYS library.
see: Export Process
This describes the workflow which is necessary for creating full documentation in various formats from a CODESYS library and the comments that are embedded in the library.
(We intend to provide an improved explanation in future versions of CODESYS.)
see: End-User Libraries
see: Export Process
A frame object is a collection of directories and reST files that represent the structure and content of a CODESYS library, as well as a complete Sphinx project. Each folder or chapter inside of the frame object is a representation of a specific content object of the CODESYS library (POU, DUT, folder, and so on). The frame object is generated by the Export command of the CODESYS LibDoc Scripting Collection and may be modified and extended by technical writers for providing additional information or tutorial-style content.
see: Generation Process
see: Interface Libraries
This is the extensive, textbook-style description. Here you will find the CODESYS Guidelines for Library Development. This document has not been released yet. We are making every effort to publish it as soon as possible.
(We intend to provide an improved explanation in future versions of CODESYS.)
(We intend to provide an improved explanation in future versions of CODESYS.)
We collect all registered library prefixes in a database and use Python script to generate source files for the Sphinx documentation generator. The result is the file LibraryRegistry.chm, which is included in every CODESYS distribution.
(We intend to provide an improved explanation in future versions of CODESYS.)
see: Merge Process
(We intend to provide an improved explanation in future versions of CODESYS.)
A library that ignores some optional rules can still receive approval for publication in the CODESYS Store.
(We intend to provide an improved explanation in future versions of CODESYS.)
see: Package Designer
(We intend to provide an improved explanation in future versions of CODESYS.)
see Placeholder
(We intend to provide an improved explanation in future versions of CODESYS.)
(We intend to provide an improved explanation in future versions of CODESYS.)
(We intend to provide an improved explanation in future versions of CODESYS.)
(We intend to provide an improved explanation in future versions of CODESYS.)
(We intend to provide an improved explanation in future versions of CODESYS.)
A better choice of words for this term is Optional
A library that ignores one required rule may not receive approval for publication in the CODESYS Store.
see: reStructuredText
The term "reStructuredText" (abbreviated reST) refers a file format for textual data that is used primarily for technical documentation.
In this sense, "reStructuredText" is a lightweight markup language designed for
easy readability by human programmers who read and write source code,
easy readability by technical writers who read and write documentation, and
processability by documentation-processing software, such as Docutils.
Please refer to original documentation.
The source object is very similar to the Frame object with the exception that it is generated by the merge command, not the export command. Therefore, this command merges the current contents of the CODESYS library, which come from the content object with the structure of the frame object, which may be modified by technical writers.
This tool is a documentation generator that is based on Python. It translates a set of reStructuredText formated files into various output formats, such as CHM (see: Tool installation) or HTML. Sphinx can produce cross-references, indices, etc. automatically. Please refer to original documentation of Sphinx or read this Tutorial.
