Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-01-11 20:38:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Minor corrections

Browse Source
This commit is contained in:
Dennis Eichhorn 2016-07-05 16:36:21 +02:00
parent 2084dcf99c
commit aabef68bdb
3 changed files with 4 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,17 +1,5 @@
# Introduction
This developer guides intention is to provide useful information
for developers to help you to understand the structure of the
application, important classes, workflows and standards for
code quality as well as code style. The intention is to provide
enough information to get a basic understanding of these
key elements for module developers, frontend developers or
developers working on the core application.
This developer guides intention is to provide useful information for developers to help you to understand the structure of the application, important classes, workflows and standards for code quality as well as code style. The intention is to provide enough information to get a basic understanding of these key elements for module developers, frontend developers or developers working on the core application.
The guide is **not** explaining in detail how to use classes,
for this you can find the automatically generated code
documentation. All the provided information are very important
to ensure the quality of the published code and often are mandatory.
Not following these guides can cause security issues, worsen the
user experience or even cause malfunction as well as make it
difficult for other developers to understand the code.
The guide is **not** explaining in detail how to use classes, for this you can find the automatically generated code documentation. All the provided information are very important to ensure the quality of the published code and often are mandatory. Not following these guides can cause security issues, worsen the user experience or even cause malfunction as well as make it difficult for other developers to understand the code.

2
caching,_sessions,_local_storage_&_cookies.md
View File

@ -19,7 +19,7 @@ In order to trigger a re-cache of stylesheets or javascript files make sure to u
Example usage:
```
$head->addAsset(AssetType::JS, $request->getUri()->getBase() . 'Modules/Media/ModuleMedia.js?v=' . self::MODULE_VERSION);
$head->addAsset(AssetType::JS, $request->getUri()->getBase() . 'Modules/Media/Controller.js?v=' . self::MODULE_VERSION);
```
## Sessions

3
modules.md
View File

@ -28,14 +28,13 @@ The following directory structure should roughly visualize how modules are struc
* yourTemplateImages.jpg
* Lang
* en.lang.php
* navigation.en.lang.php
* Navigation.en.lang.php
* your_template_files.tpl.php
* Views
* YourPhpViews.php
* YourJavaScriptViews.js
* Controller.php
* Controller.js
* Module{UniqueModuleName}.js
* info.json
All modules are located inside the `/Modules` directory and their directory name has to be the module name itself without whitespaces.