[Projekt: Entwicklung - Neon][TicketNr.: 1048996][Alphabetische Sortierung und...

[Projekt: Entwicklung - Neon][TicketNr.: 1048996][Alphabetische Sortierung und manuelle Sortierung über Pfeile von Schlüsselwortlisten] Bugfixing 6

entity/KeywordEntry_entity/documentation.adoc

@@ -12,14 +12,18 @@ Glossary
 
 
 [glossary]
+Keyword Category (former Keyword container)::
+  A Keyword Category is the element that keeps several entries of Keyword entirestogether. That could be for example something like "Contact-Status".
+
 Keyword Container::
-  A keyword container is the element that keeps several entries of Keywords together. That could be for example something like "Contact-Status". Keep in mind that this done virtually and not in the actual way of storage.
+  This was once the group of a keyword entry list (like "Contact-Status"). Since this now done via the Keyword Category, the keyword container describes
++ the name of the Keyword Category
 
 Keyword Entry::
-  A keyword entry is a specific child-element of a keyword container. For the upper example "Contact-Status" this could be "Active", "Inactive", etc.
+  A keyword entry is a specific child-element of a keyword category. For the upper example "Contact-Status" this could be "Active", "Inactive", etc.
   
 Keyword::
-  Keyword describes the whole set of elements like keyword container and keyword entry. It's more like a virtual bracket for the whole construct.
+  Keyword describes the whole set of elements like keyword category and keyword entry. It's more like a virtual bracket for the whole construct.
   
 
 == Types of Keywords ==
@@ -38,13 +42,13 @@ digraph g {
   graph [ dpi = 100 ]
   node [ shape = box color="#dddddd" fontcolor="#dddddd" fontname = "Consolas"];
   edge [ color="#dddddd" ]
-  { rank=max;  kwdContainer [label="Keyword Container"] }
+  { rank=max;  kwdCategory [label="Keyword Category"] }
   { rank=same; kwdEntry [label="Keyword Entry"] }
   { rank=next; entry1 [label="Entry 1" shape=ellipse] }
   { rank=same entry1; entryN [label="Entry N" shape=ellipse] }
   
-  kwdEntry -> kwdContainer;
-  kwdEntry -> kwdContainer;
+  kwdEntry -> kwdCategory;
+  kwdEntry -> kwdCategory;
   entry1 -> kwdEntry
   entryN -> kwdEntry
 }
@@ -52,32 +56,58 @@ digraph g {
 
 
 Take a look at the following table. Beware that these are not the actual db-column-names but the information what's represented.
+simplified, abstract representation how keywords are actually stored:
 
-.simplified, abstract representation how keywords are actually stored
+.Keyword Entry
 [options="header", cols="m,m,d,d"]
 |=======
-|UID |key-ID |tile | container
+|{set:cellbgcolor:!}
+ UID |key-ID |tile | Category-reference
+|{set:cellbgcolor:#90b678}
+ unique key 1|1-key-value A|one|category_id1
+|unique key 2|2-key-value A|two|category_id1
+|unique key 3|3-key-value A|three|category_id1
+|{set:cellbgcolor:#b69e78 }
+ unique key 4|1-key-value B|I|category_id2
+|unique key 5|2-key-value B|II|category_id2
+|=======
+
+.Keyword Category
+[options="header"]
+|=======
+|{set:cellbgcolor:!}
+ UID |Name | Sorting type |Sorting direction
 |{set:cellbgcolor:#90b678}
- unique key 1|1-key-value A|one|container 1
-|unique key 2|2-key-value A|two|container 1
-|unique key 3|3-key-value A|three|container 1
+ category_id1|Name 1| sort-type 1| sort-direction 1
 |{set:cellbgcolor:#b69e78 }
- unique key 4|1-key-value B|I|container 2
-|unique key 5|2-key-value B|II|container 2
+ category_id2|Name 2| sort-type 2| sort-direction 2
 |=======
 
 And, to clarify an example:
+Simplified, example representation how keywords are acutllay stored:
 
-.simplified, example representation how keywords are acutllay stored
+.Keyword Entry
 [options="header", cols="m,m,d,d"]
 |=======
 |{set:cellbgcolor:! }
- UID |key-ID |tile | container
-|{set:cellbgcolor:#90b678}db1792cd|de-DE|German (Germany)|Language
-|62df7f0ba|en-GB|English (United Kingdom)|Language
-|126229d9|fr-FR|French (France)|Language
-|{set:cellbgcolor:#b69e78 }3508929f|ab7b1885|active|ContactStatus
-|52ce5785|2b2091eb|inactive|ContactStatus
+ UID |key-ID |tile | Category-reference
+|{set:cellbgcolor:#90b678}db1792cd|de-DE|German (Germany)|3fd65
+|62df7f0ba|en-GB|English (United Kingdom)|3fd65
+|126229d9|fr-FR|French (France)|3fd65
+|{set:cellbgcolor:#b69e78 }3508929f|ab7b1885|active|85c1e
+|52ce5785|2b2091eb|inactive|85c1e
+|=======
+
+
+.Keyword Category
+[options="header"]
+|=======
+|{set:cellbgcolor:!}
+ UID |Name | Sorting type |Sorting direction
+|{set:cellbgcolor:#90b678}
+ 3fd65|Language| Alphanumeric| ascending
+|{set:cellbgcolor:#b69e78 }
+ 85c1e|Status| Manual | ascending
 |=======
 
 === Extended Key-Value lists with special Attributes ===
@@ -86,7 +116,7 @@ Basically this is an extension of the <<Simple Key-Value lists>>.
 Sometimes it's necessary to have some more properties within a keyword-entry.
 Example:
 
-You've got a Keyword-container for Types of Communication with basically the following values:
+You've got a Keyword-Category for Types of Communication with basically the following values:
 
 - mobile phone
 - landline phone