mirror of
https://github.com/Karaka-Management/oms-Help.git
synced 2026-01-11 12:58:41 +00:00
Add help module doc
This commit is contained in:
parent
b301301a54
commit
5f361d913b
3
Docs/Help/en/SUMMARY.md
Normal file
3
Docs/Help/en/SUMMARY.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Table of Contents
|
||||
|
||||
* [Documentation]({%}&page=documentation)
|
||||
17
Docs/Help/en/documentation.md
Normal file
17
Docs/Help/en/documentation.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# Documentation
|
||||
|
||||
A documentation can be added to every module by adding the `Docs/Help/{lang}` directory in the module. The language directory needs to be a 2 character ISO code. Inside of this directory you can add/find all the documentation files provided by the module.
|
||||
|
||||
Mandatory files are a `SUMMARY.md` file which contains the list of all documents and a `introduction.md` file which contains a general description of the module.
|
||||
|
||||
## SUMMARY.md example
|
||||
|
||||
```md
|
||||
# Table of Contents
|
||||
|
||||
* [Link Name 1]({%}&page=document_name_1)
|
||||
* [Link Name 2]({%}&page=document_name_2)
|
||||
* [Link Name 3]({%}&page=document_name_3)
|
||||
```
|
||||
|
||||

|
||||
11
Docs/Help/en/introduction.md
Normal file
11
Docs/Help/en/introduction.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# Introduction
|
||||
|
||||
The **Help** module is one of the essential core modules that is always required. This module allows other modules to provide helpful documentation for users, administrators and developers.
|
||||
|
||||
## Target Group
|
||||
|
||||
The target group for this module is everyone.
|
||||
|
||||
# Setup
|
||||
|
||||
This module doesn't have any additional setup requirements since it is installed during the application install process. This module cannot be uninstalled if it is manually deleted from the hard drive please manually download the module from the page and put it into the `Modules/` directory.
|
||||
BIN
Docs/Help/img/directory_structure.png
Normal file
BIN
Docs/Help/img/directory_structure.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -1,21 +0,0 @@
|
|||
# Introduction
|
||||
|
||||
The **Dashboard** module is one of the essential core modules that is always required. This module is responsible for providing a personalizable dashboard after login.
|
||||
|
||||
## Target Group
|
||||
|
||||
The target group for this module is everyone.
|
||||
|
||||
# Setup
|
||||
|
||||
The module can be installed through the integrated module downloader and installer or by uploading the module into the `Modules/` directory and executing the installation through the module installer.
|
||||
|
||||
# Features
|
||||
|
||||
## Customizability
|
||||
|
||||
The dashboard can be custamized by every user according to his/her needs. It's also possible to define default dashboards for different user groups which can be used by users. This allows the administrator to provide default dashboards which then can be used without manually creating a dashboard.
|
||||
|
||||
## Extendability
|
||||
|
||||
All modules can provide one or multiple dashboard components which can be integrated in the dashboard.
|
||||
Loading…
Reference in New Issue
Block a user