MidCOM component directory structure

1. Component base directory
2. Component directory structure

MidCOM components obey a strict namespacing. Each component must reside in the directory based on this name, and contain a specified set of subdirectories.

Component base directory

Components are located under the MidCOM lib directory. The name of each component consists of three parts:

• Toplevel domain of the developing organization (e.g. fi, org)
• Actual domain of the organization (e.g. nemein, linkm)
• Component name (e.g. rss, newsticker)

Each of these three parts is a level in the directory structure. So if we're developing a component named net.nemein.rss, we will use lib/net/nemein/rss as its base directory.

Component directory structure

Everything supplied with the component is stored under the base directory. The directory structure is the following:

• Base directory
  • This is where the request handler, navigation and administration classes are located
  • config
    • This is where the component manifest, and possible configuration and schema files are located
  • documentation
    • This is where the change log and online documentation is located
  • handler
    • This is where the handler classes are located
  • locale
    • This is where the localization system places the translation files
  • midcom
    • This is where the interface class is located
  • static
    • This is where the possible files and images are located in SVN. They are copied under PEAR web_dir when installing
  • style
    • This is where the possible style templates are located