From 0b0b90413efea3c9841198c6be72003f7d238257 Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Sun, 15 Nov 2020 21:12:23 +0100 Subject: [PATCH] start adding docs --- Docs/Dev/en/SUMMARY.md | 3 ++ Docs/Dev/en/search.md | 0 Docs/Dev/en/tag.md | 0 Docs/Help/en/SUMMARY.md | 4 +++ Docs/Help/en/introduction.md | 17 +++++++++++ Docs/Help/en/search.md | 0 Docs/Help/en/tag.md | 0 Docs/introduction.md | 58 ------------------------------------ 8 files changed, 24 insertions(+), 58 deletions(-) create mode 100644 Docs/Dev/en/SUMMARY.md create mode 100644 Docs/Dev/en/search.md create mode 100644 Docs/Dev/en/tag.md create mode 100644 Docs/Help/en/SUMMARY.md create mode 100755 Docs/Help/en/introduction.md create mode 100644 Docs/Help/en/search.md create mode 100644 Docs/Help/en/tag.md delete mode 100755 Docs/introduction.md diff --git a/Docs/Dev/en/SUMMARY.md b/Docs/Dev/en/SUMMARY.md new file mode 100644 index 0000000..d41540c --- /dev/null +++ b/Docs/Dev/en/SUMMARY.md @@ -0,0 +1,3 @@ +# User Content + +* [Search]({%}&page=Tag/search) diff --git a/Docs/Dev/en/search.md b/Docs/Dev/en/search.md new file mode 100644 index 0000000..e69de29 diff --git a/Docs/Dev/en/tag.md b/Docs/Dev/en/tag.md new file mode 100644 index 0000000..e69de29 diff --git a/Docs/Help/en/SUMMARY.md b/Docs/Help/en/SUMMARY.md new file mode 100644 index 0000000..fd75f17 --- /dev/null +++ b/Docs/Help/en/SUMMARY.md @@ -0,0 +1,4 @@ +# User Content + +* [Templates]({%}&page=Help/templates) +* [Reports]({%}&page=Help/reports) diff --git a/Docs/Help/en/introduction.md b/Docs/Help/en/introduction.md new file mode 100755 index 0000000..9495949 --- /dev/null +++ b/Docs/Help/en/introduction.md @@ -0,0 +1,17 @@ +# Introduction + +The **Tag** module can create global tags which can be used for grouping and categorizing content. With tags you can easily search for similar and related content across all modules. + +## Target Group + +The target groups for this module are users that would like to group content together in one module or accross different modules. + +# 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 + +## User Tags + +Users may create their own tags for grouping and categorizing their own content. Other users cannot the user specific tags. diff --git a/Docs/Help/en/search.md b/Docs/Help/en/search.md new file mode 100644 index 0000000..e69de29 diff --git a/Docs/Help/en/tag.md b/Docs/Help/en/tag.md new file mode 100644 index 0000000..e69de29 diff --git a/Docs/introduction.md b/Docs/introduction.md deleted file mode 100755 index 7a9212a..0000000 --- a/Docs/introduction.md +++ /dev/null @@ -1,58 +0,0 @@ -# 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.). - -## Localization - -News articles can get assigned to a language upon which it will be visible only to those who have the same language configuration. This allows organizations to target news articles not only by groups and permissions but also by localization. - -## 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) \ No newline at end of file