From 9878d1c83cc10c8247a673d7d6ef134df199014c Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Fri, 3 Mar 2017 16:05:48 +0100 Subject: [PATCH] More introductions --- Docs/introduction.md | 27 +++++++++++++++++++++++++++ docs/guidelines.dev.md | 3 --- docs/info.md | 11 ----------- 3 files changed, 27 insertions(+), 14 deletions(-) create mode 100644 Docs/introduction.md delete mode 100644 docs/guidelines.dev.md delete mode 100644 docs/info.md diff --git a/Docs/introduction.md b/Docs/introduction.md new file mode 100644 index 0000000..630d9fc --- /dev/null +++ b/Docs/introduction.md @@ -0,0 +1,27 @@ +# Introduction + +The **Navigation** module is one of the essential core modules that is always installed. This module handles navigation elements for the application and all modules that implement a navigation. + +## Target Group + +The target group for this module is everyone, since every application should have this module. + +# Setup + +This module doesn't have any additional setup requirements since it is installed during the application install process. + +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 + +Creating differnt navigation systems. The supported features are: + +* Icons +* Target (e.g. _blank, _self, etc) +* Categories/Groups +* Hierarchy +* Type (e.g. top navigation, side navigation etc.) +* Data-Bind for special behavior +* Custom templates +* State storage (active categories, scroll position, active hierarchy) +* Permissions on customers/groups \ No newline at end of file diff --git a/docs/guidelines.dev.md b/docs/guidelines.dev.md deleted file mode 100644 index 2796bd7..0000000 --- a/docs/guidelines.dev.md +++ /dev/null @@ -1,3 +0,0 @@ -## Installation - -The order of link elements inside the `Navigation.install.json` file needs to be unique. In case the order is not unique it's possible that the link order can vary from page to page. diff --git a/docs/info.md b/docs/info.md deleted file mode 100644 index db3bfa1..0000000 --- a/docs/info.md +++ /dev/null @@ -1,11 +0,0 @@ -# Navigation levels - -0. None -1. Top bar -2. Side bar -3. Content bar -4. Content Side -5. Tabs -6. Dashboard -7. Content Footer -8. Footer \ No newline at end of file