add pseudo de help doc

This commit is contained in:
Dennis Eichhorn 2020-06-25 19:41:45 +02:00
parent 63fa783599
commit 3cba67e898
6 changed files with 87 additions and 0 deletions

3
Docs/Dev/de/SUMMARY.md Normal file
View File

@ -0,0 +1,3 @@
# Developer Content
* [Templates]({%}&page=Dev/api_template)

View File

@ -0,0 +1,2 @@
# Template API

4
Docs/Help/de/SUMMARY.md Normal file
View File

@ -0,0 +1,4 @@
# User Content
* [Templates]({%}&page=Help/templates)
* [Reports]({%}&page=Help/reports)

View File

@ -0,0 +1,31 @@
# Introduction
The **Helper** module is a very powerful module which allows users to create custom tools/helpers and make them available to other users. A very common use case is to create custom reports which can be based on the Orange-Management database but also on data from other databases. Other examples could be a helper to generate recurring mailings based on data stored in the database or small applications for storing and managing data.
## Target Group
The target group for this module is every organization which would like to create customized helper & reports while still integrating and managing them through the Orange-Management application. The implementation of such helpers requires programming knowledge in PHP and potentially JavaScript.
# Setup
This module doesn't have any additional setup requirements since it is installed during the application install process.
# Features
## Permission Management
It's possible to only give selected users and groups access to certain helper.
## Input handling
The custom helper can be created in a way which allows UI interaction by the user and it's also possible to allow helper to handle uploaded user data. E.g. a tool could create different reports based on the date defined by the user.
In some cases it's not possible to directly access data from within the application for such purposes it's possible to create helper which take additional data as uploads and use/transform this data according to the in the tool defined specifications. This way the same tool can be used in re-curring situation to create different results based on the different data without re-writing or re-uploading the tool every time. E.g. a tool could create reports based on uploaded data in excel or csv format.
## Localization
The module allows users to create helper which also support localization.
## Default UI styles
Users can make use of the default styles in order to create tools which fit visually into the application design for a better user experience.

5
Docs/Help/de/reports.md Normal file
View File

@ -0,0 +1,5 @@
# Reports
Reports provide data for templates most often used when a template otherwise would require a lot of user data in order create the desired output.
All specified file names in the template are valid uploads. Other files will be ignored.

42
Docs/Help/de/templates.md Normal file
View File

@ -0,0 +1,42 @@
# Templates
Templates are the basis for every helper. They can be defined in such a way that they don't need additional uploaded by using already available data stored in database, the web etc. or in such a way which requires user uploaded data whenever it should create a new output.
## File types
When creating a template the following file endings have special meaning:
* \*.tpl.php - This is the user interface the user sees when he opens a helper
* \*.lang.php - This is the language file which can be used for different localizations
* The * needs to be replaced with 2 character language codes such as `en` for english
* Export
* \*.pdf.php - This allows the user to create a pdf export (e.g. for reports)
* \*.xls.php - This allows the user to create a excel export (e.g. for reports or data analysis)
* \*.doc.php - This allows the user to create a word export (e.g. for reports or mailings)
* \*.ppt.php - This allows the user to create a powerpoint export (e.g. for reports)
* \*.json.php - This allows the user to create a json export
* \*.csv.php - This allows the user to create a csv export
* \*.css - This can be used in order to define helper specific designs which can be used in the `*.tpl.php`
* \*.js - This can be used in order to define helper specific frontend interactions which can be used in the `*.tpl.php`
Other file endings can be used as well but they don't have a special meaning for the template.
## Standalone
By defining a helper `standalone` no additional user upload is required after the creation of a new helper. This is often useful if the helper is using global data stored in databases. If the template is not `standalone` the user needs to upload additional data whenever he wants to create a new output. This is helpful whenever large amounts of user input is required and therefore makes more sense to be provided as file uploads.
## Media
When creating a new template it's also possible to use already uploaded media files. This allows users to re-use existing data and files. As a result if multiple helpers share some files these files only need to be updated once if required instead of changing them for every implemented helper. A common example are database connection information or general purpose settings and definitions.
### Expected
If the template is not `standalone` the user also has to define what kind of file names he expects to be uploaded when a new output should be created by the helper. Only specified file names will be uploaded and used.
Expected user uploads can be defined via `regex` like this:
* \*.csv - This means all files with the ending `.csv` are valid (at least one such file must be uploaded)
* testfile\.txt - This means at least one file with the name `testfile.txt` has to be uploaded
* testfile\-([0-9]+)\.csv - this means at least one file with the name `testfile-{any_number}.txt` has to be uploaded.