Introduction

Introduction About ModuleStudio ModuleStudio (MOST) is a development environment for quick, simple and efficient creation of extensions for the Zikula Application Framework. Based on principles of …

Installation

Installation Simply download the archive for your operating system and extract it inside your home directory. You can also choose any other directory, but your user needs to have write access to it. …

Getting started

Getting started This chapter explains the first steps required for starting creating applications with ModuleStudio. Create your first application in 10 minutes This chapter shows how easy it is to …

User interface

User interface This section shows how to use ModuleStudio. Starting with a general demonstration of the user interface it goes step by step through all UI functions and explains their purpose. Note …

Diagram editor

Diagram editor The diagram editor represents a model in a graphical way and offers several convenience functions to aid in the modelling process. This chapter gives an overview of all the main …

Views

Views This chapter explains the available views and shows their functions in detail. Dashboard view The dashboard view is just a control panel providing you quick links to some commonly used …

Textual editor

Textual editor ModuleStudio also includes a textual syntax notation. The textual editor can be used in two different ways: Included in the diagram editor: see this section. Standalone: to use the …

Preferences

Preferences In the preferences section you can adjust several base settings of ModuleStudio. This chapters explains what these settings do. AutoSave Here you can enable automatic save for the editors. …

Validation

Validation This chapter explains the intention behind validation in ModuleStudio. Introduction Validation is an essential part of a modelling language. By checking the current model against several …

Generating applications

Generating applications The main use case for ModuleStudio application models is the creation of Zikula extensions. This section describes how the generator works. Basic idea Every application …

Customisation and maintenance

Customisation and maintenance This section gives a few hints for changing arbitrary things in your generated applications while keeping in sync with upcoming releases of Zikula and ModuleStudio. How …

Keyboard shortcuts

Keyboard shortcuts Keyboard shortcuts in all editors F1 - Open the help system. Ctrl + E - Display a filterable list of open editors to get direct access to an editor. Ctrl + Shift + E - Display the …

Validation reference

Validation Reference The biggest part is a reference section listing all validation rules in detail and explains the motivation behind them. You can use this reference to search for certain error …

Generator reference

Generator reference This reference goes through all available model elements as well as their properties, describing what the generator does with this information and which things are still missing in …

Web resources

Web resources This chapter collects links to several manuals and further documentation you will find useful when customising generated applications. ModuleStudio You can find further information on …

How to contribute

How to contribute This chapter shows how you can help improving ModuleStudio. Report problems If you think you found a bug please add an issue for it in our tracker: Generator and tooling Fix …

Changelog

Changelog ModuleStudio 1.5.0 (unreleased) Product / Tooling changes Updated to Eclipse 2023-12 (4.30). Updated included Java version from 14.0.1 to 17.0.6 Fixed problem preventing embedded textual …

Glossary

Glossary A-C Abstract syntax - Technology independent part of a domain-specific language, represented by meta models. AC-MDSD - Architecture-Centric MDSD: a specialisation of MDSD, often used for the …