Documentation (PDF and CHM) 

The documentation of the library must be saved as a *.pdf file in the *.zip folder and uploaded to the PLCnext Store. Ideally, you should also create this documentation as a *.chm or *.html file.

For examples of how the documentation can be structured, go to the PLCnext Store and open a Phoenix Contact library documentation of any library. Please create the documentation as in these examples. 

Note: If you want a documentation template, you can get one on GitHub.

The documentation template offers the following benefits:

  • Focus on documentation content.
  • Coverage of all information relevant to library users.
  • Consistent content in HTML and PDF output.
  • Predefined formatting and layout.

To achieve this, the template provides Markdown template files, a ready-to-use batch script, and predefined stylesheets.

The following points must at least be included:

Cover with the following information:

  • Name and version of the library
  • Revision of the documentation
  • Release date

Table of content

Description of the library (purpose, intended use, benefits)

A change notes table with one row for each library version:

Library version Library build date Tested PLCnext Engineer version Changes to the previous version
2 yyyy-mm-dd 2021.0 LTS

New: 

  • FB_Name_1
  • FB_Name_2

Bugfix:

  • ...
1 yyyy-mm-dd 2020.0 LTS Converted from PC Worx 6

 

Supported PLCnext Engineer versions

Minimum required version: 
Maximum supported version: 

Supported PLCs and firmware

Supported PLCs Firmware
Product category Item designation Item no. 
Controller AXC F 2152 2404267 2025.0.x
2026.0.x LTS
Safety controller RFC 4072S 1051328 2025.0.x

 

Installation hint

Please copy the library data to the working library directory of PLCnext Engineer.

Overview of the functionblocks, ideally structured in tables:

Function block Description Version Supported products
FB_Name Lorem ipsum dolor sit amet, consetetur sadipscing elitr, … 1 Communication module
AXL SE RS232
(item no. 1181787)

 

For each POE (FB or FC):

  • Functional description of the POE
  • Screenshot of the POE in FBD (functionblock diagram)
  • Three tables (input parameters, output parameters, inout parameters) with the description for each connection: Name, type, description
    Name Type Description
    xActivate BOOL Rising edge: Activates the function block.
    FALSE: Deactivates the function block.
  • One table with all diagnostic codes of this POE: Diagnostic code, additional diagnostic code (if applicable), description
    wDiagCode wAddDiagCode Description
    16#0000 16#0000 Function block is deactivated.
    16#8000 16#0000 Function block is in regular operation.

 

Documentation of used system variables:

  • Name
  • Type
  • Description

Documentation of user relevant structures:

  • Name
  • Type
  • Description

A startup example:

  • Description of the startup example
  • If applicable, then the necessary hardware and start-up parameters
  • Explanation of different POE states or functionalities:
    • Description
    • Screenshots of the POE connections with activated online values

Third party licenses

  • "This software makes use of third party packages with different licenses. The software packages and the licenses are listed in this chapter."
  • List of all licenses with a reference to where the licenses can be found.

Contact information (e.g. email address) for support

 

 

Go back to Overview.

 

 

• Published/reviewed: 2026-09-25 • Revision 27 •