1 Project Layout

Rumperuu edited this page 2021-04-29 18:30:48 +01:00

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/)

Table of Contents

1. Home
2. Project Layout
   1. Repo. Root
   2. Plugin Source Directory
      1. Plugin Classes Directory
         1. Plugin Dashboard Directory
         2. Plugin Widgets Directory
   3. Plugin Stylesheets Directory
   4. Plugin Images Directory
   5. Plugin Scripts Directory
   6. Plugin Translations Directory
   7. Plugin Templates Directory
3. Git Tips
4. Versioning
5. SVN Release Guide

Appendices

1. Custom Template Stack
2. Customised Documentation Schema