mirror of
https://github.com/Karaka-Management/oms-News.git
synced 2026-01-11 16:18:41 +00:00
More introductions
This commit is contained in:
parent
bafcb84963
commit
1ffeac2304
54
Docs/introduction.md
Normal file
54
Docs/introduction.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
# Introduction
|
||||
|
||||
The **News** module can create articles, headlines and links which can be shown in the intranet, website, blog etc.
|
||||
|
||||
## Target Group
|
||||
|
||||
The target groups for this module are intranet users that want to inform other people about changes or news. The module can also be used for websites or blogs in order to write and show articles to visitors/customers.
|
||||
|
||||
# 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.
|
||||
|
||||
The module is depending on the **Editor** module which provides most of the writing features.
|
||||
|
||||
# Features
|
||||
|
||||
## Timed Release
|
||||
|
||||
Articles can be written in advanced and stored as a draft for further adjustments. In case an article should be released at a specific date/time this can also be configured.
|
||||
|
||||
## Permissions & Groups
|
||||
|
||||
By assigning permissions and groups to articles it's possible to only make them visible to intended audiences and different pages (e.g. intranet, website, blog etc.).
|
||||
|
||||
## Markdown
|
||||
|
||||
The module makes use of an extended markdown version for easy writing and modifications.
|
||||
|
||||
### Extendability
|
||||
|
||||
Modules can provide custom elements which allows them to provide elemnts that normal markdown doesn't support. Some modules that already provide custom elements for articles:
|
||||
|
||||
* Media
|
||||
* Charts
|
||||
* Spreadsheets
|
||||
* Calendar/Events
|
||||
* Tasks
|
||||
* Checklists
|
||||
* Profiles/Contacts
|
||||
|
||||
## Version Control
|
||||
|
||||
Articles can be version controlled which enables to easily see changes made by collaborators.
|
||||
|
||||
## Comments
|
||||
|
||||
One important module that is not required but can be used for better user interaction is the **Comments** module. This module allows to create comments to articles if enabled.
|
||||
|
||||
# Recommendation
|
||||
|
||||
Other modules that work great with this one together are:
|
||||
|
||||
* [Editor](Editor)
|
||||
* [Comments](Comments)
|
||||
Loading…
Reference in New Issue
Block a user