documenting a directory in the tag (original) (raw)
– documenting a directory in the tag
Documenting directories
The <dir> tag describes a directory in the package sources. A <dir> tag may contain other<dir> tags as well as tags.
All files must be contained in a single top-level tag. For simple packages, simply use as the directory name.
Attributes
Required attributes
| Attribute name | Description |
|---|---|
| name | Name of the directory in the sources |
Optional attributes
| Attribute name | Description |
|---|---|
| baseinstalldir | Relative location where all files and subdirectories will be installed |
Examples
An excerpt of the <contents> tag of a real package.xml:
The baseinstalldir attribute is mostly used when the directory structure in the package source tree does not match the layout when installed (e.g. when the QuickForm/ directory needs to be installed asHTML/QuickForm/: