Name of your plugin

Note

Add a high-level description of the intended use-case and functionality of your plugin in this paragraph

Installation

Note

Describe, how to install your plugin and what are the installation requirements, e.g. if a specific ALLPLAN version is required. You can use the description below as a boilerplate

The Plugin Example plugin can be installed directly from the Plugin Manager in ALLPLAN.

Alternatively, the corresponding .allep package can be downloaded from the [release page](url of the release). *.allep* files are ALLPLAN extension packages that can be installed via drag and drop into the program window.

Requirements

• ALLPLAN >=2026

Installed Assets

Note

What your plugin includes. Note, that this is the only possibility for the user to figure out what your .allep package delivers. The plugin manager won't tell, what was installed, but only where (Office or Private library)

The plugin installs following assets into ALLPLAN:

• PythonParts

  • Example Name
  • ...

  They can be found under Office/Private/Project → Developer_Name → (Subfolder) → Example Name.
  They are also added to the ActionBar in a new created task area Task_area_name on the Plug-ins tab.

• VisualScripting nodes

  • Example node
  • ...

  They can be found in the Visual Editor under Custom Library → STD/USR → Developer_Name → (Subfolder) → Example Name

• Reports

  • Report 1
  • ...

  They can be found in std\Reports\eng\...

Preparation

Note

Add a description of prerequisites that must be done before your plugin can be used. You can skip this section, if there is nothing to do in advance.

Workflow

Note

Describe, how to use the tools you deliver. Provide the user with remarks, he should keep in mind.

The plugin is executed in ALLPLAN from the Library. In general, all PythonParts can be stated either with a double-click on the entry or per drag & drop. This shows the corresponding Properties palette and executes the skript.