Documentation Topics

The documentation folder of a project can contain the following topics:

  • Title page

  • Contents

  • General information

  • Configuration

  • Derived Data Types

  • Derived FB Types

  • EFB types

  • EF types

  • FB variables and instances

  • Application structure

  • Functional project

  • Communication

  • Programs

  • Animation table

  • Operator screen

  • Cross-References

  • Footer

NOTE: Using the menu commands Edit > Include heading and Edit > Exclude heading you can define the topics you want to use in your documentation.

Title Page

This topic deals with printing the title page.

Topic contents:

  • Name of the project

  • Name of the designer

  • Software version

  • Creation date

  • Date of last change

  • Target PLC

NOTE: In the Title Page area of Printout Setup dialog box you can define the name of the project and the designer. All other details are automatically generated.

Contents

The contents page is generated automatically according to the topics selected.

When a topic is selected, its corresponding number of pages appears in the contents. If the topic contains documentation but is not selected, No print job is displayed instead of the number of pages.

The total number of pages is displayed at the end of the contents.

General Information

This topic deals with printing user content entered in Documentation > General Information tab of the project browser.

This information can be comments on the project, hyper-links and/or bitmaps.

Configuration

This topic deals with printing the hardware configuration.

Topic contents:

  • Bus topology

  • Bus parameters (except for the X bus)

  • PLC and rack configuration

  • Parameterization of the input/output modules and the communication modules.

Derived Data Types

This topic deals with printing the derived datatypes for the project.

Topic contents:

  • Names of the data structure and their elements

  • Data structure types (for example, structure, array) and element datatypes

  • Data structure comments

Derived FB Types

This topic deals with printing the DFBs used in the project.

Every DFB has a structure which contains the section of the DFB.

Topic contents:

  • Topic Derived FB types

    • Table of all DFBs used in the project and their properties (name, version, creation / change date)

  • Topic "DFB name"

    • Type name

    • Version

    • Short description of how the DFB work (if available)

    • Properties of the inputs, outputs, in/outputs and public variables (name, data type, initial value and comment)

  • Topic Sections

    • Name of the section and the DFB

    • Section comment

    • Type of protection

    • Assigned functional module

    • Name of the condition for conditional call

    • Section code (except for the diagnostics DFBs provided by Schneider).

      Details on the section documentation can be found in the topic Programs.

EFB (Types)

This topic deals with printing the Elementary Function Block types used in the project.

Topic contents:

  • Table of all EFBs used in the project and their properties (name, version, creation / change date)

  • For every EFB type

    • Type name

    • Version

    • Short description of the how the EFB works

    • Properties of the inputs, outputs, in/outputs and public variables (name, data type, initial value and comment)

FB (types)

This topic deals with printing the Elementary Function types (FBs) used in the project.

Topic contents:

  • Table of all FBs used in the project and their properties (name, version, creation / change date)

  • For every FB type

    • Type name

    • Properties of the inputs, outputs, in/outputs and public variables (name, data type, initial value and comment)

Variables & FB instances

This topic deals with printing the following objects in a tabular format:

  • Elementary datatypes (EDTs)

  • Derived Data Types (DDTs)

  • I/O derived data types (IODDTs)

  • Instances of elementary functions

  • Instances of elementary functions blocks

  • Instances of derived functions blocks

Topic contents:

  • Symbolic name (variable name or FB instance name)

  • Constants (only for variables)

  • Address (only for variables)

  • Initial value

  • Number of connections

  • Global file (only for elementary datatypes and FB instances)

  • Which attributes, for example, alias of, diag and so on (only if defined)

NOTE: In the Variables & FB-Instances area of Printout Setup dialog box you can define the attributes printed for the variables and FB instances.

Application Structure

This topic deals with printing the project structure.

Topic contents:

  • List of the Program Units and/or program sections:

    • Release conditions

    • Comments

    • Module

    • Language type

  • Sub-programs and macro steps calling tree

Depending on the view selected the documentation is shown in the Structural View or the Functional View . If the Functional View is chosen the section documentation is sorted according to the assigned functional module. The documentation of sections not assigned to any functional module is shown in its own table.

Functional Project

This topic is only available in the Functional View and is used to print the sections assigned to a functional module.

Sections not assigned to documentation are not documented under the topic Programs .

Communication

This topic deals with printing the networks communication parameters.

Programs

This topic deals with printing the program elements.

Topic contents:

  • MAST task

    • Properties (for example, configuration, configuration task duration, watchdog time) in the MAST task.

    • Program Units of the MAST task ( Interface & Variables, sections)

    • Sections of the MAST task

    • Subroutine section of the MAST task

  • FAST task

    • Properties (for example, configuration, configuration task duration, watchdog time) in the FAST task.

    • Program Units of the FAST task ( Interface & Variables, sections)

    • Sections of the FAST task

    • Subroutine section of the FAST task

  • AUX0 and AUX1 tasks when available

  • Events

    • Sections of the Timer Events tasks

    • Sections of the I/O event tasks

The contents of the section documentation depend on their programming languages.

All sections:

  • Name of the sections and the assigned tasks

  • Section comment

  • Type of protection

  • Assigned functional module

  • Name of the condition for conditional call

  • Section code

FBD sections:

  • Component tables with Execution by attribute.

    Blocks that have an Execute by reference to another block appear in a table that shows the instance names and the position of the referenced and referencing blocks.

LD sections:

  • Table for all of the object names not fully shown.

    Because of the fixed column width it can happen that variable names or block types are not shown fully. The incomplete object names appear in a table that shows the full object names and their position(s).

  • Using the checkbox Mixed Display Mode in the Printout Setup dialog, you can define whether the documentation in the LD section is displayed in Input mode or in mixed display mode.

SFC sections:

  • Tables for the step / action properties:

    • Step name

    • Position of the step object

    • Minimum and maximum supervision time

    • Delay Time

    • Step comment

    • Identifiers for the action(s)

    • Time literal / variable for the identifier (if required)

    • Action name

  • Transition properties table:

    • Name of transition

    • Type of transition condition

    • Position of the transition object

    • Comment

  • Jump properties table:

    • Target step name

    • Position of the jump object

    • Comment

Animation Tables

This topic deals with printing the animation tables.

Topic contents:

  • Name of the animation table

  • Comment

  • Functional module

  • Name of the object (for example, variable name, EFB/DFB/DDT instance name, address)

  • Type

  • Comment

Operator Screen

This topic deals with printing the operator screens.

This heading is used to print the properties of the operator screens, their graphic representations and the lists of messages associated with each screen.

Topic contents:

  • Message lists

  • Operator screen

    • Properties

    • Graphical representation

    • List of the animated variables

NOTE: In the Operator Screens area of Printout Setup dialog box you can define the scope and display of the documentation and the variables and FB instances.

Cross-References

This topic deals with printing the cross-references for the application and the DFBs used.

Every cross-reference can contain the following tables:

  • Addresses

  • FB variables and instances

  • FB objects

  • Subroutine

Every table contains the following attributes:

  • Name of the object

  • Location of the reference (for example, section name, module name)

  • Position used (for example, line and column in the section, type of module)

User Objects

This topic deals with printing the properties of the hyperlinks and the user directories.

Contents of the topic Hyperlinks :

  • Nodes containing hyperlinks (for example, station\animation tables)

  • Comment

  • Target path

Contents of the topic User directories :

  • Nodes containing hyperlinks (for example, station\animation tables)

  • Comment

Footer

This topic deals with printing the footer.

Topic contents:

  • Bitmap (logo)

  • Author

  • Dept.

  • Target PLC

  • Page title

  • Two spare fields

  • The date of printing

  • Page number

NOTE: The target PLC, the page title, the printing date and the page number are automatically generated. In the Footer area of the Printout Setup dialog box you can define other attributes.