From 7a16bab7eb55a03da9044007f43f49f48000a2c7 Mon Sep 17 00:00:00 2001 From: Marc Date: Wed, 6 Apr 2016 00:00:40 +0100 Subject: [PATCH] Add information about structure --- creating_modules.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/creating_modules.md b/creating_modules.md index 7f68812..2952351 100644 --- a/creating_modules.md +++ b/creating_modules.md @@ -9,8 +9,20 @@ Modules use HTML, AngularJS and PHP to make requests and retrieve a response. Th ##Anatomy of a basic module A basic module will request information through AngularJS to PHP, and then the PHP will provide a response to AngularJS, where it will then be displayed on the HTML page for the user to see. + ``` +-------------------+ +--------------+ +-----------+ +------+ | AngularJS Request | --> | PHP Response | --> | AngularJS | --> | HTML | +-------------------+ +--------------+ +-----------+ +------+ ``` + +A module will contain at least four files required to function. A `module.html` that contains the HTML for the module, A `module.info` that contains the name, description, version and author of the module in JSON format, a `module.js` file inside of the `js/` folder that contains the AngularJS, and finally a `module.php` file inside of the `php/` folder. It is structured like this: +``` +. +├── js +│   └── module.js +├── module.html +├── module.info +└── php + └── module.php +```