Documentation link - Manual - Library Toolbox - Library toolbox - Library toolbox,extension

Library Toolbox Extension
Portfolio
SIMATIC AX
Product
Library Toolbox
Software version
0.20.2
Edition
10/2024
Language
English (original)
Package Name
@ax-vscode/siemens.library-toolbox

Note

This feature is currently provided as a preview. Features and workflows may change; compatibility with future versions is not guaranteed.

If you want to use this extension, you have to enable the "Enable Non Productive Extensions" setting in the Extension Manager.

To provide direct access to more information about a type or function, Markdown documentation can be added to the Apax package.

Adding the following ST pragma to the declaration:

{axcode:docs-v0:<library-package-name>:<path-to-md-file>}

The provided path-to-md-file is expected to be relative from the directory docs.

will enable a link being displayed in the hover.

image

Example

NAMESPACE library
    TYPE
        {axcode:docs-v0:library:types/example.md}
        Example : STRUCT
            Member : INT;
        END_STRUCT;
    END_TYPE
END_NAMESPACE

Project structure

/library-project
    +-apax.yml
    +-/docs
    |   +-/types
    |   |   +-example.md
    +-/src
    |   +-example.st

apax.yml

name: "library"
version: 0.0.1
type: lib