Project Layout

This Wiki page outlines how the Plugin is constructed and what does what.

It has been initially produced as part of Issue #87, but is a living document and is intended to keep up-to-date with changes to the project structure. As such, it is only intended to provide a high-level overview; more detailed documentation can be found in the automatically-generated documentation here.

1. Repo. Root
2. Plugin Source directory (src/)
   1. Plugin classes sub-directory (src/class/)
      1. Plugin Dashboard sub-directory (src/class/dashboard/)
      2. Plugin Widgets sub-directory (src/class/widgets/)
   2. Plugin stylesheets sub-directory (src/css/)
   3. Plugin images sub-directory (src/img/)
   4. Plugin scripts sub-directory (src/js/)
   5. Plugin translations sub-directory (src/languages/)
   6. Plugin templates sub-directory (src/templates/)