2.2. The Package.def File

2.2. The `Package.def` File
	Chapter 2. Package Components

2.2. The `Package.def` File

The file Package.def is part of every package. It defines the position of the package in the PackageGroup.

A typical example (excerpt from the MeVisLab/Standard/Package.def):

Package {
  packageGroup = MeVisLab
  packageName  = Standard

  owner        = "MeVis Medical Solutions"
  description  = "Standard MeVisLab Modules"
}

	Note
	In principle, the package structure is defined by `Package.def`. However, the implementation of the package handling expects that all packages are below their PackageGroup.

In the following, all possible tags are listed.

packageGroup (string): The name of the package group. Must not contain spaces.
packageName (string): The name of the package. Must not contain spaces.
owner (string): The name of the owner of the package.
description (string): A text that describes this package.
defaultModuleGroup (string): Sets the default name of the module group to which modules of this package are added.
The name of the module group appears in the list of Module Groups of MeVisLab's preferences dialog, and the visibility of modules in that module group can be adjusted there.
By default, modules of new and unknown module groups are 'invisible', meaning that their full name with the correct capitalization must be entered in MeVisLab's quick search bar to instantiate them.
Reserved special values include "hidden", "example", and "deprecated".
A module group defined in a module’s specific .def file overrides this setting.
allowSaveOfInternalNetworks (enum string): Sets whether a 'live' internal network of a macro module can be saved.
- allow: Saving the internal network is allowed.
- warn: Saving the internal network is allowed, but a requester is shown when saving.
- refuse: Saving the internal network is not allowed. This is the default for new user-defined packages.
mayDependOn (string): A space-separated list of other package names that this package may depend on. A .def file can contain multiple instances of this tag.
If the internal network of a macro module in this package contains at least one module from another user package that this package may not depend on, a warning is printed to MeVisLab's debug console when such a macro module is instantiated.
If this tag is not set at all, macro modules in this package may depend on modules from any other package.
If you indeed want to declare that the package should not have dependencies to any other package, you may declare the package itself as its own dependency.
testsAndExamplesMayAlsoDependOn (string): Same as mayDependOn, but applies to automated tests and example networks.
projectsSearchDepth (int): Sets the depth for searching module definition files in projects directories in this package. A lower search depth speeds up the MeVisLab startup process, while a greater search depth allows for deeper directory nesting.
By default, the search depth is 3.
showHelpOnIndexPage (bool): Sets whether the help files of this package should be listed on the help index page.
By default, this is set to true.